intersight.getWorkflowWorkflowInfo
Explore with Pulumi AI
Contains information for a workflow which is an execution instance of the workflow definition given in the relationship. The workflow definition will provide the schema of the inputs taken to start the workflow execution and the schema of the outputs generated at the end of successful workflow execution. The sequence of tasks to be executed is also provided in the workflow definition. For a workflow to successfully start execution the following properties must be provided- Name, AssociatedObject that carries the relationship to Organization under which the workflow must be executed, WorkflowDefinition, and Inputs with all the required data in order to start workflow execution.
Using getWorkflowWorkflowInfo
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getWorkflowWorkflowInfo(args: GetWorkflowWorkflowInfoArgs, opts?: InvokeOptions): Promise<GetWorkflowWorkflowInfoResult>
function getWorkflowWorkflowInfoOutput(args: GetWorkflowWorkflowInfoOutputArgs, opts?: InvokeOptions): Output<GetWorkflowWorkflowInfoResult>def get_workflow_workflow_info(account: Optional[GetWorkflowWorkflowInfoAccount] = None,
                               account_moid: Optional[str] = None,
                               action: Optional[str] = None,
                               additional_properties: Optional[str] = None,
                               ancestors: Optional[Sequence[GetWorkflowWorkflowInfoAncestor]] = None,
                               associated_object: Optional[GetWorkflowWorkflowInfoAssociatedObject] = None,
                               class_id: Optional[str] = None,
                               cleanup_time: Optional[str] = None,
                               create_time: Optional[str] = None,
                               domain_group_moid: Optional[str] = None,
                               email: Optional[str] = None,
                               end_time: Optional[str] = None,
                               failed_workflow_cleanup_duration: Optional[float] = None,
                               id: Optional[str] = None,
                               input: Optional[str] = None,
                               inst_id: Optional[str] = None,
                               internal: Optional[bool] = None,
                               last_action: Optional[str] = None,
                               messages: Optional[Sequence[GetWorkflowWorkflowInfoMessage]] = None,
                               mod_time: Optional[str] = None,
                               moid: Optional[str] = None,
                               name: Optional[str] = None,
                               object_type: Optional[str] = None,
                               organization: Optional[GetWorkflowWorkflowInfoOrganization] = None,
                               output: Optional[str] = None,
                               owners: Optional[Sequence[str]] = None,
                               parent: Optional[GetWorkflowWorkflowInfoParent] = None,
                               parent_task_info: Optional[GetWorkflowWorkflowInfoParentTaskInfo] = None,
                               pause_reason: Optional[str] = None,
                               permission: Optional[GetWorkflowWorkflowInfoPermission] = None,
                               permission_resources: Optional[Sequence[GetWorkflowWorkflowInfoPermissionResource]] = None,
                               progress: Optional[float] = None,
                               properties: Optional[GetWorkflowWorkflowInfoProperties] = None,
                               retry_from_task_name: Optional[str] = None,
                               shared_scope: Optional[str] = None,
                               src: Optional[str] = None,
                               start_time: Optional[str] = None,
                               status: Optional[str] = None,
                               success_workflow_cleanup_duration: Optional[float] = None,
                               tags: Optional[Sequence[GetWorkflowWorkflowInfoTag]] = None,
                               task_info_update: Optional[GetWorkflowWorkflowInfoTaskInfoUpdate] = None,
                               task_infos: Optional[Sequence[GetWorkflowWorkflowInfoTaskInfo]] = None,
                               trace_id: Optional[str] = None,
                               type: Optional[str] = None,
                               user_action_required: Optional[bool] = None,
                               user_id: Optional[str] = None,
                               variable: Optional[str] = None,
                               version_context: Optional[GetWorkflowWorkflowInfoVersionContext] = None,
                               wait_reason: Optional[str] = None,
                               workflow_ctx: Optional[GetWorkflowWorkflowInfoWorkflowCtx] = None,
                               workflow_definition: Optional[GetWorkflowWorkflowInfoWorkflowDefinition] = None,
                               workflow_status: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetWorkflowWorkflowInfoResult
def get_workflow_workflow_info_output(account: Optional[pulumi.Input[GetWorkflowWorkflowInfoAccountArgs]] = None,
                               account_moid: Optional[pulumi.Input[str]] = None,
                               action: Optional[pulumi.Input[str]] = None,
                               additional_properties: Optional[pulumi.Input[str]] = None,
                               ancestors: Optional[pulumi.Input[Sequence[pulumi.Input[GetWorkflowWorkflowInfoAncestorArgs]]]] = None,
                               associated_object: Optional[pulumi.Input[GetWorkflowWorkflowInfoAssociatedObjectArgs]] = None,
                               class_id: Optional[pulumi.Input[str]] = None,
                               cleanup_time: Optional[pulumi.Input[str]] = None,
                               create_time: Optional[pulumi.Input[str]] = None,
                               domain_group_moid: Optional[pulumi.Input[str]] = None,
                               email: Optional[pulumi.Input[str]] = None,
                               end_time: Optional[pulumi.Input[str]] = None,
                               failed_workflow_cleanup_duration: Optional[pulumi.Input[float]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               input: Optional[pulumi.Input[str]] = None,
                               inst_id: Optional[pulumi.Input[str]] = None,
                               internal: Optional[pulumi.Input[bool]] = None,
                               last_action: Optional[pulumi.Input[str]] = None,
                               messages: Optional[pulumi.Input[Sequence[pulumi.Input[GetWorkflowWorkflowInfoMessageArgs]]]] = None,
                               mod_time: Optional[pulumi.Input[str]] = None,
                               moid: Optional[pulumi.Input[str]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               object_type: Optional[pulumi.Input[str]] = None,
                               organization: Optional[pulumi.Input[GetWorkflowWorkflowInfoOrganizationArgs]] = None,
                               output: Optional[pulumi.Input[str]] = None,
                               owners: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               parent: Optional[pulumi.Input[GetWorkflowWorkflowInfoParentArgs]] = None,
                               parent_task_info: Optional[pulumi.Input[GetWorkflowWorkflowInfoParentTaskInfoArgs]] = None,
                               pause_reason: Optional[pulumi.Input[str]] = None,
                               permission: Optional[pulumi.Input[GetWorkflowWorkflowInfoPermissionArgs]] = None,
                               permission_resources: Optional[pulumi.Input[Sequence[pulumi.Input[GetWorkflowWorkflowInfoPermissionResourceArgs]]]] = None,
                               progress: Optional[pulumi.Input[float]] = None,
                               properties: Optional[pulumi.Input[GetWorkflowWorkflowInfoPropertiesArgs]] = None,
                               retry_from_task_name: Optional[pulumi.Input[str]] = None,
                               shared_scope: Optional[pulumi.Input[str]] = None,
                               src: Optional[pulumi.Input[str]] = None,
                               start_time: Optional[pulumi.Input[str]] = None,
                               status: Optional[pulumi.Input[str]] = None,
                               success_workflow_cleanup_duration: Optional[pulumi.Input[float]] = None,
                               tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetWorkflowWorkflowInfoTagArgs]]]] = None,
                               task_info_update: Optional[pulumi.Input[GetWorkflowWorkflowInfoTaskInfoUpdateArgs]] = None,
                               task_infos: Optional[pulumi.Input[Sequence[pulumi.Input[GetWorkflowWorkflowInfoTaskInfoArgs]]]] = None,
                               trace_id: Optional[pulumi.Input[str]] = None,
                               type: Optional[pulumi.Input[str]] = None,
                               user_action_required: Optional[pulumi.Input[bool]] = None,
                               user_id: Optional[pulumi.Input[str]] = None,
                               variable: Optional[pulumi.Input[str]] = None,
                               version_context: Optional[pulumi.Input[GetWorkflowWorkflowInfoVersionContextArgs]] = None,
                               wait_reason: Optional[pulumi.Input[str]] = None,
                               workflow_ctx: Optional[pulumi.Input[GetWorkflowWorkflowInfoWorkflowCtxArgs]] = None,
                               workflow_definition: Optional[pulumi.Input[GetWorkflowWorkflowInfoWorkflowDefinitionArgs]] = None,
                               workflow_status: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetWorkflowWorkflowInfoResult]func LookupWorkflowWorkflowInfo(ctx *Context, args *LookupWorkflowWorkflowInfoArgs, opts ...InvokeOption) (*LookupWorkflowWorkflowInfoResult, error)
