intersight 1.0.64, Apr 30 25

intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet

ciscodevnet/terraform-provider-intersight

intersight.WorkflowBatchApiExecutor

Explore with Pulumi AI

intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet

ciscodevnet/terraform-provider-intersight

Intersight allows generic API tasks to be created by taking the API request body and a response parser specification in the form of content.Grammar object. Batch API associates the list of API requests to be executed as part of single task execution. Each API request takes the request body and a response parser specification.

Usage Example

Resource Creation

import * as pulumi from "@pulumi/pulumi";
import * as intersight from "@pulumi/intersight";

const config = new pulumi.Config();
const workflowTaskDefinition = config.require("workflowTaskDefinition");
const workflowBatchApiExecutor1 = new intersight.WorkflowBatchApiExecutor("workflowBatchApiExecutor1", {
    retryFromFailedApi: false,
    taskDefinitions: [{
        objectType: "workflow.TaskDefinition",
        moid: workflowTaskDefinition,
    }],
});

import pulumi
import pulumi_intersight as intersight

config = pulumi.Config()
workflow_task_definition = config.require("workflowTaskDefinition")
workflow_batch_api_executor1 = intersight.WorkflowBatchApiExecutor("workflowBatchApiExecutor1",
    retry_from_failed_api=False,
    task_definitions=[{
        "object_type": "workflow.TaskDefinition",
        "moid": workflow_task_definition,
    }])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/intersight/intersight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		workflowTaskDefinition := cfg.Require("workflowTaskDefinition")
		_, err := intersight.NewWorkflowBatchApiExecutor(ctx, "workflowBatchApiExecutor1", &intersight.WorkflowBatchApiExecutorArgs{
			RetryFromFailedApi: pulumi.Bool(false),
			TaskDefinitions: intersight.WorkflowBatchApiExecutorTaskDefinitionArray{
				&intersight.WorkflowBatchApiExecutorTaskDefinitionArgs{
					ObjectType: pulumi.String("workflow.TaskDefinition"),
					Moid:       pulumi.String(workflowTaskDefinition),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Intersight = Pulumi.Intersight;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var workflowTaskDefinition = config.Require("workflowTaskDefinition");
    var workflowBatchApiExecutor1 = new Intersight.WorkflowBatchApiExecutor("workflowBatchApiExecutor1", new()
    {
        RetryFromFailedApi = false,
        TaskDefinitions = new[]
        {
            new Intersight.Inputs.WorkflowBatchApiExecutorTaskDefinitionArgs
            {
                ObjectType = "workflow.TaskDefinition",
                Moid = workflowTaskDefinition,
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.intersight.WorkflowBatchApiExecutor;
import com.pulumi.intersight.WorkflowBatchApiExecutorArgs;
import com.pulumi.intersight.inputs.WorkflowBatchApiExecutorTaskDefinitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var workflowTaskDefinition = config.get("workflowTaskDefinition");
        var workflowBatchApiExecutor1 = new WorkflowBatchApiExecutor("workflowBatchApiExecutor1", WorkflowBatchApiExecutorArgs.builder()
            .retryFromFailedApi(false)
            .taskDefinitions(WorkflowBatchApiExecutorTaskDefinitionArgs.builder()
                .objectType("workflow.TaskDefinition")
                .moid(workflowTaskDefinition)
                .build())
            .build());

    }
}

configuration:
  workflowTaskDefinition:
    type: string
resources:
  workflowBatchApiExecutor1:
    type: intersight:WorkflowBatchApiExecutor
    properties:
      retryFromFailedApi: false
      taskDefinitions:
        - objectType: workflow.TaskDefinition
          moid: ${workflowTaskDefinition}

Allowed Types in `AdditionalProperties`

workflow.AnsiblePlaySession

This models a single Ansible playbook execution session on the Ansible Control node. While execution of the respective Ansible task, the below provided property values are used to construct the SSH Batch executor, which gets executed on the endpoint.

command_line_arguments:(string) The command line arguments for running the Ansible playbook against the given endpoint. Escape character backslash needs to be used when the command line arguments contain double quotes in them.
host_inventory:(string) The path of the host inventory file that resides on the Ansible Endpoint target or the comma separated list of hosts on which the Ansible playbook is to be run. Make sure to suffix a comma when the list of hosts is provided as input, even if the list has only one value.
playbook_path:(string) The path of the Ansible playbook that resides on the Ansible Endpoint target.
ssh_op_timeout:(string) SSH operation timeout value in seconds. Value provided should be string representation of an interger.

workflow.CliCommand

This models a single CLI command that can be executed on the end point.

command:(string) The command to run on the device connector.
end_prompt:(string) The regex string that identifies the end of the command response.
expect_prompts:(Array) This complex property has following sub-properties:
- expect:(string) The regex of the expect prompt of the interactive command.
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- send:(string) The answer string to the expect prompt.
expected_exit_codes: (Array of schema.TypeInt) -
skip_status_check:(bool) Skips the execution status check of the terminal command. One use case for this is while exiting theterminal session from esxi host.
terminal_end:(bool) If this flag is set, it marks the end of the terminal session where the previous commands were executed.
terminal_start:(bool) If this flag is set, the execution of this command initiates a terminal session in which the subsequentCLI commands are executed until a command with terminalEnd flag is encountered or the end of the batch.
type:(string) The type of the command - can be interactive or non-interactive.* NonInteractive - The CLI command is not an interactive command.* Interactive - The CLI command is executed in interactive mode and the command must provide the expects andanswers.

workflow.FileOperations

This models a single File Operation request within a batch of requests that get executed within a single workflow task.

file_download:(HashMap) - File operation to download a given file from Intersight storage services such asAWS or Minio bucket to a specified path on one or more Intersight connected devices. This complex property has following sub-properties:
- destination_path:(string) Path on the Intersight connected device to which file needs to be downloaded.
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- source_bucket:(string) Source bucket name hosting the file.
- source_file:(string) Name of the file to be downloaded from bucket to endpoint devices.
file_template:(HashMap) - Populates data driven template file with input values to generate textual output. This complex property has following sub-properties:
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- template_file_path:(string) Path of the template file on the connected device.
- template_values:(JSON as string) Input values to render text output file from template file.
operation_type:(string) File operation type to be executed on the connected endpoint.* FileDownload - The API is executed in a remote device connected to the Intersightthrough its device connector. This operation is to download the filefrom specified storage bucket to the specific path on the device.* FileTemplatize - Populates data driven template file with input values to generate textual output.Inputs - the path of the template file on the device and json values to populate.An error will be returned if the file does not exists or if there is an error whileexecuting the template.

workflow.PowerShellApi

This models a single PowerShell script execution that can be sent to a claimed PowerShell target.

depth:(int) The response of a PowerShell script is an object, since PowerShell is an Object based language.Each object can contain multiple objects as properties, each of which in turn can contain multiple objects and so on and so forth.The depth field specifies how many levels of contained objects are included in the JSON representation.
operation_timeout:(string) The timeout in seconds for the execution of the script against the given endpoint.
power_shell_response_spec:(JSON as string) The grammar specification to parse the response and extract the required values.

workflow.SshSession

This models a single SSH session from Intersight connected endpoint to a remote server. Multiple SSH operations can be run sequentially over a single SSH session.

capture_complete_response:(string) Flag to allow capturing entire command response as batch API output.
expected_exit_codes:(JSON as string) Optional array of integer values to specify the expected exit codes of a SSH command execution. SSH commandexecution is marked success upon receiving any of the expected exit code from command execution. If not set, successexit code of 0 is expected from command execution.
file_transfer_to_remote:(HashMap) - Message to transfer a file from Intersight connected device to remote server. This complex property has following sub-properties:
- destination_file_path:(string) Destination file path on the target server.
- encrypted_aes_key:(string) The secure properties that have large text content as value can be encrypted using AES key. In these cases, the AES key needs to be encrypted using the device connector’s public key and passed as the value for this property.The secure properties that are encrypted using the AES key are mapped against the property name with prefix ‘AES’ in SecureProperties dictionary.
- encryption_key:(string) The public key that was used to encrypt the values present in SecureProperties dictionary.If the given public key is not the same as device connector’s public key, an error response with appropriate error message is thrown back.
- file_mode:(int) File permission to set on the transferred file.
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- secure_properties:(JSON as string) A dictionary of encrypted secure values mapped against the secure property name. The values that are encrypted using the AES key must be mapped against the secure property name with an ‘AES’ prefixDevice connector expects the message body to be a golang template and the template can use the secure property names as placeholders.
- source_file_path:(string) Source file path on the Intersight connected device.
message_type:(string) The type of SSH message to be sent to the remote server.* ExecuteCommand - Execute a SSH command on the remote server.* NewSession - Open a new SSH connection to the remote server.* FileTransfer - Transfer a file from Intersight connected device to the remote server.* CloseSession - Close the SSH connection to the remote server.
ssh_command:(JSON as string) SSH command to execute on the remote server.
ssh_configuration:(HashMap) - Carries the SSH session details for opening a new connection. This complex property has following sub-properties:
- encrypted_aes_key:(string) The secure properties that have large text content as value can be encrypted using AES key. In these cases, the AES key needs to be encrypted using the device connector’s public key and passed as the value for this property.The secure properties that are encrypted using the AES key are mapped against the property name with prefix ‘AES’ in SecureProperties dictionary.
- encryption_key:(string) The public key that was used to encrypt the values present in SecureProperties dictionary.If the given public key is not the same as device connector’s public key, an error response with appropriate error message is thrown back.
- is_passphrase_set:(bool)(ReadOnly) Indicates whether the value of the ‘passphrase’ property has been set.
- is_password_set:(bool)(ReadOnly) Indicates whether the value of the ‘password’ property has been set.
- is_private_key_set:(bool)(ReadOnly) Indicates whether the value of the ‘privateKey’ property has been set.
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- passphrase:(string) Optional passphrase if provided while creating the private key.
- password:(string) Password to use in the SSH connection credentials (If empty, private key will be used).
- private_key:(string) PEM encoded private key to be used in the SSH connection credentials (Optional if password is given).
- secure_properties:(JSON as string) A dictionary of encrypted secure values mapped against the secure property name. The values that are encrypted using the AES key must be mapped against the secure property name with an ‘AES’ prefixDevice connector expects the message body to be a golang template and the template can use the secure property names as placeholders.
- target:(string) The remote server to connect to. IPv4 address represented in dot decimal notation or hostname can bespecified.
- user:(string) Username for the remote SSH connection.
ssh_op_timeout:(string) SSH operation timeout value in seconds. The provided string value should be able to convert torespective integer value.

workflow.WebApi

This models a single Web API request within a batch of requests that get executed within a single workflow task.

cookies:(JSON as string) Collection of key value pairs to set in the request header as Cookie list.
endpoint_request_type:(string) If the target type is Endpoint, this property determines whether the request isto be handled as internal request or external request by the device connector.* Internal - The endpoint API executed is an internal request handled by the device connector plugin.* External - The endpoint API request is passed through by the device connector.
headers:(JSON as string) Collection of key value pairs to set in the request header.
method:(string) The HTTP method to be executed in the given URL (GET, POST, PUT, etc).If the value is not specified, GET will be used as default.The supported values are GET, POST, PUT, DELETE, PATCH, HEAD.
mo_type:(string) The type of the intersight object for which API request is to be made.The property is valid in case of Intersight API calls and the base url is automatically prepended based on the value.
protocol:(string) The accepted web protocol values are http and https.
target_type:(string) If the web API is to be executed in a remote device connected to theIntersight through device connector, ‘Endpoint’ is expected as the valuewhereas if the API is an Intersight API, ‘Local’ is expected as the value.
url:(string) The URL of the resource in the target to which the API request is made.

workflow.XmlApi

This models a single XML API request that can be sent to any Cisco UCS devices that support Cisco UCS XML API interface.

workflow.AnsiblePlaySession

command_line_arguments:(string) The command line arguments for running the Ansible playbook against the given endpoint. Escape character backslash needs to be used when the command line arguments contain double quotes in them.
host_inventory:(string) The path of the host inventory file that resides on the Ansible Endpoint target or the comma separated list of hosts on which the Ansible playbook is to be run. Make sure to suffix a comma when the list of hosts is provided as input, even if the list has only one value.
playbook_path:(string) The path of the Ansible playbook that resides on the Ansible Endpoint target.
ssh_op_timeout:(string) SSH operation timeout value in seconds. Value provided should be string representation of an interger.

workflow.CliCommand

This models a single CLI command that can be executed on the end point.

command:(string) The command to run on the device connector.
end_prompt:(string) The regex string that identifies the end of the command response.
expect_prompts:(Array) This complex property has following sub-properties:
- expect:(string) The regex of the expect prompt of the interactive command.
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- send:(string) The answer string to the expect prompt.
expected_exit_codes: (Array of schema.TypeInt) -
skip_status_check:(bool) Skips the execution status check of the terminal command. One use case for this is while exiting theterminal session from esxi host.
terminal_end:(bool) If this flag is set, it marks the end of the terminal session where the previous commands were executed.
terminal_start:(bool) If this flag is set, the execution of this command initiates a terminal session in which the subsequentCLI commands are executed until a command with terminalEnd flag is encountered or the end of the batch.
type:(string) The type of the command - can be interactive or non-interactive.* NonInteractive - The CLI command is not an interactive command.* Interactive - The CLI command is executed in interactive mode and the command must provide the expects andanswers.

workflow.FileOperations

This models a single File Operation request within a batch of requests that get executed within a single workflow task.

file_download:(HashMap) - File operation to download a given file from Intersight storage services such asAWS or Minio bucket to a specified path on one or more Intersight connected devices. This complex property has following sub-properties:
- destination_path:(string) Path on the Intersight connected device to which file needs to be downloaded.
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- source_bucket:(string) Source bucket name hosting the file.
- source_file:(string) Name of the file to be downloaded from bucket to endpoint devices.
file_template:(HashMap) - Populates data driven template file with input values to generate textual output. This complex property has following sub-properties:
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- template_file_path:(string) Path of the template file on the connected device.
- template_values:(JSON as string) Input values to render text output file from template file.
operation_type:(string) File operation type to be executed on the connected endpoint.* FileDownload - The API is executed in a remote device connected to the Intersightthrough its device connector. This operation is to download the filefrom specified storage bucket to the specific path on the device.* FileTemplatize - Populates data driven template file with input values to generate textual output.Inputs - the path of the template file on the device and json values to populate.An error will be returned if the file does not exists or if there is an error whileexecuting the template.

workflow.PowerShellApi

This models a single PowerShell script execution that can be sent to a claimed PowerShell target.

depth:(int) The response of a PowerShell script is an object, since PowerShell is an Object based language.Each object can contain multiple objects as properties, each of which in turn can contain multiple objects and so on and so forth.The depth field specifies how many levels of contained objects are included in the JSON representation.
operation_timeout:(string) The timeout in seconds for the execution of the script against the given endpoint.
power_shell_response_spec:(JSON as string) The grammar specification to parse the response and extract the required values.

workflow.SshSession

This models a single SSH session from Intersight connected endpoint to a remote server. Multiple SSH operations can be run sequentially over a single SSH session.

capture_complete_response:(string) Flag to allow capturing entire command response as batch API output.
expected_exit_codes:(JSON as string) Optional array of integer values to specify the expected exit codes of a SSH command execution. SSH commandexecution is marked success upon receiving any of the expected exit code from command execution. If not set, successexit code of 0 is expected from command execution.
file_transfer_to_remote:(HashMap) - Message to transfer a file from Intersight connected device to remote server. This complex property has following sub-properties:
- destination_file_path:(string) Destination file path on the target server.
- encrypted_aes_key:(string) The secure properties that have large text content as value can be encrypted using AES key. In these cases, the AES key needs to be encrypted using the device connector’s public key and passed as the value for this property.The secure properties that are encrypted using the AES key are mapped against the property name with prefix ‘AES’ in SecureProperties dictionary.
- encryption_key:(string) The public key that was used to encrypt the values present in SecureProperties dictionary.If the given public key is not the same as device connector’s public key, an error response with appropriate error message is thrown back.
- file_mode:(int) File permission to set on the transferred file.
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- secure_properties:(JSON as string) A dictionary of encrypted secure values mapped against the secure property name. The values that are encrypted using the AES key must be mapped against the secure property name with an ‘AES’ prefixDevice connector expects the message body to be a golang template and the template can use the secure property names as placeholders.
- source_file_path:(string) Source file path on the Intersight connected device.
message_type:(string) The type of SSH message to be sent to the remote server.* ExecuteCommand - Execute a SSH command on the remote server.* NewSession - Open a new SSH connection to the remote server.* FileTransfer - Transfer a file from Intersight connected device to the remote server.* CloseSession - Close the SSH connection to the remote server.
ssh_command:(JSON as string) SSH command to execute on the remote server.
ssh_configuration:(HashMap) - Carries the SSH session details for opening a new connection. This complex property has following sub-properties:
- encrypted_aes_key:(string) The secure properties that have large text content as value can be encrypted using AES key. In these cases, the AES key needs to be encrypted using the device connector’s public key and passed as the value for this property.The secure properties that are encrypted using the AES key are mapped against the property name with prefix ‘AES’ in SecureProperties dictionary.
- encryption_key:(string) The public key that was used to encrypt the values present in SecureProperties dictionary.If the given public key is not the same as device connector’s public key, an error response with appropriate error message is thrown back.
- is_passphrase_set:(bool)(ReadOnly) Indicates whether the value of the ‘passphrase’ property has been set.
- is_password_set:(bool)(ReadOnly) Indicates whether the value of the ‘password’ property has been set.
- is_private_key_set:(bool)(ReadOnly) Indicates whether the value of the ‘privateKey’ property has been set.
- object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
- passphrase:(string) Optional passphrase if provided while creating the private key.
- password:(string) Password to use in the SSH connection credentials (If empty, private key will be used).
- private_key:(string) PEM encoded private key to be used in the SSH connection credentials (Optional if password is given).
- secure_properties:(JSON as string) A dictionary of encrypted secure values mapped against the secure property name. The values that are encrypted using the AES key must be mapped against the secure property name with an ‘AES’ prefixDevice connector expects the message body to be a golang template and the template can use the secure property names as placeholders.
- target:(string) The remote server to connect to. IPv4 address represented in dot decimal notation or hostname can bespecified.
- user:(string) Username for the remote SSH connection.
ssh_op_timeout:(string) SSH operation timeout value in seconds. The provided string value should be able to convert torespective integer value.

workflow.WebApi

This models a single Web API request within a batch of requests that get executed within a single workflow task.

cookies:(JSON as string) Collection of key value pairs to set in the request header as Cookie list.
endpoint_request_type:(string) If the target type is Endpoint, this property determines whether the request isto be handled as internal request or external request by the device connector.* Internal - The endpoint API executed is an internal request handled by the device connector plugin.* External - The endpoint API request is passed through by the device connector.
headers:(JSON as string) Collection of key value pairs to set in the request header.
method:(string) The HTTP method to be executed in the given URL (GET, POST, PUT, etc).If the value is not specified, GET will be used as default.The supported values are GET, POST, PUT, DELETE, PATCH, HEAD.
mo_type:(string) The type of the intersight object for which API request is to be made.The property is valid in case of Intersight API calls and the base url is automatically prepended based on the value.
protocol:(string) The accepted web protocol values are http and https.
target_type:(string) If the web API is to be executed in a remote device connected to theIntersight through device connector, ‘Endpoint’ is expected as the valuewhereas if the API is an Intersight API, ‘Local’ is expected as the value.
url:(string) The URL of the resource in the target to which the API request is made.

workflow.XmlApi

This models a single XML API request that can be sent to any Cisco UCS devices that support Cisco UCS XML API interface.

Create WorkflowBatchApiExecutor Resource

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

Constructor syntax

new WorkflowBatchApiExecutor(name: string, args?: WorkflowBatchApiExecutorArgs, opts?: CustomResourceOptions);

@overload
def WorkflowBatchApiExecutor(resource_name: str,
                             args: Optional[WorkflowBatchApiExecutorArgs] = None,
                             opts: Optional[ResourceOptions] = None)

@overload
def WorkflowBatchApiExecutor(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             account_moid: Optional[str] = None,
                             additional_properties: Optional[str] = None,
                             ancestors: Optional[Sequence[WorkflowBatchApiExecutorAncestorArgs]] = None,
                             batches: Optional[Sequence[WorkflowBatchApiExecutorBatchArgs]] = None,
                             cancel_actions: Optional[Sequence[WorkflowBatchApiExecutorCancelActionArgs]] = None,
                             class_id: Optional[str] = None,
                             constraints: Optional[Sequence[WorkflowBatchApiExecutorConstraintArgs]] = None,
                             create_time: Optional[str] = None,
                             description: Optional[str] = None,
                             domain_group_moid: Optional[str] = None,
                             error_response_handlers: Optional[Sequence[WorkflowBatchApiExecutorErrorResponseHandlerArgs]] = None,
                             mod_time: Optional[str] = None,
                             moid: Optional[str] = None,
                             name: Optional[str] = None,
                             object_type: Optional[str] = None,
                             outcomes: Optional[str] = None,
                             output: Optional[str] = None,
                             owners: Optional[Sequence[str]] = None,
                             parents: Optional[Sequence[WorkflowBatchApiExecutorParentArgs]] = None,
                             permission_resources: Optional[Sequence[WorkflowBatchApiExecutorPermissionResourceArgs]] = None,
                             retry_from_failed_api: Optional[bool] = None,
                             shared_scope: Optional[str] = None,
                             skip_on_condition: Optional[str] = None,
                             tags: Optional[Sequence[WorkflowBatchApiExecutorTagArgs]] = None,
                             task_definitions: Optional[Sequence[WorkflowBatchApiExecutorTaskDefinitionArgs]] = None,
                             ui_rendering_data: Optional[str] = None,
                             version_contexts: Optional[Sequence[WorkflowBatchApiExecutorVersionContextArgs]] = None,
                             workflow_batch_api_executor_id: Optional[str] = None)

func NewWorkflowBatchApiExecutor(ctx *Context, name string, args *WorkflowBatchApiExecutorArgs, opts ...ResourceOption) (*WorkflowBatchApiExecutor, error)

public WorkflowBatchApiExecutor(string name, WorkflowBatchApiExecutorArgs? args = null, CustomResourceOptions? opts = null)

public WorkflowBatchApiExecutor(String name, WorkflowBatchApiExecutorArgs args)
public WorkflowBatchApiExecutor(String name, WorkflowBatchApiExecutorArgs args, CustomResourceOptions options)

type: intersight:WorkflowBatchApiExecutor
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 WorkflowBatchApiExecutorArgs: 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 WorkflowBatchApiExecutorArgs: 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 WorkflowBatchApiExecutorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WorkflowBatchApiExecutorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WorkflowBatchApiExecutorArgs: 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 workflowBatchApiExecutorResource = new Intersight.WorkflowBatchApiExecutor("workflowBatchApiExecutorResource", new()
{
    AccountMoid = "string",
    AdditionalProperties = "string",
    Ancestors = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorAncestorArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    Batches = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorBatchArgs
        {
            AdditionalProperties = "string",
            AssetTargetMoid = "string",
            Body = "string",
            ClassId = "string",
            ContentType = "string",
            Description = "string",
            ErrorContentType = "string",
            Label = "string",
            Name = "string",
            ObjectType = "string",
            Outcomes = "string",
            ResponseSpec = "string",
            SkipOnCondition = "string",
            StartDelay = 0,
            Timeout = 0,
        },
    },
    CancelActions = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorCancelActionArgs
        {
            AdditionalProperties = "string",
            AssetTargetMoid = "string",
            Body = "string",
            ClassId = "string",
            ContentType = "string",
            Description = "string",
            ErrorContentType = "string",
            Label = "string",
            Name = "string",
            ObjectType = "string",
            Outcomes = "string",
            ResponseSpec = "string",
            SkipOnCondition = "string",
            StartDelay = 0,
            Timeout = 0,
        },
    },
    ClassId = "string",
    Constraints = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorConstraintArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            ObjectType = "string",
            TargetDataType = "string",
        },
    },
    CreateTime = "string",
    Description = "string",
    DomainGroupMoid = "string",
    ErrorResponseHandlers = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorErrorResponseHandlerArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    ModTime = "string",
    Moid = "string",
    Name = "string",
    ObjectType = "string",
    Outcomes = "string",
    Output = "string",
    Owners = new[]
    {
        "string",
    },
    Parents = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorParentArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    PermissionResources = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorPermissionResourceArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    RetryFromFailedApi = false,
    SharedScope = "string",
    SkipOnCondition = "string",
    Tags = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorTagArgs
        {
            AdditionalProperties = "string",
            Key = "string",
            Value = "string",
        },
    },
    TaskDefinitions = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorTaskDefinitionArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            Moid = "string",
            ObjectType = "string",
            Selector = "string",
        },
    },
    UiRenderingData = "string",
    VersionContexts = new[]
    {
        new Intersight.Inputs.WorkflowBatchApiExecutorVersionContextArgs
        {
            AdditionalProperties = "string",
            ClassId = "string",
            InterestedMos = new[]
            {
                new Intersight.Inputs.WorkflowBatchApiExecutorVersionContextInterestedMoArgs
                {
                    AdditionalProperties = "string",
                    ClassId = "string",
                    Moid = "string",
                    ObjectType = "string",
                    Selector = "string",
                },
            },
            MarkedForDeletion = false,
            NrVersion = "string",
            ObjectType = "string",
            RefMos = new[]
            {
                new Intersight.Inputs.WorkflowBatchApiExecutorVersionContextRefMoArgs
                {
                    AdditionalProperties = "string",
                    ClassId = "string",
                    Moid = "string",
                    ObjectType = "string",
                    Selector = "string",
                },
            },
            Timestamp = "string",
            VersionType = "string",
        },
    },
    WorkflowBatchApiExecutorId = "string",
});

