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 dictionary
The following arguments are supported:
- Account
Get
Workflow Workflow Info Account - Account
Moid 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. - Additional
Properties string - Ancestors
List<Get
Workflow Workflow Info Ancestor> - Associated
Object GetWorkflow Workflow Info Associated Object - Class
Id string - Cleanup
Time 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.
- Create
Time string - The time when this managed object was created.
- Domain
Group 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.
- End
Time string - The time when the workflow reached a final state.
- Failed
Workflow 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
- Inst
Id 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.
- Last
Action 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<Get
Workflow Workflow Info Message> - Mod
Time 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.
- Object
Type string - Organization
Get
Workflow Workflow Info Organization - Output string
- Owners List<string>
- Parent
Get
Workflow Workflow Info Parent - Parent
Task GetInfo Workflow Workflow Info Parent Task Info - Pause
Reason 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
Get
Workflow Workflow Info Permission - Permission
Resources 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
Get
Workflow Workflow Info Properties - Retry
From 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.
- Start
Time 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.
- Success
Workflow 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<Get
Workflow Workflow Info Tag> - Task
Info GetUpdate Workflow Workflow Info Task Info Update - Task
Infos List<GetWorkflow Workflow Info Task Info> - Trace
Id string - The trace id to keep track of workflow execution.
- Type string
- 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 string - The user identifier which indicates the user that started this workflow.
- Variable string
- Version
Context GetWorkflow Workflow Info Version Context - Wait
Reason 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. - Workflow
Ctx GetWorkflow Workflow Info Workflow Ctx - Workflow
Definition GetWorkflow Workflow Info Workflow Definition - Workflow
Status 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
Get
Workflow Workflow Info Account - Account
Moid 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. - Additional
Properties string - Ancestors
[]Get
Workflow Workflow Info Ancestor - Associated
Object GetWorkflow Workflow Info Associated Object - Class
Id string - Cleanup
Time 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.
- Create
Time string - The time when this managed object was created.
- Domain
Group 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.
- End
Time string - The time when the workflow reached a final state.
- Failed
Workflow 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
- Inst
Id 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.
- Last
Action 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
[]Get
Workflow Workflow Info Message - Mod
Time 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.
- Object
Type string - Organization
Get
Workflow Workflow Info Organization - Output string
- Owners []string
- Parent
Get
Workflow Workflow Info Parent - Parent
Task GetInfo Workflow Workflow Info Parent Task Info - Pause
Reason 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
Get
Workflow Workflow Info Permission - Permission
Resources []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
Get
Workflow Workflow Info Properties - Retry
From 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.
- Start
Time 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.
- Success
Workflow 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.
- []Get
Workflow Workflow Info Tag - Task
Info GetUpdate Workflow Workflow Info Task Info Update - Task
Infos []GetWorkflow Workflow Info Task Info - Trace
Id string - The trace id to keep track of workflow execution.
- Type string
- 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 string - The user identifier which indicates the user that started this workflow.
- Variable string
- Version
Context GetWorkflow Workflow Info Version Context - Wait
Reason 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. - Workflow
Ctx GetWorkflow Workflow Info Workflow Ctx - Workflow
Definition GetWorkflow Workflow Info Workflow Definition - Workflow
Status 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
Get
Workflow Workflow Info Account - account
Moid 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. - additional
Properties String - ancestors
List<Get
Workflow Workflow Info Ancestor> - associated
Object GetWorkflow Workflow Info Associated Object - class
Id String - cleanup
Time 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.
- create
Time String - The time when this managed object was created.
- domain
Group 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.
- end
Time String - The time when the workflow reached a final state.
- failed
Workflow 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
- inst
Id 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.
- last
Action 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<Get
Workflow Workflow Info Message> - mod
Time 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.
- object
Type String - organization
Get
Workflow Workflow Info Organization - output String
- owners List<String>
- parent
Get
Workflow Workflow Info Parent - parent
Task GetInfo Workflow Workflow Info Parent Task Info - pause
Reason 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
Get
Workflow Workflow Info Permission - permission
Resources 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
Get
Workflow Workflow Info Properties - retry
From 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.
- start
Time 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.
- success
Workflow 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<Get
Workflow Workflow Info Tag> - task
Info GetUpdate Workflow Workflow Info Task Info Update - task
Infos List<GetWorkflow Workflow Info Task Info> - trace
Id String - The trace id to keep track of workflow execution.
- type String
- A type of the workflow (serverconfig, ansible_monitoring).
- user
Action 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.
- user
Id String - The user identifier which indicates the user that started this workflow.
- variable String
- version
Context GetWorkflow Workflow Info Version Context - wait
Reason 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. - workflow
Ctx GetWorkflow Workflow Info Workflow Ctx - workflow
Definition GetWorkflow Workflow Info Workflow Definition - workflow
Status 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
Get
Workflow Workflow Info Account - account
Moid 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. - additional
Properties string - ancestors
Get
Workflow Workflow Info Ancestor[] - associated
Object GetWorkflow Workflow Info Associated Object - class
Id string - cleanup
Time 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.
- create
Time string - The time when this managed object was created.
- domain
Group 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.
- end
Time string - The time when the workflow reached a final state.
- failed
Workflow 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
- inst
Id 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.
- last
Action 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
Get
Workflow Workflow Info Message[] - mod
Time 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.
- object
Type string - organization
Get
Workflow Workflow Info Organization - output string
- owners string[]
- parent
Get
Workflow Workflow Info Parent - parent
Task GetInfo Workflow Workflow Info Parent Task Info - pause
Reason 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
Get
Workflow Workflow Info Permission - permission
Resources 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
Get
Workflow Workflow Info Properties - retry
From 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.
- start
Time 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.
- success
Workflow 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.
- Get
Workflow Workflow Info Tag[] - task
Info GetUpdate Workflow Workflow Info Task Info Update - task
Infos GetWorkflow Workflow Info Task Info[] - trace
Id string - The trace id to keep track of workflow execution.
- type string
- A type of the workflow (serverconfig, ansible_monitoring).
- user
Action 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.
- user
Id string - The user identifier which indicates the user that started this workflow.
- variable string
- version
Context GetWorkflow Workflow Info Version Context - wait
Reason 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. - workflow
Ctx GetWorkflow Workflow Info Workflow Ctx - workflow
Definition GetWorkflow Workflow Info Workflow Definition - workflow
Status 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
Get
Workflow 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[Get
Workflow 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[Get
Workflow 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
Get
Workflow Workflow Info Organization - output str
- owners Sequence[str]
- parent
Get
Workflow 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
Get
Workflow 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
Get
Workflow 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[Get
Workflow 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
- account
Moid 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. - additional
Properties String - ancestors List<Property Map>
- associated
Object Property Map - class
Id String - cleanup
Time 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.
- create
Time String - The time when this managed object was created.
- domain
Group 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.
- end
Time String - The time when the workflow reached a final state.
- failed
Workflow 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
- inst
Id 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.
- last
Action 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>
- mod
Time 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.
- object
Type String - organization Property Map
- output String
- owners List<String>
- parent Property Map
- parent
Task Property MapInfo - pause
Reason 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
- permission
Resources 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
- retry
From 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.
- start
Time 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.
- success
Workflow 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>
- task
Info Property MapUpdate - task
Infos List<Property Map> - trace
Id String - The trace id to keep track of workflow execution.
- type String
- A type of the workflow (serverconfig, ansible_monitoring).
- user
Action 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.
- user
Id String - The user identifier which indicates the user that started this workflow.
- variable String
- version
Context Property Map - wait
Reason 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. - workflow
Ctx Property Map - workflow
Definition Property Map - workflow
Status 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<Get
Workflow Workflow Info Result> - Account
Get
Workflow Workflow Info Account - Account
Moid string - Action string
- Additional
Properties string - Ancestors
List<Get
Workflow Workflow Info Ancestor> - Associated
Object GetWorkflow Workflow Info Associated Object - Class
Id string - Cleanup
Time string - Create
Time string - Domain
Group stringMoid - Email string
- End
Time string - Failed
Workflow doubleCleanup Duration - Input string
- Inst
Id string - Internal bool
- Last
Action string - Messages
List<Get
Workflow Workflow Info Message> - Mod
Time string - Moid string
- Name string
- Object
Type string - Organization
Get
Workflow Workflow Info Organization - Output string
- Owners List<string>
- Parent
Get
Workflow Workflow Info Parent - Parent
Task GetInfo Workflow Workflow Info Parent Task Info - Pause
Reason string - Permission
Get
Workflow Workflow Info Permission - Permission
Resources List<GetWorkflow Workflow Info Permission Resource> - Progress double
- Properties
Get
Workflow Workflow Info Properties - Retry
From stringTask Name - string
- Src string
- Start
Time string - Status string
- Success
Workflow doubleCleanup Duration - List<Get
Workflow Workflow Info Tag> - Task
Info GetUpdate Workflow Workflow Info Task Info Update - Task
Infos List<GetWorkflow Workflow Info Task Info> - Trace
Id string - Type string
- User
Action boolRequired - User
Id string - Variable string
- Version
Context GetWorkflow Workflow Info Version Context - Wait
Reason string - Workflow
Ctx GetWorkflow Workflow Info Workflow Ctx - Workflow
Definition GetWorkflow Workflow Info Workflow Definition - Workflow
Status string
- Id string
- Results
[]Get
Workflow Workflow Info Result - Account
Get
Workflow Workflow Info Account - Account
Moid string - Action string
- Additional
Properties string - Ancestors
[]Get
Workflow Workflow Info Ancestor - Associated
Object GetWorkflow Workflow Info Associated Object - Class
Id string - Cleanup
Time string - Create
Time string - Domain
Group stringMoid - Email string
- End
Time string - Failed
Workflow float64Cleanup Duration - Input string
- Inst
Id string - Internal bool
- Last
Action string - Messages
[]Get
Workflow Workflow Info Message - Mod
Time string - Moid string
- Name string
- Object
Type string - Organization
Get
Workflow Workflow Info Organization - Output string
- Owners []string
- Parent
Get
Workflow Workflow Info Parent - Parent
Task GetInfo Workflow Workflow Info Parent Task Info - Pause
Reason string - Permission
Get
Workflow Workflow Info Permission - Permission
Resources []GetWorkflow Workflow Info Permission Resource - Progress float64
- Properties
Get
Workflow Workflow Info Properties - Retry
From stringTask Name - string
- Src string
- Start
Time string - Status string
- Success
Workflow float64Cleanup Duration - []Get
Workflow Workflow Info Tag - Task
Info GetUpdate Workflow Workflow Info Task Info Update - Task
Infos []GetWorkflow Workflow Info Task Info - Trace
Id string - Type string
- User
Action boolRequired - User
Id string - Variable string
- Version
Context GetWorkflow Workflow Info Version Context - Wait
Reason string - Workflow
Ctx GetWorkflow Workflow Info Workflow Ctx - Workflow
Definition GetWorkflow Workflow Info Workflow Definition - Workflow
Status string
- id String
- results
List<Get
Workflow Workflow Info Result> - account
Get
Workflow Workflow Info Account - account
Moid String - action String
- additional
Properties String - ancestors
List<Get
Workflow Workflow Info Ancestor> - associated
Object GetWorkflow Workflow Info Associated Object - class
Id String - cleanup
Time String - create
Time String - domain
Group StringMoid - email String
- end
Time String - failed
Workflow DoubleCleanup Duration - input String
- inst
Id String - internal Boolean
- last
Action String - messages
List<Get
Workflow Workflow Info Message> - mod
Time String - moid String
- name String
- object
Type String - organization
Get
Workflow Workflow Info Organization - output String
- owners List<String>
- parent
Get
Workflow Workflow Info Parent - parent
Task GetInfo Workflow Workflow Info Parent Task Info - pause
Reason String - permission
Get
Workflow Workflow Info Permission - permission
Resources List<GetWorkflow Workflow Info Permission Resource> - progress Double
- properties
Get
Workflow Workflow Info Properties - retry
From StringTask Name - String
- src String
- start
Time String - status String
- success
Workflow DoubleCleanup Duration - List<Get
Workflow Workflow Info Tag> - task
Info GetUpdate Workflow Workflow Info Task Info Update - task
Infos List<GetWorkflow Workflow Info Task Info> - trace
Id String - type String
- user
Action BooleanRequired - user
Id String - variable String
- version
Context GetWorkflow Workflow Info Version Context - wait
Reason String - workflow
Ctx GetWorkflow Workflow Info Workflow Ctx - workflow
Definition GetWorkflow Workflow Info Workflow Definition - workflow
Status String
- id string
- results
Get
Workflow Workflow Info Result[] - account
Get
Workflow Workflow Info Account - account
Moid string - action string
- additional
Properties string - ancestors
Get
Workflow Workflow Info Ancestor[] - associated
Object GetWorkflow Workflow Info Associated Object - class
Id string - cleanup
Time string - create
Time string - domain
Group stringMoid - email string
- end
Time string - failed
Workflow numberCleanup Duration - input string
- inst
Id string - internal boolean
- last
Action string - messages
Get
Workflow Workflow Info Message[] - mod
Time string - moid string
- name string
- object
Type string - organization
Get
Workflow Workflow Info Organization - output string
- owners string[]
- parent
Get
Workflow Workflow Info Parent - parent
Task GetInfo Workflow Workflow Info Parent Task Info - pause
Reason string - permission
Get
Workflow Workflow Info Permission - permission
Resources GetWorkflow Workflow Info Permission Resource[] - progress number
- properties
Get
Workflow Workflow Info Properties - retry
From stringTask Name - string
- src string
- start
Time string - status string
- success
Workflow numberCleanup Duration - Get
Workflow Workflow Info Tag[] - task
Info GetUpdate Workflow Workflow Info Task Info Update - task
Infos GetWorkflow Workflow Info Task Info[] - trace
Id string - type string
- user
Action booleanRequired - user
Id string - variable string
- version
Context GetWorkflow Workflow Info Version Context - wait
Reason string - workflow
Ctx GetWorkflow Workflow Info Workflow Ctx - workflow
Definition GetWorkflow Workflow Info Workflow Definition - workflow
Status string
- id str
- results
Sequence[Get
Workflow Workflow Info Result] - account
Get
Workflow Workflow Info Account - account_
moid str - action str
- additional_
properties str - ancestors
Sequence[Get
Workflow 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[Get
Workflow Workflow Info Message] - mod_
time str - moid str
- name str
- object_
type str - organization
Get
Workflow Workflow Info Organization - output str
- owners Sequence[str]
- parent
Get
Workflow Workflow Info Parent - parent_
task_ Getinfo Workflow Workflow Info Parent Task Info - pause_
reason str - permission
Get
Workflow Workflow Info Permission - permission_
resources Sequence[GetWorkflow Workflow Info Permission Resource] - progress float
- properties
Get
Workflow Workflow Info Properties - retry_
from_ strtask_ name - str
- src str
- start_
time str - status str
- success_
workflow_ floatcleanup_ duration - Sequence[Get
Workflow 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
- account
Moid String - action String
- additional
Properties String - ancestors List<Property Map>
- associated
Object Property Map - class
Id String - cleanup
Time String - create
Time String - domain
Group StringMoid - email String
- end
Time String - failed
Workflow NumberCleanup Duration - input String
- inst
Id String - internal Boolean
- last
Action String - messages List<Property Map>
- mod
Time String - moid String
- name String
- object
Type String - organization Property Map
- output String
- owners List<String>
- parent Property Map
- parent
Task Property MapInfo - pause
Reason String - permission Property Map
- permission
Resources List<Property Map> - progress Number
- properties Property Map
- retry
From StringTask Name - String
- src String
- start
Time String - status String
- success
Workflow NumberCleanup Duration - List<Property Map>
- task
Info Property MapUpdate - task
Infos List<Property Map> - trace
Id String - type String
- user
Action BooleanRequired - user
Id String - variable String
- version
Context Property Map - wait
Reason String - workflow
Ctx Property Map - workflow
Definition Property Map - workflow
Status String
Supporting Types
GetWorkflowWorkflowInfoAccount
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Message string
- An i18n message that can be translated into multiple languages to support internationalization.
- Object
Type 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Message string
- An i18n message that can be translated into multiple languages to support internationalization.
- Object
Type 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- message String
- An i18n message that can be translated into multiple languages to support internationalization.
- object
Type 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- message string
- An i18n message that can be translated into multiple languages to support internationalization.
- object
Type 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.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- message String
- An i18n message that can be translated into multiple languages to support internationalization.
- object
Type 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Cancelable
Get
Workflow Workflow Info Properties Cancelable - Holds the parameters and conditions for a workflow to be cancelable.
- Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Object
Type 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.
- Rollback
Action 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.
- 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.
- Additional
Properties string - Cancelable
Get
Workflow Workflow Info Properties Cancelable - Holds the parameters and conditions for a workflow to be cancelable.
- Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Object
Type 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.
- Rollback
Action 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.
- 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.
- additional
Properties String - cancelable
Get
Workflow Workflow Info Properties Cancelable - Holds the parameters and conditions for a workflow to be cancelable.
- class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- object
Type 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.
- rollback
Action 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.
- rollback
On BooleanCancel - When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollback
On BooleanFailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additional
Properties string - cancelable
Get
Workflow Workflow Info Properties Cancelable - Holds the parameters and conditions for a workflow to be cancelable.
- class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- object
Type 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.
- rollback
Action 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.
- rollback
On booleanCancel - When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollback
On booleanFailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additional_
properties str - cancelable
Get
Workflow 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.
- additional
Properties String - cancelable Property Map
- Holds the parameters and conditions for a workflow to be cancelable.
- class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- object
Type 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.
- rollback
Action 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.
- rollback
On BooleanCancel - When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollback
On BooleanFailure - When set to true, the changes are automatically rolled back if the workflow fails to execute.
GetWorkflowWorkflowInfoPropertiesCancelable
- Additional
Properties string - Cancelable
States List<string> - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Additional
Properties string - Cancelable
States []string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additional
Properties String - cancelable
States List<String> - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additional
Properties string - cancelable
States string[] - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- object
Type 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.
- additional
Properties String - cancelable
States List<String> - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
GetWorkflowWorkflowInfoResult
- Account
Moid string - The Account ID for this managed object.
- Accounts
List<Get
Workflow 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. - Additional
Properties string - Ancestors
List<Get
Workflow Workflow Info Result Ancestor> - Associated
Objects List<GetWorkflow Workflow Info Result Associated Object> - Class
Id string - Cleanup
Time 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.
- Create
Time string - The time when this managed object was created.
- Domain
Group 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.
- End
Time string - The time when the workflow reached a final state.
- Failed
Workflow 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
- Inst
Id 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.
- Last
Action 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<Get
Workflow Workflow Info Result Message> - Mod
Time 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.
- Object
Type string - Organizations
List<Get
Workflow Workflow Info Result Organization> - Output string
- Owners List<string>
- Parent
Task List<GetInfos Workflow Workflow Info Result Parent Task Info> - Parents
List<Get
Workflow Workflow Info Result Parent> - Pause
Reason 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
Resources List<GetWorkflow Workflow Info Result Permission Resource> - Permissions
List<Get
Workflow 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<Get
Workflow Workflow Info Result Property> - Retry
From 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.
- Start
Time 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.
- Success
Workflow 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<Get
Workflow Workflow Info Result Tag> - Task
Info List<GetUpdates Workflow Workflow Info Result Task Info Update> - Task
Infos List<GetWorkflow Workflow Info Result Task Info> - Trace
Id string - The trace id to keep track of workflow execution.
- Type string
- 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 string - The user identifier which indicates the user that started this workflow.
- Variable string
- Version
Contexts List<GetWorkflow Workflow Info Result Version Context> - Wait
Reason 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. - Workflow
Ctxes List<GetWorkflow Workflow Info Result Workflow Ctx> - Workflow
Definitions List<GetWorkflow Workflow Info Result Workflow Definition> - Workflow
Status 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 string - The Account ID for this managed object.
- Accounts
[]Get
Workflow 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. - Additional
Properties string - Ancestors
[]Get
Workflow Workflow Info Result Ancestor - Associated
Objects []GetWorkflow Workflow Info Result Associated Object - Class
Id string - Cleanup
Time 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.
- Create
Time string - The time when this managed object was created.
- Domain
Group 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.
- End
Time string - The time when the workflow reached a final state.
- Failed
Workflow 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
- Inst
Id 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.
- Last
Action 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
[]Get
Workflow Workflow Info Result Message - Mod
Time 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.
- Object
Type string - Organizations
[]Get
Workflow Workflow Info Result Organization - Output string
- Owners []string
- Parent
Task []GetInfos Workflow Workflow Info Result Parent Task Info - Parents
[]Get
Workflow Workflow Info Result Parent - Pause
Reason 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
Resources []GetWorkflow Workflow Info Result Permission Resource - Permissions
[]Get
Workflow 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
[]Get
Workflow Workflow Info Result Property - Retry
From 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.
- Start
Time 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.
- Success
Workflow 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.
- []Get
Workflow Workflow Info Result Tag - Task
Info []GetUpdates Workflow Workflow Info Result Task Info Update - Task
Infos []GetWorkflow Workflow Info Result Task Info - Trace
Id string - The trace id to keep track of workflow execution.
- Type string
- 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 string - The user identifier which indicates the user that started this workflow.
- Variable string
- Version
Contexts []GetWorkflow Workflow Info Result Version Context - Wait
Reason 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. - Workflow
Ctxes []GetWorkflow Workflow Info Result Workflow Ctx - Workflow
Definitions []GetWorkflow Workflow Info Result Workflow Definition - Workflow
Status 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 String - The Account ID for this managed object.
- accounts
List<Get
Workflow 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. - additional
Properties String - ancestors
List<Get
Workflow Workflow Info Result Ancestor> - associated
Objects List<GetWorkflow Workflow Info Result Associated Object> - class
Id String - cleanup
Time 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.
- create
Time String - The time when this managed object was created.
- domain
Group 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.
- end
Time String - The time when the workflow reached a final state.
- failed
Workflow 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
- inst
Id 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.
- last
Action 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<Get
Workflow Workflow Info Result Message> - mod
Time 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.
- object
Type String - organizations
List<Get
Workflow Workflow Info Result Organization> - output String
- owners List<String>
- parent
Task List<GetInfos Workflow Workflow Info Result Parent Task Info> - parents
List<Get
Workflow Workflow Info Result Parent> - pause
Reason 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
Resources List<GetWorkflow Workflow Info Result Permission Resource> - permissions
List<Get
Workflow 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<Get
Workflow Workflow Info Result Property> - retry
From 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.
- start
Time 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.
- success
Workflow 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<Get
Workflow Workflow Info Result Tag> - task
Info List<GetUpdates Workflow Workflow Info Result Task Info Update> - task
Infos List<GetWorkflow Workflow Info Result Task Info> - trace
Id String - The trace id to keep track of workflow execution.
- type String
- A type of the workflow (serverconfig, ansible_monitoring).
- user
Action 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.
- user
Id String - The user identifier which indicates the user that started this workflow.
- variable String
- version
Contexts List<GetWorkflow Workflow Info Result Version Context> - wait
Reason 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. - workflow
Ctxes List<GetWorkflow Workflow Info Result Workflow Ctx> - workflow
Definitions List<GetWorkflow Workflow Info Result Workflow Definition> - workflow
Status 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 string - The Account ID for this managed object.
- accounts
Get
Workflow 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. - additional
Properties string - ancestors
Get
Workflow Workflow Info Result Ancestor[] - associated
Objects GetWorkflow Workflow Info Result Associated Object[] - class
Id string - cleanup
Time 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.
- create
Time string - The time when this managed object was created.
- domain
Group 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.
- end
Time string - The time when the workflow reached a final state.
- failed
Workflow 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
- inst
Id 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.
- last
Action 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
Get
Workflow Workflow Info Result Message[] - mod
Time 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.
- object
Type string - organizations
Get
Workflow Workflow Info Result Organization[] - output string
- owners string[]
- parent
Task GetInfos Workflow Workflow Info Result Parent Task Info[] - parents
Get
Workflow Workflow Info Result Parent[] - pause
Reason 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
Resources GetWorkflow Workflow Info Result Permission Resource[] - permissions
Get
Workflow 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
Get
Workflow Workflow Info Result Property[] - retry
From 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.
- start
Time 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.
- success
Workflow 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.
- Get
Workflow Workflow Info Result Tag[] - task
Info GetUpdates Workflow Workflow Info Result Task Info Update[] - task
Infos GetWorkflow Workflow Info Result Task Info[] - trace
Id string - The trace id to keep track of workflow execution.
- type string
- A type of the workflow (serverconfig, ansible_monitoring).
- user
Action 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.
- user
Id string - The user identifier which indicates the user that started this workflow.
- variable string
- version
Contexts GetWorkflow Workflow Info Result Version Context[] - wait
Reason 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. - workflow
Ctxes GetWorkflow Workflow Info Result Workflow Ctx[] - workflow
Definitions GetWorkflow Workflow Info Result Workflow Definition[] - workflow
Status 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[Get
Workflow 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[Get
Workflow 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[Get
Workflow 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[Get
Workflow Workflow Info Result Organization] - output str
- owners Sequence[str]
- parent_
task_ Sequence[Getinfos Workflow Workflow Info Result Parent Task Info] - parents
Sequence[Get
Workflow 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[Get
Workflow 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[Get
Workflow 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[Get
Workflow 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.
- account
Moid 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. - additional
Properties String - ancestors List<Property Map>
- associated
Objects List<Property Map> - class
Id String - cleanup
Time 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.
- create
Time String - The time when this managed object was created.
- domain
Group 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.
- end
Time String - The time when the workflow reached a final state.
- failed
Workflow 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
- inst
Id 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.
- last
Action 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>
- mod
Time 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.
- object
Type String - organizations List<Property Map>
- output String
- owners List<String>
- parent
Task List<Property Map>Infos - parents List<Property Map>
- pause
Reason 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
Resources 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>
- retry
From 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.
- start
Time 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.
- success
Workflow 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>
- task
Info List<Property Map>Updates - task
Infos List<Property Map> - trace
Id String - The trace id to keep track of workflow execution.
- type String
- A type of the workflow (serverconfig, ansible_monitoring).
- user
Action 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.
- user
Id String - The user identifier which indicates the user that started this workflow.
- variable String
- version
Contexts List<Property Map> - wait
Reason 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. - workflow
Ctxes List<Property Map> - workflow
Definitions List<Property Map> - workflow
Status 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
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultAncestor
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultAssociatedObject
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultMessage
- Additional
Properties string - Class
Id string - Message string
- Object
Type string - Severity string
- Additional
Properties string - Class
Id string - Message string
- Object
Type string - Severity string
- additional
Properties String - class
Id String - message String
- object
Type String - severity String
- additional
Properties string - class
Id string - message string
- object
Type string - severity string
- additional_
properties str - class_
id str - message str
- object_
type str - severity str
- additional
Properties String - class
Id String - message String
- object
Type String - severity String
GetWorkflowWorkflowInfoResultOrganization
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultParent
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultParentTaskInfo
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultPermission
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultPermissionResource
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultProperty
- Additional
Properties string - Cancelables
List<Get
Workflow Workflow Info Result Property Cancelable> - Class
Id string - Object
Type string - Retryable bool
- Rollback
Action string - Rollback
On boolCancel - Rollback
On boolFailure
- Additional
Properties string - Cancelables
[]Get
Workflow Workflow Info Result Property Cancelable - Class
Id string - Object
Type string - Retryable bool
- Rollback
Action string - Rollback
On boolCancel - Rollback
On boolFailure
- additional
Properties String - cancelables
List<Get
Workflow Workflow Info Result Property Cancelable> - class
Id String - object
Type String - retryable Boolean
- rollback
Action String - rollback
On BooleanCancel - rollback
On BooleanFailure
- additional
Properties string - cancelables
Get
Workflow Workflow Info Result Property Cancelable[] - class
Id string - object
Type string - retryable boolean
- rollback
Action string - rollback
On booleanCancel - rollback
On booleanFailure
- additional
Properties String - cancelables List<Property Map>
- class
Id String - object
Type String - retryable Boolean
- rollback
Action String - rollback
On BooleanCancel - rollback
On BooleanFailure
GetWorkflowWorkflowInfoResultPropertyCancelable
- Additional
Properties string - Cancelable
States List<string> - Class
Id string - Enabled bool
- Mode string
- Object
Type string
- Additional
Properties string - Cancelable
States []string - Class
Id string - Enabled bool
- Mode string
- Object
Type string
- additional
Properties String - cancelable
States List<String> - class
Id String - enabled Boolean
- mode String
- object
Type String
- additional
Properties string - cancelable
States string[] - class
Id string - enabled boolean
- mode string
- object
Type string
- additional_
properties str - cancelable_
states Sequence[str] - class_
id str - enabled bool
- mode str
- object_
type str
- additional
Properties String - cancelable
States List<String> - class
Id String - enabled Boolean
- mode String
- object
Type String
GetWorkflowWorkflowInfoResultTag
- Additional
Properties string - Key string
- Value string
- Additional
Properties string - Key string
- Value string
- additional
Properties String - key String
- value String
- additional
Properties string - key string
- value string
- additional_
properties str - key str
- value str
- additional
Properties String - key String
- value String
GetWorkflowWorkflowInfoResultTaskInfo
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultTaskInfoUpdate
- Additional
Properties string - Class
Id string - Input string
- Name string
- A name of the workflow execution instance.
- Object
Type 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 string - Class
Id string - Input string
- Name string
- A name of the workflow execution instance.
- Object
Type 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 String - class
Id String - input String
- name String
- A name of the workflow execution instance.
- object
Type 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 string - class
Id string - input string
- name string
- A name of the workflow execution instance.
- object
Type 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.
- additional
Properties String - class
Id String - input String
- name String
- A name of the workflow execution instance.
- object
Type 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
- additional
Properties String - class
Id String - interested
Mos List<Property Map> - marked
For BooleanDeletion - nr
Version String - object
Type String - ref
Mos List<Property Map> - timestamp String
- version
Type String
GetWorkflowWorkflowInfoResultVersionContextInterestedMo
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultVersionContextRefMo
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoResultWorkflowCtx
- additional
Properties String - class
Id String - initiator
Ctxes List<Property Map> - object
Type String - target
Ctx List<Property Map>Lists - workflow
Subtype String - workflow
Type String
GetWorkflowWorkflowInfoResultWorkflowCtxInitiatorCtx
- Additional
Properties string - Class
Id string - Initiator
Moid string - Initiator
Name string - Initiator
Type string - Object
Type string
- Additional
Properties string - Class
Id string - Initiator
Moid string - Initiator
Name string - Initiator
Type string - Object
Type string
- additional
Properties String - class
Id String - initiator
Moid String - initiator
Name String - initiator
Type String - object
Type String
- additional
Properties string - class
Id string - initiator
Moid string - initiator
Name string - initiator
Type string - object
Type string
- additional_
properties str - class_
id str - initiator_
moid str - initiator_
name str - initiator_
type str - object_
type str
- additional
Properties String - class
Id String - initiator
Moid String - initiator
Name String - initiator
Type String - object
Type String
GetWorkflowWorkflowInfoResultWorkflowCtxTargetCtxList
- Additional
Properties string - Class
Id string - Object
Type string - Target
Moid string - Target
Name string - Target
Type string
- Additional
Properties string - Class
Id string - Object
Type string - Target
Moid string - Target
Name string - Target
Type string
- additional
Properties String - class
Id String - object
Type String - target
Moid String - target
Name String - target
Type String
- additional
Properties string - class
Id string - object
Type string - target
Moid string - target
Name string - target
Type string
- additional_
properties str - class_
id str - object_
type str - target_
moid str - target_
name str - target_
type str
- additional
Properties String - class
Id String - object
Type String - target
Moid String - target
Name String - target
Type String
GetWorkflowWorkflowInfoResultWorkflowDefinition
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- Additional
Properties string - Class
Id string - Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - Selector string
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
- additional
Properties string - class
Id string - moid string
- The unique identifier of this Managed Object instance.
- object
Type string - selector string
- additional_
properties str - class_
id str - moid str
- The unique identifier of this Managed Object instance.
- object_
type str - selector str
- additional
Properties String - class
Id String - moid String
- The unique identifier of this Managed Object instance.
- object
Type String - selector String
GetWorkflowWorkflowInfoTag
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
- additional
Properties string - key string
- The string representation of a tag key.
- value string
- The string representation of a tag value.
- additional_
properties str - key str
- The string representation of a tag key.
- value str
- The string representation of a tag value.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
GetWorkflowWorkflowInfoTaskInfo
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- Object
Type 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- Object
Type 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- object
Type 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- object
Type 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.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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.
- object
Type 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Interested
Mos List<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 string - The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Ref
Mo GetWorkflow Workflow Info Version Context Ref Mo - A reference to the original Managed Object.
- Timestamp string
- The time this versioned Managed Object was created.
- Version
Type 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Interested
Mos []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 string - The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Ref
Mo GetWorkflow Workflow Info Version Context Ref Mo - A reference to the original Managed Object.
- Timestamp string
- The time this versioned Managed Object was created.
- Version
Type 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- interested
Mos List<GetWorkflow Workflow Info Version Context Interested Mo> - marked
For 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.
- nr
Version String - The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- ref
Mo GetWorkflow Workflow Info Version Context Ref Mo - A reference to the original Managed Object.
- timestamp String
- The time this versioned Managed Object was created.
- version
Type 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- interested
Mos GetWorkflow Workflow Info Version Context Interested Mo[] - marked
For 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.
- nr
Version string - The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- ref
Mo GetWorkflow Workflow Info Version Context Ref Mo - A reference to the original Managed Object.
- timestamp string
- The time this versioned Managed Object was created.
- version
Type 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.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- interested
Mos List<Property Map> - marked
For 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.
- nr
Version String - The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- ref
Mo Property Map - A reference to the original Managed Object.
- timestamp String
- The time this versioned Managed Object was created.
- version
Type 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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 string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Target
Ctx List<GetLists Workflow Workflow Info Workflow Ctx Target Ctx List> - Workflow
Subtype 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.
- Workflow
Type 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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 string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Target
Ctx []GetLists Workflow Workflow Info Workflow Ctx Target Ctx List - Workflow
Subtype 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.
- Workflow
Type 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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 String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- target
Ctx List<GetLists Workflow Workflow Info Workflow Ctx Target Ctx List> - workflow
Subtype 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.
- workflow
Type 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- 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 string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- target
Ctx GetLists Workflow Workflow Info Workflow Ctx Target Ctx List[] - workflow
Subtype 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.
- workflow
Type 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.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiator
Ctx 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.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- target
Ctx List<Property Map>Lists - workflow
Subtype 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.
- workflow
Type 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
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Initiator
Moid string - The moid of the Intersight managed object that initiated the workflow.
- Initiator
Name string - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- Initiator
Type string - Type of Intersight managed object that initiated the workflow.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Initiator
Moid string - The moid of the Intersight managed object that initiated the workflow.
- Initiator
Name string - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- Initiator
Type string - Type of Intersight managed object that initiated the workflow.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiator
Moid String - The moid of the Intersight managed object that initiated the workflow.
- initiator
Name String - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiator
Type String - Type of Intersight managed object that initiated the workflow.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- additional
Properties string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiator
Moid string - The moid of the Intersight managed object that initiated the workflow.
- initiator
Name string - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiator
Type string - Type of Intersight managed object that initiated the workflow.
- object
Type 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.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- initiator
Moid String - The moid of the Intersight managed object that initiated the workflow.
- initiator
Name String - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiator
Type String - Type of Intersight managed object that initiated the workflow.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
GetWorkflowWorkflowInfoWorkflowCtxTargetCtxList
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Target
Moid string - Moid of the target Intersight managed object.
- Target
Name string - Name of the target instance.
- Target
Type string - Object type of the target Intersight managed object.
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Target
Moid string - Moid of the target Intersight managed object.
- Target
Name string - Name of the target instance.
- Target
Type string - Object type of the target Intersight managed object.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- target
Moid String - Moid of the target Intersight managed object.
- target
Name String - Name of the target instance.
- target
Type String - Object type of the target Intersight managed object.
- additional
Properties string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- target
Moid string - Moid of the target Intersight managed object.
- target
Name string - Name of the target instance.
- target
Type 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.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- target
Moid String - Moid of the target Intersight managed object.
- target
Name String - Name of the target instance.
- target
Type String - Object type of the target Intersight managed object.
GetWorkflowWorkflowInfoWorkflowDefinition
- Additional
Properties string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Moid string
- The unique identifier of this Managed Object instance.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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 String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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 string - class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid string
- The unique identifier of this Managed Object instance.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field 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'.
- additional
Properties String - class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- moid String
- The unique identifier of this Managed Object instance.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field 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
intersight
Terraform Provider.