Docs Home
intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet
intersight.WorkflowWorkflowDefinition
Explore with Pulumi AI
intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet
Workflow definition is a collection of tasks that are sequenced in a certain way using control tasks. The tasks in the workflow definition is represented as a directed acyclic graph where each node in the graph is a task and the edges in the graph are transitions from one task to another.
Usage Example
Resource Creation
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.intersight.WorkflowWorkflowDefinition;
import com.pulumi.intersight.WorkflowWorkflowDefinitionArgs;
import com.pulumi.intersight.inputs.WorkflowWorkflowDefinitionOutputDefinitionArgs;
import com.pulumi.intersight.inputs.WorkflowWorkflowDefinitionTaskArgs;
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();
var workflowWorkflowDefinition1 = new WorkflowWorkflowDefinition("workflowWorkflowDefinition1", WorkflowWorkflowDefinitionArgs.builder()
.label("Value for label")
.outputDefinitions(WorkflowWorkflowDefinitionOutputDefinitionArgs.builder()
.classId("workflow.StartTask")
.objectType("workflow.PrimitiveDataType")
.name("status")
.label("Value for label")
.required(false)
.description("Value for description")
.default_(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.displayMeta(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build())
.tasks(WorkflowWorkflowDefinitionTaskArgs.builder()
.description("Create a vm")
.label("value for lable")
.name("StartTask")
.objectType("workflow.StartTask")
.classId("workflow.StartTask")
.build())
.uiRenderingData("""
"{
positions {
name = "StartTask"
x = 209
y = 79
}
version = 1
catalog = {
object_type = "workflow.Catalog"
moid = var.workflow_catalog
}
workflow_metadata = {
object_type = "workflow.WorkflowMetadata"
moid = var.workflow_workflow_metadata
}
}"
""")
.build());
final var workflowCatalog = config.get("workflowCatalog");
final var workflowWorkflowMetadata = config.get("workflowWorkflowMetadata");
}
}
configuration:
workflowCatalog:
type: string
workflowWorkflowMetadata:
type: string
resources:
workflowWorkflowDefinition1:
type: intersight:WorkflowWorkflowDefinition
properties:
label: Value for label
outputDefinitions:
- classId: workflow.StartTask
objectType: workflow.PrimitiveDataType
name: status
label: Value for label
required: false
description: Value for description
default:
- objectType: workflow.DefaultValue
override: false
classId: workflow.DefaultValue
displayMeta:
- classId: workflow.DisplayMeta
objectType: workflow.DisplayMeta
inventorySelector: true
tasks:
- description: Create a vm
label: value for lable
name: StartTask
objectType: workflow.StartTask
classId: workflow.StartTask
uiRenderingData: |2
"{
positions {
name = "StartTask"
x = 209
y = 79
}
version = 1
catalog = {
object_type = "workflow.Catalog"
moid = var.workflow_catalog
}
workflow_metadata = {
object_type = "workflow.WorkflowMetadata"
moid = var.workflow_workflow_metadata
}
}"
Allowed Types in AdditionalProperties
workflow.ArrayDataType
This data type represents an array of a given type. It can be an array of primitive data or of custom data.
array_item_type:(HashMap) - Data item within the array data type. 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.The enum values provides the list of concrete types that can be instantiated from this abstract type.
max:(int) Specify the maximum value of the array.min:(int) Specify the minimum value of the array.
workflow.CustomDataType
This data type represents a custom data object.
properties:(HashMap) - Captures the custom data type properties. This complex property has following sub-properties:catalog_moid:(string) Specify the catalog moid that this custom data type belongs.custom_data_type_id:(string)(ReadOnly) The resolved custom data type definition managed object.custom_data_type_name:(string) Name of the custom data type for this input.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
workflow.DynamicTemplateParserDataType
Data type to fetch a generic template from given selector and parse it using an api to give an array of secure and non-secure keys for form generation. URL used to fetch the template object is based on the templateType. Final input passed to the workflow using this data type is a JSON containing {‘Template’:’’, ‘Keys’:[{’
is_template_secure:(bool) When set to true, the template is marked as secure and the content is encrypted and stored.template_type:(string) Template type decides on the API to be used to fetch the placeholders present inside the template.*OsInstall- This refers to the OS configuration template MO.
workflow.MoInventoryDataType
The data type to represent the selected properties of an Intersight managed object. This data type is used only in Service items to define the schema of resources and their attributes.
properties:(Array) This complex property has following sub-properties:attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.reference_object_type:(string) ObjectType for which the attributes need to be collected.reference_type:(string) Defines how the reference to the shadow resource is done. Base case is via an Moid, but reference via a selector is also possible.*Moid- The reference to the original resource is via an Moid.*Selector- The reference to the original resource is via a selector query. This can potentially lead to tracking data for multiple resources.
workflow.MoReferenceAutoDataType
The data type to capture an Intersight managed object reference that is automatically selected by the system based on a given selection criteria.
properties:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -filters: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.order_by:(string) Determines properties that are used to sort the collection of resources.rule:(HashMap) - The rule can be obtained directly from a Resource Selection Criteria or provided as inline resource filter conditions. 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.The enum values provides the list of concrete types that can be instantiated from this abstract type.
workflow.MoReferenceDataType
Data type to capture an Intersight Managed object reference.
properties:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
value_attribute:(string) A property from the Intersight object, value of which can be used as value for referenced input definition.
workflow.PrimitiveDataType
This data type is used to represent primitives like string, floats and integers.
properties:(HashMap) - Primitive data type properties. This complex property has following sub-properties:constraints:(HashMap) - Constraints that must be applied to the parameter value supplied for this data type. This complex property has following sub-properties:enum_list:(Array) This complex property has following sub-properties:label:(string) Label for the enum value. A user friendly short string to identify the enum value. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote (’), forward slash (/), round parenthesis ( () ), or an underscore (_) and must have an alphanumeric character.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.value:(string) Enum value for this enum entry. Value will be passed to the workflow as string type for execution. Value can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), round parenthesis ( () ), forward slash (/), or an underscore (_).
max:(float) Allowed maximum value of the parameter if parameter is integer/float or maximum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then maximum number supported is 1.797693134862315708145274237317043567981e+308 or (21023 * (253 - 1) / 2**52). When a number bigger than this is given as Maximum value, the constraints will not be enforced.min:(float) Allowed minimum value of the parameter if parameter is integer/float or minimum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then minimum number supported is 4.940656458412465441765687928682213723651e-324 or (1 / 2 ** (1023 - 1 + 52)). When a number smaller than this is given as minimum value, the constraints will not be enforced.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.regex:(string) When the parameter is a string this regular expression is used to ensure the value is valid.data_source_selector:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) This field holds mapping information used to provide suggestions to the user. The mapping should be in the ‘${workflow.input.property}’ format. It supports workflow input mapping for workflows, and for User Actions, it supports workflow inputs, workflow outputs, workflow variables, and outputs from previous tasks.value_attribute:(string) A property from the mapped parameter, value of which can be used as value for referenced input definition.
inventory_selector:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
value_attribute:(string) A property from the Intersight object, value of which can be used as value for referenced input definition.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.secure:(bool) Intersight supports secure properties as task input/output. The values ofthese properties are encrypted and stored in Intersight.This flag marks the property to be secure when it is set to true.type:(string) Specify the enum type for primitive data type.*string- Enum to specify a string data type.*integer- Enum to specify an integer32 data type.*float- Enum to specify a float64 data type.*boolean- Enum to specify a boolean data type.*json- Enum to specify a json data type.*enum- Enum to specify a enum data type which is a list of pre-defined strings.
workflow.TargetDataType
Data type to capture a target endpoint or device.
custom_data_type_properties:(HashMap) - Reference to custom data type definition. This complex property has following sub-properties:catalog_moid:(string) Specify the catalog moid that this custom data type belongs.custom_data_type_id:(string)(ReadOnly) The resolved custom data type definition managed object.custom_data_type_name:(string) Name of the custom data type for this input.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
is_array:(bool) When this property is true then an array of targets can be passed as input.max:(int) Specify the maximum value of the array.min:(int) Specify the minimum value of the array.properties:(Array) This complex property has following sub-properties:connector_attribute:(string) A singleton value which will contain the path to connector object from the selected object.constraint_attributes: (Array of schema.TypeString) -display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.platform_type: (Array of schema.TypeString) -selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options for target device.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
supported_objects: (Array of schema.TypeString) -
workflow.ArrayDataType
This data type represents an array of a given type. It can be an array of primitive data or of custom data.
array_item_type:(HashMap) - Data item within the array data type. 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.The enum values provides the list of concrete types that can be instantiated from this abstract type.
max:(int) Specify the maximum value of the array.min:(int) Specify the minimum value of the array.
workflow.CustomDataType
This data type represents a custom data object.
properties:(HashMap) - Captures the custom data type properties. This complex property has following sub-properties:catalog_moid:(string) Specify the catalog moid that this custom data type belongs.custom_data_type_id:(string)(ReadOnly) The resolved custom data type definition managed object.custom_data_type_name:(string) Name of the custom data type for this input.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
workflow.DynamicTemplateParserDataType
Data type to fetch a generic template from given selector and parse it using an api to give an array of secure and non-secure keys for form generation. URL used to fetch the template object is based on the templateType. Final input passed to the workflow using this data type is a JSON containing {‘Template’:’’, ‘Keys’:[{’
is_template_secure:(bool) When set to true, the template is marked as secure and the content is encrypted and stored.template_type:(string) Template type decides on the API to be used to fetch the placeholders present inside the template.*OsInstall- This refers to the OS configuration template MO.
workflow.MoInventoryDataType
The data type to represent the selected properties of an Intersight managed object. This data type is used only in Service items to define the schema of resources and their attributes.
properties:(Array) This complex property has following sub-properties:attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.reference_object_type:(string) ObjectType for which the attributes need to be collected.reference_type:(string) Defines how the reference to the shadow resource is done. Base case is via an Moid, but reference via a selector is also possible.*Moid- The reference to the original resource is via an Moid.*Selector- The reference to the original resource is via a selector query. This can potentially lead to tracking data for multiple resources.
workflow.MoReferenceAutoDataType
The data type to capture an Intersight managed object reference that is automatically selected by the system based on a given selection criteria.
properties:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -filters: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.order_by:(string) Determines properties that are used to sort the collection of resources.rule:(HashMap) - The rule can be obtained directly from a Resource Selection Criteria or provided as inline resource filter conditions. 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.The enum values provides the list of concrete types that can be instantiated from this abstract type.
workflow.MoReferenceDataType
Data type to capture an Intersight Managed object reference.
properties:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
value_attribute:(string) A property from the Intersight object, value of which can be used as value for referenced input definition.
workflow.PrimitiveDataType
This data type is used to represent primitives like string, floats and integers.
properties:(HashMap) - Primitive data type properties. This complex property has following sub-properties:constraints:(HashMap) - Constraints that must be applied to the parameter value supplied for this data type. This complex property has following sub-properties:enum_list:(Array) This complex property has following sub-properties:label:(string) Label for the enum value. A user friendly short string to identify the enum value. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote (’), forward slash (/), round parenthesis ( () ), or an underscore (_) and must have an alphanumeric character.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.value:(string) Enum value for this enum entry. Value will be passed to the workflow as string type for execution. Value can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), round parenthesis ( () ), forward slash (/), or an underscore (_).
max:(float) Allowed maximum value of the parameter if parameter is integer/float or maximum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then maximum number supported is 1.797693134862315708145274237317043567981e+308 or (21023 * (253 - 1) / 2**52). When a number bigger than this is given as Maximum value, the constraints will not be enforced.min:(float) Allowed minimum value of the parameter if parameter is integer/float or minimum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then minimum number supported is 4.940656458412465441765687928682213723651e-324 or (1 / 2 ** (1023 - 1 + 52)). When a number smaller than this is given as minimum value, the constraints will not be enforced.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.regex:(string) When the parameter is a string this regular expression is used to ensure the value is valid.data_source_selector:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) This field holds mapping information used to provide suggestions to the user. The mapping should be in the ‘${workflow.input.property}’ format. It supports workflow input mapping for workflows, and for User Actions, it supports workflow inputs, workflow outputs, workflow variables, and outputs from previous tasks.value_attribute:(string) A property from the mapped parameter, value of which can be used as value for referenced input definition.
inventory_selector:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
value_attribute:(string) A property from the Intersight object, value of which can be used as value for referenced input definition.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.secure:(bool) Intersight supports secure properties as task input/output. The values ofthese properties are encrypted and stored in Intersight.This flag marks the property to be secure when it is set to true.type:(string) Specify the enum type for primitive data type.*string- Enum to specify a string data type.*integer- Enum to specify an integer32 data type.*float- Enum to specify a float64 data type.*boolean- Enum to specify a boolean data type.*json- Enum to specify a json data type.*enum- Enum to specify a enum data type which is a list of pre-defined strings.
workflow.TargetDataType
Data type to capture a target endpoint or device.
custom_data_type_properties:(HashMap) - Reference to custom data type definition. This complex property has following sub-properties:catalog_moid:(string) Specify the catalog moid that this custom data type belongs.custom_data_type_id:(string)(ReadOnly) The resolved custom data type definition managed object.custom_data_type_name:(string) Name of the custom data type for this input.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
is_array:(bool) When this property is true then an array of targets can be passed as input.max:(int) Specify the maximum value of the array.min:(int) Specify the minimum value of the array.properties:(Array) This complex property has following sub-properties:connector_attribute:(string) A singleton value which will contain the path to connector object from the selected object.constraint_attributes: (Array of schema.TypeString) -display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.platform_type: (Array of schema.TypeString) -selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options for target device.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
supported_objects: (Array of schema.TypeString) -
workflow.ArrayDataType
This data type represents an array of a given type. It can be an array of primitive data or of custom data.
array_item_type:(HashMap) - Data item within the array data type. 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.The enum values provides the list of concrete types that can be instantiated from this abstract type.
max:(int) Specify the maximum value of the array.min:(int) Specify the minimum value of the array.
workflow.CustomDataType
This data type represents a custom data object.
properties:(HashMap) - Captures the custom data type properties. This complex property has following sub-properties:catalog_moid:(string) Specify the catalog moid that this custom data type belongs.custom_data_type_id:(string)(ReadOnly) The resolved custom data type definition managed object.custom_data_type_name:(string) Name of the custom data type for this input.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
workflow.DynamicTemplateParserDataType
Data type to fetch a generic template from given selector and parse it using an api to give an array of secure and non-secure keys for form generation. URL used to fetch the template object is based on the templateType. Final input passed to the workflow using this data type is a JSON containing {‘Template’:’’, ‘Keys’:[{’
is_template_secure:(bool) When set to true, the template is marked as secure and the content is encrypted and stored.template_type:(string) Template type decides on the API to be used to fetch the placeholders present inside the template.*OsInstall- This refers to the OS configuration template MO.
workflow.MoInventoryDataType
The data type to represent the selected properties of an Intersight managed object. This data type is used only in Service items to define the schema of resources and their attributes.
properties:(Array) This complex property has following sub-properties:attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.reference_object_type:(string) ObjectType for which the attributes need to be collected.reference_type:(string) Defines how the reference to the shadow resource is done. Base case is via an Moid, but reference via a selector is also possible.*Moid- The reference to the original resource is via an Moid.*Selector- The reference to the original resource is via a selector query. This can potentially lead to tracking data for multiple resources.
workflow.MoReferenceAutoDataType
The data type to capture an Intersight managed object reference that is automatically selected by the system based on a given selection criteria.
properties:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -filters: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.order_by:(string) Determines properties that are used to sort the collection of resources.rule:(HashMap) - The rule can be obtained directly from a Resource Selection Criteria or provided as inline resource filter conditions. 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.The enum values provides the list of concrete types that can be instantiated from this abstract type.
workflow.MoReferenceDataType
Data type to capture an Intersight Managed object reference.
properties:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
value_attribute:(string) A property from the Intersight object, value of which can be used as value for referenced input definition.
workflow.PrimitiveDataType
This data type is used to represent primitives like string, floats and integers.
properties:(HashMap) - Primitive data type properties. This complex property has following sub-properties:constraints:(HashMap) - Constraints that must be applied to the parameter value supplied for this data type. This complex property has following sub-properties:enum_list:(Array) This complex property has following sub-properties:label:(string) Label for the enum value. A user friendly short string to identify the enum value. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote (’), forward slash (/), round parenthesis ( () ), or an underscore (_) and must have an alphanumeric character.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.value:(string) Enum value for this enum entry. Value will be passed to the workflow as string type for execution. Value can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), round parenthesis ( () ), forward slash (/), or an underscore (_).
max:(float) Allowed maximum value of the parameter if parameter is integer/float or maximum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then maximum number supported is 1.797693134862315708145274237317043567981e+308 or (21023 * (253 - 1) / 2**52). When a number bigger than this is given as Maximum value, the constraints will not be enforced.min:(float) Allowed minimum value of the parameter if parameter is integer/float or minimum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then minimum number supported is 4.940656458412465441765687928682213723651e-324 or (1 / 2 ** (1023 - 1 + 52)). When a number smaller than this is given as minimum value, the constraints will not be enforced.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.regex:(string) When the parameter is a string this regular expression is used to ensure the value is valid.data_source_selector:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) This field holds mapping information used to provide suggestions to the user. The mapping should be in the ‘${workflow.input.property}’ format. It supports workflow input mapping for workflows, and for User Actions, it supports workflow inputs, workflow outputs, workflow variables, and outputs from previous tasks.value_attribute:(string) A property from the mapped parameter, value of which can be used as value for referenced input definition.
inventory_selector:(Array) This complex property has following sub-properties:display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
value_attribute:(string) A property from the Intersight object, value of which can be used as value for referenced input definition.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.secure:(bool) Intersight supports secure properties as task input/output. The values ofthese properties are encrypted and stored in Intersight.This flag marks the property to be secure when it is set to true.type:(string) Specify the enum type for primitive data type.*string- Enum to specify a string data type.*integer- Enum to specify an integer32 data type.*float- Enum to specify a float64 data type.*boolean- Enum to specify a boolean data type.*json- Enum to specify a json data type.*enum- Enum to specify a enum data type which is a list of pre-defined strings.
workflow.TargetDataType
Data type to capture a target endpoint or device.
custom_data_type_properties:(HashMap) - Reference to custom data type definition. This complex property has following sub-properties:catalog_moid:(string) Specify the catalog moid that this custom data type belongs.custom_data_type_id:(string)(ReadOnly) The resolved custom data type definition managed object.custom_data_type_name:(string) Name of the custom data type for this input.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
is_array:(bool) When this property is true then an array of targets can be passed as input.max:(int) Specify the maximum value of the array.min:(int) Specify the minimum value of the array.properties:(Array) This complex property has following sub-properties:connector_attribute:(string) A singleton value which will contain the path to connector object from the selected object.constraint_attributes: (Array of schema.TypeString) -display_attributes: (Array of schema.TypeString) -object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.platform_type: (Array of schema.TypeString) -selector:(string) Field to hold an Intersight API along with an optional filter to narrow down the search options for target device.selector_property:(HashMap) - Selector properties to define HTTP method and ‘body’ in case of upsert operation. This complex property has following sub-properties:body:(JSON as string) Content of the request body to send for POST request.method:(string) The HTTP method to be used.*GET- The HTTP GET method requests a representation of the specified resource.*POST- The HTTP POST method sends data to the server.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.
supported_objects: (Array of schema.TypeString) -
workflow.DecisionTask
A DecisionTask is a control task that executes a sequence of WorkflowTasks based off decision provided and evaluated by this task.
condition:(string) The condition to evaluate for this decision task. The condition can be a workflow or task variable or an JavaScript expression. Example value for condition could be a variable like \ ${task1.output.var1} or ${workflow.input.var2}\ which evaluates to a value matching any of the decision case values. Example value for condition if it’s an expression - \ if ( ${task1.output.var1} ! = null && ${task1.output.var1} > 0 ) ’true’; else ‘false’; \ which evaluates to ’true’ or ‘false’ and will match one of the decision case values. You can also use JavaScript functions like indexOf, toUpperCase in the expression which will be evaluated by the expression evaluator.decision_cases:(Array) This complex property has following sub-properties:description:(string) Description of this decision case.next_task:(string) The name of the next task (Task names unique within workflow) to run. In a graph model, denotes an edge to another Task Node.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.value:(string) Value for the decision case.
default_task:(string) The default next Task to execute if the decision cannot be evaluated to any of the DecisionCases.input_parameters:(JSON as string) This field is deprecated. Decision case conditions can be added using the workflow input or task output variables in the Condition field. Refer to Condition field for more details.
workflow.FailureEndTask
A FailureEndTask denotes the failed completion of a workflow.
workflow.ForkTask
A ForkTask is a control task that forks tasks for parallel execution in a workflow.
forked_tasks: (Array of schema.TypeString) -join_task:(string) Task name for the join control task that must follow a fork control task.
workflow.JoinTask
A JoinTask is a control task that must follow a fork task and specify all the fork tasks that must complete and join before the worfklow can proceed to the task specified in the OnSuccess transition.
join_on_tasks: (Array of schema.TypeString) -on_success:(string) Name of the next task to run if all fork path specified in the JoinOnTasks list succeeds which is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.
workflow.LoopTask
A Parallel Loop is a control task that runs one task or one sub-workflow multiple times based on a specified count. The count can be a static value that is specified during design time or a dynamic value that is derived from workflow inputs or task outputs. When the loop is executed, the count ‘N’ is determined and then N tasks or sub-workflows are scheduled for execution in parallel. When all N instances of the task or sub-workflow reach a final state the parallel loop will complete and workflow execution will move on to the next task. If any one of the tasks or sub-workflows fails, then the entire loop will fail.
nr_count:(string) Count value for the loop, this can be a static value defined as a constant at design time or can be a dynamic value defined as an expression that will evaluate to an integer value at execution time. Dynamic values for count must be specified as a template. For example, if a loop must run for a count which matches the length of a workflow input called StringArray, then the count must be specified using a template ‘{{ len .global.workflow.input.StringArray }}’. The count must be less than or equal to 100. If count is given as a dynamic value, and during execution time if count evaluates to be a value greater than 100, then the loop task will fail.failure_policy:(string) The policy to handle the failure of an iteration within a parallel loop.*FailOnFirstFailure- The enum specifies the option as FailOnFirstFailure where the loop task will fail if one of the iteration in the loop fails. The running iterations will be cancelled on first failure and the loop will be marked as failed.*ContinueOnFailure- The enum specifies the option as ContinueOnFailure where the loop task will continue with all iterations, even if one fails. Running iterations will not be canceled, but the loop will be marked as failed after all iterations are complete.loop_start_task:(string) Start task where the list of tasks will be executed multiple times based on the count or condition value.number_of_batches:(int) All iterations of the loop run in parallel within a single batch, with a maximum of 100 iterations. To run more than 100 iterations, you can increase the number of batches. The configuration is acceptable as long as the total number of iterations divided by the number of batches is less than 100. Adjusting the number of batches also allows you to control how many iterations run in parallel. For example, if the total count is 100 and you set the number of batches to 5, then 20 tasks will run in parallel across the 5 batches. It’s important to note that the number of batches must be less than the total count. If the count is dynamic and falls below the number of batches, this may result in empty batches with no tasks.on_failure:(string) This specifies the name of the next task to run if all iterations of the loop task do not succeed. The unique name given to the task instance within the workflow must be provided here. In a graph model, denotes an edge to another Task Node.on_success:(string) This specifies the name of the next task to run if all iterations of the loop task succeeds. The unique name given to the task instance within the workflow must be provided here. In a graph model, denotes an edge to another Task Node.parallel:(bool) This field is deprecated. Always set to true for parallel loop.
workflow.SerialLoopTask
A Serial Loop is a control task that runs one or more worker tasks multiple times based on a specified count or a given condition. Either count or condition must be provided, not both. When the loop is executed, based on count or condition, each iteration of task or a sequence of tasks inside loop run in serial. If any of the task fail then the entire loop will fail.
condition:(string) Condition expression which will be evaluated and when expression is true the tasks under loop will be executed.nr_count:(string) Count value for the loop, this can be a static value defined as a constant at design time or can be a dynamic value defined as an expression that will evaluate to an integer value at execution time. Dynamic values for count must be specified as a template. For example, if a loop must run for a count which matches the length of a workflow input called StringArray, then the count must be specified using a template ‘{{ len .global.workflow.input.StringArray }}’. The count must be less than or equal to 100. If count is given as a dynamic value, and during execution time if count evaluates to be a value greater than 100, then the loop task will fail.loop_start_task:(string) Start task where the list of tasks will be executed multiple times based on the count or condition value.on_failure:(string) This specifies the name of the next task to run if all iterations of the loop task do not succeed. The unique name given to the task instance within the workflow must be provided here. In a graph model, denotes an edge to another Task Node.on_success:(string) This specifies the name of the next task to run if all iterations of the loop task succeeds. The unique name given to the task instance within the workflow must be provided here. In a graph model, denotes an edge to another Task Node.
workflow.StartTask
A StartTask is the starting point for a workflow. There can only be one StartTask in a workflow.
next_task:(string) The name of the next task (Task names unique within workflow) to run. In a graph model, denotes an edge to another Task Node.
workflow.SubWorkflowTask
A SubWorkflowTask is used to include another workflow as a task within this workflow.
catalog_moid:(string) Specify the catalog moid that this task belongs.input_parameters:(JSON as string) JSON formatted key-value pairs that define the inputs given to the task. Mapping for task inputs can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as ‘${Source.< input | output | variable>.}’. ‘Source’ can be either workflow or the name of an earlier task within the workflow. You can map the task input to either a workflow input, a task output or a variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \ InputParameters\ :{ \ input1\ :\ ${workflow.variable.var1}\ , \ input2\ :\ prefixStr_{{.global.workflow.input.input1}}\ } where task input1 is mapped directly to variable var1 and task input2 is using a template to prefix a string to workflow input1 and then assign that value. on_failure:(string) This specifies the name of the next task to run if Task fails. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.on_success:(string) This specifies the name of the next task to run if Task succeeds. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.rollback_disabled:(bool) The task is disabled/enabled for rollback operation in this workflow if the task has rollback support.variable_parameters:(JSON as string) JSON formatted key-value pairs that perform variable update at the end of the task execution. Mapping for variables can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as ‘${Source.< input | output | variable>.}’. ‘Source’ can be either workflow or the name of the current or an earlier task within the workflow. You can map the variable to either a workflow input, a task output or another variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \ VariableParameters\ :{ \ var1\ :\ ${task1.output.output1}\ , \ var2\ :\ {{ Itoa .global.workflow.variable.varInt}}\ } where variable var1 is mapped directly to output1 of task1 and variable var2 is using a template to convert another variable varInt to string and assign that value. nr_version:(int) The workflow definition version to use as subworkflow. When no version is specified then the default version of the workflow at the time of creating or updating this workflow is used.workflow_definition_id:(string)(ReadOnly) The resolved referenced workflow definition managed object.workflow_definition_name:(string) The qualified name of workflow that should be executed as a task.
workflow.SuccessEndTask
A SuccessEndTask denotes the successful completion of a workflow.
workflow.WaitTask
A WaitTask will remain in progress until marked success or failed by an external trigger. The timeout for wait task is 180 days, so a workflow can wait for task status update for upto 180 days. Currently the only supported means to update the task status is through an API that provides the status of the task runtime instance. Once the wait task status has been set the workflow will continue with the execution based on the task status.
input_definition:(Array) This complex property has following sub-properties:additional_properties:(JSON as string) - Additional Properties as per object type, can be added as JSON usingjsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataTypedefault:(HashMap) - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:is_value_set:(bool)(ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.override:(bool) Override the default value provided for the data type. When true, allow the user to enter value for the data type.value:(JSON as string) Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
description:(string) Provide a detailed description of the data type.display_meta:(HashMap) - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:inventory_selector:(bool) Inventory selector specified for primitive data property should be used in Intersight User Interface.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.widget_type:(string) Specify the widget type for data display.*None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
input_parameters:(JSON as string) JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is ‘${workflow.input.property}’. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is ‘${workflow.input.property.subproperty}’. The format to specify mapping in a custom data type definition is ‘${datatype.type.property}’. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like ‘cdt_property:${workflow.input.property}’.label:(string) Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.name:(string) Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.object_type:(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.required:(bool) Specifies whether this parameter is required. The field is applicable for task and workflow.
input_parameters:(JSON as string) JSON formatted key-value pairs that define the inputs given to the task. Mapping for task inputs can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as ‘${Source.< input | output | variable>.}’. ‘Source’ can be either workflow or the name of an earlier task within the workflow. You can map the task input to either a workflow input, a task output or a variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \ InputParameters\ :{ \ input1\ :\ ${workflow.variable.var1}\ , \ input2\ :\ prefixStr_{{.global.workflow.input.input1}}\ } where task input1 is mapped directly to variable var1 and task input2 is using a template to prefix a string to workflow input1 and then assign that value. on_failure:(string) This specifies the name of the next task to run if Task fails. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.on_success:(string) This specifies the name of the next task to run if Task succeeds. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.output_definition:(Array) This complex property has following sub-properties:additional_properties:(JSON as string) - Additional Properties as per object type, can be added as JSON usingjsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataTypedefault:(HashMap) - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:is_value_set:(bool)(ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.override:(bool) Override the default value provided for the data type. When true, allow the user to enter value for the data type.value:(JSON as string) Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
description:(string) Provide a detailed description of the data type.display_meta:(HashMap) - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:inventory_selector:(bool) Inventory selector specified for primitive data property should be used in Intersight User Interface.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.widget_type:(string) Specify the widget type for data display.*None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
input_parameters:(JSON as string) JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is ‘${workflow.input.property}’. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is ‘${workflow.input.property.subproperty}’. The format to specify mapping in a custom data type definition is ‘${datatype.type.property}’. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like ‘cdt_property:${workflow.input.property}’.label:(string) Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.name:(string) Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.object_type:(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.required:(bool) Specifies whether this parameter is required. The field is applicable for task and workflow.
prompts:(Array) This complex property has following sub-properties:description:(string) Description that give more details about what it means to pick this prompt option for the wait task.label:(string) User friendly label for the prompt. This label will be shown to the user as one of available options for the wait task.name:(string) Name for the wait prompt.object_type:(string) The fully-qualified name of the instantiated, concrete type.The value should be the same as the ‘ClassId’ property.task_status:(string) Task status for the wait task when this prompt option is selected.*Scheduled- The enum represents the status when task is in scheduled state.*InProgress- The enum represents the status when task is in-progress state.*NoOp- The enum represents the status when task is a noop.*Timeout- The enum represents the status when task has timed out.*Completed- The enum represents the status when task has completed.*Failed- The enum represents the status when task has failed.
rollback_disabled:(bool) The task is disabled/enabled for rollback operation in this workflow if the task has rollback support.variable_parameters:(JSON as string) JSON formatted key-value pairs that perform variable update at the end of the task execution. Mapping for variables can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as ‘${Source.< input | output | variable>.}’. ‘Source’ can be either workflow or the name of the current or an earlier task within the workflow. You can map the variable to either a workflow input, a task output or another variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \ VariableParameters\ :{ \ var1\ :\ ${task1.output.output1}\ , \ var2\ :\ {{ Itoa .global.workflow.variable.varInt}}\ } where variable var1 is mapped directly to output1 of task1 and variable var2 is using a template to convert another variable varInt to string and assign that value.
workflow.WorkerTask
A WorkerTask is a simple task and the smallest granularity of work that can be defined as a task.
catalog_moid:(string) Specify the catalog moid that this task belongs.input_parameters:(JSON as string) JSON formatted key-value pairs that define the inputs given to the task. Mapping for task inputs can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as ‘${Source.< input | output | variable>.}’. ‘Source’ can be either workflow or the name of an earlier task within the workflow. You can map the task input to either a workflow input, a task output or a variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \ InputParameters\ :{ \ input1\ :\ ${workflow.variable.var1}\ , \ input2\ :\ prefixStr_{{.global.workflow.input.input1}}\ } where task input1 is mapped directly to variable var1 and task input2 is using a template to prefix a string to workflow input1 and then assign that value. on_failure:(string) This specifies the name of the next task to run if Task fails. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.on_success:(string) This specifies the name of the next task to run if Task succeeds. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.rollback_disabled:(bool) The task is disabled/enabled for rollback operation in this workflow if the task has rollback support.task_definition_id:(string)(ReadOnly) The resolved referenced task definition managed object.task_definition_name:(string) The qualified name of task that should be executed.variable_parameters:(JSON as string) JSON formatted key-value pairs that perform variable update at the end of the task execution. Mapping for variables can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as ‘${Source.< input | output | variable>.}’. ‘Source’ can be either workflow or the name of the current or an earlier task within the workflow. You can map the variable to either a workflow input, a task output or another variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \ VariableParameters\ :{ \ var1\ :\ ${task1.output.output1}\ , \ var2\ :\ {{ Itoa .global.workflow.variable.varInt}}\ } where variable var1 is mapped directly to output1 of task1 and variable var2 is using a template to convert another variable varInt to string and assign that value. nr_version:(int) The task definition version to use in this workflow. When no version is specified then the default version of the task at the time of creating or updating this workflow is used.
Create WorkflowWorkflowDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkflowWorkflowDefinition(name: string, args?: WorkflowWorkflowDefinitionArgs, opts?: CustomResourceOptions);@overload
def WorkflowWorkflowDefinition(resource_name: str,
args: Optional[WorkflowWorkflowDefinitionArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def WorkflowWorkflowDefinition(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_moid: Optional[str] = None,
additional_properties: Optional[str] = None,
ancestors: Optional[Sequence[WorkflowWorkflowDefinitionAncestorArgs]] = None,
catalogs: Optional[Sequence[WorkflowWorkflowDefinitionCatalogArgs]] = None,
class_id: Optional[str] = None,
cloned_froms: Optional[Sequence[WorkflowWorkflowDefinitionClonedFromArgs]] = None,
create_time: Optional[str] = None,
create_user: Optional[str] = None,
default_version: Optional[bool] = None,
description: Optional[str] = None,
domain_group_moid: Optional[str] = None,
input_definitions: Optional[Sequence[WorkflowWorkflowDefinitionInputDefinitionArgs]] = None,
input_parameter_sets: Optional[Sequence[WorkflowWorkflowDefinitionInputParameterSetArgs]] = None,
label: Optional[str] = None,
license_entitlement: Optional[str] = None,
max_task_count: Optional[float] = None,
max_worker_task_count: Optional[float] = None,
mod_time: Optional[str] = None,
mod_user: Optional[str] = None,
moid: Optional[str] = None,
name: Optional[str] = None,
nr_version: Optional[float] = None,
object_type: Optional[str] = None,
output_definitions: Optional[Sequence[WorkflowWorkflowDefinitionOutputDefinitionArgs]] = None,
output_parameters: Optional[str] = None,
owners: Optional[Sequence[str]] = None,
parents: Optional[Sequence[WorkflowWorkflowDefinitionParentArgs]] = None,
permission_resources: Optional[Sequence[WorkflowWorkflowDefinitionPermissionResourceArgs]] = None,
properties: Optional[Sequence[WorkflowWorkflowDefinitionPropertyArgs]] = None,
shared_scope: Optional[str] = None,
tags: Optional[Sequence[WorkflowWorkflowDefinitionTagArgs]] = None,
tasks: Optional[Sequence[WorkflowWorkflowDefinitionTaskArgs]] = None,
ui_input_filters: Optional[Sequence[WorkflowWorkflowDefinitionUiInputFilterArgs]] = None,
ui_rendering_data: Optional[str] = None,
validation_informations: Optional[Sequence[WorkflowWorkflowDefinitionValidationInformationArgs]] = None,
variable_definitions: Optional[Sequence[WorkflowWorkflowDefinitionVariableDefinitionArgs]] = None,
version_contexts: Optional[Sequence[WorkflowWorkflowDefinitionVersionContextArgs]] = None,
workflow_metadatas: Optional[Sequence[WorkflowWorkflowDefinitionWorkflowMetadataArgs]] = None,
workflow_workflow_definition_id: Optional[str] = None)func NewWorkflowWorkflowDefinition(ctx *Context, name string, args *WorkflowWorkflowDefinitionArgs, opts ...ResourceOption) (*WorkflowWorkflowDefinition, error)public WorkflowWorkflowDefinition(string name, WorkflowWorkflowDefinitionArgs? args = null, CustomResourceOptions? opts = null)
public WorkflowWorkflowDefinition(String name, WorkflowWorkflowDefinitionArgs args)
public WorkflowWorkflowDefinition(String name, WorkflowWorkflowDefinitionArgs args, CustomResourceOptions options)
type: intersight:WorkflowWorkflowDefinition
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 WorkflowWorkflowDefinitionArgs
- 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 WorkflowWorkflowDefinitionArgs
- 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 WorkflowWorkflowDefinitionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkflowWorkflowDefinitionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkflowWorkflowDefinitionArgs
- 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 workflowWorkflowDefinitionResource = new Intersight.WorkflowWorkflowDefinition("workflowWorkflowDefinitionResource", new()
{
AccountMoid = "string",
AdditionalProperties = "string",
Ancestors = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionAncestorArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Catalogs = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionCatalogArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
ClassId = "string",
ClonedFroms = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionClonedFromArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
CreateTime = "string",
CreateUser = "string",
DefaultVersion = false,
Description = "string",
DomainGroupMoid = "string",
InputDefinitions = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionInputDefinitionArgs
{
AdditionalProperties = "string",
ClassId = "string",
Defaults = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionInputDefinitionDefaultArgs
{
AdditionalProperties = "string",
ClassId = "string",
IsValueSet = false,
ObjectType = "string",
Override = false,
Value = "string",
},
},
Description = "string",
DisplayMetas = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionInputDefinitionDisplayMetaArgs
{
AdditionalProperties = "string",
ClassId = "string",
InventorySelector = false,
ObjectType = "string",
WidgetType = "string",
},
},
InputParameters = "string",
Label = "string",
Name = "string",
ObjectType = "string",
Required = false,
},
},
InputParameterSets = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionInputParameterSetArgs
{
AdditionalProperties = "string",
ClassId = "string",
Condition = "string",
ControlParameter = "string",
EnableParameters = new[]
{
"string",
},
Name = "string",
ObjectType = "string",
Value = "string",
},
},
Label = "string",
LicenseEntitlement = "string",
MaxTaskCount = 0,
MaxWorkerTaskCount = 0,
ModTime = "string",
ModUser = "string",
Moid = "string",
Name = "string",
NrVersion = 0,
ObjectType = "string",
OutputDefinitions = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionOutputDefinitionArgs
{
AdditionalProperties = "string",
ClassId = "string",
Defaults = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionOutputDefinitionDefaultArgs
{
AdditionalProperties = "string",
ClassId = "string",
IsValueSet = false,
ObjectType = "string",
Override = false,
Value = "string",
},
},
Description = "string",
DisplayMetas = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionOutputDefinitionDisplayMetaArgs
{
AdditionalProperties = "string",
ClassId = "string",
InventorySelector = false,
ObjectType = "string",
WidgetType = "string",
},
},
InputParameters = "string",
Label = "string",
Name = "string",
ObjectType = "string",
Required = false,
},
},
OutputParameters = "string",
Owners = new[]
{
"string",
},
Parents = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionParentArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
PermissionResources = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionPermissionResourceArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Properties = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionPropertyArgs
{
AdditionalProperties = "string",
ClassId = "string",
Cloneable = false,
EnableDebug = false,
EnablePublishStatus = false,
ExternalMeta = false,
ObjectType = "string",
PublishStatus = "string",
Retryable = false,
RollbackOnCancel = false,
RollbackOnFailure = false,
SupportStatus = "string",
},
},
SharedScope = "string",
Tags = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionTagArgs
{
AdditionalProperties = "string",
Key = "string",
Value = "string",
},
},
Tasks = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionTaskArgs
{
AdditionalProperties = "string",
ClassId = "string",
Description = "string",
Label = "string",
Name = "string",
ObjectType = "string",
},
},
UiInputFilters = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionUiInputFilterArgs
{
AdditionalProperties = "string",
ClassId = "string",
Filters = new[]
{
"string",
},
Name = "string",
ObjectType = "string",
UserHelpMessage = "string",
},
},
UiRenderingData = "string",
ValidationInformations = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionValidationInformationArgs
{
AdditionalProperties = "string",
ClassId = "string",
EngineState = "string",
ObjectType = "string",
State = "string",
ValidationErrors = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionValidationInformationValidationErrorArgs
{
AdditionalProperties = "string",
ClassId = "string",
ErrorLog = "string",
Field = "string",
ObjectType = "string",
TaskName = "string",
TransitionName = "string",
},
},
},
},
VariableDefinitions = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionVariableDefinitionArgs
{
AdditionalProperties = "string",
ClassId = "string",
Defaults = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionVariableDefinitionDefaultArgs
{
AdditionalProperties = "string",
ClassId = "string",
IsValueSet = false,
ObjectType = "string",
Override = false,
Value = "string",
},
},
Description = "string",
DisplayMetas = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionVariableDefinitionDisplayMetaArgs
{
AdditionalProperties = "string",
ClassId = "string",
InventorySelector = false,
ObjectType = "string",
WidgetType = "string",
},
},
InputParameters = "string",
Label = "string",
Name = "string",
ObjectType = "string",
Required = false,
},
},
VersionContexts = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionVersionContextArgs
{
AdditionalProperties = "string",
ClassId = "string",
InterestedMos = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionVersionContextInterestedMoArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
MarkedForDeletion = false,
NrVersion = "string",
ObjectType = "string",
RefMos = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionVersionContextRefMoArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Timestamp = "string",
VersionType = "string",
},
},
WorkflowMetadatas = new[]
{
new Intersight.Inputs.WorkflowWorkflowDefinitionWorkflowMetadataArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
WorkflowWorkflowDefinitionId = "string",
});
example, err := intersight.NewWorkflowWorkflowDefinition(ctx, "workflowWorkflowDefinitionResource", &intersight.WorkflowWorkflowDefinitionArgs{
AccountMoid: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
Ancestors: intersight.WorkflowWorkflowDefinitionAncestorArray{
&intersight.WorkflowWorkflowDefinitionAncestorArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Catalogs: intersight.WorkflowWorkflowDefinitionCatalogArray{
&intersight.WorkflowWorkflowDefinitionCatalogArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
ClassId: pulumi.String("string"),
ClonedFroms: intersight.WorkflowWorkflowDefinitionClonedFromArray{
&intersight.WorkflowWorkflowDefinitionClonedFromArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
CreateTime: pulumi.String("string"),
CreateUser: pulumi.String("string"),
DefaultVersion: pulumi.Bool(false),
Description: pulumi.String("string"),
DomainGroupMoid: pulumi.String("string"),
InputDefinitions: intersight.WorkflowWorkflowDefinitionInputDefinitionArray{
&intersight.WorkflowWorkflowDefinitionInputDefinitionArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Defaults: intersight.WorkflowWorkflowDefinitionInputDefinitionDefaultArray{
&intersight.WorkflowWorkflowDefinitionInputDefinitionDefaultArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
IsValueSet: pulumi.Bool(false),
ObjectType: pulumi.String("string"),
Override: pulumi.Bool(false),
Value: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
DisplayMetas: intersight.WorkflowWorkflowDefinitionInputDefinitionDisplayMetaArray{
&intersight.WorkflowWorkflowDefinitionInputDefinitionDisplayMetaArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
InventorySelector: pulumi.Bool(false),
ObjectType: pulumi.String("string"),
WidgetType: pulumi.String("string"),
},
},
InputParameters: pulumi.String("string"),
Label: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Required: pulumi.Bool(false),
},
},
InputParameterSets: intersight.WorkflowWorkflowDefinitionInputParameterSetArray{
&intersight.WorkflowWorkflowDefinitionInputParameterSetArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Condition: pulumi.String("string"),
ControlParameter: pulumi.String("string"),
EnableParameters: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Label: pulumi.String("string"),
LicenseEntitlement: pulumi.String("string"),
MaxTaskCount: pulumi.Float64(0),
MaxWorkerTaskCount: pulumi.Float64(0),
ModTime: pulumi.String("string"),
ModUser: pulumi.String("string"),
Moid: pulumi.String("string"),
Name: pulumi.String("string"),
NrVersion: pulumi.Float64(0),
ObjectType: pulumi.String("string"),
OutputDefinitions: intersight.WorkflowWorkflowDefinitionOutputDefinitionArray{
&intersight.WorkflowWorkflowDefinitionOutputDefinitionArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Defaults: intersight.WorkflowWorkflowDefinitionOutputDefinitionDefaultArray{
&intersight.WorkflowWorkflowDefinitionOutputDefinitionDefaultArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
IsValueSet: pulumi.Bool(false),
ObjectType: pulumi.String("string"),
Override: pulumi.Bool(false),
Value: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
DisplayMetas: intersight.WorkflowWorkflowDefinitionOutputDefinitionDisplayMetaArray{
&intersight.WorkflowWorkflowDefinitionOutputDefinitionDisplayMetaArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
InventorySelector: pulumi.Bool(false),
ObjectType: pulumi.String("string"),
WidgetType: pulumi.String("string"),
},
},
InputParameters: pulumi.String("string"),
Label: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Required: pulumi.Bool(false),
},
},
OutputParameters: pulumi.String("string"),
Owners: pulumi.StringArray{
pulumi.String("string"),
},
Parents: intersight.WorkflowWorkflowDefinitionParentArray{
&intersight.WorkflowWorkflowDefinitionParentArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
PermissionResources: intersight.WorkflowWorkflowDefinitionPermissionResourceArray{
&intersight.WorkflowWorkflowDefinitionPermissionResourceArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Properties: intersight.WorkflowWorkflowDefinitionPropertyArray{
&intersight.WorkflowWorkflowDefinitionPropertyArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Cloneable: pulumi.Bool(false),
EnableDebug: pulumi.Bool(false),
EnablePublishStatus: pulumi.Bool(false),
ExternalMeta: pulumi.Bool(false),
ObjectType: pulumi.String("string"),
PublishStatus: pulumi.String("string"),
Retryable: pulumi.Bool(false),
RollbackOnCancel: pulumi.Bool(false),
RollbackOnFailure: pulumi.Bool(false),
SupportStatus: pulumi.String("string"),
},
},
SharedScope: pulumi.String("string"),
Tags: intersight.WorkflowWorkflowDefinitionTagArray{
&intersight.WorkflowWorkflowDefinitionTagArgs{
AdditionalProperties: pulumi.String("string"),
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Tasks: intersight.WorkflowWorkflowDefinitionTaskArray{
&intersight.WorkflowWorkflowDefinitionTaskArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Description: pulumi.String("string"),
Label: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectType: pulumi.String("string"),
},
},
UiInputFilters: intersight.WorkflowWorkflowDefinitionUiInputFilterArray{
&intersight.WorkflowWorkflowDefinitionUiInputFilterArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Filters: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
ObjectType: pulumi.String("string"),
UserHelpMessage: pulumi.String("string"),
},
},
UiRenderingData: pulumi.String("string"),
ValidationInformations: intersight.WorkflowWorkflowDefinitionValidationInformationArray{
&intersight.WorkflowWorkflowDefinitionValidationInformationArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
EngineState: pulumi.String("string"),
ObjectType: pulumi.String("string"),
State: pulumi.String("string"),
ValidationErrors: intersight.WorkflowWorkflowDefinitionValidationInformationValidationErrorArray{
&intersight.WorkflowWorkflowDefinitionValidationInformationValidationErrorArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
ErrorLog: pulumi.String("string"),
Field: pulumi.String("string"),
ObjectType: pulumi.String("string"),
TaskName: pulumi.String("string"),
TransitionName: pulumi.String("string"),
},
},
},
},
VariableDefinitions: intersight.WorkflowWorkflowDefinitionVariableDefinitionArray{
&intersight.WorkflowWorkflowDefinitionVariableDefinitionArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Defaults: intersight.WorkflowWorkflowDefinitionVariableDefinitionDefaultArray{
&intersight.WorkflowWorkflowDefinitionVariableDefinitionDefaultArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
IsValueSet: pulumi.Bool(false),
ObjectType: pulumi.String("string"),
Override: pulumi.Bool(false),
Value: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
DisplayMetas: intersight.WorkflowWorkflowDefinitionVariableDefinitionDisplayMetaArray{
&intersight.WorkflowWorkflowDefinitionVariableDefinitionDisplayMetaArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
InventorySelector: pulumi.Bool(false),
ObjectType: pulumi.String("string"),
WidgetType: pulumi.String("string"),
},
},
InputParameters: pulumi.String("string"),
Label: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Required: pulumi.Bool(false),
},
},
VersionContexts: intersight.WorkflowWorkflowDefinitionVersionContextArray{
&intersight.WorkflowWorkflowDefinitionVersionContextArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
InterestedMos: intersight.WorkflowWorkflowDefinitionVersionContextInterestedMoArray{
&intersight.WorkflowWorkflowDefinitionVersionContextInterestedMoArgs{
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.WorkflowWorkflowDefinitionVersionContextRefMoArray{
&intersight.WorkflowWorkflowDefinitionVersionContextRefMoArgs{
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"),
},
},
WorkflowMetadatas: intersight.WorkflowWorkflowDefinitionWorkflowMetadataArray{
&intersight.WorkflowWorkflowDefinitionWorkflowMetadataArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
WorkflowWorkflowDefinitionId: pulumi.String("string"),
})
var workflowWorkflowDefinitionResource = new WorkflowWorkflowDefinition("workflowWorkflowDefinitionResource", WorkflowWorkflowDefinitionArgs.builder()
.accountMoid("string")
.additionalProperties("string")
.ancestors(WorkflowWorkflowDefinitionAncestorArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.catalogs(WorkflowWorkflowDefinitionCatalogArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.classId("string")
.clonedFroms(WorkflowWorkflowDefinitionClonedFromArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.createTime("string")
.createUser("string")
.defaultVersion(false)
.description("string")
.domainGroupMoid("string")
.inputDefinitions(WorkflowWorkflowDefinitionInputDefinitionArgs.builder()
.additionalProperties("string")
.classId("string")
.defaults(WorkflowWorkflowDefinitionInputDefinitionDefaultArgs.builder()
.additionalProperties("string")
.classId("string")
.isValueSet(false)
.objectType("string")
.override(false)
.value("string")
.build())
.description("string")
.displayMetas(WorkflowWorkflowDefinitionInputDefinitionDisplayMetaArgs.builder()
.additionalProperties("string")
.classId("string")
.inventorySelector(false)
.objectType("string")
.widgetType("string")
.build())
.inputParameters("string")
.label("string")
.name("string")
.objectType("string")
.required(false)
.build())
.inputParameterSets(WorkflowWorkflowDefinitionInputParameterSetArgs.builder()
.additionalProperties("string")
.classId("string")
.condition("string")
.controlParameter("string")
.enableParameters("string")
.name("string")
.objectType("string")
.value("string")
.build())
.label("string")
.licenseEntitlement("string")
.maxTaskCount(0)
.maxWorkerTaskCount(0)
.modTime("string")
.modUser("string")
.moid("string")
.name("string")
.nrVersion(0)
.objectType("string")
.outputDefinitions(WorkflowWorkflowDefinitionOutputDefinitionArgs.builder()
.additionalProperties("string")
.classId("string")
.defaults(WorkflowWorkflowDefinitionOutputDefinitionDefaultArgs.builder()
.additionalProperties("string")
.classId("string")
.isValueSet(false)
.objectType("string")
.override(false)
.value("string")
.build())
.description("string")
.displayMetas(WorkflowWorkflowDefinitionOutputDefinitionDisplayMetaArgs.builder()
.additionalProperties("string")
.classId("string")
.inventorySelector(false)
.objectType("string")
.widgetType("string")
.build())
.inputParameters("string")
.label("string")
.name("string")
.objectType("string")
.required(false)
.build())
.outputParameters("string")
.owners("string")
.parents(WorkflowWorkflowDefinitionParentArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.permissionResources(WorkflowWorkflowDefinitionPermissionResourceArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.properties(WorkflowWorkflowDefinitionPropertyArgs.builder()
.additionalProperties("string")
.classId("string")
.cloneable(false)
.enableDebug(false)
.enablePublishStatus(false)
.externalMeta(false)
.objectType("string")
.publishStatus("string")
.retryable(false)
.rollbackOnCancel(false)
.rollbackOnFailure(false)
.supportStatus("string")
.build())
.sharedScope("string")
.tags(WorkflowWorkflowDefinitionTagArgs.builder()
.additionalProperties("string")
.key("string")
.value("string")
.build())
.tasks(WorkflowWorkflowDefinitionTaskArgs.builder()
.additionalProperties("string")
.classId("string")
.description("string")
.label("string")
.name("string")
.objectType("string")
.build())
.uiInputFilters(WorkflowWorkflowDefinitionUiInputFilterArgs.builder()
.additionalProperties("string")
.classId("string")
.filters("string")
.name("string")
.objectType("string")
.userHelpMessage("string")
.build())
.uiRenderingData("string")
.validationInformations(WorkflowWorkflowDefinitionValidationInformationArgs.builder()
.additionalProperties("string")
.classId("string")
.engineState("string")
.objectType("string")
.state("string")
.validationErrors(WorkflowWorkflowDefinitionValidationInformationValidationErrorArgs.builder()
.additionalProperties("string")
.classId("string")
.errorLog("string")
.field("string")
.objectType("string")
.taskName("string")
.transitionName("string")
.build())
.build())
.variableDefinitions(WorkflowWorkflowDefinitionVariableDefinitionArgs.builder()
.additionalProperties("string")
.classId("string")
.defaults(WorkflowWorkflowDefinitionVariableDefinitionDefaultArgs.builder()
.additionalProperties("string")
.classId("string")
.isValueSet(false)
.objectType("string")
.override(false)
.value("string")
.build())
.description("string")
.displayMetas(WorkflowWorkflowDefinitionVariableDefinitionDisplayMetaArgs.builder()
.additionalProperties("string")
.classId("string")
.inventorySelector(false)
.objectType("string")
.widgetType("string")
.build())
.inputParameters("string")
.label("string")
.name("string")
.objectType("string")
.required(false)
.build())
.versionContexts(WorkflowWorkflowDefinitionVersionContextArgs.builder()
.additionalProperties("string")
.classId("string")
.interestedMos(WorkflowWorkflowDefinitionVersionContextInterestedMoArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.markedForDeletion(false)
.nrVersion("string")
.objectType("string")
.refMos(WorkflowWorkflowDefinitionVersionContextRefMoArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.timestamp("string")
.versionType("string")
.build())
.workflowMetadatas(WorkflowWorkflowDefinitionWorkflowMetadataArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.workflowWorkflowDefinitionId("string")
.build());
workflow_workflow_definition_resource = intersight.WorkflowWorkflowDefinition("workflowWorkflowDefinitionResource",
account_moid="string",
additional_properties="string",
ancestors=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
catalogs=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
class_id="string",
cloned_froms=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
create_time="string",
create_user="string",
default_version=False,
description="string",
domain_group_moid="string",
input_definitions=[{
"additional_properties": "string",
"class_id": "string",
"defaults": [{
"additional_properties": "string",
"class_id": "string",
"is_value_set": False,
"object_type": "string",
"override": False,
"value": "string",
}],
"description": "string",
"display_metas": [{
"additional_properties": "string",
"class_id": "string",
"inventory_selector": False,
"object_type": "string",
"widget_type": "string",
}],
"input_parameters": "string",
"label": "string",
"name": "string",
"object_type": "string",
"required": False,
}],
input_parameter_sets=[{
"additional_properties": "string",
"class_id": "string",
"condition": "string",
"control_parameter": "string",
"enable_parameters": ["string"],
"name": "string",
"object_type": "string",
"value": "string",
}],
label="string",
license_entitlement="string",
max_task_count=0,
max_worker_task_count=0,
mod_time="string",
mod_user="string",
moid="string",
name="string",
nr_version=0,
object_type="string",
output_definitions=[{
"additional_properties": "string",
"class_id": "string",
"defaults": [{
"additional_properties": "string",
"class_id": "string",
"is_value_set": False,
"object_type": "string",
"override": False,
"value": "string",
}],
"description": "string",
"display_metas": [{
"additional_properties": "string",
"class_id": "string",
"inventory_selector": False,
"object_type": "string",
"widget_type": "string",
}],
"input_parameters": "string",
"label": "string",
"name": "string",
"object_type": "string",
"required": False,
}],
output_parameters="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",
}],
properties=[{
"additional_properties": "string",
"class_id": "string",
"cloneable": False,
"enable_debug": False,
"enable_publish_status": False,
"external_meta": False,
"object_type": "string",
"publish_status": "string",
"retryable": False,
"rollback_on_cancel": False,
"rollback_on_failure": False,
"support_status": "string",
}],
shared_scope="string",
tags=[{
"additional_properties": "string",
"key": "string",
"value": "string",
}],
tasks=[{
"additional_properties": "string",
"class_id": "string",
"description": "string",
"label": "string",
"name": "string",
"object_type": "string",
}],
ui_input_filters=[{
"additional_properties": "string",
"class_id": "string",
"filters": ["string"],
"name": "string",
"object_type": "string",
"user_help_message": "string",
}],
ui_rendering_data="string",
validation_informations=[{
"additional_properties": "string",
"class_id": "string",
"engine_state": "string",
"object_type": "string",
"state": "string",
"validation_errors": [{
"additional_properties": "string",
"class_id": "string",
"error_log": "string",
"field": "string",
"object_type": "string",
"task_name": "string",
"transition_name": "string",
}],
}],
variable_definitions=[{
"additional_properties": "string",
"class_id": "string",
"defaults": [{
"additional_properties": "string",
"class_id": "string",
"is_value_set": False,
"object_type": "string",
"override": False,
"value": "string",
}],
"description": "string",
"display_metas": [{
"additional_properties": "string",
"class_id": "string",
"inventory_selector": False,
"object_type": "string",
"widget_type": "string",
}],
"input_parameters": "string",
"label": "string",
"name": "string",
"object_type": "string",
"required": False,
}],
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_metadatas=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
workflow_workflow_definition_id="string")
const workflowWorkflowDefinitionResource = new intersight.WorkflowWorkflowDefinition("workflowWorkflowDefinitionResource", {
accountMoid: "string",
additionalProperties: "string",
ancestors: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
catalogs: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
classId: "string",
clonedFroms: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
createTime: "string",
createUser: "string",
defaultVersion: false,
description: "string",
domainGroupMoid: "string",
inputDefinitions: [{
additionalProperties: "string",
classId: "string",
defaults: [{
additionalProperties: "string",
classId: "string",
isValueSet: false,
objectType: "string",
override: false,
value: "string",
}],
description: "string",
displayMetas: [{
additionalProperties: "string",
classId: "string",
inventorySelector: false,
objectType: "string",
widgetType: "string",
}],
inputParameters: "string",
label: "string",
name: "string",
objectType: "string",
required: false,
}],
inputParameterSets: [{
additionalProperties: "string",
classId: "string",
condition: "string",
controlParameter: "string",
enableParameters: ["string"],
name: "string",
objectType: "string",
value: "string",
}],
label: "string",
licenseEntitlement: "string",
maxTaskCount: 0,
maxWorkerTaskCount: 0,
modTime: "string",
modUser: "string",
moid: "string",
name: "string",
nrVersion: 0,
objectType: "string",
outputDefinitions: [{
additionalProperties: "string",
classId: "string",
defaults: [{
additionalProperties: "string",
classId: "string",
isValueSet: false,
objectType: "string",
override: false,
value: "string",
}],
description: "string",
displayMetas: [{
additionalProperties: "string",
classId: "string",
inventorySelector: false,
objectType: "string",
widgetType: "string",
}],
inputParameters: "string",
label: "string",
name: "string",
objectType: "string",
required: false,
}],
outputParameters: "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",
}],
properties: [{
additionalProperties: "string",
classId: "string",
cloneable: false,
enableDebug: false,
enablePublishStatus: false,
externalMeta: false,
objectType: "string",
publishStatus: "string",
retryable: false,
rollbackOnCancel: false,
rollbackOnFailure: false,
supportStatus: "string",
}],
sharedScope: "string",
tags: [{
additionalProperties: "string",
key: "string",
value: "string",
}],
tasks: [{
additionalProperties: "string",
classId: "string",
description: "string",
label: "string",
name: "string",
objectType: "string",
}],
uiInputFilters: [{
additionalProperties: "string",
classId: "string",
filters: ["string"],
name: "string",
objectType: "string",
userHelpMessage: "string",
}],
uiRenderingData: "string",
validationInformations: [{
additionalProperties: "string",
classId: "string",
engineState: "string",
objectType: "string",
state: "string",
validationErrors: [{
additionalProperties: "string",
classId: "string",
errorLog: "string",
field: "string",
objectType: "string",
taskName: "string",
transitionName: "string",
}],
}],
variableDefinitions: [{
additionalProperties: "string",
classId: "string",
defaults: [{
additionalProperties: "string",
classId: "string",
isValueSet: false,
objectType: "string",
override: false,
value: "string",
}],
description: "string",
displayMetas: [{
additionalProperties: "string",
classId: "string",
inventorySelector: false,
objectType: "string",
widgetType: "string",
}],
inputParameters: "string",
label: "string",
name: "string",
objectType: "string",
required: false,
}],
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",
}],
workflowMetadatas: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
workflowWorkflowDefinitionId: "string",
});
type: intersight:WorkflowWorkflowDefinition
properties:
accountMoid: string
additionalProperties: string
ancestors:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
catalogs:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
classId: string
clonedFroms:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
createTime: string
createUser: string
defaultVersion: false
description: string
domainGroupMoid: string
inputDefinitions:
- additionalProperties: string
classId: string
defaults:
- additionalProperties: string
classId: string
isValueSet: false
objectType: string
override: false
value: string
description: string
displayMetas:
- additionalProperties: string
classId: string
inventorySelector: false
objectType: string
widgetType: string
inputParameters: string
label: string
name: string
objectType: string
required: false
inputParameterSets:
- additionalProperties: string
classId: string
condition: string
controlParameter: string
enableParameters:
- string
name: string
objectType: string
value: string
label: string
licenseEntitlement: string
maxTaskCount: 0
maxWorkerTaskCount: 0
modTime: string
modUser: string
moid: string
name: string
nrVersion: 0
objectType: string
outputDefinitions:
- additionalProperties: string
classId: string
defaults:
- additionalProperties: string
classId: string
isValueSet: false
objectType: string
override: false
value: string
description: string
displayMetas:
- additionalProperties: string
classId: string
inventorySelector: false
objectType: string
widgetType: string
inputParameters: string
label: string
name: string
objectType: string
required: false
outputParameters: 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
properties:
- additionalProperties: string
classId: string
cloneable: false
enableDebug: false
enablePublishStatus: false
externalMeta: false
objectType: string
publishStatus: string
retryable: false
rollbackOnCancel: false
rollbackOnFailure: false
supportStatus: string
sharedScope: string
tags:
- additionalProperties: string
key: string
value: string
tasks:
- additionalProperties: string
classId: string
description: string
label: string
name: string
objectType: string
uiInputFilters:
- additionalProperties: string
classId: string
filters:
- string
name: string
objectType: string
userHelpMessage: string
uiRenderingData: string
validationInformations:
- additionalProperties: string
classId: string
engineState: string
objectType: string
state: string
validationErrors:
- additionalProperties: string
classId: string
errorLog: string
field: string
objectType: string
taskName: string
transitionName: string
variableDefinitions:
- additionalProperties: string
classId: string
defaults:
- additionalProperties: string
classId: string
isValueSet: false
objectType: string
override: false
value: string
description: string
displayMetas:
- additionalProperties: string
classId: string
inventorySelector: false
objectType: string
widgetType: string
inputParameters: string
label: string
name: string
objectType: string
required: false
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
workflowMetadatas:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
workflowWorkflowDefinitionId: string
WorkflowWorkflowDefinition 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 WorkflowWorkflowDefinition resource accepts the following input properties:
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Additional
Properties string - Ancestors
List<Workflow
Workflow Definition Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Catalogs
List<Workflow
Workflow Definition Catalog> - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Class
Id 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.
- Cloned
Froms List<WorkflowWorkflow Definition Cloned From> - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Create
Time string - (ReadOnly) The time when this managed object was created.
- Create
User string - (ReadOnly) The user identifier who created or cloned the workflow definition.
- Default
Version bool - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- Description string
- The description for this workflow.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Input
Definitions List<WorkflowWorkflow Definition Input Definition> - This complex property has following sub-properties:
- Input
Parameter List<WorkflowSets Workflow Definition Input Parameter Set> - This complex property has following sub-properties:
- Label string
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- License
Entitlement string - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - Max
Task doubleCount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- Max
Worker doubleTask Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Mod
User string - (ReadOnly) The user identifier who last updated the workflow definition.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- Nr
Version double - The version of the workflow to support multiple versions.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Output
Definitions List<WorkflowWorkflow Definition Output Definition> - This complex property has following sub-properties:
- Output
Parameters string - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- Owners List<string>
- (Array of schema.TypeString) -(ReadOnly)
- Parents
List<Workflow
Workflow Definition Parent> - (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 List<WorkflowWorkflow Definition Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Properties
List<Workflow
Workflow Definition Property> - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
List<Workflow
Workflow Definition Tag> - This complex property has following sub-properties:
- Tasks
List<Workflow
Workflow Definition Task> - This complex property has following sub-properties:
- Ui
Input List<WorkflowFilters Workflow Definition Ui Input Filter> - This complex property has following sub-properties:
- Ui
Rendering stringData - This will hold the data needed for workflow to be rendered in the user interface.
- Validation
Informations List<WorkflowWorkflow Definition Validation Information> - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- Variable
Definitions List<WorkflowWorkflow Definition Variable Definition> - This complex property has following sub-properties:
- Version
Contexts List<WorkflowWorkflow Definition Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Workflow
Metadatas List<WorkflowWorkflow Definition Workflow Metadata> - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Workflow
Workflow stringDefinition Id
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Additional
Properties string - Ancestors
[]Workflow
Workflow Definition Ancestor Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Catalogs
[]Workflow
Workflow Definition Catalog Args - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Class
Id 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.
- Cloned
Froms []WorkflowWorkflow Definition Cloned From Args - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Create
Time string - (ReadOnly) The time when this managed object was created.
- Create
User string - (ReadOnly) The user identifier who created or cloned the workflow definition.
- Default
Version bool - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- Description string
- The description for this workflow.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Input
Definitions []WorkflowWorkflow Definition Input Definition Args - This complex property has following sub-properties:
- Input
Parameter []WorkflowSets Workflow Definition Input Parameter Set Args - This complex property has following sub-properties:
- Label string
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- License
Entitlement string - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - Max
Task float64Count - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- Max
Worker float64Task Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Mod
User string - (ReadOnly) The user identifier who last updated the workflow definition.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- Nr
Version float64 - The version of the workflow to support multiple versions.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Output
Definitions []WorkflowWorkflow Definition Output Definition Args - This complex property has following sub-properties:
- Output
Parameters string - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- Owners []string
- (Array of schema.TypeString) -(ReadOnly)
- Parents
[]Workflow
Workflow Definition Parent Args - (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 []WorkflowWorkflow Definition Permission Resource Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Properties
[]Workflow
Workflow Definition Property Args - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
[]Workflow
Workflow Definition Tag Args - This complex property has following sub-properties:
- Tasks
[]Workflow
Workflow Definition Task Args - This complex property has following sub-properties:
- Ui
Input []WorkflowFilters Workflow Definition Ui Input Filter Args - This complex property has following sub-properties:
- Ui
Rendering stringData - This will hold the data needed for workflow to be rendered in the user interface.
- Validation
Informations []WorkflowWorkflow Definition Validation Information Args - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- Variable
Definitions []WorkflowWorkflow Definition Variable Definition Args - This complex property has following sub-properties:
- Version
Contexts []WorkflowWorkflow Definition Version Context Args - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Workflow
Metadatas []WorkflowWorkflow Definition Workflow Metadata Args - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Workflow
Workflow stringDefinition Id
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- additional
Properties String - ancestors
List<Workflow
Workflow Definition Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- catalogs
List<Workflow
Workflow Definition Catalog> - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id 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.
- cloned
Froms List<WorkflowWorkflow Definition Cloned From> - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- create
Time String - (ReadOnly) The time when this managed object was created.
- create
User String - (ReadOnly) The user identifier who created or cloned the workflow definition.
- default
Version Boolean - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- description String
- The description for this workflow.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- input
Definitions List<WorkflowWorkflow Definition Input Definition> - This complex property has following sub-properties:
- input
Parameter List<WorkflowSets Workflow Definition Input Parameter Set> - This complex property has following sub-properties:
- label String
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- license
Entitlement String - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - max
Task DoubleCount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- max
Worker DoubleTask Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- mod
User String - (ReadOnly) The user identifier who last updated the workflow definition.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- nr
Version Double - The version of the workflow to support multiple versions.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- output
Definitions List<WorkflowWorkflow Definition Output Definition> - This complex property has following sub-properties:
- output
Parameters String - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- owners List<String>
- (Array of schema.TypeString) -(ReadOnly)
- parents
List<Workflow
Workflow Definition Parent> - (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 List<WorkflowWorkflow Definition Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- properties
List<Workflow
Workflow Definition Property> - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
List<Workflow
Workflow Definition Tag> - This complex property has following sub-properties:
- tasks
List<Workflow
Workflow Definition Task> - This complex property has following sub-properties:
- ui
Input List<WorkflowFilters Workflow Definition Ui Input Filter> - This complex property has following sub-properties:
- ui
Rendering StringData - This will hold the data needed for workflow to be rendered in the user interface.
- validation
Informations List<WorkflowWorkflow Definition Validation Information> - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- variable
Definitions List<WorkflowWorkflow Definition Variable Definition> - This complex property has following sub-properties:
- version
Contexts List<WorkflowWorkflow Definition Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- workflow
Metadatas List<WorkflowWorkflow Definition Workflow Metadata> - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Workflow StringDefinition Id
- account
Moid string - (ReadOnly) The Account ID for this managed object.
- additional
Properties string - ancestors
Workflow
Workflow Definition Ancestor[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- catalogs
Workflow
Workflow Definition Catalog[] - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id 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.
- cloned
Froms WorkflowWorkflow Definition Cloned From[] - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- create
Time string - (ReadOnly) The time when this managed object was created.
- create
User string - (ReadOnly) The user identifier who created or cloned the workflow definition.
- default
Version boolean - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- description string
- The description for this workflow.
- domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- input
Definitions WorkflowWorkflow Definition Input Definition[] - This complex property has following sub-properties:
- input
Parameter WorkflowSets Workflow Definition Input Parameter Set[] - This complex property has following sub-properties:
- label string
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- license
Entitlement string - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - max
Task numberCount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- max
Worker numberTask Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- mod
Time string - (ReadOnly) The time when this managed object was last modified.
- mod
User string - (ReadOnly) The user identifier who last updated the workflow definition.
- moid string
- The unique identifier of this Managed Object instance.
- name string
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- nr
Version number - The version of the workflow to support multiple versions.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- output
Definitions WorkflowWorkflow Definition Output Definition[] - This complex property has following sub-properties:
- output
Parameters string - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- owners string[]
- (Array of schema.TypeString) -(ReadOnly)
- parents
Workflow
Workflow Definition Parent[] - (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 WorkflowWorkflow Definition Permission Resource[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- properties
Workflow
Workflow Definition Property[] - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
Workflow
Workflow Definition Tag[] - This complex property has following sub-properties:
- tasks
Workflow
Workflow Definition Task[] - This complex property has following sub-properties:
- ui
Input WorkflowFilters Workflow Definition Ui Input Filter[] - This complex property has following sub-properties:
- ui
Rendering stringData - This will hold the data needed for workflow to be rendered in the user interface.
- validation
Informations WorkflowWorkflow Definition Validation Information[] - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- variable
Definitions WorkflowWorkflow Definition Variable Definition[] - This complex property has following sub-properties:
- version
Contexts WorkflowWorkflow Definition Version Context[] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- workflow
Metadatas WorkflowWorkflow Definition Workflow Metadata[] - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Workflow stringDefinition Id
- account_
moid str - (ReadOnly) The Account ID for this managed object.
- additional_
properties str - ancestors
Sequence[Workflow
Workflow Definition Ancestor Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- catalogs
Sequence[Workflow
Workflow Definition Catalog Args] - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. 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.
- cloned_
froms Sequence[WorkflowWorkflow Definition Cloned From Args] - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- create_
time str - (ReadOnly) The time when this managed object was created.
- create_
user str - (ReadOnly) The user identifier who created or cloned the workflow definition.
- default_
version bool - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- description str
- The description for this workflow.
- domain_
group_ strmoid - (ReadOnly) The DomainGroup ID for this managed object.
- input_
definitions Sequence[WorkflowWorkflow Definition Input Definition Args] - This complex property has following sub-properties:
- input_
parameter_ Sequence[Workflowsets Workflow Definition Input Parameter Set Args] - This complex property has following sub-properties:
- label str
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- license_
entitlement str - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - max_
task_ floatcount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- max_
worker_ floattask_ count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- mod_
time str - (ReadOnly) The time when this managed object was last modified.
- mod_
user str - (ReadOnly) The user identifier who last updated the workflow definition.
- moid str
- The unique identifier of this Managed Object instance.
- name str
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- nr_
version float - The version of the workflow to support multiple versions.
- object_
type str - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- output_
definitions Sequence[WorkflowWorkflow Definition Output Definition Args] - This complex property has following sub-properties:
- output_
parameters str - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- owners Sequence[str]
- (Array of schema.TypeString) -(ReadOnly)
- parents
Sequence[Workflow
Workflow Definition Parent Args] - (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[WorkflowWorkflow Definition Permission Resource Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- properties
Sequence[Workflow
Workflow Definition Property Args] - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
Sequence[Workflow
Workflow Definition Tag Args] - This complex property has following sub-properties:
- tasks
Sequence[Workflow
Workflow Definition Task Args] - This complex property has following sub-properties:
- ui_
input_ Sequence[Workflowfilters Workflow Definition Ui Input Filter Args] - This complex property has following sub-properties:
- ui_
rendering_ strdata - This will hold the data needed for workflow to be rendered in the user interface.
- validation_
informations Sequence[WorkflowWorkflow Definition Validation Information Args] - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- variable_
definitions Sequence[WorkflowWorkflow Definition Variable Definition Args] - This complex property has following sub-properties:
- version_
contexts Sequence[WorkflowWorkflow Definition Version Context Args] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- workflow_
metadatas Sequence[WorkflowWorkflow Definition Workflow Metadata Args] - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow_
workflow_ strdefinition_ id
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- additional
Properties String - ancestors List<Property Map>
- (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- catalogs List<Property Map>
- A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id 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.
- cloned
Froms List<Property Map> - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- create
Time String - (ReadOnly) The time when this managed object was created.
- create
User String - (ReadOnly) The user identifier who created or cloned the workflow definition.
- default
Version Boolean - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- description String
- The description for this workflow.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- input
Definitions List<Property Map> - This complex property has following sub-properties:
- input
Parameter List<Property Map>Sets - This complex property has following sub-properties:
- label String
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- license
Entitlement String - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - max
Task NumberCount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- max
Worker NumberTask Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- mod
User String - (ReadOnly) The user identifier who last updated the workflow definition.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- nr
Version Number - The version of the workflow to support multiple versions.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- output
Definitions List<Property Map> - This complex property has following sub-properties:
- output
Parameters String - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- 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:
- permission
Resources List<Property Map> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- properties List<Property Map>
- Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
- List<Property Map>
- This complex property has following sub-properties:
- tasks List<Property Map>
- This complex property has following sub-properties:
- ui
Input List<Property Map>Filters - This complex property has following sub-properties:
- ui
Rendering StringData - This will hold the data needed for workflow to be rendered in the user interface.
- validation
Informations List<Property Map> - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- variable
Definitions List<Property Map> - This complex property has following sub-properties:
- version
Contexts List<Property Map> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- workflow
Metadatas List<Property Map> - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Workflow StringDefinition Id
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkflowWorkflowDefinition 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 WorkflowWorkflowDefinition Resource
Get an existing WorkflowWorkflowDefinition 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?: WorkflowWorkflowDefinitionState, opts?: CustomResourceOptions): WorkflowWorkflowDefinition@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[WorkflowWorkflowDefinitionAncestorArgs]] = None,
catalogs: Optional[Sequence[WorkflowWorkflowDefinitionCatalogArgs]] = None,
class_id: Optional[str] = None,
cloned_froms: Optional[Sequence[WorkflowWorkflowDefinitionClonedFromArgs]] = None,
create_time: Optional[str] = None,
create_user: Optional[str] = None,
default_version: Optional[bool] = None,
description: Optional[str] = None,
domain_group_moid: Optional[str] = None,
input_definitions: Optional[Sequence[WorkflowWorkflowDefinitionInputDefinitionArgs]] = None,
input_parameter_sets: Optional[Sequence[WorkflowWorkflowDefinitionInputParameterSetArgs]] = None,
label: Optional[str] = None,
license_entitlement: Optional[str] = None,
max_task_count: Optional[float] = None,
max_worker_task_count: Optional[float] = None,
mod_time: Optional[str] = None,
mod_user: Optional[str] = None,
moid: Optional[str] = None,
name: Optional[str] = None,
nr_version: Optional[float] = None,
object_type: Optional[str] = None,
output_definitions: Optional[Sequence[WorkflowWorkflowDefinitionOutputDefinitionArgs]] = None,
output_parameters: Optional[str] = None,
owners: Optional[Sequence[str]] = None,
parents: Optional[Sequence[WorkflowWorkflowDefinitionParentArgs]] = None,
permission_resources: Optional[Sequence[WorkflowWorkflowDefinitionPermissionResourceArgs]] = None,
properties: Optional[Sequence[WorkflowWorkflowDefinitionPropertyArgs]] = None,
shared_scope: Optional[str] = None,
tags: Optional[Sequence[WorkflowWorkflowDefinitionTagArgs]] = None,
tasks: Optional[Sequence[WorkflowWorkflowDefinitionTaskArgs]] = None,
ui_input_filters: Optional[Sequence[WorkflowWorkflowDefinitionUiInputFilterArgs]] = None,
ui_rendering_data: Optional[str] = None,
validation_informations: Optional[Sequence[WorkflowWorkflowDefinitionValidationInformationArgs]] = None,
variable_definitions: Optional[Sequence[WorkflowWorkflowDefinitionVariableDefinitionArgs]] = None,
version_contexts: Optional[Sequence[WorkflowWorkflowDefinitionVersionContextArgs]] = None,
workflow_metadatas: Optional[Sequence[WorkflowWorkflowDefinitionWorkflowMetadataArgs]] = None,
workflow_workflow_definition_id: Optional[str] = None) -> WorkflowWorkflowDefinitionfunc GetWorkflowWorkflowDefinition(ctx *Context, name string, id IDInput, state *WorkflowWorkflowDefinitionState, opts ...ResourceOption) (*WorkflowWorkflowDefinition, error)public static WorkflowWorkflowDefinition Get(string name, Input<string> id, WorkflowWorkflowDefinitionState? state, CustomResourceOptions? opts = null)public static WorkflowWorkflowDefinition get(String name, Output<String> id, WorkflowWorkflowDefinitionState state, CustomResourceOptions options)resources: _: type: intersight:WorkflowWorkflowDefinition 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.
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Additional
Properties string - Ancestors
List<Workflow
Workflow Definition Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Catalogs
List<Workflow
Workflow Definition Catalog> - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Class
Id 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.
- Cloned
Froms List<WorkflowWorkflow Definition Cloned From> - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Create
Time string - (ReadOnly) The time when this managed object was created.
- Create
User string - (ReadOnly) The user identifier who created or cloned the workflow definition.
- Default
Version bool - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- Description string
- The description for this workflow.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Input
Definitions List<WorkflowWorkflow Definition Input Definition> - This complex property has following sub-properties:
- Input
Parameter List<WorkflowSets Workflow Definition Input Parameter Set> - This complex property has following sub-properties:
- Label string
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- License
Entitlement string - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - Max
Task doubleCount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- Max
Worker doubleTask Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Mod
User string - (ReadOnly) The user identifier who last updated the workflow definition.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- Nr
Version double - The version of the workflow to support multiple versions.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Output
Definitions List<WorkflowWorkflow Definition Output Definition> - This complex property has following sub-properties:
- Output
Parameters string - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- Owners List<string>
- (Array of schema.TypeString) -(ReadOnly)
- Parents
List<Workflow
Workflow Definition Parent> - (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 List<WorkflowWorkflow Definition Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Properties
List<Workflow
Workflow Definition Property> - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
List<Workflow
Workflow Definition Tag> - This complex property has following sub-properties:
- Tasks
List<Workflow
Workflow Definition Task> - This complex property has following sub-properties:
- Ui
Input List<WorkflowFilters Workflow Definition Ui Input Filter> - This complex property has following sub-properties:
- Ui
Rendering stringData - This will hold the data needed for workflow to be rendered in the user interface.
- Validation
Informations List<WorkflowWorkflow Definition Validation Information> - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- Variable
Definitions List<WorkflowWorkflow Definition Variable Definition> - This complex property has following sub-properties:
- Version
Contexts List<WorkflowWorkflow Definition Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Workflow
Metadatas List<WorkflowWorkflow Definition Workflow Metadata> - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Workflow
Workflow stringDefinition Id
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Additional
Properties string - Ancestors
[]Workflow
Workflow Definition Ancestor Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Catalogs
[]Workflow
Workflow Definition Catalog Args - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Class
Id 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.
- Cloned
Froms []WorkflowWorkflow Definition Cloned From Args - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Create
Time string - (ReadOnly) The time when this managed object was created.
- Create
User string - (ReadOnly) The user identifier who created or cloned the workflow definition.
- Default
Version bool - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- Description string
- The description for this workflow.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Input
Definitions []WorkflowWorkflow Definition Input Definition Args - This complex property has following sub-properties:
- Input
Parameter []WorkflowSets Workflow Definition Input Parameter Set Args - This complex property has following sub-properties:
- Label string
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- License
Entitlement string - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - Max
Task float64Count - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- Max
Worker float64Task Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Mod
User string - (ReadOnly) The user identifier who last updated the workflow definition.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- Nr
Version float64 - The version of the workflow to support multiple versions.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Output
Definitions []WorkflowWorkflow Definition Output Definition Args - This complex property has following sub-properties:
- Output
Parameters string - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- Owners []string
- (Array of schema.TypeString) -(ReadOnly)
- Parents
[]Workflow
Workflow Definition Parent Args - (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 []WorkflowWorkflow Definition Permission Resource Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Properties
[]Workflow
Workflow Definition Property Args - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
[]Workflow
Workflow Definition Tag Args - This complex property has following sub-properties:
- Tasks
[]Workflow
Workflow Definition Task Args - This complex property has following sub-properties:
- Ui
Input []WorkflowFilters Workflow Definition Ui Input Filter Args - This complex property has following sub-properties:
- Ui
Rendering stringData - This will hold the data needed for workflow to be rendered in the user interface.
- Validation
Informations []WorkflowWorkflow Definition Validation Information Args - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- Variable
Definitions []WorkflowWorkflow Definition Variable Definition Args - This complex property has following sub-properties:
- Version
Contexts []WorkflowWorkflow Definition Version Context Args - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Workflow
Metadatas []WorkflowWorkflow Definition Workflow Metadata Args - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Workflow
Workflow stringDefinition Id
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- additional
Properties String - ancestors
List<Workflow
Workflow Definition Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- catalogs
List<Workflow
Workflow Definition Catalog> - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id 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.
- cloned
Froms List<WorkflowWorkflow Definition Cloned From> - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- create
Time String - (ReadOnly) The time when this managed object was created.
- create
User String - (ReadOnly) The user identifier who created or cloned the workflow definition.
- default
Version Boolean - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- description String
- The description for this workflow.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- input
Definitions List<WorkflowWorkflow Definition Input Definition> - This complex property has following sub-properties:
- input
Parameter List<WorkflowSets Workflow Definition Input Parameter Set> - This complex property has following sub-properties:
- label String
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- license
Entitlement String - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - max
Task DoubleCount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- max
Worker DoubleTask Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- mod
User String - (ReadOnly) The user identifier who last updated the workflow definition.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- nr
Version Double - The version of the workflow to support multiple versions.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- output
Definitions List<WorkflowWorkflow Definition Output Definition> - This complex property has following sub-properties:
- output
Parameters String - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- owners List<String>
- (Array of schema.TypeString) -(ReadOnly)
- parents
List<Workflow
Workflow Definition Parent> - (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 List<WorkflowWorkflow Definition Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- properties
List<Workflow
Workflow Definition Property> - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
List<Workflow
Workflow Definition Tag> - This complex property has following sub-properties:
- tasks
List<Workflow
Workflow Definition Task> - This complex property has following sub-properties:
- ui
Input List<WorkflowFilters Workflow Definition Ui Input Filter> - This complex property has following sub-properties:
- ui
Rendering StringData - This will hold the data needed for workflow to be rendered in the user interface.
- validation
Informations List<WorkflowWorkflow Definition Validation Information> - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- variable
Definitions List<WorkflowWorkflow Definition Variable Definition> - This complex property has following sub-properties:
- version
Contexts List<WorkflowWorkflow Definition Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- workflow
Metadatas List<WorkflowWorkflow Definition Workflow Metadata> - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Workflow StringDefinition Id
- account
Moid string - (ReadOnly) The Account ID for this managed object.
- additional
Properties string - ancestors
Workflow
Workflow Definition Ancestor[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- catalogs
Workflow
Workflow Definition Catalog[] - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id 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.
- cloned
Froms WorkflowWorkflow Definition Cloned From[] - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- create
Time string - (ReadOnly) The time when this managed object was created.
- create
User string - (ReadOnly) The user identifier who created or cloned the workflow definition.
- default
Version boolean - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- description string
- The description for this workflow.
- domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- input
Definitions WorkflowWorkflow Definition Input Definition[] - This complex property has following sub-properties:
- input
Parameter WorkflowSets Workflow Definition Input Parameter Set[] - This complex property has following sub-properties:
- label string
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- license
Entitlement string - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - max
Task numberCount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- max
Worker numberTask Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- mod
Time string - (ReadOnly) The time when this managed object was last modified.
- mod
User string - (ReadOnly) The user identifier who last updated the workflow definition.
- moid string
- The unique identifier of this Managed Object instance.
- name string
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- nr
Version number - The version of the workflow to support multiple versions.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- output
Definitions WorkflowWorkflow Definition Output Definition[] - This complex property has following sub-properties:
- output
Parameters string - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- owners string[]
- (Array of schema.TypeString) -(ReadOnly)
- parents
Workflow
Workflow Definition Parent[] - (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 WorkflowWorkflow Definition Permission Resource[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- properties
Workflow
Workflow Definition Property[] - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
Workflow
Workflow Definition Tag[] - This complex property has following sub-properties:
- tasks
Workflow
Workflow Definition Task[] - This complex property has following sub-properties:
- ui
Input WorkflowFilters Workflow Definition Ui Input Filter[] - This complex property has following sub-properties:
- ui
Rendering stringData - This will hold the data needed for workflow to be rendered in the user interface.
- validation
Informations WorkflowWorkflow Definition Validation Information[] - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- variable
Definitions WorkflowWorkflow Definition Variable Definition[] - This complex property has following sub-properties:
- version
Contexts WorkflowWorkflow Definition Version Context[] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- workflow
Metadatas WorkflowWorkflow Definition Workflow Metadata[] - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Workflow stringDefinition Id
- account_
moid str - (ReadOnly) The Account ID for this managed object.
- additional_
properties str - ancestors
Sequence[Workflow
Workflow Definition Ancestor Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- catalogs
Sequence[Workflow
Workflow Definition Catalog Args] - A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. 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.
- cloned_
froms Sequence[WorkflowWorkflow Definition Cloned From Args] - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- create_
time str - (ReadOnly) The time when this managed object was created.
- create_
user str - (ReadOnly) The user identifier who created or cloned the workflow definition.
- default_
version bool - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- description str
- The description for this workflow.
- domain_
group_ strmoid - (ReadOnly) The DomainGroup ID for this managed object.
- input_
definitions Sequence[WorkflowWorkflow Definition Input Definition Args] - This complex property has following sub-properties:
- input_
parameter_ Sequence[Workflowsets Workflow Definition Input Parameter Set Args] - This complex property has following sub-properties:
- label str
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- license_
entitlement str - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - max_
task_ floatcount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- max_
worker_ floattask_ count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- mod_
time str - (ReadOnly) The time when this managed object was last modified.
- mod_
user str - (ReadOnly) The user identifier who last updated the workflow definition.
- moid str
- The unique identifier of this Managed Object instance.
- name str
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- nr_
version float - The version of the workflow to support multiple versions.
- object_
type str - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- output_
definitions Sequence[WorkflowWorkflow Definition Output Definition Args] - This complex property has following sub-properties:
- output_
parameters str - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- owners Sequence[str]
- (Array of schema.TypeString) -(ReadOnly)
- parents
Sequence[Workflow
Workflow Definition Parent Args] - (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[WorkflowWorkflow Definition Permission Resource Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- properties
Sequence[Workflow
Workflow Definition Property Args] - Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
-
Sequence[Workflow
Workflow Definition Tag Args] - This complex property has following sub-properties:
- tasks
Sequence[Workflow
Workflow Definition Task Args] - This complex property has following sub-properties:
- ui_
input_ Sequence[Workflowfilters Workflow Definition Ui Input Filter Args] - This complex property has following sub-properties:
- ui_
rendering_ strdata - This will hold the data needed for workflow to be rendered in the user interface.
- validation_
informations Sequence[WorkflowWorkflow Definition Validation Information Args] - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- variable_
definitions Sequence[WorkflowWorkflow Definition Variable Definition Args] - This complex property has following sub-properties:
- version_
contexts Sequence[WorkflowWorkflow Definition Version Context Args] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- workflow_
metadatas Sequence[WorkflowWorkflow Definition Workflow Metadata Args] - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow_
workflow_ strdefinition_ id
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- additional
Properties String - ancestors List<Property Map>
- (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- catalogs List<Property Map>
- A reference to a workflowCatalog resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id 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.
- cloned
Froms List<Property Map> - (ReadOnly) A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- create
Time String - (ReadOnly) The time when this managed object was created.
- create
User String - (ReadOnly) The user identifier who created or cloned the workflow definition.
- default
Version Boolean - When true this will be the workflow version that is used when a specific workflow definition version is not specified. The default version is used when user executes a workflow without specifying a version or when workflow is included in another workflow without a specific version. The very first workflow definition created with a name will be set as the default version, after that user can explicitly set any version of the workflow definition as the default version.
- description String
- The description for this workflow.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- input
Definitions List<Property Map> - This complex property has following sub-properties:
- input
Parameter List<Property Map>Sets - This complex property has following sub-properties:
- label String
- A user friendly short name to identify the workflow. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), or an underscore (_).
- license
Entitlement String - (ReadOnly) License entitlement required to run this workflow. It is calculated based on the highest license requirement of all its tasks.*
Base- Base as a License type. It is default license type.*Essential- Essential as a License type.*Standard- Standard as a License type.*Advantage- Advantage as a License type.*Premier- Premier as a License type.*IWO-Essential- IWO-Essential as a License type.*IWO-Advantage- IWO-Advantage as a License type.*IWO-Premier- IWO-Premier as a License type.*IKS-Advantage- IKS-Advantage as a License type.*INC-Premier-1GFixed- Premier 1G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-10GFixed- Premier 10G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-100GFixed- Premier 100G Fixed license tier for Intersight Nexus Cloud.*INC-Premier-Mod4Slot- Premier Modular 4 slot license tier for Intersight Nexus Cloud.*INC-Premier-Mod8Slot- Premier Modular 8 slot license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsFixed- Premier D2Ops fixed license tier for Intersight Nexus Cloud.*INC-Premier-D2OpsMod- Premier D2Ops modular license tier for Intersight Nexus Cloud.*INC-Premier-CentralizedMod8Slot- Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.*INC-Premier-DistributedMod8Slot- Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.*ERP-Advantage- Advantage license tier for ERP workflows.*IntersightTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.*IWOTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.*IKSTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.*INCTrial- Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers. - max
Task NumberCount - (ReadOnly) The maximum number of tasks that can be executed on this workflow.
- max
Worker NumberTask Count - (ReadOnly) The maximum number of external (worker) tasks that can be executed on this workflow.
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- mod
User String - (ReadOnly) The user identifier who last updated the workflow definition.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- The name for this workflow. You can have multiple versions of the workflow with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.) or an underscore (_).
- nr
Version Number - The version of the workflow to support multiple versions.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- output
Definitions List<Property Map> - This complex property has following sub-properties:
- output
Parameters String - The output mappings for the workflow. The schema for outputs of a workflow is defined using OutputDefinition. The outputs for workflows that we want to export out at the end of the workflow can be mapped from task outputs, workflow inputs, or workflow variables. Any task output, workflow input, or workflow variable can be mapped to a workflow output as long as the types are compatible. The format to specify the mapping is '${ 'workflow | '. 'output |input | variable'.[.]}'. First, either the keyword 'workflow' or the name of the task in the workflow must be given. If a task name is used, then it must be followed by the keyword 'output', if the keyword workflow was used, then it must be followed by the keyword 'input' or 'variable'. Following this '' must be the name of either input, output, or variable that must be mapped as workflow output. The last part of the mapping can be an optional to extract specific fields on the data.
- 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:
- permission
Resources List<Property Map> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- properties List<Property Map>
- Type to capture the properties of a workflow definition. Some of these properties are passed to workflow execution instance. This complex property has following sub-properties:
- 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.
- List<Property Map>
- This complex property has following sub-properties:
- tasks List<Property Map>
- This complex property has following sub-properties:
- ui
Input List<Property Map>Filters - This complex property has following sub-properties:
- ui
Rendering StringData - This will hold the data needed for workflow to be rendered in the user interface.
- validation
Informations List<Property Map> - (ReadOnly) The current validation state and associated information for this workflow. This complex property has following sub-properties:
- variable
Definitions List<Property Map> - This complex property has following sub-properties:
- version
Contexts List<Property Map> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- workflow
Metadatas List<Property Map> - A reference to a workflowWorkflowMetadata resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Workflow StringDefinition Id
Supporting Types
WorkflowWorkflowDefinitionAncestor, WorkflowWorkflowDefinitionAncestorArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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'.
WorkflowWorkflowDefinitionCatalog, WorkflowWorkflowDefinitionCatalogArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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'.
WorkflowWorkflowDefinitionClonedFrom, WorkflowWorkflowDefinitionClonedFromArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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'.
WorkflowWorkflowDefinitionInputDefinition, WorkflowWorkflowDefinitionInputDefinitionArgs
- Additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - Class
Id string - Defaults
List<Workflow
Workflow Definition Input Definition Default> - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- Description string
- Provide a detailed description of the data type.
- Display
Metas List<WorkflowWorkflow Definition Input Definition Display Meta> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- Input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- Label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- Name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- Object
Type 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.
- Required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- Additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - Class
Id string - Defaults
[]Workflow
Workflow Definition Input Definition Default - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- Description string
- Provide a detailed description of the data type.
- Display
Metas []WorkflowWorkflow Definition Input Definition Display Meta - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- Input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- Label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- Name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- Object
Type 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.
- Required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties String - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id String - defaults
List<Workflow
Workflow Definition Input Definition Default> - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description String
- Provide a detailed description of the data type.
- display
Metas List<WorkflowWorkflow Definition Input Definition Display Meta> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters String - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label String
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name String
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required Boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id string - defaults
Workflow
Workflow Definition Input Definition Default[] - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description string
- Provide a detailed description of the data type.
- display
Metas WorkflowWorkflow Definition Input Definition Display Meta[] - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional_
properties str - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class_
id str - defaults
Sequence[Workflow
Workflow Definition Input Definition Default] - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description str
- Provide a detailed description of the data type.
- display_
metas Sequence[WorkflowWorkflow Definition Input Definition Display Meta] - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input_
parameters str - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label str
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name str
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- 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.
- required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties String - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id String - defaults List<Property Map>
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description String
- Provide a detailed description of the data type.
- display
Metas List<Property Map> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters String - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label String
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name String
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required Boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
WorkflowWorkflowDefinitionInputDefinitionDefault, WorkflowWorkflowDefinitionInputDefinitionDefaultArgs
- Additional
Properties string - Class
Id string - Is
Value boolSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- Value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- Additional
Properties string - Class
Id string - Is
Value boolSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- Value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties String - class
Id String - is
Value BooleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override Boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value String
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties string - class
Id string - is
Value booleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional_
properties str - class_
id str - is_
value_ boolset - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value str
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties String - class
Id String - is
Value BooleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override Boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value String
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
WorkflowWorkflowDefinitionInputDefinitionDisplayMeta, WorkflowWorkflowDefinitionInputDefinitionDisplayMetaArgs
- Additional
Properties string - Class
Id string - Inventory
Selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- Additional
Properties string - Class
Id string - Inventory
Selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties String - class
Id String - inventory
Selector Boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type String - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties string - class
Id string - inventory
Selector boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional_
properties str - class_
id str - inventory_
selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget_
type str - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties String - class
Id String - inventory
Selector Boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type String - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
WorkflowWorkflowDefinitionInputParameterSet, WorkflowWorkflowDefinitionInputParameterSetArgs
- Additional
Properties string - Class
Id string - Condition string
- The condition to be evaluated.*
eq- Checks if the values of the two parameters are equal.*ne- Checks if the values of the two parameters are not equal.*contains- Checks if the second parameter string value is a substring of the first parameter string value.*matchesPattern- Checks if a string matches a regular expression. - Control
Parameter string - Name of the controlling entity, whose value will be used for evaluating the parameter set.
- Enable
Parameters List<string> - (Array of schema.TypeString) -
- Name string
- Name for the parameter set. Limited to 64 alphanumeric characters (upper and lower case), and special characters '-' and '_'.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Value string
- The controlling parameter will be evaluated against this 'value'.
- Additional
Properties string - Class
Id string - Condition string
- The condition to be evaluated.*
eq- Checks if the values of the two parameters are equal.*ne- Checks if the values of the two parameters are not equal.*contains- Checks if the second parameter string value is a substring of the first parameter string value.*matchesPattern- Checks if a string matches a regular expression. - Control
Parameter string - Name of the controlling entity, whose value will be used for evaluating the parameter set.
- Enable
Parameters []string - (Array of schema.TypeString) -
- Name string
- Name for the parameter set. Limited to 64 alphanumeric characters (upper and lower case), and special characters '-' and '_'.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Value string
- The controlling parameter will be evaluated against this 'value'.
- additional
Properties String - class
Id String - condition String
- The condition to be evaluated.*
eq- Checks if the values of the two parameters are equal.*ne- Checks if the values of the two parameters are not equal.*contains- Checks if the second parameter string value is a substring of the first parameter string value.*matchesPattern- Checks if a string matches a regular expression. - control
Parameter String - Name of the controlling entity, whose value will be used for evaluating the parameter set.
- enable
Parameters List<String> - (Array of schema.TypeString) -
- name String
- Name for the parameter set. Limited to 64 alphanumeric characters (upper and lower case), and special characters '-' and '_'.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- value String
- The controlling parameter will be evaluated against this 'value'.
- additional
Properties string - class
Id string - condition string
- The condition to be evaluated.*
eq- Checks if the values of the two parameters are equal.*ne- Checks if the values of the two parameters are not equal.*contains- Checks if the second parameter string value is a substring of the first parameter string value.*matchesPattern- Checks if a string matches a regular expression. - control
Parameter string - Name of the controlling entity, whose value will be used for evaluating the parameter set.
- enable
Parameters string[] - (Array of schema.TypeString) -
- name string
- Name for the parameter set. Limited to 64 alphanumeric characters (upper and lower case), and special characters '-' and '_'.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- value string
- The controlling parameter will be evaluated against this 'value'.
- additional_
properties str - class_
id str - condition str
- The condition to be evaluated.*
eq- Checks if the values of the two parameters are equal.*ne- Checks if the values of the two parameters are not equal.*contains- Checks if the second parameter string value is a substring of the first parameter string value.*matchesPattern- Checks if a string matches a regular expression. - control_
parameter str - Name of the controlling entity, whose value will be used for evaluating the parameter set.
- enable_
parameters Sequence[str] - (Array of schema.TypeString) -
- name str
- Name for the parameter set. Limited to 64 alphanumeric characters (upper and lower case), and special characters '-' and '_'.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- value str
- The controlling parameter will be evaluated against this 'value'.
- additional
Properties String - class
Id String - condition String
- The condition to be evaluated.*
eq- Checks if the values of the two parameters are equal.*ne- Checks if the values of the two parameters are not equal.*contains- Checks if the second parameter string value is a substring of the first parameter string value.*matchesPattern- Checks if a string matches a regular expression. - control
Parameter String - Name of the controlling entity, whose value will be used for evaluating the parameter set.
- enable
Parameters List<String> - (Array of schema.TypeString) -
- name String
- Name for the parameter set. Limited to 64 alphanumeric characters (upper and lower case), and special characters '-' and '_'.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- value String
- The controlling parameter will be evaluated against this 'value'.
WorkflowWorkflowDefinitionOutputDefinition, WorkflowWorkflowDefinitionOutputDefinitionArgs
- Additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - Class
Id string - Defaults
List<Workflow
Workflow Definition Output Definition Default> - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- Description string
- Provide a detailed description of the data type.
- Display
Metas List<WorkflowWorkflow Definition Output Definition Display Meta> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- Input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- Label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- Name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- Object
Type 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.
- Required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- Additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - Class
Id string - Defaults
[]Workflow
Workflow Definition Output Definition Default - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- Description string
- Provide a detailed description of the data type.
- Display
Metas []WorkflowWorkflow Definition Output Definition Display Meta - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- Input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- Label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- Name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- Object
Type 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.
- Required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties String - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id String - defaults
List<Workflow
Workflow Definition Output Definition Default> - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description String
- Provide a detailed description of the data type.
- display
Metas List<WorkflowWorkflow Definition Output Definition Display Meta> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters String - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label String
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name String
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required Boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id string - defaults
Workflow
Workflow Definition Output Definition Default[] - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description string
- Provide a detailed description of the data type.
- display
Metas WorkflowWorkflow Definition Output Definition Display Meta[] - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional_
properties str - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class_
id str - defaults
Sequence[Workflow
Workflow Definition Output Definition Default] - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description str
- Provide a detailed description of the data type.
- display_
metas Sequence[WorkflowWorkflow Definition Output Definition Display Meta] - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input_
parameters str - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label str
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name str
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- 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.
- required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties String - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id String - defaults List<Property Map>
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description String
- Provide a detailed description of the data type.
- display
Metas List<Property Map> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters String - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label String
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name String
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required Boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
WorkflowWorkflowDefinitionOutputDefinitionDefault, WorkflowWorkflowDefinitionOutputDefinitionDefaultArgs
- Additional
Properties string - Class
Id string - Is
Value boolSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- Value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- Additional
Properties string - Class
Id string - Is
Value boolSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- Value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties String - class
Id String - is
Value BooleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override Boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value String
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties string - class
Id string - is
Value booleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional_
properties str - class_
id str - is_
value_ boolset - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value str
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties String - class
Id String - is
Value BooleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override Boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value String
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
WorkflowWorkflowDefinitionOutputDefinitionDisplayMeta, WorkflowWorkflowDefinitionOutputDefinitionDisplayMetaArgs
- Additional
Properties string - Class
Id string - Inventory
Selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- Additional
Properties string - Class
Id string - Inventory
Selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties String - class
Id String - inventory
Selector Boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type String - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties string - class
Id string - inventory
Selector boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional_
properties str - class_
id str - inventory_
selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget_
type str - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties String - class
Id String - inventory
Selector Boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type String - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
WorkflowWorkflowDefinitionParent, WorkflowWorkflowDefinitionParentArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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'.
WorkflowWorkflowDefinitionPermissionResource, WorkflowWorkflowDefinitionPermissionResourceArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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'.
WorkflowWorkflowDefinitionProperty, WorkflowWorkflowDefinitionPropertyArgs
- Additional
Properties string - Class
Id string - Cloneable bool
- (ReadOnly) When set to false workflow is not cloneable. It is set to true only if Workflow is not internal and it does not have any internal tasks.
- Enable
Debug bool - Enabling this flag will capture request and response details as debug logs for tasks that are using workflow.BatchApi for implementation. For other tasks in the workflow which are not based on workflow.BatchApi logs will not be generated.
- Enable
Publish boolStatus - This flag determines if this workflow publish status is enforced or not.
- External
Meta bool - (ReadOnly) When set to false the workflow is owned by the system and used for internal services. Such workflows cannot be directly used by external entities.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Publish
Status string - The workflow publish status (Draft, Published, Archived), this property is relevant only when enablePublishStatus is set to true.*
Draft- The enum specifies the option as Draft which means the meta definition is being designed and tested.*Published- The enum specifies the option as Published which means the meta definition is ready for consumption.*Archived- The enum specifies the option as Archived which means the meta definition is archived and can no longer be consumed. - Retryable bool
- When set to true, the failed workflow executions from this workflow definition can be retried for up to 2 weeks since the last modification time. After two weeks of inactivity on the workflow execution, the option to retry the failed workflow will be disabled.
- Rollback
On boolCancel - When set to true, the changes are automatically rolled back if the workflow execution is canceled.
- Rollback
On boolFailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
- Support
Status string - Supported status of the definition.*
Supported- The definition is a supported version and there will be no changes to the mandatory inputs or outputs.*Beta- The definition is a Beta version and this version can under go changes until the version is marked supported.*Deprecated- The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.
- Additional
Properties string - Class
Id string - Cloneable bool
- (ReadOnly) When set to false workflow is not cloneable. It is set to true only if Workflow is not internal and it does not have any internal tasks.
- Enable
Debug bool - Enabling this flag will capture request and response details as debug logs for tasks that are using workflow.BatchApi for implementation. For other tasks in the workflow which are not based on workflow.BatchApi logs will not be generated.
- Enable
Publish boolStatus - This flag determines if this workflow publish status is enforced or not.
- External
Meta bool - (ReadOnly) When set to false the workflow is owned by the system and used for internal services. Such workflows cannot be directly used by external entities.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Publish
Status string - The workflow publish status (Draft, Published, Archived), this property is relevant only when enablePublishStatus is set to true.*
Draft- The enum specifies the option as Draft which means the meta definition is being designed and tested.*Published- The enum specifies the option as Published which means the meta definition is ready for consumption.*Archived- The enum specifies the option as Archived which means the meta definition is archived and can no longer be consumed. - Retryable bool
- When set to true, the failed workflow executions from this workflow definition can be retried for up to 2 weeks since the last modification time. After two weeks of inactivity on the workflow execution, the option to retry the failed workflow will be disabled.
- Rollback
On boolCancel - When set to true, the changes are automatically rolled back if the workflow execution is canceled.
- Rollback
On boolFailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
- Support
Status string - Supported status of the definition.*
Supported- The definition is a supported version and there will be no changes to the mandatory inputs or outputs.*Beta- The definition is a Beta version and this version can under go changes until the version is marked supported.*Deprecated- The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.
- additional
Properties String - class
Id String - cloneable Boolean
- (ReadOnly) When set to false workflow is not cloneable. It is set to true only if Workflow is not internal and it does not have any internal tasks.
- enable
Debug Boolean - Enabling this flag will capture request and response details as debug logs for tasks that are using workflow.BatchApi for implementation. For other tasks in the workflow which are not based on workflow.BatchApi logs will not be generated.
- enable
Publish BooleanStatus - This flag determines if this workflow publish status is enforced or not.
- external
Meta Boolean - (ReadOnly) When set to false the workflow is owned by the system and used for internal services. Such workflows cannot be directly used by external entities.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- publish
Status String - The workflow publish status (Draft, Published, Archived), this property is relevant only when enablePublishStatus is set to true.*
Draft- The enum specifies the option as Draft which means the meta definition is being designed and tested.*Published- The enum specifies the option as Published which means the meta definition is ready for consumption.*Archived- The enum specifies the option as Archived which means the meta definition is archived and can no longer be consumed. - retryable Boolean
- When set to true, the failed workflow executions from this workflow definition can be retried for up to 2 weeks since the last modification time. After two weeks of inactivity on the workflow execution, the option to retry the failed workflow will be disabled.
- rollback
On BooleanCancel - When set to true, the changes are automatically rolled back if the workflow execution is canceled.
- rollback
On BooleanFailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
- support
Status String - Supported status of the definition.*
Supported- The definition is a supported version and there will be no changes to the mandatory inputs or outputs.*Beta- The definition is a Beta version and this version can under go changes until the version is marked supported.*Deprecated- The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.
- additional
Properties string - class
Id string - cloneable boolean
- (ReadOnly) When set to false workflow is not cloneable. It is set to true only if Workflow is not internal and it does not have any internal tasks.
- enable
Debug boolean - Enabling this flag will capture request and response details as debug logs for tasks that are using workflow.BatchApi for implementation. For other tasks in the workflow which are not based on workflow.BatchApi logs will not be generated.
- enable
Publish booleanStatus - This flag determines if this workflow publish status is enforced or not.
- external
Meta boolean - (ReadOnly) When set to false the workflow is owned by the system and used for internal services. Such workflows cannot be directly used by external entities.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- publish
Status string - The workflow publish status (Draft, Published, Archived), this property is relevant only when enablePublishStatus is set to true.*
Draft- The enum specifies the option as Draft which means the meta definition is being designed and tested.*Published- The enum specifies the option as Published which means the meta definition is ready for consumption.*Archived- The enum specifies the option as Archived which means the meta definition is archived and can no longer be consumed. - retryable boolean
- When set to true, the failed workflow executions from this workflow definition can be retried for up to 2 weeks since the last modification time. After two weeks of inactivity on the workflow execution, the option to retry the failed workflow will be disabled.
- rollback
On booleanCancel - When set to true, the changes are automatically rolled back if the workflow execution is canceled.
- rollback
On booleanFailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
- support
Status string - Supported status of the definition.*
Supported- The definition is a supported version and there will be no changes to the mandatory inputs or outputs.*Beta- The definition is a Beta version and this version can under go changes until the version is marked supported.*Deprecated- The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.
- additional_
properties str - class_
id str - cloneable bool
- (ReadOnly) When set to false workflow is not cloneable. It is set to true only if Workflow is not internal and it does not have any internal tasks.
- enable_
debug bool - Enabling this flag will capture request and response details as debug logs for tasks that are using workflow.BatchApi for implementation. For other tasks in the workflow which are not based on workflow.BatchApi logs will not be generated.
- enable_
publish_ boolstatus - This flag determines if this workflow publish status is enforced or not.
- external_
meta bool - (ReadOnly) When set to false the workflow is owned by the system and used for internal services. Such workflows cannot be directly used by external entities.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- publish_
status str - The workflow publish status (Draft, Published, Archived), this property is relevant only when enablePublishStatus is set to true.*
Draft- The enum specifies the option as Draft which means the meta definition is being designed and tested.*Published- The enum specifies the option as Published which means the meta definition is ready for consumption.*Archived- The enum specifies the option as Archived which means the meta definition is archived and can no longer be consumed. - retryable bool
- When set to true, the failed workflow executions from this workflow definition can be retried for up to 2 weeks since the last modification time. After two weeks of inactivity on the workflow execution, the option to retry the failed workflow will be disabled.
- rollback_
on_ boolcancel - When set to true, the changes are automatically rolled back if the workflow execution is canceled.
- rollback_
on_ boolfailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
- support_
status str - Supported status of the definition.*
Supported- The definition is a supported version and there will be no changes to the mandatory inputs or outputs.*Beta- The definition is a Beta version and this version can under go changes until the version is marked supported.*Deprecated- The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.
- additional
Properties String - class
Id String - cloneable Boolean
- (ReadOnly) When set to false workflow is not cloneable. It is set to true only if Workflow is not internal and it does not have any internal tasks.
- enable
Debug Boolean - Enabling this flag will capture request and response details as debug logs for tasks that are using workflow.BatchApi for implementation. For other tasks in the workflow which are not based on workflow.BatchApi logs will not be generated.
- enable
Publish BooleanStatus - This flag determines if this workflow publish status is enforced or not.
- external
Meta Boolean - (ReadOnly) When set to false the workflow is owned by the system and used for internal services. Such workflows cannot be directly used by external entities.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- publish
Status String - The workflow publish status (Draft, Published, Archived), this property is relevant only when enablePublishStatus is set to true.*
Draft- The enum specifies the option as Draft which means the meta definition is being designed and tested.*Published- The enum specifies the option as Published which means the meta definition is ready for consumption.*Archived- The enum specifies the option as Archived which means the meta definition is archived and can no longer be consumed. - retryable Boolean
- When set to true, the failed workflow executions from this workflow definition can be retried for up to 2 weeks since the last modification time. After two weeks of inactivity on the workflow execution, the option to retry the failed workflow will be disabled.
- rollback
On BooleanCancel - When set to true, the changes are automatically rolled back if the workflow execution is canceled.
- rollback
On BooleanFailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
- support
Status String - Supported status of the definition.*
Supported- The definition is a supported version and there will be no changes to the mandatory inputs or outputs.*Beta- The definition is a Beta version and this version can under go changes until the version is marked supported.*Deprecated- The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.
WorkflowWorkflowDefinitionTag, WorkflowWorkflowDefinitionTagArgs
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
- additional
Properties 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.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
WorkflowWorkflowDefinitionTask, WorkflowWorkflowDefinitionTaskArgs
- Additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.DecisionTask workflow.FailureEndTask workflow.ForkTask workflow.JoinTask workflow.LoopTask workflow.SerialLoopTask workflow.StartTask workflow.SubWorkflowTask workflow.SuccessEndTask workflow.WaitTask workflow.WorkerTask - Class
Id string - Description string
- The description of this task instance in the workflow.
- Label string
- A user defined label identifier of the workflow task used for UI display.
- Name string
- The name of the task within the workflow and it must be unique among all WorkflowTasks within a workflow definition. This name serves as the internal unique identifier for the task and is used to pick input and output parameters to feed into other tasks.
- Object
Type 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.
- Additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.DecisionTask workflow.FailureEndTask workflow.ForkTask workflow.JoinTask workflow.LoopTask workflow.SerialLoopTask workflow.StartTask workflow.SubWorkflowTask workflow.SuccessEndTask workflow.WaitTask workflow.WorkerTask - Class
Id string - Description string
- The description of this task instance in the workflow.
- Label string
- A user defined label identifier of the workflow task used for UI display.
- Name string
- The name of the task within the workflow and it must be unique among all WorkflowTasks within a workflow definition. This name serves as the internal unique identifier for the task and is used to pick input and output parameters to feed into other tasks.
- Object
Type 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.
- additional
Properties String - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.DecisionTask workflow.FailureEndTask workflow.ForkTask workflow.JoinTask workflow.LoopTask workflow.SerialLoopTask workflow.StartTask workflow.SubWorkflowTask workflow.SuccessEndTask workflow.WaitTask workflow.WorkerTask - class
Id String - description String
- The description of this task instance in the workflow.
- label String
- A user defined label identifier of the workflow task used for UI display.
- name String
- The name of the task within the workflow and it must be unique among all WorkflowTasks within a workflow definition. This name serves as the internal unique identifier for the task and is used to pick input and output parameters to feed into other tasks.
- object
Type 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.
- additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.DecisionTask workflow.FailureEndTask workflow.ForkTask workflow.JoinTask workflow.LoopTask workflow.SerialLoopTask workflow.StartTask workflow.SubWorkflowTask workflow.SuccessEndTask workflow.WaitTask workflow.WorkerTask - class
Id string - description string
- The description of this task instance in the workflow.
- label string
- A user defined label identifier of the workflow task used for UI display.
- name string
- The name of the task within the workflow and it must be unique among all WorkflowTasks within a workflow definition. This name serves as the internal unique identifier for the task and is used to pick input and output parameters to feed into other tasks.
- object
Type 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.
- additional_
properties str - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.DecisionTask workflow.FailureEndTask workflow.ForkTask workflow.JoinTask workflow.LoopTask workflow.SerialLoopTask workflow.StartTask workflow.SubWorkflowTask workflow.SuccessEndTask workflow.WaitTask workflow.WorkerTask - class_
id str - description str
- The description of this task instance in the workflow.
- label str
- A user defined label identifier of the workflow task used for UI display.
- name str
- The name of the task within the workflow and it must be unique among all WorkflowTasks within a workflow definition. This name serves as the internal unique identifier for the task and is used to pick input and output parameters to feed into other tasks.
- 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.
- additional
Properties String - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.DecisionTask workflow.FailureEndTask workflow.ForkTask workflow.JoinTask workflow.LoopTask workflow.SerialLoopTask workflow.StartTask workflow.SubWorkflowTask workflow.SuccessEndTask workflow.WaitTask workflow.WorkerTask - class
Id String - description String
- The description of this task instance in the workflow.
- label String
- A user defined label identifier of the workflow task used for UI display.
- name String
- The name of the task within the workflow and it must be unique among all WorkflowTasks within a workflow definition. This name serves as the internal unique identifier for the task and is used to pick input and output parameters to feed into other tasks.
- object
Type 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.
WorkflowWorkflowDefinitionUiInputFilter, WorkflowWorkflowDefinitionUiInputFilterArgs
- Additional
Properties string - Class
Id string - Filters List<string>
- (Array of schema.TypeString) -
- Name string
- Name for the input definition to which this filter applies. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character. When defining the cascade filter for a sub property, use a period (.) to separate each section of the name like \ StorageConfig.Volume\ where 'StorageConfig' is an input name and 'Volume' is a sub property defined through custom data type definition.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- User
Help stringMessage - Help message shown to the user about which prior input needs to be selected to enable the input mapped to this filter.
- Additional
Properties string - Class
Id string - Filters []string
- (Array of schema.TypeString) -
- Name string
- Name for the input definition to which this filter applies. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character. When defining the cascade filter for a sub property, use a period (.) to separate each section of the name like \ StorageConfig.Volume\ where 'StorageConfig' is an input name and 'Volume' is a sub property defined through custom data type definition.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- User
Help stringMessage - Help message shown to the user about which prior input needs to be selected to enable the input mapped to this filter.
- additional
Properties String - class
Id String - filters List<String>
- (Array of schema.TypeString) -
- name String
- Name for the input definition to which this filter applies. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character. When defining the cascade filter for a sub property, use a period (.) to separate each section of the name like \ StorageConfig.Volume\ where 'StorageConfig' is an input name and 'Volume' is a sub property defined through custom data type definition.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- user
Help StringMessage - Help message shown to the user about which prior input needs to be selected to enable the input mapped to this filter.
- additional
Properties string - class
Id string - filters string[]
- (Array of schema.TypeString) -
- name string
- Name for the input definition to which this filter applies. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character. When defining the cascade filter for a sub property, use a period (.) to separate each section of the name like \ StorageConfig.Volume\ where 'StorageConfig' is an input name and 'Volume' is a sub property defined through custom data type definition.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- user
Help stringMessage - Help message shown to the user about which prior input needs to be selected to enable the input mapped to this filter.
- additional_
properties str - class_
id str - filters Sequence[str]
- (Array of schema.TypeString) -
- name str
- Name for the input definition to which this filter applies. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character. When defining the cascade filter for a sub property, use a period (.) to separate each section of the name like \ StorageConfig.Volume\ where 'StorageConfig' is an input name and 'Volume' is a sub property defined through custom data type definition.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- user_
help_ strmessage - Help message shown to the user about which prior input needs to be selected to enable the input mapped to this filter.
- additional
Properties String - class
Id String - filters List<String>
- (Array of schema.TypeString) -
- name String
- Name for the input definition to which this filter applies. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character. When defining the cascade filter for a sub property, use a period (.) to separate each section of the name like \ StorageConfig.Volume\ where 'StorageConfig' is an input name and 'Volume' is a sub property defined through custom data type definition.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- user
Help StringMessage - Help message shown to the user about which prior input needs to be selected to enable the input mapped to this filter.
WorkflowWorkflowDefinitionValidationInformation, WorkflowWorkflowDefinitionValidationInformationArgs
- Additional
Properties string - Class
Id string - Engine
State string - (ReadOnly) The state of workflow definition metadata in the workflow engine. The workflow definition must be successfully updated in the engine before workflows can be executed.*
NotUpdated- The workflow and task definition metadata is not yet updated in the workflow engine.*Updating- The workflow and task definition metadata is in the processing of being updated in the workflow engine.*UpdateFailed- The workflow and task definition metadata failed to be updated in the workflow engine.*Updated- The workflow and task definition metadata was updated successfully in the workflow engine. - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- State string
- (ReadOnly) The current validation state of this workflow. The possible states are Valid, Invalid, NotValidated (default).*
NotValidated- The state when workflow definition has not been validated.*Valid- The state when workflow definition is valid.*Invalid- The state when workflow definition is invalid. - Validation
Errors List<WorkflowWorkflow Definition Validation Information Validation Error> - This complex property has following sub-properties:
- Additional
Properties string - Class
Id string - Engine
State string - (ReadOnly) The state of workflow definition metadata in the workflow engine. The workflow definition must be successfully updated in the engine before workflows can be executed.*
NotUpdated- The workflow and task definition metadata is not yet updated in the workflow engine.*Updating- The workflow and task definition metadata is in the processing of being updated in the workflow engine.*UpdateFailed- The workflow and task definition metadata failed to be updated in the workflow engine.*Updated- The workflow and task definition metadata was updated successfully in the workflow engine. - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- State string
- (ReadOnly) The current validation state of this workflow. The possible states are Valid, Invalid, NotValidated (default).*
NotValidated- The state when workflow definition has not been validated.*Valid- The state when workflow definition is valid.*Invalid- The state when workflow definition is invalid. - Validation
Errors []WorkflowWorkflow Definition Validation Information Validation Error - This complex property has following sub-properties:
- additional
Properties String - class
Id String - engine
State String - (ReadOnly) The state of workflow definition metadata in the workflow engine. The workflow definition must be successfully updated in the engine before workflows can be executed.*
NotUpdated- The workflow and task definition metadata is not yet updated in the workflow engine.*Updating- The workflow and task definition metadata is in the processing of being updated in the workflow engine.*UpdateFailed- The workflow and task definition metadata failed to be updated in the workflow engine.*Updated- The workflow and task definition metadata was updated successfully in the workflow engine. - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- state String
- (ReadOnly) The current validation state of this workflow. The possible states are Valid, Invalid, NotValidated (default).*
NotValidated- The state when workflow definition has not been validated.*Valid- The state when workflow definition is valid.*Invalid- The state when workflow definition is invalid. - validation
Errors List<WorkflowWorkflow Definition Validation Information Validation Error> - This complex property has following sub-properties:
- additional
Properties string - class
Id string - engine
State string - (ReadOnly) The state of workflow definition metadata in the workflow engine. The workflow definition must be successfully updated in the engine before workflows can be executed.*
NotUpdated- The workflow and task definition metadata is not yet updated in the workflow engine.*Updating- The workflow and task definition metadata is in the processing of being updated in the workflow engine.*UpdateFailed- The workflow and task definition metadata failed to be updated in the workflow engine.*Updated- The workflow and task definition metadata was updated successfully in the workflow engine. - object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- state string
- (ReadOnly) The current validation state of this workflow. The possible states are Valid, Invalid, NotValidated (default).*
NotValidated- The state when workflow definition has not been validated.*Valid- The state when workflow definition is valid.*Invalid- The state when workflow definition is invalid. - validation
Errors WorkflowWorkflow Definition Validation Information Validation Error[] - This complex property has following sub-properties:
- additional_
properties str - class_
id str - engine_
state str - (ReadOnly) The state of workflow definition metadata in the workflow engine. The workflow definition must be successfully updated in the engine before workflows can be executed.*
NotUpdated- The workflow and task definition metadata is not yet updated in the workflow engine.*Updating- The workflow and task definition metadata is in the processing of being updated in the workflow engine.*UpdateFailed- The workflow and task definition metadata failed to be updated in the workflow engine.*Updated- The workflow and task definition metadata was updated successfully in the workflow engine. - object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- state str
- (ReadOnly) The current validation state of this workflow. The possible states are Valid, Invalid, NotValidated (default).*
NotValidated- The state when workflow definition has not been validated.*Valid- The state when workflow definition is valid.*Invalid- The state when workflow definition is invalid. - validation_
errors Sequence[WorkflowWorkflow Definition Validation Information Validation Error] - This complex property has following sub-properties:
- additional
Properties String - class
Id String - engine
State String - (ReadOnly) The state of workflow definition metadata in the workflow engine. The workflow definition must be successfully updated in the engine before workflows can be executed.*
NotUpdated- The workflow and task definition metadata is not yet updated in the workflow engine.*Updating- The workflow and task definition metadata is in the processing of being updated in the workflow engine.*UpdateFailed- The workflow and task definition metadata failed to be updated in the workflow engine.*Updated- The workflow and task definition metadata was updated successfully in the workflow engine. - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- state String
- (ReadOnly) The current validation state of this workflow. The possible states are Valid, Invalid, NotValidated (default).*
NotValidated- The state when workflow definition has not been validated.*Valid- The state when workflow definition is valid.*Invalid- The state when workflow definition is invalid. - validation
Errors List<Property Map> - This complex property has following sub-properties:
WorkflowWorkflowDefinitionValidationInformationValidationError, WorkflowWorkflowDefinitionValidationInformationValidationErrorArgs
- Additional
Properties string - Class
Id string - Error
Log string - (ReadOnly) Description of the error.
- Field string
- (ReadOnly) When populated this refers to the input or output field within the workflow or task.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Task
Name string - (ReadOnly) The task name on which the error is found, when empty the error applies to the top level workflow.
- Transition
Name string - (ReadOnly) When populated this refers to the transition connection that has a problem. When this field has value OnSuccess it means the transition connection OnSuccess for the task has an issue.
- Additional
Properties string - Class
Id string - Error
Log string - (ReadOnly) Description of the error.
- Field string
- (ReadOnly) When populated this refers to the input or output field within the workflow or task.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Task
Name string - (ReadOnly) The task name on which the error is found, when empty the error applies to the top level workflow.
- Transition
Name string - (ReadOnly) When populated this refers to the transition connection that has a problem. When this field has value OnSuccess it means the transition connection OnSuccess for the task has an issue.
- additional
Properties String - class
Id String - error
Log String - (ReadOnly) Description of the error.
- field String
- (ReadOnly) When populated this refers to the input or output field within the workflow or task.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- task
Name String - (ReadOnly) The task name on which the error is found, when empty the error applies to the top level workflow.
- transition
Name String - (ReadOnly) When populated this refers to the transition connection that has a problem. When this field has value OnSuccess it means the transition connection OnSuccess for the task has an issue.
- additional
Properties string - class
Id string - error
Log string - (ReadOnly) Description of the error.
- field string
- (ReadOnly) When populated this refers to the input or output field within the workflow or task.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- task
Name string - (ReadOnly) The task name on which the error is found, when empty the error applies to the top level workflow.
- transition
Name string - (ReadOnly) When populated this refers to the transition connection that has a problem. When this field has value OnSuccess it means the transition connection OnSuccess for the task has an issue.
- additional_
properties str - class_
id str - error_
log str - (ReadOnly) Description of the error.
- field str
- (ReadOnly) When populated this refers to the input or output field within the workflow or task.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- task_
name str - (ReadOnly) The task name on which the error is found, when empty the error applies to the top level workflow.
- transition_
name str - (ReadOnly) When populated this refers to the transition connection that has a problem. When this field has value OnSuccess it means the transition connection OnSuccess for the task has an issue.
- additional
Properties String - class
Id String - error
Log String - (ReadOnly) Description of the error.
- field String
- (ReadOnly) When populated this refers to the input or output field within the workflow or task.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- task
Name String - (ReadOnly) The task name on which the error is found, when empty the error applies to the top level workflow.
- transition
Name String - (ReadOnly) When populated this refers to the transition connection that has a problem. When this field has value OnSuccess it means the transition connection OnSuccess for the task has an issue.
WorkflowWorkflowDefinitionVariableDefinition, WorkflowWorkflowDefinitionVariableDefinitionArgs
- Additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - Class
Id string - Defaults
List<Workflow
Workflow Definition Variable Definition Default> - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- Description string
- Provide a detailed description of the data type.
- Display
Metas List<WorkflowWorkflow Definition Variable Definition Display Meta> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- Input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- Label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- Name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- Object
Type 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.
- Required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- Additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - Class
Id string - Defaults
[]Workflow
Workflow Definition Variable Definition Default - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- Description string
- Provide a detailed description of the data type.
- Display
Metas []WorkflowWorkflow Definition Variable Definition Display Meta - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- Input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- Label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- Name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- Object
Type 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.
- Required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties String - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id String - defaults
List<Workflow
Workflow Definition Variable Definition Default> - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description String
- Provide a detailed description of the data type.
- display
Metas List<WorkflowWorkflow Definition Variable Definition Display Meta> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters String - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label String
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name String
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required Boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties string - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id string - defaults
Workflow
Workflow Definition Variable Definition Default[] - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description string
- Provide a detailed description of the data type.
- display
Metas WorkflowWorkflow Definition Variable Definition Display Meta[] - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters string - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label string
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name string
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional_
properties str - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class_
id str - defaults
Sequence[Workflow
Workflow Definition Variable Definition Default] - Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description str
- Provide a detailed description of the data type.
- display_
metas Sequence[WorkflowWorkflow Definition Variable Definition Display Meta] - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input_
parameters str - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label str
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name str
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- 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.
- required bool
- Specifies whether this parameter is required. The field is applicable for task and workflow.
- additional
Properties String - Additional Properties as per object type, can be added as JSON using
jsonencode(). Allowed Types are: workflow.ArrayDataType workflow.CustomDataType workflow.DynamicTemplateParserDataType workflow.MoInventoryDataType workflow.MoReferenceAutoDataType workflow.MoReferenceDataType workflow.PrimitiveDataType workflow.TargetDataType - class
Id String - defaults List<Property Map>
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input. This complex property has following sub-properties:
- description String
- Provide a detailed description of the data type.
- display
Metas List<Property Map> - Captures the meta data needed for displaying workflow data types in Intersight User Interface. This complex property has following sub-properties:
- input
Parameters String - JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.
- label String
- Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.
- name String
- Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.
- object
Type 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.
- required Boolean
- Specifies whether this parameter is required. The field is applicable for task and workflow.
WorkflowWorkflowDefinitionVariableDefinitionDefault, WorkflowWorkflowDefinitionVariableDefinitionDefaultArgs
- Additional
Properties string - Class
Id string - Is
Value boolSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- Value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- Additional
Properties string - Class
Id string - Is
Value boolSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- Value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties String - class
Id String - is
Value BooleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override Boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value String
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties string - class
Id string - is
Value booleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value string
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional_
properties str - class_
id str - is_
value_ boolset - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override bool
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value str
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
- additional
Properties String - class
Id String - is
Value BooleanSet - (ReadOnly) A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- override Boolean
- Override the default value provided for the data type. When true, allow the user to enter value for the data type.
- value String
- Default value for the data type. If default value was provided and the input was required the default value will be used as the input.
WorkflowWorkflowDefinitionVariableDefinitionDisplayMeta, WorkflowWorkflowDefinitionVariableDefinitionDisplayMetaArgs
- Additional
Properties string - Class
Id string - Inventory
Selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- Additional
Properties string - Class
Id string - Inventory
Selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties String - class
Id String - inventory
Selector Boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type String - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties string - class
Id string - inventory
Selector boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type string - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional_
properties str - class_
id str - inventory_
selector bool - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget_
type str - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
- additional
Properties String - class
Id String - inventory
Selector Boolean - Inventory selector specified for primitive data property should be used in Intersight User Interface.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- widget
Type String - Specify the widget type for data display.*
None- Display none of the widget types.*Radio- Display the widget as a radio button.*Dropdown- Display the widget as a dropdown.*GridSelector- Display the widget as a selector.*DrawerSelector- Display the widget as a selector.
WorkflowWorkflowDefinitionVersionContext, WorkflowWorkflowDefinitionVersionContextArgs
- Additional
Properties string - Class
Id string - Interested
Mos List<WorkflowWorkflow Definition Version Context Interested Mo> - This complex property has following sub-properties:
- Marked
For boolDeletion - (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 string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Ref
Mos List<WorkflowWorkflow Definition Version Context Ref Mo> - (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.
- Version
Type 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 string - Class
Id string - Interested
Mos []WorkflowWorkflow Definition Version Context Interested Mo - This complex property has following sub-properties:
- Marked
For boolDeletion - (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 string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Ref
Mos []WorkflowWorkflow Definition Version Context Ref Mo - (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.
- Version
Type 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 String - class
Id String - interested
Mos List<WorkflowWorkflow Definition Version Context Interested Mo> - This complex property has following sub-properties:
- marked
For BooleanDeletion - (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 String - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos List<WorkflowWorkflow Definition Version Context Ref Mo> - (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.
- version
Type 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 string - class
Id string - interested
Mos WorkflowWorkflow Definition Version Context Interested Mo[] - This complex property has following sub-properties:
- marked
For booleanDeletion - (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 string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos WorkflowWorkflow Definition Version Context Ref Mo[] - (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.
- version
Type 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[WorkflowWorkflow Definition Version Context Interested Mo] - This complex property has following sub-properties:
- marked_
for_ booldeletion - (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[WorkflowWorkflow Definition Version Context Ref Mo] - (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.
- additional
Properties String - class
Id String - interested
Mos List<Property Map> - This complex property has following sub-properties:
- marked
For BooleanDeletion - (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 String - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos 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.
- version
Type 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.
WorkflowWorkflowDefinitionVersionContextInterestedMo, WorkflowWorkflowDefinitionVersionContextInterestedMoArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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'.
WorkflowWorkflowDefinitionVersionContextRefMo, WorkflowWorkflowDefinitionVersionContextRefMoArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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'.
WorkflowWorkflowDefinitionWorkflowMetadata, WorkflowWorkflowDefinitionWorkflowMetadataArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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_workflow_definition can be imported using the Moid of the object, e.g.
$ pulumi import intersight:index/workflowWorkflowDefinition:WorkflowWorkflowDefinition 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
intersightTerraform Provider.
intersight 1.0.64 published on Wednesday, Apr 30, 2025 by ciscodevnet