example, err := intersight.NewWorkflowBatchApiExecutor(ctx, "workflowBatchApiExecutorResource", &intersight.WorkflowBatchApiExecutorArgs{
	AccountMoid:          pulumi.String("string"),
	AdditionalProperties: pulumi.String("string"),
	Ancestors: intersight.WorkflowBatchApiExecutorAncestorArray{
		&intersight.WorkflowBatchApiExecutorAncestorArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	Batches: intersight.WorkflowBatchApiExecutorBatchArray{
		&intersight.WorkflowBatchApiExecutorBatchArgs{
			AdditionalProperties: pulumi.String("string"),
			AssetTargetMoid:      pulumi.String("string"),
			Body:                 pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			ContentType:          pulumi.String("string"),
			Description:          pulumi.String("string"),
			ErrorContentType:     pulumi.String("string"),
			Label:                pulumi.String("string"),
			Name:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Outcomes:             pulumi.String("string"),
			ResponseSpec:         pulumi.String("string"),
			SkipOnCondition:      pulumi.String("string"),
			StartDelay:           pulumi.Float64(0),
			Timeout:              pulumi.Float64(0),
		},
	},
	CancelActions: intersight.WorkflowBatchApiExecutorCancelActionArray{
		&intersight.WorkflowBatchApiExecutorCancelActionArgs{
			AdditionalProperties: pulumi.String("string"),
			AssetTargetMoid:      pulumi.String("string"),
			Body:                 pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			ContentType:          pulumi.String("string"),
			Description:          pulumi.String("string"),
			ErrorContentType:     pulumi.String("string"),
			Label:                pulumi.String("string"),
			Name:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Outcomes:             pulumi.String("string"),
			ResponseSpec:         pulumi.String("string"),
			SkipOnCondition:      pulumi.String("string"),
			StartDelay:           pulumi.Float64(0),
			Timeout:              pulumi.Float64(0),
		},
	},
	ClassId: pulumi.String("string"),
	Constraints: intersight.WorkflowBatchApiExecutorConstraintArray{
		&intersight.WorkflowBatchApiExecutorConstraintArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			TargetDataType:       pulumi.String("string"),
		},
	},
	CreateTime:      pulumi.String("string"),
	Description:     pulumi.String("string"),
	DomainGroupMoid: pulumi.String("string"),
	ErrorResponseHandlers: intersight.WorkflowBatchApiExecutorErrorResponseHandlerArray{
		&intersight.WorkflowBatchApiExecutorErrorResponseHandlerArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	ModTime:    pulumi.String("string"),
	Moid:       pulumi.String("string"),
	Name:       pulumi.String("string"),
	ObjectType: pulumi.String("string"),
	Outcomes:   pulumi.String("string"),
	Output:     pulumi.String("string"),
	Owners: pulumi.StringArray{
		pulumi.String("string"),
	},
	Parents: intersight.WorkflowBatchApiExecutorParentArray{
		&intersight.WorkflowBatchApiExecutorParentArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	PermissionResources: intersight.WorkflowBatchApiExecutorPermissionResourceArray{
		&intersight.WorkflowBatchApiExecutorPermissionResourceArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	RetryFromFailedApi: pulumi.Bool(false),
	SharedScope:        pulumi.String("string"),
	SkipOnCondition:    pulumi.String("string"),
	Tags: intersight.WorkflowBatchApiExecutorTagArray{
		&intersight.WorkflowBatchApiExecutorTagArgs{
			AdditionalProperties: pulumi.String("string"),
			Key:                  pulumi.String("string"),
			Value:                pulumi.String("string"),
		},
	},
	TaskDefinitions: intersight.WorkflowBatchApiExecutorTaskDefinitionArray{
		&intersight.WorkflowBatchApiExecutorTaskDefinitionArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			Moid:                 pulumi.String("string"),
			ObjectType:           pulumi.String("string"),
			Selector:             pulumi.String("string"),
		},
	},
	UiRenderingData: pulumi.String("string"),
	VersionContexts: intersight.WorkflowBatchApiExecutorVersionContextArray{
		&intersight.WorkflowBatchApiExecutorVersionContextArgs{
			AdditionalProperties: pulumi.String("string"),
			ClassId:              pulumi.String("string"),
			InterestedMos: intersight.WorkflowBatchApiExecutorVersionContextInterestedMoArray{
				&intersight.WorkflowBatchApiExecutorVersionContextInterestedMoArgs{
					AdditionalProperties: pulumi.String("string"),
					ClassId:              pulumi.String("string"),
					Moid:                 pulumi.String("string"),
					ObjectType:           pulumi.String("string"),
					Selector:             pulumi.String("string"),
				},
			},
			MarkedForDeletion: pulumi.Bool(false),
			NrVersion:         pulumi.String("string"),
			ObjectType:        pulumi.String("string"),
			RefMos: intersight.WorkflowBatchApiExecutorVersionContextRefMoArray{
				&intersight.WorkflowBatchApiExecutorVersionContextRefMoArgs{
					AdditionalProperties: pulumi.String("string"),
					ClassId:              pulumi.String("string"),
					Moid:                 pulumi.String("string"),
					ObjectType:           pulumi.String("string"),
					Selector:             pulumi.String("string"),
				},
			},
			Timestamp:   pulumi.String("string"),
			VersionType: pulumi.String("string"),
		},
	},
	WorkflowBatchApiExecutorId: pulumi.String("string"),
})

var workflowBatchApiExecutorResource = new WorkflowBatchApiExecutor("workflowBatchApiExecutorResource", WorkflowBatchApiExecutorArgs.builder()
    .accountMoid("string")
    .additionalProperties("string")
    .ancestors(WorkflowBatchApiExecutorAncestorArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .batches(WorkflowBatchApiExecutorBatchArgs.builder()
        .additionalProperties("string")
        .assetTargetMoid("string")
        .body("string")
        .classId("string")
        .contentType("string")
        .description("string")
        .errorContentType("string")
        .label("string")
        .name("string")
        .objectType("string")
        .outcomes("string")
        .responseSpec("string")
        .skipOnCondition("string")
        .startDelay(0)
        .timeout(0)
        .build())
    .cancelActions(WorkflowBatchApiExecutorCancelActionArgs.builder()
        .additionalProperties("string")
        .assetTargetMoid("string")
        .body("string")
        .classId("string")
        .contentType("string")
        .description("string")
        .errorContentType("string")
        .label("string")
        .name("string")
        .objectType("string")
        .outcomes("string")
        .responseSpec("string")
        .skipOnCondition("string")
        .startDelay(0)
        .timeout(0)
        .build())
    .classId("string")
    .constraints(WorkflowBatchApiExecutorConstraintArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .objectType("string")
        .targetDataType("string")
        .build())
    .createTime("string")
    .description("string")
    .domainGroupMoid("string")
    .errorResponseHandlers(WorkflowBatchApiExecutorErrorResponseHandlerArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .modTime("string")
    .moid("string")
    .name("string")
    .objectType("string")
    .outcomes("string")
    .output("string")
    .owners("string")
    .parents(WorkflowBatchApiExecutorParentArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .permissionResources(WorkflowBatchApiExecutorPermissionResourceArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .retryFromFailedApi(false)
    .sharedScope("string")
    .skipOnCondition("string")
    .tags(WorkflowBatchApiExecutorTagArgs.builder()
        .additionalProperties("string")
        .key("string")
        .value("string")
        .build())
    .taskDefinitions(WorkflowBatchApiExecutorTaskDefinitionArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .moid("string")
        .objectType("string")
        .selector("string")
        .build())
    .uiRenderingData("string")
    .versionContexts(WorkflowBatchApiExecutorVersionContextArgs.builder()
        .additionalProperties("string")
        .classId("string")
        .interestedMos(WorkflowBatchApiExecutorVersionContextInterestedMoArgs.builder()
            .additionalProperties("string")
            .classId("string")
            .moid("string")
            .objectType("string")
            .selector("string")
            .build())
        .markedForDeletion(false)
        .nrVersion("string")
        .objectType("string")
        .refMos(WorkflowBatchApiExecutorVersionContextRefMoArgs.builder()
            .additionalProperties("string")
            .classId("string")
            .moid("string")
            .objectType("string")
            .selector("string")
            .build())
        .timestamp("string")
        .versionType("string")
        .build())
    .workflowBatchApiExecutorId("string")
    .build());

workflow_batch_api_executor_resource = intersight.WorkflowBatchApiExecutor("workflowBatchApiExecutorResource",
    account_moid="string",
    additional_properties="string",
    ancestors=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    batches=[{
        "additional_properties": "string",
        "asset_target_moid": "string",
        "body": "string",
        "class_id": "string",
        "content_type": "string",
        "description": "string",
        "error_content_type": "string",
        "label": "string",
        "name": "string",
        "object_type": "string",
        "outcomes": "string",
        "response_spec": "string",
        "skip_on_condition": "string",
        "start_delay": 0,
        "timeout": 0,
    }],
    cancel_actions=[{
        "additional_properties": "string",
        "asset_target_moid": "string",
        "body": "string",
        "class_id": "string",
        "content_type": "string",
        "description": "string",
        "error_content_type": "string",
        "label": "string",
        "name": "string",
        "object_type": "string",
        "outcomes": "string",
        "response_spec": "string",
        "skip_on_condition": "string",
        "start_delay": 0,
        "timeout": 0,
    }],
    class_id="string",
    constraints=[{
        "additional_properties": "string",
        "class_id": "string",
        "object_type": "string",
        "target_data_type": "string",
    }],
    create_time="string",
    description="string",
    domain_group_moid="string",
    error_response_handlers=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    mod_time="string",
    moid="string",
    name="string",
    object_type="string",
    outcomes="string",
    output="string",
    owners=["string"],
    parents=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    permission_resources=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    retry_from_failed_api=False,
    shared_scope="string",
    skip_on_condition="string",
    tags=[{
        "additional_properties": "string",
        "key": "string",
        "value": "string",
    }],
    task_definitions=[{
        "additional_properties": "string",
        "class_id": "string",
        "moid": "string",
        "object_type": "string",
        "selector": "string",
    }],
    ui_rendering_data="string",
    version_contexts=[{
        "additional_properties": "string",
        "class_id": "string",
        "interested_mos": [{
            "additional_properties": "string",
            "class_id": "string",
            "moid": "string",
            "object_type": "string",
            "selector": "string",
        }],
        "marked_for_deletion": False,
        "nr_version": "string",
        "object_type": "string",
        "ref_mos": [{
            "additional_properties": "string",
            "class_id": "string",
            "moid": "string",
            "object_type": "string",
            "selector": "string",
        }],
        "timestamp": "string",
        "version_type": "string",
    }],
    workflow_batch_api_executor_id="string")

const workflowBatchApiExecutorResource = new intersight.WorkflowBatchApiExecutor("workflowBatchApiExecutorResource", {
    accountMoid: "string",
    additionalProperties: "string",
    ancestors: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    batches: [{
        additionalProperties: "string",
        assetTargetMoid: "string",
        body: "string",
        classId: "string",
        contentType: "string",
        description: "string",
        errorContentType: "string",
        label: "string",
        name: "string",
        objectType: "string",
        outcomes: "string",
        responseSpec: "string",
        skipOnCondition: "string",
        startDelay: 0,
        timeout: 0,
    }],
    cancelActions: [{
        additionalProperties: "string",
        assetTargetMoid: "string",
        body: "string",
        classId: "string",
        contentType: "string",
        description: "string",
        errorContentType: "string",
        label: "string",
        name: "string",
        objectType: "string",
        outcomes: "string",
        responseSpec: "string",
        skipOnCondition: "string",
        startDelay: 0,
        timeout: 0,
    }],
    classId: "string",
    constraints: [{
        additionalProperties: "string",
        classId: "string",
        objectType: "string",
        targetDataType: "string",
    }],
    createTime: "string",
    description: "string",
    domainGroupMoid: "string",
    errorResponseHandlers: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    modTime: "string",
    moid: "string",
    name: "string",
    objectType: "string",
    outcomes: "string",
    output: "string",
    owners: ["string"],
    parents: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    permissionResources: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    retryFromFailedApi: false,
    sharedScope: "string",
    skipOnCondition: "string",
    tags: [{
        additionalProperties: "string",
        key: "string",
        value: "string",
    }],
    taskDefinitions: [{
        additionalProperties: "string",
        classId: "string",
        moid: "string",
        objectType: "string",
        selector: "string",
    }],
    uiRenderingData: "string",
    versionContexts: [{
        additionalProperties: "string",
        classId: "string",
        interestedMos: [{
            additionalProperties: "string",
            classId: "string",
            moid: "string",
            objectType: "string",
            selector: "string",
        }],
        markedForDeletion: false,
        nrVersion: "string",
        objectType: "string",
        refMos: [{
            additionalProperties: "string",
            classId: "string",
            moid: "string",
            objectType: "string",
            selector: "string",
        }],
        timestamp: "string",
        versionType: "string",
    }],
    workflowBatchApiExecutorId: "string",
});

type: intersight:WorkflowBatchApiExecutor
properties:
    accountMoid: string
    additionalProperties: string
    ancestors:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    batches:
        - additionalProperties: string
          assetTargetMoid: string
          body: string
          classId: string
          contentType: string
          description: string
          errorContentType: string
          label: string
          name: string
          objectType: string
          outcomes: string
          responseSpec: string
          skipOnCondition: string
          startDelay: 0
          timeout: 0
    cancelActions:
        - additionalProperties: string
          assetTargetMoid: string
          body: string
          classId: string
          contentType: string
          description: string
          errorContentType: string
          label: string
          name: string
          objectType: string
          outcomes: string
          responseSpec: string
          skipOnCondition: string
          startDelay: 0
          timeout: 0
    classId: string
    constraints:
        - additionalProperties: string
          classId: string
          objectType: string
          targetDataType: string
    createTime: string
    description: string
    domainGroupMoid: string
    errorResponseHandlers:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    modTime: string
    moid: string
    name: string
    objectType: string
    outcomes: string
    output: string
    owners:
        - string
    parents:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    permissionResources:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    retryFromFailedApi: false
    sharedScope: string
    skipOnCondition: string
    tags:
        - additionalProperties: string
          key: string
          value: string
    taskDefinitions:
        - additionalProperties: string
          classId: string
          moid: string
          objectType: string
          selector: string
    uiRenderingData: string
    versionContexts:
        - additionalProperties: string
          classId: string
          interestedMos:
            - additionalProperties: string
              classId: string
              moid: string
              objectType: string
              selector: string
          markedForDeletion: false
          nrVersion: string
          objectType: string
          refMos:
            - additionalProperties: string
              classId: string
              moid: string
              objectType: string
              selector: string
          timestamp: string
          versionType: string
    workflowBatchApiExecutorId: string

WorkflowBatchApiExecutor 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 WorkflowBatchApiExecutor resource accepts the following input properties:

AccountMoid string: (ReadOnly) The Account ID for this managed object.
AdditionalProperties string
Ancestors List<WorkflowBatchApiExecutorAncestor>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
Batches List<WorkflowBatchApiExecutorBatch>: This complex property has following sub-properties:
CancelActions List<WorkflowBatchApiExecutorCancelAction>: This complex property has following sub-properties:
ClassId string: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
Constraints List<WorkflowBatchApiExecutorConstraint>: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
CreateTime string: (ReadOnly) The time when this managed object was created.
Description string: A detailed description about the batch APIs.
DomainGroupMoid string: (ReadOnly) The DomainGroup ID for this managed object.
ErrorResponseHandlers List<WorkflowBatchApiExecutorErrorResponseHandler>: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
ModTime string: (ReadOnly) The time when this managed object was last modified.
Moid string: The unique identifier of this Managed Object instance.
Name string: Name for the batch API task.
ObjectType string: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
Outcomes string: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
Output string: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
Owners List<string>: (Array of schema.TypeString) -(ReadOnly)
Parents List<WorkflowBatchApiExecutorParent>: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
PermissionResources List<WorkflowBatchApiExecutorPermissionResource>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
RetryFromFailedApi bool: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
SharedScope string: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
SkipOnCondition string: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
Tags List<WorkflowBatchApiExecutorTag>: This complex property has following sub-properties:
TaskDefinitions List<WorkflowBatchApiExecutorTaskDefinition>: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
UiRenderingData string: This will hold the data needed for task to be rendered in the user interface.
VersionContexts List<WorkflowBatchApiExecutorVersionContext>: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
WorkflowBatchApiExecutorId string

AccountMoid string: (ReadOnly) The Account ID for this managed object.
AdditionalProperties string
Ancestors []WorkflowBatchApiExecutorAncestorArgs: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
Batches []WorkflowBatchApiExecutorBatchArgs: This complex property has following sub-properties:
CancelActions []WorkflowBatchApiExecutorCancelActionArgs: This complex property has following sub-properties:
ClassId string: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
Constraints []WorkflowBatchApiExecutorConstraintArgs: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
CreateTime string: (ReadOnly) The time when this managed object was created.
Description string: A detailed description about the batch APIs.
DomainGroupMoid string: (ReadOnly) The DomainGroup ID for this managed object.
ErrorResponseHandlers []WorkflowBatchApiExecutorErrorResponseHandlerArgs: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
ModTime string: (ReadOnly) The time when this managed object was last modified.
Moid string: The unique identifier of this Managed Object instance.
Name string: Name for the batch API task.
ObjectType string: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
Outcomes string: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
Output string: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
Owners []string: (Array of schema.TypeString) -(ReadOnly)
Parents []WorkflowBatchApiExecutorParentArgs: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
PermissionResources []WorkflowBatchApiExecutorPermissionResourceArgs: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
RetryFromFailedApi bool: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
SharedScope string: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
SkipOnCondition string: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
Tags []WorkflowBatchApiExecutorTagArgs: This complex property has following sub-properties:
TaskDefinitions []WorkflowBatchApiExecutorTaskDefinitionArgs: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
UiRenderingData string: This will hold the data needed for task to be rendered in the user interface.
VersionContexts []WorkflowBatchApiExecutorVersionContextArgs: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
WorkflowBatchApiExecutorId string

accountMoid String: (ReadOnly) The Account ID for this managed object.
additionalProperties String
ancestors List<WorkflowBatchApiExecutorAncestor>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
batches List<WorkflowBatchApiExecutorBatch>: This complex property has following sub-properties:
cancelActions List<WorkflowBatchApiExecutorCancelAction>: This complex property has following sub-properties:
classId String: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
constraints List<WorkflowBatchApiExecutorConstraint>: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
createTime String: (ReadOnly) The time when this managed object was created.
description String: A detailed description about the batch APIs.
domainGroupMoid String: (ReadOnly) The DomainGroup ID for this managed object.
errorResponseHandlers List<WorkflowBatchApiExecutorErrorResponseHandler>: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
modTime String: (ReadOnly) The time when this managed object was last modified.
moid String: The unique identifier of this Managed Object instance.
name String: Name for the batch API task.
objectType String: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
outcomes String: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
output String: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
owners List<String>: (Array of schema.TypeString) -(ReadOnly)
parents List<WorkflowBatchApiExecutorParent>: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
permissionResources List<WorkflowBatchApiExecutorPermissionResource>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
retryFromFailedApi Boolean: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
sharedScope String: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
skipOnCondition String: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
tags List<WorkflowBatchApiExecutorTag>: This complex property has following sub-properties:
taskDefinitions List<WorkflowBatchApiExecutorTaskDefinition>: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
uiRenderingData String: This will hold the data needed for task to be rendered in the user interface.
versionContexts List<WorkflowBatchApiExecutorVersionContext>: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
workflowBatchApiExecutorId String

accountMoid string: (ReadOnly) The Account ID for this managed object.
additionalProperties string
ancestors WorkflowBatchApiExecutorAncestor[]: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
batches WorkflowBatchApiExecutorBatch[]: This complex property has following sub-properties:
cancelActions WorkflowBatchApiExecutorCancelAction[]: This complex property has following sub-properties:
classId string: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
constraints WorkflowBatchApiExecutorConstraint[]: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
createTime string: (ReadOnly) The time when this managed object was created.
description string: A detailed description about the batch APIs.
domainGroupMoid string: (ReadOnly) The DomainGroup ID for this managed object.
errorResponseHandlers WorkflowBatchApiExecutorErrorResponseHandler[]: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
modTime string: (ReadOnly) The time when this managed object was last modified.
moid string: The unique identifier of this Managed Object instance.
name string: Name for the batch API task.
objectType string: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
outcomes string: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
output string: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
owners string[]: (Array of schema.TypeString) -(ReadOnly)
parents WorkflowBatchApiExecutorParent[]: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
permissionResources WorkflowBatchApiExecutorPermissionResource[]: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
retryFromFailedApi boolean: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
sharedScope string: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
skipOnCondition string: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
tags WorkflowBatchApiExecutorTag[]: This complex property has following sub-properties:
taskDefinitions WorkflowBatchApiExecutorTaskDefinition[]: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
uiRenderingData string: This will hold the data needed for task to be rendered in the user interface.
versionContexts WorkflowBatchApiExecutorVersionContext[]: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
workflowBatchApiExecutorId string

account_moid str: (ReadOnly) The Account ID for this managed object.
additional_properties str
ancestors Sequence[WorkflowBatchApiExecutorAncestorArgs]: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
batches Sequence[WorkflowBatchApiExecutorBatchArgs]: This complex property has following sub-properties:
cancel_actions Sequence[WorkflowBatchApiExecutorCancelActionArgs]: This complex property has following sub-properties:
class_id str: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
constraints Sequence[WorkflowBatchApiExecutorConstraintArgs]: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
create_time str: (ReadOnly) The time when this managed object was created.
description str: A detailed description about the batch APIs.
domain_group_moid str: (ReadOnly) The DomainGroup ID for this managed object.
error_response_handlers Sequence[WorkflowBatchApiExecutorErrorResponseHandlerArgs]: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
mod_time str: (ReadOnly) The time when this managed object was last modified.
moid str: The unique identifier of this Managed Object instance.
name str: Name for the batch API task.
object_type str: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
outcomes str: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
output str: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
owners Sequence[str]: (Array of schema.TypeString) -(ReadOnly)
parents Sequence[WorkflowBatchApiExecutorParentArgs]: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
permission_resources Sequence[WorkflowBatchApiExecutorPermissionResourceArgs]: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
retry_from_failed_api bool: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
shared_scope str: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
skip_on_condition str: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
tags Sequence[WorkflowBatchApiExecutorTagArgs]: This complex property has following sub-properties:
task_definitions Sequence[WorkflowBatchApiExecutorTaskDefinitionArgs]: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
ui_rendering_data str: This will hold the data needed for task to be rendered in the user interface.
version_contexts Sequence[WorkflowBatchApiExecutorVersionContextArgs]: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
workflow_batch_api_executor_id str

accountMoid String: (ReadOnly) The Account ID for this managed object.
additionalProperties String
ancestors List<Property Map>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
batches List<Property Map>: This complex property has following sub-properties:
cancelActions List<Property Map>: This complex property has following sub-properties:
classId String: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
constraints List<Property Map>: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
createTime String: (ReadOnly) The time when this managed object was created.
description String: A detailed description about the batch APIs.
domainGroupMoid String: (ReadOnly) The DomainGroup ID for this managed object.
errorResponseHandlers List<Property Map>: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
modTime String: (ReadOnly) The time when this managed object was last modified.
moid String: The unique identifier of this Managed Object instance.
name String: Name for the batch API task.
objectType String: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
outcomes String: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
output String: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
owners List<String>: (Array of schema.TypeString) -(ReadOnly)
parents List<Property Map>: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
permissionResources List<Property Map>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
retryFromFailedApi Boolean: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
sharedScope String: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
skipOnCondition String: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
tags List<Property Map>: This complex property has following sub-properties:
taskDefinitions List<Property Map>: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
uiRenderingData String: This will hold the data needed for task to be rendered in the user interface.
versionContexts List<Property Map>: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
workflowBatchApiExecutorId String

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkflowBatchApiExecutor 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 WorkflowBatchApiExecutor Resource

Get an existing WorkflowBatchApiExecutor 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?: WorkflowBatchApiExecutorState, opts?: CustomResourceOptions): WorkflowBatchApiExecutor

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_moid: Optional[str] = None,
        additional_properties: Optional[str] = None,
        ancestors: Optional[Sequence[WorkflowBatchApiExecutorAncestorArgs]] = None,
        batches: Optional[Sequence[WorkflowBatchApiExecutorBatchArgs]] = None,
        cancel_actions: Optional[Sequence[WorkflowBatchApiExecutorCancelActionArgs]] = None,
        class_id: Optional[str] = None,
        constraints: Optional[Sequence[WorkflowBatchApiExecutorConstraintArgs]] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        domain_group_moid: Optional[str] = None,
        error_response_handlers: Optional[Sequence[WorkflowBatchApiExecutorErrorResponseHandlerArgs]] = None,
        mod_time: Optional[str] = None,
        moid: Optional[str] = None,
        name: Optional[str] = None,
        object_type: Optional[str] = None,
        outcomes: Optional[str] = None,
        output: Optional[str] = None,
        owners: Optional[Sequence[str]] = None,
        parents: Optional[Sequence[WorkflowBatchApiExecutorParentArgs]] = None,
        permission_resources: Optional[Sequence[WorkflowBatchApiExecutorPermissionResourceArgs]] = None,
        retry_from_failed_api: Optional[bool] = None,
        shared_scope: Optional[str] = None,
        skip_on_condition: Optional[str] = None,
        tags: Optional[Sequence[WorkflowBatchApiExecutorTagArgs]] = None,
        task_definitions: Optional[Sequence[WorkflowBatchApiExecutorTaskDefinitionArgs]] = None,
        ui_rendering_data: Optional[str] = None,
        version_contexts: Optional[Sequence[WorkflowBatchApiExecutorVersionContextArgs]] = None,
        workflow_batch_api_executor_id: Optional[str] = None) -> WorkflowBatchApiExecutor

func GetWorkflowBatchApiExecutor(ctx *Context, name string, id IDInput, state *WorkflowBatchApiExecutorState, opts ...ResourceOption) (*WorkflowBatchApiExecutor, error)

public static WorkflowBatchApiExecutor Get(string name, Input<string> id, WorkflowBatchApiExecutorState? state, CustomResourceOptions? opts = null)

public static WorkflowBatchApiExecutor get(String name, Output<String> id, WorkflowBatchApiExecutorState state, CustomResourceOptions options)

resources:  _:    type: intersight:WorkflowBatchApiExecutor    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:

AccountMoid string: (ReadOnly) The Account ID for this managed object.
AdditionalProperties string
Ancestors List<WorkflowBatchApiExecutorAncestor>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
Batches List<WorkflowBatchApiExecutorBatch>: This complex property has following sub-properties:
CancelActions List<WorkflowBatchApiExecutorCancelAction>: This complex property has following sub-properties:
ClassId string: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
Constraints List<WorkflowBatchApiExecutorConstraint>: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
CreateTime string: (ReadOnly) The time when this managed object was created.
Description string: A detailed description about the batch APIs.
DomainGroupMoid string: (ReadOnly) The DomainGroup ID for this managed object.
ErrorResponseHandlers List<WorkflowBatchApiExecutorErrorResponseHandler>: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
ModTime string: (ReadOnly) The time when this managed object was last modified.
Moid string: The unique identifier of this Managed Object instance.
Name string: Name for the batch API task.
ObjectType string: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
Outcomes string: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
Output string: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
Owners List<string>: (Array of schema.TypeString) -(ReadOnly)
Parents List<WorkflowBatchApiExecutorParent>: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
PermissionResources List<WorkflowBatchApiExecutorPermissionResource>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
RetryFromFailedApi bool: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
SharedScope string: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
SkipOnCondition string: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
Tags List<WorkflowBatchApiExecutorTag>: This complex property has following sub-properties:
TaskDefinitions List<WorkflowBatchApiExecutorTaskDefinition>: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
UiRenderingData string: This will hold the data needed for task to be rendered in the user interface.
VersionContexts List<WorkflowBatchApiExecutorVersionContext>: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
WorkflowBatchApiExecutorId string

AccountMoid string: (ReadOnly) The Account ID for this managed object.
AdditionalProperties string
Ancestors []WorkflowBatchApiExecutorAncestorArgs: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
Batches []WorkflowBatchApiExecutorBatchArgs: This complex property has following sub-properties:
CancelActions []WorkflowBatchApiExecutorCancelActionArgs: This complex property has following sub-properties:
ClassId string: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
Constraints []WorkflowBatchApiExecutorConstraintArgs: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
CreateTime string: (ReadOnly) The time when this managed object was created.
Description string: A detailed description about the batch APIs.
DomainGroupMoid string: (ReadOnly) The DomainGroup ID for this managed object.
ErrorResponseHandlers []WorkflowBatchApiExecutorErrorResponseHandlerArgs: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
ModTime string: (ReadOnly) The time when this managed object was last modified.
Moid string: The unique identifier of this Managed Object instance.
Name string: Name for the batch API task.
ObjectType string: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
Outcomes string: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
Output string: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
Owners []string: (Array of schema.TypeString) -(ReadOnly)
Parents []WorkflowBatchApiExecutorParentArgs: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
PermissionResources []WorkflowBatchApiExecutorPermissionResourceArgs: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
RetryFromFailedApi bool: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
SharedScope string: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
SkipOnCondition string: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
Tags []WorkflowBatchApiExecutorTagArgs: This complex property has following sub-properties:
TaskDefinitions []WorkflowBatchApiExecutorTaskDefinitionArgs: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
UiRenderingData string: This will hold the data needed for task to be rendered in the user interface.
VersionContexts []WorkflowBatchApiExecutorVersionContextArgs: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
WorkflowBatchApiExecutorId string

accountMoid String: (ReadOnly) The Account ID for this managed object.
additionalProperties String
ancestors List<WorkflowBatchApiExecutorAncestor>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
batches List<WorkflowBatchApiExecutorBatch>: This complex property has following sub-properties:
cancelActions List<WorkflowBatchApiExecutorCancelAction>: This complex property has following sub-properties:
classId String: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
constraints List<WorkflowBatchApiExecutorConstraint>: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
createTime String: (ReadOnly) The time when this managed object was created.
description String: A detailed description about the batch APIs.
domainGroupMoid String: (ReadOnly) The DomainGroup ID for this managed object.
errorResponseHandlers List<WorkflowBatchApiExecutorErrorResponseHandler>: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
modTime String: (ReadOnly) The time when this managed object was last modified.
moid String: The unique identifier of this Managed Object instance.
name String: Name for the batch API task.
objectType String: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
outcomes String: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
output String: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
owners List<String>: (Array of schema.TypeString) -(ReadOnly)
parents List<WorkflowBatchApiExecutorParent>: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
permissionResources List<WorkflowBatchApiExecutorPermissionResource>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
retryFromFailedApi Boolean: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
sharedScope String: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
skipOnCondition String: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
tags List<WorkflowBatchApiExecutorTag>: This complex property has following sub-properties:
taskDefinitions List<WorkflowBatchApiExecutorTaskDefinition>: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
uiRenderingData String: This will hold the data needed for task to be rendered in the user interface.
versionContexts List<WorkflowBatchApiExecutorVersionContext>: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
workflowBatchApiExecutorId String

accountMoid string: (ReadOnly) The Account ID for this managed object.
additionalProperties string
ancestors WorkflowBatchApiExecutorAncestor[]: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
batches WorkflowBatchApiExecutorBatch[]: This complex property has following sub-properties:
cancelActions WorkflowBatchApiExecutorCancelAction[]: This complex property has following sub-properties:
classId string: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
constraints WorkflowBatchApiExecutorConstraint[]: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
createTime string: (ReadOnly) The time when this managed object was created.
description string: A detailed description about the batch APIs.
domainGroupMoid string: (ReadOnly) The DomainGroup ID for this managed object.
errorResponseHandlers WorkflowBatchApiExecutorErrorResponseHandler[]: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
modTime string: (ReadOnly) The time when this managed object was last modified.
moid string: The unique identifier of this Managed Object instance.
name string: Name for the batch API task.
objectType string: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
outcomes string: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
output string: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
owners string[]: (Array of schema.TypeString) -(ReadOnly)
parents WorkflowBatchApiExecutorParent[]: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
permissionResources WorkflowBatchApiExecutorPermissionResource[]: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
retryFromFailedApi boolean: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
sharedScope string: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
skipOnCondition string: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
tags WorkflowBatchApiExecutorTag[]: This complex property has following sub-properties:
taskDefinitions WorkflowBatchApiExecutorTaskDefinition[]: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
uiRenderingData string: This will hold the data needed for task to be rendered in the user interface.
versionContexts WorkflowBatchApiExecutorVersionContext[]: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
workflowBatchApiExecutorId string

account_moid str: (ReadOnly) The Account ID for this managed object.
additional_properties str
ancestors Sequence[WorkflowBatchApiExecutorAncestorArgs]: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
batches Sequence[WorkflowBatchApiExecutorBatchArgs]: This complex property has following sub-properties:
cancel_actions Sequence[WorkflowBatchApiExecutorCancelActionArgs]: This complex property has following sub-properties:
class_id str: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
constraints Sequence[WorkflowBatchApiExecutorConstraintArgs]: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
create_time str: (ReadOnly) The time when this managed object was created.
description str: A detailed description about the batch APIs.
domain_group_moid str: (ReadOnly) The DomainGroup ID for this managed object.
error_response_handlers Sequence[WorkflowBatchApiExecutorErrorResponseHandlerArgs]: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
mod_time str: (ReadOnly) The time when this managed object was last modified.
moid str: The unique identifier of this Managed Object instance.
name str: Name for the batch API task.
object_type str: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
outcomes str: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
output str: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
owners Sequence[str]: (Array of schema.TypeString) -(ReadOnly)
parents Sequence[WorkflowBatchApiExecutorParentArgs]: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
permission_resources Sequence[WorkflowBatchApiExecutorPermissionResourceArgs]: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
retry_from_failed_api bool: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
shared_scope str: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
skip_on_condition str: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
tags Sequence[WorkflowBatchApiExecutorTagArgs]: This complex property has following sub-properties:
task_definitions Sequence[WorkflowBatchApiExecutorTaskDefinitionArgs]: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
ui_rendering_data str: This will hold the data needed for task to be rendered in the user interface.
version_contexts Sequence[WorkflowBatchApiExecutorVersionContextArgs]: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
workflow_batch_api_executor_id str

accountMoid String: (ReadOnly) The Account ID for this managed object.
additionalProperties String
ancestors List<Property Map>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
batches List<Property Map>: This complex property has following sub-properties:
cancelActions List<Property Map>: This complex property has following sub-properties:
classId String: The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
constraints List<Property Map>: Enter the constraints on when this task should match against the task definition. This complex property has following sub-properties:
createTime String: (ReadOnly) The time when this managed object was created.
description String: A detailed description about the batch APIs.
domainGroupMoid String: (ReadOnly) The DomainGroup ID for this managed object.
errorResponseHandlers List<Property Map>: A reference to a workflowErrorResponseHandler resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
modTime String: (ReadOnly) The time when this managed object was last modified.
moid String: The unique identifier of this Managed Object instance.
name String: Name for the batch API task.
objectType String: The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
outcomes String: All the possible outcomes of this task are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
output String: Intersight Orchestrator allows the extraction of required values from APIresponses using the API response grammar. These extracted values can be mappedto task output parameters defined in task definition.The mapping of API output parameters to the task output parameters is providedas JSON in this property.
owners List<String>: (Array of schema.TypeString) -(ReadOnly)
parents List<Property Map>: (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
permissionResources List<Property Map>: (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
retryFromFailedApi Boolean: When an execution of a nth API in the Batch fails,Retry from failed API flag indicates if the execution should start from the nth API or the first API during task retry.By default the value is set to false.
sharedScope String: (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
skipOnCondition String: The skip expression, if provided, allows the batch API executor to skip thetask execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
tags List<Property Map>: This complex property has following sub-properties:
taskDefinitions List<Property Map>: A reference to a workflowTaskDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
uiRenderingData String: This will hold the data needed for task to be rendered in the user interface.
versionContexts List<Property Map>: (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
workflowBatchApiExecutorId String

Supporting Types

WorkflowBatchApiExecutorAncestor, WorkflowBatchApiExecutorAncestorArgs

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string
classId string
moid string: The Moid of the referenced REST resource.
objectType string: The fully-qualified name of the remote type referred by this relationship.
selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str
class_id str
moid str: The Moid of the referenced REST resource.
object_type str: The fully-qualified name of the remote type referred by this relationship.
selector str: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

WorkflowBatchApiExecutorBatch, WorkflowBatchApiExecutorBatchArgs

AdditionalProperties string: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
AssetTargetMoid string: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
Body string: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
ClassId string
ContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
Description string: A description that task designer can add to individual API requests that explain what the API call is about.
ErrorContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
Label string: A user friendly label that task designers have given to the batch API request.
Name string: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
ObjectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
Outcomes string: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
ResponseSpec string: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
SkipOnCondition string: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
StartDelay double: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
Timeout double: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

AdditionalProperties string: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
AssetTargetMoid string: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
Body string: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
ClassId string
ContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
Description string: A description that task designer can add to individual API requests that explain what the API call is about.
ErrorContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
Label string: A user friendly label that task designers have given to the batch API request.
Name string: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
ObjectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
Outcomes string: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
ResponseSpec string: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
SkipOnCondition string: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
StartDelay float64: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
Timeout float64: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

additionalProperties String: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
assetTargetMoid String: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
body String: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
classId String
contentType String: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
description String: A description that task designer can add to individual API requests that explain what the API call is about.
errorContentType String: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
label String: A user friendly label that task designers have given to the batch API request.
name String: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
objectType String: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
outcomes String: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
responseSpec String: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
skipOnCondition String: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
startDelay Double: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
timeout Double: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

additionalProperties string: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
assetTargetMoid string: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
body string: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
classId string
contentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
description string: A description that task designer can add to individual API requests that explain what the API call is about.
errorContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
label string: A user friendly label that task designers have given to the batch API request.
name string: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
objectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
outcomes string: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
responseSpec string: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
skipOnCondition string: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
startDelay number: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
timeout number: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

additional_properties str: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
asset_target_moid str: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
body str: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
class_id str
content_type str: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
description str: A description that task designer can add to individual API requests that explain what the API call is about.
error_content_type str: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
label str: A user friendly label that task designers have given to the batch API request.
name str: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
object_type str: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
outcomes str: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
response_spec str: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
skip_on_condition str: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
start_delay float: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
timeout float: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

additionalProperties String: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
assetTargetMoid String: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
body String: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
classId String
contentType String: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
description String: A description that task designer can add to individual API requests that explain what the API call is about.
errorContentType String: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
label String: A user friendly label that task designers have given to the batch API request.
name String: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
objectType String: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
outcomes String: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
responseSpec String: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
skipOnCondition String: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
startDelay Number: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
timeout Number: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

WorkflowBatchApiExecutorCancelAction, WorkflowBatchApiExecutorCancelActionArgs

AdditionalProperties string: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
AssetTargetMoid string: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
Body string: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
ClassId string
ContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
Description string: A description that task designer can add to individual API requests that explain what the API call is about.
ErrorContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
Label string: A user friendly label that task designers have given to the batch API request.
Name string: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
ObjectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
Outcomes string: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
ResponseSpec string: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
SkipOnCondition string: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
StartDelay double: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
Timeout double: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

AdditionalProperties string: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
AssetTargetMoid string: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
Body string: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
ClassId string
ContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
Description string: A description that task designer can add to individual API requests that explain what the API call is about.
ErrorContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
Label string: A user friendly label that task designers have given to the batch API request.
Name string: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
ObjectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
Outcomes string: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
ResponseSpec string: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
SkipOnCondition string: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
StartDelay float64: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
Timeout float64: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

additionalProperties String: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
assetTargetMoid String: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
body String: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
classId String
contentType String: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
description String: A description that task designer can add to individual API requests that explain what the API call is about.
errorContentType String: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
label String: A user friendly label that task designers have given to the batch API request.
name String: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
objectType String: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
outcomes String: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
responseSpec String: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
skipOnCondition String: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
startDelay Double: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
timeout Double: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

additionalProperties string: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
assetTargetMoid string: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
body string: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
classId string
contentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
description string: A description that task designer can add to individual API requests that explain what the API call is about.
errorContentType string: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
label string: A user friendly label that task designers have given to the batch API request.
name string: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
objectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
outcomes string: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
responseSpec string: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
skipOnCondition string: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
startDelay number: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
timeout number: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

additional_properties str: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
asset_target_moid str: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
body str: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
class_id str
content_type str: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
description str: A description that task designer can add to individual API requests that explain what the API call is about.
error_content_type str: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
label str: A user friendly label that task designers have given to the batch API request.
name str: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
object_type str: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
outcomes str: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
response_spec str: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
skip_on_condition str: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
start_delay float: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
timeout float: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

additionalProperties String: Additional Properties as per object type, can be added as JSON using jsonencode(). Allowed Types are: workflow.AnsiblePlaySession workflow.CliCommand workflow.FileOperations workflow.PowerShellApi workflow.SshSession workflow.WebApi workflow.XmlApi
assetTargetMoid String: (ReadOnly) Asset target defines the remote target endpoints which are either managed byIntersight or their service APIs are invoked from Intersight. Generic API executorservice Jasmine can invoke these remote APIs via its executors. Asset targets can beaccessed directly for cloud targets or via an associated Intersight Assist. Prerequisiteto use asset targets is to persist the target details.Asset target MoRef can be given as task input of type TargetDataType. Fusion determinesand populates the target context with the Assist if associated with. It is setinternally at the API level.In case of an associated assist, it is used by Assist to fetch the target detailsand form the API request to send to endpoints. In case of cloud asset targets, Jasminefetched the target details from DB, forms the API request and sends it to the target.
body String: The optional request body that is sent as part of this API request.The request body can contain a golang template that can be populated with task inputparameters and previous API output parameters.
classId String
contentType String: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.The type of the content that gets passed as payload and response in thisAPI. The supported values are json, xml, text.
description String: A description that task designer can add to individual API requests that explain what the API call is about.
errorContentType String: Intersight Orchestrator, with the support of response parser specification,can extract the values from API responses and map them to task output parameters.The value extraction is supported for response content types XML, JSON and Text.Optional input to specify the content type in case of error API response. Thisshould be used if the content type of error response is different from that ofthe success response. If not specified, contentType input value is used to parsethe error response.
label String: A user friendly label that task designers have given to the batch API request.
name String: A reference name for this API request within the batch API request.This name shall be used to map the API output parameters to subsequentAPI input parameters within a batch API task.
objectType String: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.The enum values provides the list of concrete types that can be instantiated from this abstract type.
outcomes String: All the possible outcomes of this API are captured here. Outcomes propertyis a collection property of type workflow.Outcome objects.The outcomes can be mapped to the message to be shown. The outcomes areevaluated in the order they are given. At the end of the outcomes list,an catchall success/fail outcome can be added with condition as 'true'.This is an optionalproperty and if not specified the task will be marked as success.
responseSpec String: The optional grammar specification for parsing the response to extract therequired values.The specification should have extraction specification specified forall the API output parameters.
skipOnCondition String: The skip expression, if provided, allows the batch API executor to skip theapi execution when the given expression evaluates to true.The expression is given as such a golang template that has to beevaluated to a final content true/false. The expression is an optional and incase not provided, the API will always be executed.
startDelay Number: The delay in seconds after which the API needs to be executed.By default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.Start Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.
timeout Number: The duration in seconds by which the API response is expected from the API target.If the end point does not respond for the API request within this timeoutduration, the task will be marked as failed.

WorkflowBatchApiExecutorConstraint, WorkflowBatchApiExecutorConstraintArgs

AdditionalProperties string
ClassId string
ObjectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
TargetDataType string: List of property constraints that helps to narrow down task implementations based on target device input.

AdditionalProperties string
ClassId string
ObjectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
TargetDataType string: List of property constraints that helps to narrow down task implementations based on target device input.

additionalProperties String
classId String
objectType String: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
targetDataType String: List of property constraints that helps to narrow down task implementations based on target device input.

additionalProperties string
classId string
objectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
targetDataType string: List of property constraints that helps to narrow down task implementations based on target device input.

additional_properties str
class_id str
object_type str: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
target_data_type str: List of property constraints that helps to narrow down task implementations based on target device input.

additionalProperties String
classId String
objectType String: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
targetDataType String: List of property constraints that helps to narrow down task implementations based on target device input.

WorkflowBatchApiExecutorErrorResponseHandler, WorkflowBatchApiExecutorErrorResponseHandlerArgs

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string
classId string
moid string: The Moid of the referenced REST resource.
objectType string: The fully-qualified name of the remote type referred by this relationship.
selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str
class_id str
moid str: The Moid of the referenced REST resource.
object_type str: The fully-qualified name of the remote type referred by this relationship.
selector str: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

WorkflowBatchApiExecutorParent, WorkflowBatchApiExecutorParentArgs

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string
classId string
moid string: The Moid of the referenced REST resource.
objectType string: The fully-qualified name of the remote type referred by this relationship.
selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str
class_id str
moid str: The Moid of the referenced REST resource.
object_type str: The fully-qualified name of the remote type referred by this relationship.
selector str: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

WorkflowBatchApiExecutorPermissionResource, WorkflowBatchApiExecutorPermissionResourceArgs

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string
classId string
moid string: The Moid of the referenced REST resource.
objectType string: The fully-qualified name of the remote type referred by this relationship.
selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str
class_id str
moid str: The Moid of the referenced REST resource.
object_type str: The fully-qualified name of the remote type referred by this relationship.
selector str: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

WorkflowBatchApiExecutorTag, WorkflowBatchApiExecutorTagArgs

AdditionalProperties string
Key string: The string representation of a tag key.
Value string: The string representation of a tag value.

AdditionalProperties string
Key string: The string representation of a tag key.
Value string: The string representation of a tag value.

additionalProperties String
key String: The string representation of a tag key.
value String: The string representation of a tag value.

additionalProperties string
key string: The string representation of a tag key.
value string: The string representation of a tag value.

additional_properties str
key str: The string representation of a tag key.
value str: The string representation of a tag value.

additionalProperties String
key String: The string representation of a tag key.
value String: The string representation of a tag value.

WorkflowBatchApiExecutorTaskDefinition, WorkflowBatchApiExecutorTaskDefinitionArgs

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string
classId string
moid string: The Moid of the referenced REST resource.
objectType string: The fully-qualified name of the remote type referred by this relationship.
selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str
class_id str
moid str: The Moid of the referenced REST resource.
object_type str: The fully-qualified name of the remote type referred by this relationship.
selector str: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

WorkflowBatchApiExecutorVersionContext, WorkflowBatchApiExecutorVersionContextArgs

AdditionalProperties string
ClassId string
InterestedMos List<WorkflowBatchApiExecutorVersionContextInterestedMo>: This complex property has following sub-properties:
MarkedForDeletion bool: (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
NrVersion string: (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
ObjectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
RefMos List<WorkflowBatchApiExecutorVersionContextRefMo>: (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
Timestamp string: (ReadOnly) The time this versioned Managed Object was created.
VersionType string: (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.

AdditionalProperties string
ClassId string
InterestedMos []WorkflowBatchApiExecutorVersionContextInterestedMo: This complex property has following sub-properties:
MarkedForDeletion bool: (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
NrVersion string: (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
ObjectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
RefMos []WorkflowBatchApiExecutorVersionContextRefMo: (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
Timestamp string: (ReadOnly) The time this versioned Managed Object was created.
VersionType string: (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.

additionalProperties String
classId String
interestedMos List<WorkflowBatchApiExecutorVersionContextInterestedMo>: This complex property has following sub-properties:
markedForDeletion Boolean: (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
nrVersion String: (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
objectType String: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
refMos List<WorkflowBatchApiExecutorVersionContextRefMo>: (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
timestamp String: (ReadOnly) The time this versioned Managed Object was created.
versionType String: (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.

additionalProperties string
classId string
interestedMos WorkflowBatchApiExecutorVersionContextInterestedMo[]: This complex property has following sub-properties:
markedForDeletion boolean: (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
nrVersion string: (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
objectType string: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
refMos WorkflowBatchApiExecutorVersionContextRefMo[]: (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
timestamp string: (ReadOnly) The time this versioned Managed Object was created.
versionType string: (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.

additional_properties str
class_id str
interested_mos Sequence[WorkflowBatchApiExecutorVersionContextInterestedMo]: This complex property has following sub-properties:
marked_for_deletion bool: (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
nr_version str: (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
object_type str: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
ref_mos Sequence[WorkflowBatchApiExecutorVersionContextRefMo]: (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
timestamp str: (ReadOnly) The time this versioned Managed Object was created.
version_type str: (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.

additionalProperties String
classId String
interestedMos List<Property Map>: This complex property has following sub-properties:
markedForDeletion Boolean: (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
nrVersion String: (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
objectType String: The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
refMos List<Property Map>: (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
timestamp String: (ReadOnly) The time this versioned Managed Object was created.
versionType String: (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.* Modified - Version created every time an object is modified.* Configured - Version created every time an object is configured to the service profile.* Deployed - Version created for objects related to a service profile when it is deployed.

WorkflowBatchApiExecutorVersionContextInterestedMo, WorkflowBatchApiExecutorVersionContextInterestedMoArgs

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string
classId string
moid string: The Moid of the referenced REST resource.
objectType string: The fully-qualified name of the remote type referred by this relationship.
selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str
class_id str
moid str: The Moid of the referenced REST resource.
object_type str: The fully-qualified name of the remote type referred by this relationship.
selector str: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

WorkflowBatchApiExecutorVersionContextRefMo, WorkflowBatchApiExecutorVersionContextRefMoArgs

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string
ClassId string
Moid string: The Moid of the referenced REST resource.
ObjectType string: The fully-qualified name of the remote type referred by this relationship.
Selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string
classId string
moid string: The Moid of the referenced REST resource.
objectType string: The fully-qualified name of the remote type referred by this relationship.
selector string: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str
class_id str
moid str: The Moid of the referenced REST resource.
object_type str: The fully-qualified name of the remote type referred by this relationship.
selector str: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String
classId String
moid String: The Moid of the referenced REST resource.
objectType String: The fully-qualified name of the remote type referred by this relationship.
selector String: An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.

Import

intersight_workflow_batch_api_executor can be imported using the Moid of the object, e.g.

$ pulumi import intersight:index/workflowBatchApiExecutor:WorkflowBatchApiExecutor example 1234567890987654321abcde

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: intersight ciscodevnet/terraform-provider-intersight
License
Notes: This Pulumi package is based on the intersight Terraform Provider.

intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet

ciscodevnet/terraform-provider-intersight

intersight.WorkflowBatchApiExecutor

On this page

On this page

Usage Example

Resource Creation

Allowed Types in AdditionalProperties

workflow.AnsiblePlaySession

workflow.CliCommand

workflow.FileOperations

workflow.PowerShellApi

workflow.SshSession

workflow.WebApi

workflow.XmlApi

workflow.AnsiblePlaySession

workflow.CliCommand

workflow.FileOperations

workflow.PowerShellApi

workflow.SshSession

workflow.WebApi

workflow.XmlApi

Create WorkflowBatchApiExecutor Resource

Constructor syntax

Parameters

Constructor example

WorkflowBatchApiExecutor Resource Properties

Inputs

Outputs

Look up Existing WorkflowBatchApiExecutor Resource

Supporting Types

WorkflowBatchApiExecutorAncestor, WorkflowBatchApiExecutorAncestorArgs

WorkflowBatchApiExecutorBatch, WorkflowBatchApiExecutorBatchArgs

WorkflowBatchApiExecutorCancelAction, WorkflowBatchApiExecutorCancelActionArgs

WorkflowBatchApiExecutorConstraint, WorkflowBatchApiExecutorConstraintArgs

WorkflowBatchApiExecutorErrorResponseHandler, WorkflowBatchApiExecutorErrorResponseHandlerArgs

WorkflowBatchApiExecutorParent, WorkflowBatchApiExecutorParentArgs

WorkflowBatchApiExecutorPermissionResource, WorkflowBatchApiExecutorPermissionResourceArgs

WorkflowBatchApiExecutorTag, WorkflowBatchApiExecutorTagArgs

WorkflowBatchApiExecutorTaskDefinition, WorkflowBatchApiExecutorTaskDefinitionArgs

WorkflowBatchApiExecutorVersionContext, WorkflowBatchApiExecutorVersionContextArgs

WorkflowBatchApiExecutorVersionContextInterestedMo, WorkflowBatchApiExecutorVersionContextInterestedMoArgs

WorkflowBatchApiExecutorVersionContextRefMo, WorkflowBatchApiExecutorVersionContextRefMoArgs

Import

Package Details

On this page

On this page

Allowed Types in `AdditionalProperties`