func LookupWorkflowWorkflowInfoOutput(ctx *Context, args *LookupWorkflowWorkflowInfoOutputArgs, opts ...InvokeOption) LookupWorkflowWorkflowInfoResultOutput> Note: This function is named LookupWorkflowWorkflowInfo in the Go SDK.
public static class GetWorkflowWorkflowInfo 
{
    public static Task<GetWorkflowWorkflowInfoResult> InvokeAsync(GetWorkflowWorkflowInfoArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkflowWorkflowInfoResult> Invoke(GetWorkflowWorkflowInfoInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetWorkflowWorkflowInfoResult> getWorkflowWorkflowInfo(GetWorkflowWorkflowInfoArgs args, InvokeOptions options)
public static Output<GetWorkflowWorkflowInfoResult> getWorkflowWorkflowInfo(GetWorkflowWorkflowInfoArgs args, InvokeOptions options)
fn::invoke:
  function: intersight:index/getWorkflowWorkflowInfo:getWorkflowWorkflowInfo
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Account
GetWorkflow Workflow Info Account 
- AccountMoid string
- The Account ID for this managed object.
- Action string
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- AdditionalProperties string
- Ancestors
List<GetWorkflow Workflow Info Ancestor> 
- AssociatedObject GetWorkflow Workflow Info Associated Object 
- ClassId string
- CleanupTime string
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- CreateTime string
- The time when this managed object was created.
- DomainGroup stringMoid 
- The DomainGroup ID for this managed object.
- Email string
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- EndTime string
- The time when the workflow reached a final state.
- FailedWorkflow doubleCleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Id string
- Input string
- InstId string
- A workflow instance Id which is the unique identified for the workflow execution.
- Internal bool
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- LastAction string
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- Messages
List<GetWorkflow Workflow Info Message> 
- ModTime string
- The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- A name of the workflow execution instance.
- ObjectType string
- Organization
GetWorkflow Workflow Info Organization 
- Output string
- Owners List<string>
- Parent
GetWorkflow Workflow Info Parent 
- ParentTask GetInfo Workflow Workflow Info Parent Task Info 
- PauseReason string
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- Permission
GetWorkflow Workflow Info Permission 
- PermissionResources List<GetWorkflow Workflow Info Permission Resource> 
- Progress double
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- Properties
GetWorkflow Workflow Info Properties 
- RetryFrom stringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- 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.
- Src string
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- StartTime string
- The time when the workflow was started for execution.
- Status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- SuccessWorkflow doubleCleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
List<GetWorkflow Workflow Info Tag> 
- TaskInfo GetUpdate Workflow Workflow Info Task Info Update 
- TaskInfos List<GetWorkflow Workflow Info Task Info> 
- TraceId string
- The trace id to keep track of workflow execution.
- Type string
- A type of the workflow (serverconfig, ansible_monitoring).
- UserAction boolRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- UserId string
- The user identifier which indicates the user that started this workflow.
- Variable string
- VersionContext GetWorkflow Workflow Info Version Context 
- WaitReason string
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- WorkflowCtx GetWorkflow Workflow Info Workflow Ctx 
- WorkflowDefinition GetWorkflow Workflow Info Workflow Definition 
- WorkflowStatus string
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- Account
GetWorkflow Workflow Info Account 
- AccountMoid string
- The Account ID for this managed object.
- Action string
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- AdditionalProperties string
- Ancestors
[]GetWorkflow Workflow Info Ancestor 
- AssociatedObject GetWorkflow Workflow Info Associated Object 
- ClassId string
- CleanupTime string
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- CreateTime string
- The time when this managed object was created.
- DomainGroup stringMoid 
- The DomainGroup ID for this managed object.
- Email string
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- EndTime string
- The time when the workflow reached a final state.
- FailedWorkflow float64Cleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Id string
- Input string
- InstId string
- A workflow instance Id which is the unique identified for the workflow execution.
- Internal bool
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- LastAction string
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- Messages
[]GetWorkflow Workflow Info Message 
- ModTime string
- The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- A name of the workflow execution instance.
- ObjectType string
- Organization
GetWorkflow Workflow Info Organization 
- Output string
- Owners []string
- Parent
GetWorkflow Workflow Info Parent 
- ParentTask GetInfo Workflow Workflow Info Parent Task Info 
- PauseReason string
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- Permission
GetWorkflow Workflow Info Permission 
- PermissionResources []GetWorkflow Workflow Info Permission Resource 
- Progress float64
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- Properties
GetWorkflow Workflow Info Properties 
- RetryFrom stringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- 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.
- Src string
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- StartTime string
- The time when the workflow was started for execution.
- Status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- SuccessWorkflow float64Cleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
[]GetWorkflow Workflow Info Tag 
- TaskInfo GetUpdate Workflow Workflow Info Task Info Update 
- TaskInfos []GetWorkflow Workflow Info Task Info 
- TraceId string
- The trace id to keep track of workflow execution.
- Type string
- A type of the workflow (serverconfig, ansible_monitoring).
- UserAction boolRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- UserId string
- The user identifier which indicates the user that started this workflow.
- Variable string
- VersionContext GetWorkflow Workflow Info Version Context 
- WaitReason string
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- WorkflowCtx GetWorkflow Workflow Info Workflow Ctx 
- WorkflowDefinition GetWorkflow Workflow Info Workflow Definition 
- WorkflowStatus string
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- account
GetWorkflow Workflow Info Account 
- accountMoid String
- The Account ID for this managed object.
- action String
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- additionalProperties String
- ancestors
List<GetWorkflow Workflow Info Ancestor> 
- associatedObject GetWorkflow Workflow Info Associated Object 
- classId String
- cleanupTime String
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- createTime String
- The time when this managed object was created.
- domainGroup StringMoid 
- The DomainGroup ID for this managed object.
- email String
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- endTime String
- The time when the workflow reached a final state.
- failedWorkflow DoubleCleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- id String
- input String
- instId String
- A workflow instance Id which is the unique identified for the workflow execution.
- internal Boolean
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- lastAction String
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- messages
List<GetWorkflow Workflow Info Message> 
- modTime String
- The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- A name of the workflow execution instance.
- objectType String
- organization
GetWorkflow Workflow Info Organization 
- output String
- owners List<String>
- parent
GetWorkflow Workflow Info Parent 
- parentTask GetInfo Workflow Workflow Info Parent Task Info 
- pauseReason String
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- permission
GetWorkflow Workflow Info Permission 
- permissionResources List<GetWorkflow Workflow Info Permission Resource> 
- progress Double
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
GetWorkflow Workflow Info Properties 
- retryFrom StringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- String
- 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.
- src String
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- startTime String
- The time when the workflow was started for execution.
- status String
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- successWorkflow DoubleCleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
List<GetWorkflow Workflow Info Tag> 
- taskInfo GetUpdate Workflow Workflow Info Task Info Update 
- taskInfos List<GetWorkflow Workflow Info Task Info> 
- traceId String
- The trace id to keep track of workflow execution.
- type String
- A type of the workflow (serverconfig, ansible_monitoring).
- userAction BooleanRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- userId String
- The user identifier which indicates the user that started this workflow.
- variable String
- versionContext GetWorkflow Workflow Info Version Context 
- waitReason String
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- workflowCtx GetWorkflow Workflow Info Workflow Ctx 
- workflowDefinition GetWorkflow Workflow Info Workflow Definition 
- workflowStatus String
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- account
GetWorkflow Workflow Info Account 
- accountMoid string
- The Account ID for this managed object.
- action string
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- additionalProperties string
- ancestors
GetWorkflow Workflow Info Ancestor[] 
- associatedObject GetWorkflow Workflow Info Associated Object 
- classId string
- cleanupTime string
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- createTime string
- The time when this managed object was created.
- domainGroup stringMoid 
- The DomainGroup ID for this managed object.
- email string
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- endTime string
- The time when the workflow reached a final state.
- failedWorkflow numberCleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- id string
- input string
- instId string
- A workflow instance Id which is the unique identified for the workflow execution.
- internal boolean
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- lastAction string
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- messages
GetWorkflow Workflow Info Message[] 
- modTime string
- The time when this managed object was last modified.
- moid string
- The unique identifier of this Managed Object instance.
- name string
- A name of the workflow execution instance.
- objectType string
- organization
GetWorkflow Workflow Info Organization 
- output string
- owners string[]
- parent
GetWorkflow Workflow Info Parent 
- parentTask GetInfo Workflow Workflow Info Parent Task Info 
- pauseReason string
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- permission
GetWorkflow Workflow Info Permission 
- permissionResources GetWorkflow Workflow Info Permission Resource[] 
- progress number
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
GetWorkflow Workflow Info Properties 
- retryFrom stringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- 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.
- src string
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- startTime string
- The time when the workflow was started for execution.
- status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- successWorkflow numberCleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
GetWorkflow Workflow Info Tag[] 
- taskInfo GetUpdate Workflow Workflow Info Task Info Update 
- taskInfos GetWorkflow Workflow Info Task Info[] 
- traceId string
- The trace id to keep track of workflow execution.
- type string
- A type of the workflow (serverconfig, ansible_monitoring).
- userAction booleanRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- userId string
- The user identifier which indicates the user that started this workflow.
- variable string
- versionContext GetWorkflow Workflow Info Version Context 
- waitReason string
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- workflowCtx GetWorkflow Workflow Info Workflow Ctx 
- workflowDefinition GetWorkflow Workflow Info Workflow Definition 
- workflowStatus string
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- account
GetWorkflow Workflow Info Account 
- account_moid str
- The Account ID for this managed object.
- action str
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- additional_properties str
- ancestors
Sequence[GetWorkflow Workflow Info Ancestor] 
- associated_object GetWorkflow Workflow Info Associated Object 
- class_id str
- cleanup_time str
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- create_time str
- The time when this managed object was created.
- domain_group_ strmoid 
- The DomainGroup ID for this managed object.
- email str
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- end_time str
- The time when the workflow reached a final state.
- failed_workflow_ floatcleanup_ duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- id str
- input str
- inst_id str
- A workflow instance Id which is the unique identified for the workflow execution.
- internal bool
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- last_action str
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- messages
Sequence[GetWorkflow Workflow Info Message] 
- mod_time str
- The time when this managed object was last modified.
- moid str
- The unique identifier of this Managed Object instance.
- name str
- A name of the workflow execution instance.
- object_type str
- organization
GetWorkflow Workflow Info Organization 
- output str
- owners Sequence[str]
- parent
GetWorkflow Workflow Info Parent 
- parent_task_ Getinfo Workflow Workflow Info Parent Task Info 
- pause_reason str
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- permission
GetWorkflow Workflow Info Permission 
- permission_resources Sequence[GetWorkflow Workflow Info Permission Resource] 
- progress float
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
GetWorkflow Workflow Info Properties 
- retry_from_ strtask_ name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- str
- 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.
- src str
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- start_time str
- The time when the workflow was started for execution.
- status str
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success_workflow_ floatcleanup_ duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
Sequence[GetWorkflow Workflow Info Tag] 
- task_info_ Getupdate Workflow Workflow Info Task Info Update 
- task_infos Sequence[GetWorkflow Workflow Info Task Info] 
- trace_id str
- The trace id to keep track of workflow execution.
- type str
- A type of the workflow (serverconfig, ansible_monitoring).
- user_action_ boolrequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- user_id str
- The user identifier which indicates the user that started this workflow.
- variable str
- version_context GetWorkflow Workflow Info Version Context 
- wait_reason str
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- workflow_ctx GetWorkflow Workflow Info Workflow Ctx 
- workflow_definition GetWorkflow Workflow Info Workflow Definition 
- workflow_status str
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- account Property Map
- accountMoid String
- The Account ID for this managed object.
- action String
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- additionalProperties String
- ancestors List<Property Map>
- associatedObject Property Map
- classId String
- cleanupTime String
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- createTime String
- The time when this managed object was created.
- domainGroup StringMoid 
- The DomainGroup ID for this managed object.
- email String
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- endTime String
- The time when the workflow reached a final state.
- failedWorkflow NumberCleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- id String
- input String
- instId String
- A workflow instance Id which is the unique identified for the workflow execution.
- internal Boolean
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- lastAction String
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- messages List<Property Map>
- modTime String
- The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- A name of the workflow execution instance.
- objectType String
- organization Property Map
- output String
- owners List<String>
- parent Property Map
- parentTask Property MapInfo 
- pauseReason String
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- permission Property Map
- permissionResources List<Property Map>
- progress Number
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties Property Map
- retryFrom StringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- String
- 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.
- src String
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- startTime String
- The time when the workflow was started for execution.
- status String
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- successWorkflow NumberCleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- List<Property Map>
- taskInfo Property MapUpdate 
- taskInfos List<Property Map>
- traceId String
- The trace id to keep track of workflow execution.
- type String
- A type of the workflow (serverconfig, ansible_monitoring).
- userAction BooleanRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- userId String
- The user identifier which indicates the user that started this workflow.
- variable String
- versionContext Property Map
- waitReason String
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- workflowCtx Property Map
- workflowDefinition Property Map
- workflowStatus String
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
getWorkflowWorkflowInfo Result
The following output properties are available:
- Id string
- Results
List<GetWorkflow Workflow Info Result> 
- Account
GetWorkflow Workflow Info Account 
- AccountMoid string
- Action string
- AdditionalProperties string
- Ancestors
List<GetWorkflow Workflow Info Ancestor> 
- AssociatedObject GetWorkflow Workflow Info Associated Object 
- ClassId string
- CleanupTime string
- CreateTime string
- DomainGroup stringMoid 
- Email string
- EndTime string
- FailedWorkflow doubleCleanup Duration 
- Input string
- InstId string
- Internal bool
- LastAction string
- Messages
List<GetWorkflow Workflow Info Message> 
- ModTime string
- Moid string
- Name string
- ObjectType string
- Organization
GetWorkflow Workflow Info Organization 
- Output string
- Owners List<string>
- Parent
GetWorkflow Workflow Info Parent 
- ParentTask GetInfo Workflow Workflow Info Parent Task Info 
- PauseReason string
- Permission
GetWorkflow Workflow Info Permission 
- PermissionResources List<GetWorkflow Workflow Info Permission Resource> 
- Progress double
- Properties
GetWorkflow Workflow Info Properties 
- RetryFrom stringTask Name 
- string
- Src string
- StartTime string
- Status string
- SuccessWorkflow doubleCleanup Duration 
- 
List<GetWorkflow Workflow Info Tag> 
- TaskInfo GetUpdate Workflow Workflow Info Task Info Update 
- TaskInfos List<GetWorkflow Workflow Info Task Info> 
- TraceId string
- Type string
- UserAction boolRequired 
- UserId string
- Variable string
- VersionContext GetWorkflow Workflow Info Version Context 
- WaitReason string
- WorkflowCtx GetWorkflow Workflow Info Workflow Ctx 
- WorkflowDefinition GetWorkflow Workflow Info Workflow Definition 
- WorkflowStatus string
- Id string
- Results
[]GetWorkflow Workflow Info Result 
- Account
GetWorkflow Workflow Info Account 
- AccountMoid string
- Action string
- AdditionalProperties string
- Ancestors
[]GetWorkflow Workflow Info Ancestor 
- AssociatedObject GetWorkflow Workflow Info Associated Object 
- ClassId string
- CleanupTime string
- CreateTime string
- DomainGroup stringMoid 
- Email string
- EndTime string
- FailedWorkflow float64Cleanup Duration 
- Input string
- InstId string
- Internal bool
- LastAction string
- Messages
[]GetWorkflow Workflow Info Message 
- ModTime string
- Moid string
- Name string
- ObjectType string
- Organization
GetWorkflow Workflow Info Organization 
- Output string
- Owners []string
- Parent
GetWorkflow Workflow Info Parent 
- ParentTask GetInfo Workflow Workflow Info Parent Task Info 
- PauseReason string
- Permission
GetWorkflow Workflow Info Permission 
- PermissionResources []GetWorkflow Workflow Info Permission Resource 
- Progress float64
- Properties
GetWorkflow Workflow Info Properties 
- RetryFrom stringTask Name 
- string
- Src string
- StartTime string
- Status string
- SuccessWorkflow float64Cleanup Duration 
- 
[]GetWorkflow Workflow Info Tag 
- TaskInfo GetUpdate Workflow Workflow Info Task Info Update 
- TaskInfos []GetWorkflow Workflow Info Task Info 
- TraceId string
- Type string
- UserAction boolRequired 
- UserId string
- Variable string
- VersionContext GetWorkflow Workflow Info Version Context 
- WaitReason string
- WorkflowCtx GetWorkflow Workflow Info Workflow Ctx 
- WorkflowDefinition GetWorkflow Workflow Info Workflow Definition 
- WorkflowStatus string
- id String
- results
List<GetWorkflow Workflow Info Result> 
- account
GetWorkflow Workflow Info Account 
- accountMoid String
- action String
- additionalProperties String
- ancestors
List<GetWorkflow Workflow Info Ancestor> 
- associatedObject GetWorkflow Workflow Info Associated Object 
- classId String
- cleanupTime String
- createTime String
- domainGroup StringMoid 
- email String
- endTime String
- failedWorkflow DoubleCleanup Duration 
- input String
- instId String
- internal Boolean
- lastAction String
- messages
List<GetWorkflow Workflow Info Message> 
- modTime String
- moid String
- name String
- objectType String
- organization
GetWorkflow Workflow Info Organization 
- output String
- owners List<String>
- parent
GetWorkflow Workflow Info Parent 
- parentTask GetInfo Workflow Workflow Info Parent Task Info 
- pauseReason String
- permission
GetWorkflow Workflow Info Permission 
- permissionResources List<GetWorkflow Workflow Info Permission Resource> 
- progress Double
- properties
GetWorkflow Workflow Info Properties 
- retryFrom StringTask Name 
- String
- src String
- startTime String
- status String
- successWorkflow DoubleCleanup Duration 
- 
List<GetWorkflow Workflow Info Tag> 
- taskInfo GetUpdate Workflow Workflow Info Task Info Update 
- taskInfos List<GetWorkflow Workflow Info Task Info> 
- traceId String
- type String
- userAction BooleanRequired 
- userId String
- variable String
- versionContext GetWorkflow Workflow Info Version Context 
- waitReason String
- workflowCtx GetWorkflow Workflow Info Workflow Ctx 
- workflowDefinition GetWorkflow Workflow Info Workflow Definition 
- workflowStatus String
- id string
- results
GetWorkflow Workflow Info Result[] 
- account
GetWorkflow Workflow Info Account 
- accountMoid string
- action string
- additionalProperties string
- ancestors
GetWorkflow Workflow Info Ancestor[] 
- associatedObject GetWorkflow Workflow Info Associated Object 
- classId string
- cleanupTime string
- createTime string
- domainGroup stringMoid 
- email string
- endTime string
- failedWorkflow numberCleanup Duration 
- input string
- instId string
- internal boolean
- lastAction string
- messages
GetWorkflow Workflow Info Message[] 
- modTime string
- moid string
- name string
- objectType string
- organization
GetWorkflow Workflow Info Organization 
- output string
- owners string[]
- parent
GetWorkflow Workflow Info Parent 
- parentTask GetInfo Workflow Workflow Info Parent Task Info 
- pauseReason string
- permission
GetWorkflow Workflow Info Permission 
- permissionResources GetWorkflow Workflow Info Permission Resource[] 
- progress number
- properties
GetWorkflow Workflow Info Properties 
- retryFrom stringTask Name 
- string
- src string
- startTime string
- status string
- successWorkflow numberCleanup Duration 
- 
GetWorkflow Workflow Info Tag[] 
- taskInfo GetUpdate Workflow Workflow Info Task Info Update 
- taskInfos GetWorkflow Workflow Info Task Info[] 
- traceId string
- type string
- userAction booleanRequired 
- userId string
- variable string
- versionContext GetWorkflow Workflow Info Version Context 
- waitReason string
- workflowCtx GetWorkflow Workflow Info Workflow Ctx 
- workflowDefinition GetWorkflow Workflow Info Workflow Definition 
- workflowStatus string
- id str
- results
Sequence[GetWorkflow Workflow Info Result] 
- account
GetWorkflow Workflow Info Account 
- account_moid str
- action str
- additional_properties str
- ancestors
Sequence[GetWorkflow Workflow Info Ancestor] 
- associated_object GetWorkflow Workflow Info Associated Object 
- class_id str
- cleanup_time str
- create_time str
- domain_group_ strmoid 
- email str
- end_time str
- failed_workflow_ floatcleanup_ duration 
- input str
- inst_id str
- internal bool
- last_action str
- messages
Sequence[GetWorkflow Workflow Info Message] 
- mod_time str
- moid str
- name str
- object_type str
- organization
GetWorkflow Workflow Info Organization 
- output str
- owners Sequence[str]
- parent
GetWorkflow Workflow Info Parent 
- parent_task_ Getinfo Workflow Workflow Info Parent Task Info 
- pause_reason str
- permission
GetWorkflow Workflow Info Permission 
- permission_resources Sequence[GetWorkflow Workflow Info Permission Resource] 
- progress float
- properties
GetWorkflow Workflow Info Properties 
- retry_from_ strtask_ name 
- str
- src str
- start_time str
- status str
- success_workflow_ floatcleanup_ duration 
- 
Sequence[GetWorkflow Workflow Info Tag] 
- task_info_ Getupdate Workflow Workflow Info Task Info Update 
- task_infos Sequence[GetWorkflow Workflow Info Task Info] 
- trace_id str
- type str
- user_action_ boolrequired 
- user_id str
- variable str
- version_context GetWorkflow Workflow Info Version Context 
- wait_reason str
- workflow_ctx GetWorkflow Workflow Info Workflow Ctx 
- workflow_definition GetWorkflow Workflow Info Workflow Definition 
- workflow_status str
- id String
- results List<Property Map>
- account Property Map
- accountMoid String
- action String
- additionalProperties String
- ancestors List<Property Map>
- associatedObject Property Map
- classId String
- cleanupTime String
- createTime String
- domainGroup StringMoid 
- email String
- endTime String
- failedWorkflow NumberCleanup Duration 
- input String
- instId String
- internal Boolean
- lastAction String
- messages List<Property Map>
- modTime String
- moid String
- name String
- objectType String
- organization Property Map
- output String
- owners List<String>
- parent Property Map
- parentTask Property MapInfo 
- pauseReason String
- permission Property Map
- permissionResources List<Property Map>
- progress Number
- properties Property Map
- retryFrom StringTask Name 
- String
- src String
- startTime String
- status String
- successWorkflow NumberCleanup Duration 
- List<Property Map>
- taskInfo Property MapUpdate 
- taskInfos List<Property Map>
- traceId String
- type String
- userAction BooleanRequired 
- userId String
- variable String
- versionContext Property Map
- waitReason String
- workflowCtx Property Map
- workflowDefinition Property Map
- workflowStatus String
Supporting Types
GetWorkflowWorkflowInfoAccount    
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoAncestor    
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoAssociatedObject     
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoMessage    
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Message string
- An i18n message that can be translated into multiple languages to support internationalization.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Severity string
- The severity of the Task or Workflow message warning/error/info etc.- Info- The enum represents the log level to be used to convey info message.
- Warning- The enum represents the log level to be used to convey warning message.
- Debug- The enum represents the log level to be used to convey debug message.
- Error- The enum represents the log level to be used to convey error message.
 
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Message string
- An i18n message that can be translated into multiple languages to support internationalization.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Severity string
- The severity of the Task or Workflow message warning/error/info etc.- Info- The enum represents the log level to be used to convey info message.
- Warning- The enum represents the log level to be used to convey warning message.
- Debug- The enum represents the log level to be used to convey debug message.
- Error- The enum represents the log level to be used to convey error message.
 
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- message String
- An i18n message that can be translated into multiple languages to support internationalization.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- severity String
- The severity of the Task or Workflow message warning/error/info etc.- Info- The enum represents the log level to be used to convey info message.
- Warning- The enum represents the log level to be used to convey warning message.
- Debug- The enum represents the log level to be used to convey debug message.
- Error- The enum represents the log level to be used to convey error message.
 
- additionalProperties string
- classId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- message string
- An i18n message that can be translated into multiple languages to support internationalization.
- objectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- severity string
- The severity of the Task or Workflow message warning/error/info etc.- Info- The enum represents the log level to be used to convey info message.
- Warning- The enum represents the log level to be used to convey warning message.
- Debug- The enum represents the log level to be used to convey debug message.
- Error- The enum represents the log level to be used to convey error message.
 
- additional_properties str
- 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.
- message str
- An i18n message that can be translated into multiple languages to support internationalization.
- object_type str
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- severity str
- The severity of the Task or Workflow message warning/error/info etc.- Info- The enum represents the log level to be used to convey info message.
- Warning- The enum represents the log level to be used to convey warning message.
- Debug- The enum represents the log level to be used to convey debug message.
- Error- The enum represents the log level to be used to convey error message.
 
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- message String
- An i18n message that can be translated into multiple languages to support internationalization.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- severity String
- The severity of the Task or Workflow message warning/error/info etc.- Info- The enum represents the log level to be used to convey info message.
- Warning- The enum represents the log level to be used to convey warning message.
- Debug- The enum represents the log level to be used to convey debug message.
- Error- The enum represents the log level to be used to convey error message.
 
GetWorkflowWorkflowInfoOrganization    
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoParent    
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoParentTaskInfo      
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoPermission    
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoPermissionResource     
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoProperties    
- AdditionalProperties string
- Cancelable
GetWorkflow Workflow Info Properties Cancelable 
- Holds the parameters and conditions for a workflow to be cancelable.
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Retryable bool
- When true, this workflow can be retried within 2 weeks from the last failure.
- RollbackAction string
- Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.- Disabled- Status of the rollback action when workflow is disabled for rollback.
- Enabled- Status of the rollback action when workflow is enabled for rollback.
- Completed- Status of the rollback action once workflow completes the rollback for all eligible tasks.
 
- RollbackOn boolCancel 
- When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- RollbackOn boolFailure 
- When set to true, the changes are automatically rolled back if the workflow fails to execute.
- AdditionalProperties string
- Cancelable
GetWorkflow Workflow Info Properties Cancelable 
- Holds the parameters and conditions for a workflow to be cancelable.
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Retryable bool
- When true, this workflow can be retried within 2 weeks from the last failure.
- RollbackAction string
- Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.- Disabled- Status of the rollback action when workflow is disabled for rollback.
- Enabled- Status of the rollback action when workflow is enabled for rollback.
- Completed- Status of the rollback action once workflow completes the rollback for all eligible tasks.
 
- RollbackOn boolCancel 
- When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- RollbackOn boolFailure 
- When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additionalProperties String
- cancelable
GetWorkflow Workflow Info Properties Cancelable 
- Holds the parameters and conditions for a workflow to be cancelable.
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- retryable Boolean
- When true, this workflow can be retried within 2 weeks from the last failure.
- rollbackAction String
- Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.- Disabled- Status of the rollback action when workflow is disabled for rollback.
- Enabled- Status of the rollback action when workflow is enabled for rollback.
- Completed- Status of the rollback action once workflow completes the rollback for all eligible tasks.
 
- rollbackOn BooleanCancel 
- When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollbackOn BooleanFailure 
- When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additionalProperties string
- cancelable
GetWorkflow Workflow Info Properties Cancelable 
- Holds the parameters and conditions for a workflow to be cancelable.
- classId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- objectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- retryable boolean
- When true, this workflow can be retried within 2 weeks from the last failure.
- rollbackAction string
- Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.- Disabled- Status of the rollback action when workflow is disabled for rollback.
- Enabled- Status of the rollback action when workflow is enabled for rollback.
- Completed- Status of the rollback action once workflow completes the rollback for all eligible tasks.
 
- rollbackOn booleanCancel 
- When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollbackOn booleanFailure 
- When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additional_properties str
- cancelable
GetWorkflow Workflow Info Properties Cancelable 
- Holds the parameters and conditions for a workflow to be cancelable.
- 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.
- object_type str
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- retryable bool
- When true, this workflow can be retried within 2 weeks from the last failure.
- rollback_action str
- Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.- Disabled- Status of the rollback action when workflow is disabled for rollback.
- Enabled- Status of the rollback action when workflow is enabled for rollback.
- Completed- Status of the rollback action once workflow completes the rollback for all eligible tasks.
 
- rollback_on_ boolcancel 
- When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollback_on_ boolfailure 
- When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additionalProperties String
- cancelable Property Map
- Holds the parameters and conditions for a workflow to be cancelable.
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- retryable Boolean
- When true, this workflow can be retried within 2 weeks from the last failure.
- rollbackAction String
- Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.- Disabled- Status of the rollback action when workflow is disabled for rollback.
- Enabled- Status of the rollback action when workflow is enabled for rollback.
- Completed- Status of the rollback action once workflow completes the rollback for all eligible tasks.
 
- rollbackOn BooleanCancel 
- When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollbackOn BooleanFailure 
- When set to true, the changes are automatically rolled back if the workflow fails to execute.
GetWorkflowWorkflowInfoPropertiesCancelable     
- AdditionalProperties string
- CancelableStates List<string>
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Enabled bool
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- Mode string
- Mode controls how the workflow can be canceled.- ApiOnly- The workflow can only be canceled via API call.
- All- The workflow can be canceled from API or from the user interface.
 
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- AdditionalProperties string
- CancelableStates []string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Enabled bool
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- Mode string
- Mode controls how the workflow can be canceled.- ApiOnly- The workflow can only be canceled via API call.
- All- The workflow can be canceled from API or from the user interface.
 
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additionalProperties String
- cancelableStates List<String>
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- enabled Boolean
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- mode String
- Mode controls how the workflow can be canceled.- ApiOnly- The workflow can only be canceled via API call.
- All- The workflow can be canceled from API or from the user interface.
 
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additionalProperties string
- cancelableStates string[]
- classId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- enabled boolean
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- mode string
- Mode controls how the workflow can be canceled.- ApiOnly- The workflow can only be canceled via API call.
- All- The workflow can be canceled from API or from the user interface.
 
- objectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additional_properties str
- cancelable_states Sequence[str]
- 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.
- enabled bool
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- mode str
- Mode controls how the workflow can be canceled.- ApiOnly- The workflow can only be canceled via API call.
- All- The workflow can be canceled from API or from the user interface.
 
- object_type str
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additionalProperties String
- cancelableStates List<String>
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- enabled Boolean
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- mode String
- Mode controls how the workflow can be canceled.- ApiOnly- The workflow can only be canceled via API call.
- All- The workflow can be canceled from API or from the user interface.
 
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
GetWorkflowWorkflowInfoResult    
- AccountMoid string
- The Account ID for this managed object.
- Accounts
List<GetWorkflow Workflow Info Result Account> 
- Action string
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- AdditionalProperties string
- Ancestors
List<GetWorkflow Workflow Info Result Ancestor> 
- AssociatedObjects List<GetWorkflow Workflow Info Result Associated Object> 
- ClassId string
- CleanupTime string
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- CreateTime string
- The time when this managed object was created.
- DomainGroup stringMoid 
- The DomainGroup ID for this managed object.
- Email string
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- EndTime string
- The time when the workflow reached a final state.
- FailedWorkflow doubleCleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Input string
- InstId string
- A workflow instance Id which is the unique identified for the workflow execution.
- Internal bool
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- LastAction string
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- Messages
List<GetWorkflow Workflow Info Result Message> 
- ModTime string
- The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- A name of the workflow execution instance.
- ObjectType string
- Organizations
List<GetWorkflow Workflow Info Result Organization> 
- Output string
- Owners List<string>
- ParentTask List<GetInfos Workflow Workflow Info Result Parent Task Info> 
- Parents
List<GetWorkflow Workflow Info Result Parent> 
- PauseReason string
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- PermissionResources List<GetWorkflow Workflow Info Result Permission Resource> 
- Permissions
List<GetWorkflow Workflow Info Result Permission> 
- Progress double
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- Properties
List<GetWorkflow Workflow Info Result Property> 
- RetryFrom stringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- 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.
- Src string
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- StartTime string
- The time when the workflow was started for execution.
- Status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- SuccessWorkflow doubleCleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
List<GetWorkflow Workflow Info Result Tag> 
- TaskInfo List<GetUpdates Workflow Workflow Info Result Task Info Update> 
- TaskInfos List<GetWorkflow Workflow Info Result Task Info> 
- TraceId string
- The trace id to keep track of workflow execution.
- Type string
- A type of the workflow (serverconfig, ansible_monitoring).
- UserAction boolRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- UserId string
- The user identifier which indicates the user that started this workflow.
- Variable string
- VersionContexts List<GetWorkflow Workflow Info Result Version Context> 
- WaitReason string
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- WorkflowCtxes List<GetWorkflow Workflow Info Result Workflow Ctx> 
- WorkflowDefinitions List<GetWorkflow Workflow Info Result Workflow Definition> 
- WorkflowStatus string
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- AccountMoid string
- The Account ID for this managed object.
- Accounts
[]GetWorkflow Workflow Info Result Account 
- Action string
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- AdditionalProperties string
- Ancestors
[]GetWorkflow Workflow Info Result Ancestor 
- AssociatedObjects []GetWorkflow Workflow Info Result Associated Object 
- ClassId string
- CleanupTime string
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- CreateTime string
- The time when this managed object was created.
- DomainGroup stringMoid 
- The DomainGroup ID for this managed object.
- Email string
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- EndTime string
- The time when the workflow reached a final state.
- FailedWorkflow float64Cleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Input string
- InstId string
- A workflow instance Id which is the unique identified for the workflow execution.
- Internal bool
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- LastAction string
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- Messages
[]GetWorkflow Workflow Info Result Message 
- ModTime string
- The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- A name of the workflow execution instance.
- ObjectType string
- Organizations
[]GetWorkflow Workflow Info Result Organization 
- Output string
- Owners []string
- ParentTask []GetInfos Workflow Workflow Info Result Parent Task Info 
- Parents
[]GetWorkflow Workflow Info Result Parent 
- PauseReason string
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- PermissionResources []GetWorkflow Workflow Info Result Permission Resource 
- Permissions
[]GetWorkflow Workflow Info Result Permission 
- Progress float64
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- Properties
[]GetWorkflow Workflow Info Result Property 
- RetryFrom stringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- 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.
- Src string
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- StartTime string
- The time when the workflow was started for execution.
- Status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- SuccessWorkflow float64Cleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
[]GetWorkflow Workflow Info Result Tag 
- TaskInfo []GetUpdates Workflow Workflow Info Result Task Info Update 
- TaskInfos []GetWorkflow Workflow Info Result Task Info 
- TraceId string
- The trace id to keep track of workflow execution.
- Type string
- A type of the workflow (serverconfig, ansible_monitoring).
- UserAction boolRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- UserId string
- The user identifier which indicates the user that started this workflow.
- Variable string
- VersionContexts []GetWorkflow Workflow Info Result Version Context 
- WaitReason string
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- WorkflowCtxes []GetWorkflow Workflow Info Result Workflow Ctx 
- WorkflowDefinitions []GetWorkflow Workflow Info Result Workflow Definition 
- WorkflowStatus string
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- accountMoid String
- The Account ID for this managed object.
- accounts
List<GetWorkflow Workflow Info Result Account> 
- action String
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- additionalProperties String
- ancestors
List<GetWorkflow Workflow Info Result Ancestor> 
- associatedObjects List<GetWorkflow Workflow Info Result Associated Object> 
- classId String
- cleanupTime String
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- createTime String
- The time when this managed object was created.
- domainGroup StringMoid 
- The DomainGroup ID for this managed object.
- email String
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- endTime String
- The time when the workflow reached a final state.
- failedWorkflow DoubleCleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input String
- instId String
- A workflow instance Id which is the unique identified for the workflow execution.
- internal Boolean
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- lastAction String
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- messages
List<GetWorkflow Workflow Info Result Message> 
- modTime String
- The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- A name of the workflow execution instance.
- objectType String
- organizations
List<GetWorkflow Workflow Info Result Organization> 
- output String
- owners List<String>
- parentTask List<GetInfos Workflow Workflow Info Result Parent Task Info> 
- parents
List<GetWorkflow Workflow Info Result Parent> 
- pauseReason String
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- permissionResources List<GetWorkflow Workflow Info Result Permission Resource> 
- permissions
List<GetWorkflow Workflow Info Result Permission> 
- progress Double
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
List<GetWorkflow Workflow Info Result Property> 
- retryFrom StringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- String
- 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.
- src String
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- startTime String
- The time when the workflow was started for execution.
- status String
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- successWorkflow DoubleCleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
List<GetWorkflow Workflow Info Result Tag> 
- taskInfo List<GetUpdates Workflow Workflow Info Result Task Info Update> 
- taskInfos List<GetWorkflow Workflow Info Result Task Info> 
- traceId String
- The trace id to keep track of workflow execution.
- type String
- A type of the workflow (serverconfig, ansible_monitoring).
- userAction BooleanRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- userId String
- The user identifier which indicates the user that started this workflow.
- variable String
- versionContexts List<GetWorkflow Workflow Info Result Version Context> 
- waitReason String
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- workflowCtxes List<GetWorkflow Workflow Info Result Workflow Ctx> 
- workflowDefinitions List<GetWorkflow Workflow Info Result Workflow Definition> 
- workflowStatus String
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- accountMoid string
- The Account ID for this managed object.
- accounts
GetWorkflow Workflow Info Result Account[] 
- action string
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- additionalProperties string
- ancestors
GetWorkflow Workflow Info Result Ancestor[] 
- associatedObjects GetWorkflow Workflow Info Result Associated Object[] 
- classId string
- cleanupTime string
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- createTime string
- The time when this managed object was created.
- domainGroup stringMoid 
- The DomainGroup ID for this managed object.
- email string
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- endTime string
- The time when the workflow reached a final state.
- failedWorkflow numberCleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input string
- instId string
- A workflow instance Id which is the unique identified for the workflow execution.
- internal boolean
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- lastAction string
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- messages
GetWorkflow Workflow Info Result Message[] 
- modTime string
- The time when this managed object was last modified.
- moid string
- The unique identifier of this Managed Object instance.
- name string
- A name of the workflow execution instance.
- objectType string
- organizations
GetWorkflow Workflow Info Result Organization[] 
- output string
- owners string[]
- parentTask GetInfos Workflow Workflow Info Result Parent Task Info[] 
- parents
GetWorkflow Workflow Info Result Parent[] 
- pauseReason string
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- permissionResources GetWorkflow Workflow Info Result Permission Resource[] 
- permissions
GetWorkflow Workflow Info Result Permission[] 
- progress number
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
GetWorkflow Workflow Info Result Property[] 
- retryFrom stringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- 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.
- src string
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- startTime string
- The time when the workflow was started for execution.
- status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- successWorkflow numberCleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
GetWorkflow Workflow Info Result Tag[] 
- taskInfo GetUpdates Workflow Workflow Info Result Task Info Update[] 
- taskInfos GetWorkflow Workflow Info Result Task Info[] 
- traceId string
- The trace id to keep track of workflow execution.
- type string
- A type of the workflow (serverconfig, ansible_monitoring).
- userAction booleanRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- userId string
- The user identifier which indicates the user that started this workflow.
- variable string
- versionContexts GetWorkflow Workflow Info Result Version Context[] 
- waitReason string
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- workflowCtxes GetWorkflow Workflow Info Result Workflow Ctx[] 
- workflowDefinitions GetWorkflow Workflow Info Result Workflow Definition[] 
- workflowStatus string
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- account_moid str
- The Account ID for this managed object.
- accounts
Sequence[GetWorkflow Workflow Info Result Account] 
- action str
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- additional_properties str
- ancestors
Sequence[GetWorkflow Workflow Info Result Ancestor] 
- associated_objects Sequence[GetWorkflow Workflow Info Result Associated Object] 
- class_id str
- cleanup_time str
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- create_time str
- The time when this managed object was created.
- domain_group_ strmoid 
- The DomainGroup ID for this managed object.
- email str
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- end_time str
- The time when the workflow reached a final state.
- failed_workflow_ floatcleanup_ duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input str
- inst_id str
- A workflow instance Id which is the unique identified for the workflow execution.
- internal bool
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- last_action str
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- messages
Sequence[GetWorkflow Workflow Info Result Message] 
- mod_time str
- The time when this managed object was last modified.
- moid str
- The unique identifier of this Managed Object instance.
- name str
- A name of the workflow execution instance.
- object_type str
- organizations
Sequence[GetWorkflow Workflow Info Result Organization] 
- output str
- owners Sequence[str]
- parent_task_ Sequence[Getinfos Workflow Workflow Info Result Parent Task Info] 
- parents
Sequence[GetWorkflow Workflow Info Result Parent] 
- pause_reason str
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- permission_resources Sequence[GetWorkflow Workflow Info Result Permission Resource] 
- permissions
Sequence[GetWorkflow Workflow Info Result Permission] 
- progress float
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
Sequence[GetWorkflow Workflow Info Result Property] 
- retry_from_ strtask_ name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- str
- 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.
- src str
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- start_time str
- The time when the workflow was started for execution.
- status str
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success_workflow_ floatcleanup_ duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- 
Sequence[GetWorkflow Workflow Info Result Tag] 
- task_info_ Sequence[Getupdates Workflow Workflow Info Result Task Info Update] 
- task_infos Sequence[GetWorkflow Workflow Info Result Task Info] 
- trace_id str
- The trace id to keep track of workflow execution.
- type str
- A type of the workflow (serverconfig, ansible_monitoring).
- user_action_ boolrequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- user_id str
- The user identifier which indicates the user that started this workflow.
- variable str
- version_contexts Sequence[GetWorkflow Workflow Info Result Version Context] 
- wait_reason str
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- workflow_ctxes Sequence[GetWorkflow Workflow Info Result Workflow Ctx] 
- workflow_definitions Sequence[GetWorkflow Workflow Info Result Workflow Definition] 
- workflow_status str
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
- accountMoid String
- The Account ID for this managed object.
- accounts List<Property Map>
- action String
- The action of the workflow such as start, cancel, retry, pause.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- additionalProperties String
- ancestors List<Property Map>
- associatedObjects List<Property Map>
- classId String
- cleanupTime String
- The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- createTime String
- The time when this managed object was created.
- domainGroup StringMoid 
- The DomainGroup ID for this managed object.
- email String
- The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- endTime String
- The time when the workflow reached a final state.
- failedWorkflow NumberCleanup Duration 
- The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input String
- instId String
- A workflow instance Id which is the unique identified for the workflow execution.
- internal Boolean
- Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- lastAction String
- The last action that was issued on the workflow is saved in this field.* None- No action is set, this is the default value for action field.*Create- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start- Start a new execution of the workflow.*Pause- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume- Resume the workflow which was previously paused through pause action on the workflow.*Rerun- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel- Cancel the workflow that is in running or waiting state.
- messages List<Property Map>
- modTime String
- The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- A name of the workflow execution instance.
- objectType String
- organizations List<Property Map>
- output String
- owners List<String>
- parentTask List<Property Map>Infos 
- parents List<Property Map>
- pauseReason String
- Denotes the reason workflow is in paused status.* None- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.
- permissionResources List<Property Map>
- permissions List<Property Map>
- progress Number
- This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties List<Property Map>
- retryFrom StringTask Name 
- This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- String
- 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.
- src String
- The source service that started the workflow execution and hence represents the owning service for this workflow.
- startTime String
- The time when the workflow was started for execution.
- status String
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- successWorkflow NumberCleanup Duration 
- The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- List<Property Map>
- taskInfo List<Property Map>Updates 
- taskInfos List<Property Map>
- traceId String
- The trace id to keep track of workflow execution.
- type String
- A type of the workflow (serverconfig, ansible_monitoring).
- userAction BooleanRequired 
- Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- userId String
- The user identifier which indicates the user that started this workflow.
- variable String
- versionContexts List<Property Map>
- waitReason String
- Denotes the reason workflow is in waiting status.* None- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart- Workflow is waiting to start on workflow engine.
- workflowCtxes List<Property Map>
- workflowDefinitions List<Property Map>
- workflowStatus String
- The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted- Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.*InProgress- A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.*Waiting- Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.*Completed- A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.*Failed- A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.*Terminated- A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.*Canceled- A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.*Paused- A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.
GetWorkflowWorkflowInfoResultAccount     
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultAncestor     
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultAssociatedObject      
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultMessage     
- AdditionalProperties string
- ClassId string
- Message string
- ObjectType string
- Severity string
- AdditionalProperties string
- ClassId string
- Message string
- ObjectType string
- Severity string
- additionalProperties String
- classId String
- message String
- objectType String
- severity String
- additionalProperties string
- classId string
- message string
- objectType string
- severity string
- additional_properties str
- class_id str
- message str
- object_type str
- severity str
- additionalProperties String
- classId String
- message String
- objectType String
- severity String
GetWorkflowWorkflowInfoResultOrganization     
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultParent     
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultParentTaskInfo       
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultPermission     
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultPermissionResource      
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultProperty     
- AdditionalProperties string
- Cancelables
List<GetWorkflow Workflow Info Result Property Cancelable> 
- ClassId string
- ObjectType string
- Retryable bool
- RollbackAction string
- RollbackOn boolCancel 
- RollbackOn boolFailure 
- AdditionalProperties string
- Cancelables
[]GetWorkflow Workflow Info Result Property Cancelable 
- ClassId string
- ObjectType string
- Retryable bool
- RollbackAction string
- RollbackOn boolCancel 
- RollbackOn boolFailure 
- additionalProperties String
- cancelables
List<GetWorkflow Workflow Info Result Property Cancelable> 
- classId String
- objectType String
- retryable Boolean
- rollbackAction String
- rollbackOn BooleanCancel 
- rollbackOn BooleanFailure 
- additionalProperties string
- cancelables
GetWorkflow Workflow Info Result Property Cancelable[] 
- classId string
- objectType string
- retryable boolean
- rollbackAction string
- rollbackOn booleanCancel 
- rollbackOn booleanFailure 
- additionalProperties String
- cancelables List<Property Map>
- classId String
- objectType String
- retryable Boolean
- rollbackAction String
- rollbackOn BooleanCancel 
- rollbackOn BooleanFailure 
GetWorkflowWorkflowInfoResultPropertyCancelable      
- AdditionalProperties string
- CancelableStates List<string>
- ClassId string
- Enabled bool
- Mode string
- ObjectType string
- AdditionalProperties string
- CancelableStates []string
- ClassId string
- Enabled bool
- Mode string
- ObjectType string
- additionalProperties String
- cancelableStates List<String>
- classId String
- enabled Boolean
- mode String
- objectType String
- additionalProperties string
- cancelableStates string[]
- classId string
- enabled boolean
- mode string
- objectType string
- additional_properties str
- cancelable_states Sequence[str]
- class_id str
- enabled bool
- mode str
- object_type str
- additionalProperties String
- cancelableStates List<String>
- classId String
- enabled Boolean
- mode String
- objectType String
GetWorkflowWorkflowInfoResultTag     
- AdditionalProperties string
- Key string
- Value string
- AdditionalProperties string
- Key string
- Value string
- additionalProperties String
- key String
- value String
- additionalProperties string
- key string
- value string
- additional_properties str
- key str
- value str
- additionalProperties String
- key String
- value String
GetWorkflowWorkflowInfoResultTaskInfo      
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultTaskInfoUpdate       
- AdditionalProperties string
- ClassId string
- Input string
- Name string
- A name of the workflow execution instance.
- ObjectType string
- Status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- AdditionalProperties string
- ClassId string
- Input string
- Name string
- A name of the workflow execution instance.
- ObjectType string
- Status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- additionalProperties String
- classId String
- input String
- name String
- A name of the workflow execution instance.
- objectType String
- status String
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- additionalProperties string
- classId string
- input string
- name string
- A name of the workflow execution instance.
- objectType string
- status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- additional_properties str
- class_id str
- input str
- name str
- A name of the workflow execution instance.
- object_type str
- status str
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- additionalProperties String
- classId String
- input String
- name String
- A name of the workflow execution instance.
- objectType String
- status String
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
GetWorkflowWorkflowInfoResultVersionContext      
- additionalProperties String
- classId String
- interestedMos List<Property Map>
- markedFor BooleanDeletion 
- nrVersion String
- objectType String
- refMos List<Property Map>
- timestamp String
- versionType String
GetWorkflowWorkflowInfoResultVersionContextInterestedMo        
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultVersionContextRefMo        
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoResultWorkflowCtx      
- additionalProperties String
- classId String
- initiatorCtxes List<Property Map>
- objectType String
- targetCtx List<Property Map>Lists 
- workflowSubtype String
- workflowType String
GetWorkflowWorkflowInfoResultWorkflowCtxInitiatorCtx        
- AdditionalProperties string
- ClassId string
- InitiatorMoid string
- InitiatorName string
- InitiatorType string
- ObjectType string
- AdditionalProperties string
- ClassId string
- InitiatorMoid string
- InitiatorName string
- InitiatorType string
- ObjectType string
- additionalProperties String
- classId String
- initiatorMoid String
- initiatorName String
- initiatorType String
- objectType String
- additionalProperties string
- classId string
- initiatorMoid string
- initiatorName string
- initiatorType string
- objectType string
- additional_properties str
- class_id str
- initiator_moid str
- initiator_name str
- initiator_type str
- object_type str
- additionalProperties String
- classId String
- initiatorMoid String
- initiatorName String
- initiatorType String
- objectType String
GetWorkflowWorkflowInfoResultWorkflowCtxTargetCtxList         
- AdditionalProperties string
- ClassId string
- ObjectType string
- TargetMoid string
- TargetName string
- TargetType string
- AdditionalProperties string
- ClassId string
- ObjectType string
- TargetMoid string
- TargetName string
- TargetType string
- additionalProperties String
- classId String
- objectType String
- targetMoid String
- targetName String
- targetType String
- additionalProperties string
- classId string
- objectType string
- targetMoid string
- targetName string
- targetType string
- additional_properties str
- class_id str
- object_type str
- target_moid str
- target_name str
- target_type str
- additionalProperties String
- classId String
- objectType String
- targetMoid String
- targetName String
- targetType String
GetWorkflowWorkflowInfoResultWorkflowDefinition      
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- AdditionalProperties string
- ClassId string
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- Selector string
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
- additionalProperties string
- classId string
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- selector string
- additional_properties str
- class_id str
- moid str
- The unique identifier of this Managed Object instance.
- object_type str
- selector str
- additionalProperties String
- classId String
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- selector String
GetWorkflowWorkflowInfoTag    
- AdditionalProperties string
- Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- AdditionalProperties string
- Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- additionalProperties String
- key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
- additionalProperties string
- key string
- The string representation of a tag key.
- value string
- The string representation of a tag value.
- additional_properties str
- key str
- The string representation of a tag key.
- value str
- The string representation of a tag value.
- additionalProperties String
- key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
GetWorkflowWorkflowInfoTaskInfo     
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoTaskInfoUpdate      
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Input string
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- Name string
- A name of the workflow execution instance.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Input string
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- Name string
- A name of the workflow execution instance.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- input String
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- name String
- A name of the workflow execution instance.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- status String
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- additionalProperties string
- classId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- input string
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- name string
- A name of the workflow execution instance.
- objectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- status string
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- additional_properties str
- 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.
- input str
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- name str
- A name of the workflow execution instance.
- object_type str
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- status str
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- input String
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- name String
- A name of the workflow execution instance.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- status String
- A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
GetWorkflowWorkflowInfoVersionContext     
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- InterestedMos List<GetWorkflow Workflow Info Version Context Interested Mo> 
- MarkedFor boolDeletion 
- The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- NrVersion string
- The version of the Managed Object, e.g. an incrementing number or a hash id.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- RefMo GetWorkflow Workflow Info Version Context Ref Mo 
- A reference to the original Managed Object.
- Timestamp string
- The time this versioned Managed Object was created.
- VersionType string
- 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 intended
to be configured to target endpoints.- Modified- Version created every time an object is modified.
- Configured- Version created every time an object is configured to the service profile.
- Deployed- Version created for objects related to a service profile when it is deployed.
 
- AdditionalProperties string
- ClassId string
- 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.
- InterestedMos []GetWorkflow Workflow Info Version Context Interested Mo 
- MarkedFor boolDeletion 
- The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- NrVersion string
- The version of the Managed Object, e.g. an incrementing number or a hash id.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- RefMo GetWorkflow Workflow Info Version Context Ref Mo 
- A reference to the original Managed Object.
- Timestamp string
- The time this versioned Managed Object was created.
- VersionType string
- 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 intended
to be configured to target endpoints.- Modified- Version created every time an object is modified.
- Configured- Version created every time an object is configured to the service profile.
- Deployed- Version created for objects related to a service profile when it is deployed.
 
- additionalProperties String
- classId String
- 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.
- interestedMos List<GetWorkflow Workflow Info Version Context Interested Mo> 
- markedFor BooleanDeletion 
- The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nrVersion String
- The version of the Managed Object, e.g. an incrementing number or a hash id.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- refMo GetWorkflow Workflow Info Version Context Ref Mo 
- A reference to the original Managed Object.
- timestamp String
- The time this versioned Managed Object was created.
- versionType String
- 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 intended
to be configured to target endpoints.- Modified- Version created every time an object is modified.
- Configured- Version created every time an object is configured to the service profile.
- Deployed- Version created for objects related to a service profile when it is deployed.
 
- additionalProperties string
- classId string
- 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.
- interestedMos GetWorkflow Workflow Info Version Context Interested Mo[] 
- markedFor booleanDeletion 
- The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nrVersion string
- The version of the Managed Object, e.g. an incrementing number or a hash id.
- objectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- refMo GetWorkflow Workflow Info Version Context Ref Mo 
- A reference to the original Managed Object.
- timestamp string
- The time this versioned Managed Object was created.
- versionType string
- 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 intended
to 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
- 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.
- interested_mos Sequence[GetWorkflow Workflow Info Version Context Interested Mo] 
- marked_for_ booldeletion 
- 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
- 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_mo GetWorkflow Workflow Info Version Context Ref Mo 
- A reference to the original Managed Object.
- timestamp str
- The time this versioned Managed Object was created.
- version_type str
- 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 intended
to be configured to target endpoints.- Modified- Version created every time an object is modified.
- Configured- Version created every time an object is configured to the service profile.
- Deployed- Version created for objects related to a service profile when it is deployed.
 
- additionalProperties String
- classId String
- 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.
- interestedMos List<Property Map>
- markedFor BooleanDeletion 
- The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nrVersion String
- The version of the Managed Object, e.g. an incrementing number or a hash id.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- refMo Property Map
- A reference to the original Managed Object.
- timestamp String
- The time this versioned Managed Object was created.
- versionType String
- 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 intended
to 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.
 
GetWorkflowWorkflowInfoVersionContextInterestedMo       
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoVersionContextRefMo       
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
GetWorkflowWorkflowInfoWorkflowCtx     
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- InitiatorCtx GetWorkflow Workflow Info Workflow Ctx Initiator Ctx 
- Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- TargetCtx List<GetLists Workflow Workflow Info Workflow Ctx Target Ctx List> 
- WorkflowSubtype string
- The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- WorkflowType string
- Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- InitiatorCtx GetWorkflow Workflow Info Workflow Ctx Initiator Ctx 
- Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- TargetCtx []GetLists Workflow Workflow Info Workflow Ctx Target Ctx List 
- WorkflowSubtype string
- The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- WorkflowType string
- Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiatorCtx GetWorkflow Workflow Info Workflow Ctx Initiator Ctx 
- Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- targetCtx List<GetLists Workflow Workflow Info Workflow Ctx Target Ctx List> 
- workflowSubtype String
- The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- workflowType String
- Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- additionalProperties string
- classId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiatorCtx GetWorkflow Workflow Info Workflow Ctx Initiator Ctx 
- Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator.
- objectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- targetCtx GetLists Workflow Workflow Info Workflow Ctx Target Ctx List[] 
- workflowSubtype string
- The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- workflowType string
- Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- additional_properties str
- 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.
- initiator_ctx GetWorkflow Workflow Info Workflow Ctx Initiator Ctx 
- Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator.
- object_type str
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- target_ctx_ Sequence[Getlists Workflow Workflow Info Workflow Ctx Target Ctx List] 
- workflow_subtype str
- The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- workflow_type str
- Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiatorCtx Property Map
- Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- targetCtx List<Property Map>Lists 
- workflowSubtype String
- The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- workflowType String
- Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
GetWorkflowWorkflowInfoWorkflowCtxInitiatorCtx       
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- InitiatorMoid string
- The moid of the Intersight managed object that initiated the workflow.
- InitiatorName string
- Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- InitiatorType string
- Type of Intersight managed object that initiated the workflow.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- InitiatorMoid string
- The moid of the Intersight managed object that initiated the workflow.
- InitiatorName string
- Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- InitiatorType string
- Type of Intersight managed object that initiated the workflow.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiatorMoid String
- The moid of the Intersight managed object that initiated the workflow.
- initiatorName String
- Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiatorType String
- Type of Intersight managed object that initiated the workflow.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additionalProperties string
- classId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiatorMoid string
- The moid of the Intersight managed object that initiated the workflow.
- initiatorName string
- Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiatorType string
- Type of Intersight managed object that initiated the workflow.
- objectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additional_properties str
- 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.
- initiator_moid str
- The moid of the Intersight managed object that initiated the workflow.
- initiator_name str
- Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiator_type str
- Type of Intersight managed object that initiated the workflow.
- object_type str
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiatorMoid String
- The moid of the Intersight managed object that initiated the workflow.
- initiatorName String
- Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiatorType String
- Type of Intersight managed object that initiated the workflow.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
GetWorkflowWorkflowInfoWorkflowCtxTargetCtxList        
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- TargetMoid string
- Moid of the target Intersight managed object.
- TargetName string
- Name of the target instance.
- TargetType string
- Object type of the target Intersight managed object.
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- ObjectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- TargetMoid string
- Moid of the target Intersight managed object.
- TargetName string
- Name of the target instance.
- TargetType string
- Object type of the target Intersight managed object.
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- targetMoid String
- Moid of the target Intersight managed object.
- targetName String
- Name of the target instance.
- targetType String
- Object type of the target Intersight managed object.
- additionalProperties string
- classId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- objectType string
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- targetMoid string
- Moid of the target Intersight managed object.
- targetName string
- Name of the target instance.
- targetType string
- Object type of the target Intersight managed object.
- additional_properties str
- 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.
- object_type str
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- target_moid str
- Moid of the target Intersight managed object.
- target_name str
- Name of the target instance.
- target_type str
- Object type of the target Intersight managed object.
- additionalProperties String
- classId String
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- objectType String
- The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- targetMoid String
- Moid of the target Intersight managed object.
- targetName String
- Name of the target instance.
- targetType String
- Object type of the target Intersight managed object.
GetWorkflowWorkflowInfoWorkflowDefinition     
- AdditionalProperties string
- ClassId string
- The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- AdditionalProperties string
- ClassId string
- 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.
- Moid string
- The unique identifier of this Managed Object instance.
- ObjectType string
- The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties string
- classId string
- 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.
- moid string
- The unique identifier of this Managed Object instance.
- objectType string
- The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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
- 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.
- moid str
- The unique identifier of this Managed Object instance.
- 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 may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.
 
- additionalProperties String
- classId String
- 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.
- moid String
- The unique identifier of this Managed Object instance.
- objectType String
- The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field may
be set instead of 'moid' by clients.- If 'moid' is set this field is ignored.
- If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance 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'.
 
Package Details
- Repository
- intersight ciscodevnet/terraform-provider-intersight
- License
- Notes
- This Pulumi package is based on the intersightTerraform Provider.