Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ExecWorkspaceAction
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ExecWorkspaceAction

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    Workspace enables locking ADOMs, devices, or policy packages so that an administrator can prevent other administrators from making changes to the elements that they are working in.

    Create ExecWorkspaceAction Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ExecWorkspaceAction(name: string, args: ExecWorkspaceActionArgs, opts?: CustomResourceOptions);
    @overload
def ExecWorkspaceAction(resource_name: str,
                        args: ExecWorkspaceActionArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def ExecWorkspaceAction(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        action: Optional[str] = None,
                        target: Optional[str] = None,
                        adom: Optional[str] = None,
                        comment: Optional[str] = None,
                        exec_workspace_action_id: Optional[str] = None,
                        force_recreate: Optional[str] = None,
                        param: Optional[str] = None,
                        scopetype: Optional[str] = None)
    func NewExecWorkspaceAction(ctx *Context, name string, args ExecWorkspaceActionArgs, opts ...ResourceOption) (*ExecWorkspaceAction, error)
    public ExecWorkspaceAction(string name, ExecWorkspaceActionArgs args, CustomResourceOptions? opts = null)
    public ExecWorkspaceAction(String name, ExecWorkspaceActionArgs args)
public ExecWorkspaceAction(String name, ExecWorkspaceActionArgs args, CustomResourceOptions options)

    type: fortimanager:ExecWorkspaceAction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ExecWorkspaceActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ExecWorkspaceActionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ExecWorkspaceActionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExecWorkspaceActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExecWorkspaceActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var execWorkspaceActionResource = new Fortimanager.ExecWorkspaceAction("execWorkspaceActionResource", new()
{
    Action = "string",
    Target = "string",
    Adom = "string",
    Comment = "string",
    ExecWorkspaceActionId = "string",
    ForceRecreate = "string",
    Param = "string",
    Scopetype = "string",
});

    example, err := fortimanager.NewExecWorkspaceAction(ctx, "execWorkspaceActionResource", &fortimanager.ExecWorkspaceActionArgs{
Action: pulumi.String("string"),
Target: pulumi.String("string"),
Adom: pulumi.String("string"),
Comment: pulumi.String("string"),
ExecWorkspaceActionId: pulumi.String("string"),
ForceRecreate: pulumi.String("string"),
Param: pulumi.String("string"),
Scopetype: pulumi.String("string"),
})

    var execWorkspaceActionResource = new ExecWorkspaceAction("execWorkspaceActionResource", ExecWorkspaceActionArgs.builder()
    .action("string")
    .target("string")
    .adom("string")
    .comment("string")
    .execWorkspaceActionId("string")
    .forceRecreate("string")
    .param("string")
    .scopetype("string")
    .build());

    exec_workspace_action_resource = fortimanager.ExecWorkspaceAction("execWorkspaceActionResource",
    action="string",
    target="string",
    adom="string",
    comment="string",
    exec_workspace_action_id="string",
    force_recreate="string",
    param="string",
    scopetype="string")

    const execWorkspaceActionResource = new fortimanager.ExecWorkspaceAction("execWorkspaceActionResource", {
    action: "string",
    target: "string",
    adom: "string",
    comment: "string",
    execWorkspaceActionId: "string",
    forceRecreate: "string",
    param: "string",
    scopetype: "string",
});

    type: fortimanager:ExecWorkspaceAction
properties:
    action: string
    adom: string
    comment: string
    execWorkspaceActionId: string
    forceRecreate: string
    param: string
    scopetype: string
    target: string

    ExecWorkspaceAction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ExecWorkspaceAction resource accepts the following input properties:

    Action string
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    Target string
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comment string

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    ExecWorkspaceActionId string
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    ForceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    Param string
    the target param will be locked or unlocked.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Action string
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    Target string
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comment string

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    ExecWorkspaceActionId string
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    ForceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    Param string
    the target param will be locked or unlocked.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    action String
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    target String
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment String

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    execWorkspaceActionId String
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    forceRecreate String
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    param String
    the target param will be locked or unlocked.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    action string
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    target string
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment string

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    execWorkspaceActionId string
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    forceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    param string
    the target param will be locked or unlocked.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    action str
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    target str
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment str

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    exec_workspace_action_id str
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    force_recreate str
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    param str
    the target param will be locked or unlocked.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    action String
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    target String
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment String

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    execWorkspaceActionId String
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    forceRecreate String
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    param String
    the target param will be locked or unlocked.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ExecWorkspaceAction resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ExecWorkspaceAction Resource

    Get an existing ExecWorkspaceAction resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ExecWorkspaceActionState, opts?: CustomResourceOptions): ExecWorkspaceAction
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        adom: Optional[str] = None,
        comment: Optional[str] = None,
        exec_workspace_action_id: Optional[str] = None,
        force_recreate: Optional[str] = None,
        param: Optional[str] = None,
        scopetype: Optional[str] = None,
        target: Optional[str] = None) -> ExecWorkspaceAction
    func GetExecWorkspaceAction(ctx *Context, name string, id IDInput, state *ExecWorkspaceActionState, opts ...ResourceOption) (*ExecWorkspaceAction, error)
    public static ExecWorkspaceAction Get(string name, Input<string> id, ExecWorkspaceActionState? state, CustomResourceOptions? opts = null)
    public static ExecWorkspaceAction get(String name, Output<String> id, ExecWorkspaceActionState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ExecWorkspaceAction    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Action string
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comment string

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    ExecWorkspaceActionId string
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    ForceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    Param string
    the target param will be locked or unlocked.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Target string
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    Action string
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comment string

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    ExecWorkspaceActionId string
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    ForceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    Param string
    the target param will be locked or unlocked.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Target string
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    action String
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment String

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    execWorkspaceActionId String
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    forceRecreate String
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    param String
    the target param will be locked or unlocked.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    target String
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    action string
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment string

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    execWorkspaceActionId string
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    forceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    param string
    the target param will be locked or unlocked.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    target string
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    action str
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment str

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    exec_workspace_action_id str
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    force_recreate str
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    param str
    the target param will be locked or unlocked.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    target str
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.
    action String
    Lock or Commit/Unlock ADOMs, devices, or policy packages. Valid values: lockbegin lock, lockend Commit/Unlock.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comment String

    Comment.

    See Guides > To Lock for Restricting Configuration Changes for examples.

    execWorkspaceActionId String
    an identifier for the resource with format {{"workspaceaction" + adomv + action + target + param}}.
    forceRecreate String
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    param String
    the target param will be locked or unlocked.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    target String
    Lock an entire ADOM: keep the argument empty, a device: dev, a specific object : obj or a specific package: pkg.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager