intersight.getWorkflowWorkflowInfo

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.

Account GetWorkflowWorkflowInfoAccount

AccountMoid string

The Account ID for this managed object.

Action string

The action of the workflow such as start, cancel, retry, pause.* None - No action is set, this is the default value for action field.* Create - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.* Start - Start a new execution of the workflow.* Pause - Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.* Resume - Resume the workflow which was previously paused through pause action on the workflow.* Rerun - Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.* Retry - This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.* RetryFailed - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.* RetryFromTask - Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.* Cancel - Cancel the workflow that is in running or waiting state.

AdditionalProperties string

Ancestors List<GetWorkflowWorkflowInfoAncestor>

AssociatedObject GetWorkflowWorkflowInfoAssociatedObject

ClassId string

CleanupTime string

The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.

CreateTime string

The time when this managed object was created.

DomainGroupMoid string

The DomainGroup ID for this managed object.

Email string

The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.

EndTime string

The time when the workflow reached a final state.

FailedWorkflowCleanupDuration double

The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.

Id string

Input string

InstId string

A workflow instance Id which is the unique identified for the workflow execution.

Internal bool

Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.

LastAction string

The last action that was issued on the workflow is saved in this field.* None - No action is set, this is the default value for action field.* Create - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.* Start - Start a new execution of the workflow.* Pause - Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.* Resume - Resume the workflow which was previously paused through pause action on the workflow.* Rerun - Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.* Retry - This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.* RetryFailed - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.* RetryFromTask - Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.* Cancel - Cancel the workflow that is in running or waiting state.

Messages List<GetWorkflowWorkflowInfoMessage>

ModTime string

The time when this managed object was last modified.

Moid string

The unique identifier of this Managed Object instance.

Name string

A name of the workflow execution instance.

ObjectType string

Organization GetWorkflowWorkflowInfoOrganization

Output string

Owners List<string>

Parent GetWorkflowWorkflowInfoParent

ParentTaskInfo GetWorkflowWorkflowInfoParentTaskInfo

PauseReason string

Denotes the reason workflow is in paused status.* None - Pause reason is none, which indicates there is no reason for the pause state.* TaskWithWarning - Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.* SystemMaintenance - Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.

Permission GetWorkflowWorkflowInfoPermission

PermissionResources List<GetWorkflowWorkflowInfoPermissionResource>

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 GetWorkflowWorkflowInfoProperties

RetryFromTaskName string

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.

SharedScope string

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

Src string

The source service that started the workflow execution and hence represents the owning service for this workflow.

StartTime string

The time when the workflow was started for execution.

Status string

A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.

SuccessWorkflowCleanupDuration double

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.

Tags List<GetWorkflowWorkflowInfoTag>

TaskInfoUpdate GetWorkflowWorkflowInfoTaskInfoUpdate

TaskInfos List<GetWorkflowWorkflowInfoTaskInfo>

TraceId string

The trace id to keep track of workflow execution.

Type string

A type of the workflow (serverconfig, ansible_monitoring).

UserActionRequired bool

Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.

UserId string

The user identifier which indicates the user that started this workflow.

Variable string

VersionContext GetWorkflowWorkflowInfoVersionContext

WaitReason string

Denotes the reason workflow is in waiting status.* None - Wait reason is none, which indicates there is no reason for the waiting state.* GatherTasks - Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.* Duplicate - Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.* RateLimit - Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.* WaitTask - Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.* PendingRetryFailed - Wait reason when the workflow is pending a RetryFailed action.* WaitingToStart - Workflow is waiting to start on workflow engine.

WorkflowCtx GetWorkflowWorkflowInfoWorkflowCtx

WorkflowDefinition GetWorkflowWorkflowInfoWorkflowDefinition

WorkflowStatus string

The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted - Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.* InProgress - A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.* Waiting - Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.* Completed - A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.* Failed - A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.* Terminated - A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.* Canceled - A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.* Paused - A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.

Account GetWorkflowWorkflowInfoAccount

AccountMoid string

The Account ID for this managed object.

Action string

The action of the workflow such as start, cancel, retry, pause.* None - No action is set, this is the default value for action field.* Create - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.* Start - Start a new execution of the workflow.* Pause - Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.* Resume - Resume the workflow which was previously paused through pause action on the workflow.* Rerun - Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.* Retry - This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.* RetryFailed - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.* RetryFromTask - Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.* Cancel - Cancel the workflow that is in running or waiting state.

AdditionalProperties string

Ancestors []GetWorkflowWorkflowInfoAncestor

AssociatedObject GetWorkflowWorkflowInfoAssociatedObject

ClassId string

CleanupTime string

The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.

CreateTime string

The time when this managed object was created.

DomainGroupMoid string

The DomainGroup ID for this managed object.

Email string

The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.

EndTime string

The time when the workflow reached a final state.

FailedWorkflowCleanupDuration float64

The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.

Id string

Input string

InstId string

A workflow instance Id which is the unique identified for the workflow execution.

Internal bool

Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.

LastAction string

The last action that was issued on the workflow is saved in this field.* None - No action is set, this is the default value for action field.* Create - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.* Start - Start a new execution of the workflow.* Pause - Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.* Resume - Resume the workflow which was previously paused through pause action on the workflow.* Rerun - Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.* Retry - This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.* RetryFailed - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.* RetryFromTask - Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.* Cancel - Cancel the workflow that is in running or waiting state.

Messages []GetWorkflowWorkflowInfoMessage

ModTime string

The time when this managed object was last modified.

Moid string

The unique identifier of this Managed Object instance.

Name string

A name of the workflow execution instance.

ObjectType string

Organization GetWorkflowWorkflowInfoOrganization

Output string

Owners []string

Parent GetWorkflowWorkflowInfoParent

ParentTaskInfo GetWorkflowWorkflowInfoParentTaskInfo

PauseReason string

Denotes the reason workflow is in paused status.* None - Pause reason is none, which indicates there is no reason for the pause state.* TaskWithWarning - Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.* SystemMaintenance - Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.

Permission GetWorkflowWorkflowInfoPermission

PermissionResources []GetWorkflowWorkflowInfoPermissionResource

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 GetWorkflowWorkflowInfoProperties

RetryFromTaskName string

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.

SharedScope string

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

Src string

The source service that started the workflow execution and hence represents the owning service for this workflow.

StartTime string

The time when the workflow was started for execution.

Status string

A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.

SuccessWorkflowCleanupDuration float64

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.

Tags []GetWorkflowWorkflowInfoTag

TaskInfoUpdate GetWorkflowWorkflowInfoTaskInfoUpdate

TaskInfos []GetWorkflowWorkflowInfoTaskInfo

TraceId string

The trace id to keep track of workflow execution.

Type string

A type of the workflow (serverconfig, ansible_monitoring).

UserActionRequired bool

Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.

UserId string

The user identifier which indicates the user that started this workflow.

Variable string

VersionContext GetWorkflowWorkflowInfoVersionContext

WaitReason string

Denotes the reason workflow is in waiting status.* None - Wait reason is none, which indicates there is no reason for the waiting state.* GatherTasks - Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.* Duplicate - Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.* RateLimit - Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.* WaitTask - Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.* PendingRetryFailed - Wait reason when the workflow is pending a RetryFailed action.* WaitingToStart - Workflow is waiting to start on workflow engine.

WorkflowCtx GetWorkflowWorkflowInfoWorkflowCtx

WorkflowDefinition GetWorkflowWorkflowInfoWorkflowDefinition

WorkflowStatus string

The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted - Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.* InProgress - A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.* Waiting - Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.* Completed - A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.* Failed - A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.* Terminated - A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.* Canceled - A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.* Paused - A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.

account GetWorkflowWorkflowInfoAccount

accountMoid String

The Account ID for this managed object.

action String

The action of the workflow such as start, cancel, retry, pause.* None - No action is set, this is the default value for action field.* Create - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.* Start - Start a new execution of the workflow.* Pause - Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.* Resume - Resume the workflow which was previously paused through pause action on the workflow.* Rerun - Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.* Retry - This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.* RetryFailed - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.* RetryFromTask - Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.* Cancel - Cancel the workflow that is in running or waiting state.

additionalProperties String

ancestors List<GetWorkflowWorkflowInfoAncestor>

associatedObject GetWorkflowWorkflowInfoAssociatedObject

classId String

cleanupTime String

The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.

createTime String

The time when this managed object was created.

domainGroupMoid String

The DomainGroup ID for this managed object.

email String

The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.

endTime String

The time when the workflow reached a final state.

failedWorkflowCleanupDuration Double

The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.

id String

input String

instId String

A workflow instance Id which is the unique identified for the workflow execution.

internal Boolean

Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.

lastAction String

The last action that was issued on the workflow is saved in this field.* None - No action is set, this is the default value for action field.* Create - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.* Start - Start a new execution of the workflow.* Pause - Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.* Resume - Resume the workflow which was previously paused through pause action on the workflow.* Rerun - Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.* Retry - This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.* RetryFailed - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.* RetryFromTask - Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.* Cancel - Cancel the workflow that is in running or waiting state.

messages List<GetWorkflowWorkflowInfoMessage>

modTime String

The time when this managed object was last modified.

moid String

The unique identifier of this Managed Object instance.

name String

A name of the workflow execution instance.

objectType String

organization GetWorkflowWorkflowInfoOrganization

output String

owners List<String>

parent GetWorkflowWorkflowInfoParent

parentTaskInfo GetWorkflowWorkflowInfoParentTaskInfo

pauseReason String

Denotes the reason workflow is in paused status.* None - Pause reason is none, which indicates there is no reason for the pause state.* TaskWithWarning - Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.* SystemMaintenance - Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.

permission GetWorkflowWorkflowInfoPermission

permissionResources List<GetWorkflowWorkflowInfoPermissionResource>

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 GetWorkflowWorkflowInfoProperties

retryFromTaskName String

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.

sharedScope String

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

src String

The source service that started the workflow execution and hence represents the owning service for this workflow.

startTime String

The time when the workflow was started for execution.

status String

A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.

successWorkflowCleanupDuration Double

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.

tags List<GetWorkflowWorkflowInfoTag>

taskInfoUpdate GetWorkflowWorkflowInfoTaskInfoUpdate

taskInfos List<GetWorkflowWorkflowInfoTaskInfo>

traceId String

The trace id to keep track of workflow execution.

type String

A type of the workflow (serverconfig, ansible_monitoring).

userActionRequired Boolean

Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.

userId String

The user identifier which indicates the user that started this workflow.

variable String

versionContext GetWorkflowWorkflowInfoVersionContext

waitReason String

Denotes the reason workflow is in waiting status.* None - Wait reason is none, which indicates there is no reason for the waiting state.* GatherTasks - Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.* Duplicate - Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.* RateLimit - Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.* WaitTask - Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.* PendingRetryFailed - Wait reason when the workflow is pending a RetryFailed action.* WaitingToStart - Workflow is waiting to start on workflow engine.

workflowCtx GetWorkflowWorkflowInfoWorkflowCtx

workflowDefinition GetWorkflowWorkflowInfoWorkflowDefinition

workflowStatus String

The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted - Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.* InProgress - A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.* Waiting - Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.* Completed - A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.* Failed - A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.* Terminated - A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.* Canceled - A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.* Paused - A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.

account GetWorkflowWorkflowInfoAccount

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[GetWorkflowWorkflowInfoAncestor]

associated_object GetWorkflowWorkflowInfoAssociatedObject

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_moid str

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_cleanup_duration float

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[GetWorkflowWorkflowInfoMessage]

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 GetWorkflowWorkflowInfoOrganization

output str

owners Sequence[str]

parent GetWorkflowWorkflowInfoParent

parent_task_info GetWorkflowWorkflowInfoParentTaskInfo

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 GetWorkflowWorkflowInfoPermission

permission_resources Sequence[GetWorkflowWorkflowInfoPermissionResource]

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 GetWorkflowWorkflowInfoProperties

retry_from_task_name str

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.

shared_scope 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_cleanup_duration float

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.

tags Sequence[GetWorkflowWorkflowInfoTag]

task_info_update GetWorkflowWorkflowInfoTaskInfoUpdate

task_infos Sequence[GetWorkflowWorkflowInfoTaskInfo]

trace_id str

The trace id to keep track of workflow execution.

type str

A type of the workflow (serverconfig, ansible_monitoring).

user_action_required bool

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 GetWorkflowWorkflowInfoVersionContext

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 GetWorkflowWorkflowInfoWorkflowCtx

workflow_definition GetWorkflowWorkflowInfoWorkflowDefinition

workflow_status str

The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted - Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.* InProgress - A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.* Waiting - Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.* Completed - A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.* Failed - A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.* Terminated - A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.* Canceled - A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.* Paused - A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.

account Property Map

accountMoid String

The Account ID for this managed object.

action String

The action of the workflow such as start, cancel, retry, pause.* None - No action is set, this is the default value for action field.* Create - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.* Start - Start a new execution of the workflow.* Pause - Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.* Resume - Resume the workflow which was previously paused through pause action on the workflow.* Rerun - Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.* Retry - This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.* RetryFailed - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.* RetryFromTask - Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.* Cancel - Cancel the workflow that is in running or waiting state.

additionalProperties String

ancestors List<Property Map>

associatedObject Property Map

classId String

cleanupTime String

The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.

createTime String

The time when this managed object was created.

domainGroupMoid String

The DomainGroup ID for this managed object.

email String

The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.

endTime String

The time when the workflow reached a final state.

failedWorkflowCleanupDuration Number

The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.

id String

input String

instId String

A workflow instance Id which is the unique identified for the workflow execution.

internal Boolean

Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.

lastAction String

The last action that was issued on the workflow is saved in this field.* None - No action is set, this is the default value for action field.* Create - Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.* Start - Start a new execution of the workflow.* Pause - Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.* Resume - Resume the workflow which was previously paused through pause action on the workflow.* Rerun - Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.* Retry - This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.* RetryFailed - Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.* RetryFromTask - Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.* Cancel - Cancel the workflow that is in running or waiting state.

messages List<Property Map>

modTime String

The time when this managed object was last modified.

moid String

The unique identifier of this Managed Object instance.

name String

A name of the workflow execution instance.

objectType String

organization Property Map

output String

owners List<String>

parent Property Map

parentTaskInfo Property Map

pauseReason String

Denotes the reason workflow is in paused status.* None - Pause reason is none, which indicates there is no reason for the pause state.* TaskWithWarning - Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.* SystemMaintenance - Pause reason indicates the workflow is in this state based on actions of system admin for maintenance.

permission Property Map

permissionResources List<Property Map>

progress Number

This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.

properties Property Map

retryFromTaskName String

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.

sharedScope String

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

src String

The source service that started the workflow execution and hence represents the owning service for this workflow.

startTime String

The time when the workflow was started for execution.

status String

A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.

successWorkflowCleanupDuration Number

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.

tags List<Property Map>

taskInfoUpdate Property Map

taskInfos List<Property Map>

traceId String

The trace id to keep track of workflow execution.

type String

A type of the workflow (serverconfig, ansible_monitoring).

userActionRequired Boolean

Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.

userId String

The user identifier which indicates the user that started this workflow.

variable String

versionContext Property Map

waitReason String

Denotes the reason workflow is in waiting status.* None - Wait reason is none, which indicates there is no reason for the waiting state.* GatherTasks - Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.* Duplicate - Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.* RateLimit - Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.* WaitTask - Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.* PendingRetryFailed - Wait reason when the workflow is pending a RetryFailed action.* WaitingToStart - Workflow is waiting to start on workflow engine.

workflowCtx Property Map

workflowDefinition Property Map

workflowStatus String

The current state of the workflow execution instance. A draft workflow execution will be in NotStarted state and when \ Start\ action is issued then the workflow will move into Waiting state until the first task of the workflow is scheduled at which time it will move into InProgress state. When execution reaches a final state it move to either Completed, Failed or Terminated state. For more details look at the description for each state.* NotStarted - Initially all the workflow instances are at \ NotStarted\ state. A workflow can be drafted in this state by issuing Create action. When a workflow is in this state the inputs can be updated until the workflow is started.* InProgress - A workflow execution moves into \ InProgress\ state when the first task of the workflow is scheduled for execution and continues to remain in that state as long as there are tasks executing or yet to be scheduled for execution.* Waiting - Workflow can go to waiting state due to execution of wait task present in the workflow or the workflow has not started yet either due to duplicate workflow is running or due to workflow throttling. Once Workflow engine picks up the workflow for execution, it will move to in progress state.* Completed - A workflow execution moves into Completed state when the execution path of the workflow has reached the Success node in the workflow design and there are no more tasks to be executed. Completed is the final state for the workflow execution instance and no further actions are allowed on this workflow instance.* Failed - A workflow execution moves into a Failed state when the execution path of the workflow has reached the Failed node in the workflow design and there are no more tasks to be scheduled. A Failed node can be reached when the last executed task has failed or timed out and there are no further retries available for the task. Also as per the workflow design, the last executed task did not specify an OnFailure task to be executed and hence by default, the execution will reach the Failed node. Actions like \ Rerun\ , \ RetryFailed\ and \ RetryFromTask\ can be issued on failed workflow instances. Please refer to the \ Action\ description for more details.* Terminated - A workflow execution moves to Terminated state when user issues a \ Cancel\ action or due to internal errors caused during workflow execution. e.g. - Task input transformation has failed. Terminated is a final state of the workflow, no further action are allowed on this workflow instance.* Canceled - A workflow execution moves to Canceled state when a user issues a \ Cancel\ action. Cancel is not a final state, the workflow engine will issue cancel to all the running tasks and then move the workflow to the \ Terminated\ state.* Paused - A workflow execution moves to Paused state when user issues a \ Pause\ action. When in paused state the current running task will complete its execution but no further tasks will be scheduled until the workflow is resumed. A paused workflow is resumed when the user issues a \ Resume\ action. Paused workflows can be canceled by user.

Id string

Results List<GetWorkflowWorkflowInfoResult>

Account GetWorkflowWorkflowInfoAccount

AccountMoid string

Action string

AdditionalProperties string

Ancestors List<GetWorkflowWorkflowInfoAncestor>

AssociatedObject GetWorkflowWorkflowInfoAssociatedObject

ClassId string

CleanupTime string

CreateTime string

DomainGroupMoid string

Email string

EndTime string

FailedWorkflowCleanupDuration double

Input string

InstId string

Internal bool

LastAction string

Messages List<GetWorkflowWorkflowInfoMessage>

ModTime string

Moid string

Name string

ObjectType string

Organization GetWorkflowWorkflowInfoOrganization

Output string

Owners List<string>

Parent GetWorkflowWorkflowInfoParent

ParentTaskInfo GetWorkflowWorkflowInfoParentTaskInfo

PauseReason string

Permission GetWorkflowWorkflowInfoPermission

PermissionResources List<GetWorkflowWorkflowInfoPermissionResource>

Progress double

Properties GetWorkflowWorkflowInfoProperties

RetryFromTaskName string

SharedScope string

Src string

StartTime string

Status string

SuccessWorkflowCleanupDuration double

Tags List<GetWorkflowWorkflowInfoTag>

TaskInfoUpdate GetWorkflowWorkflowInfoTaskInfoUpdate

TaskInfos List<GetWorkflowWorkflowInfoTaskInfo>

TraceId string

Type string

UserActionRequired bool

UserId string

Variable string

VersionContext GetWorkflowWorkflowInfoVersionContext

WaitReason string

WorkflowCtx GetWorkflowWorkflowInfoWorkflowCtx

WorkflowDefinition GetWorkflowWorkflowInfoWorkflowDefinition

WorkflowStatus string

Id string

Results []GetWorkflowWorkflowInfoResult

Account GetWorkflowWorkflowInfoAccount

AccountMoid string

Action string

AdditionalProperties string

Ancestors []GetWorkflowWorkflowInfoAncestor

AssociatedObject GetWorkflowWorkflowInfoAssociatedObject

ClassId string

CleanupTime string

CreateTime string

DomainGroupMoid string

Email string

EndTime string

FailedWorkflowCleanupDuration float64

Input string

InstId string

Internal bool

LastAction string

Messages []GetWorkflowWorkflowInfoMessage

ModTime string

Moid string

Name string

ObjectType string

Organization GetWorkflowWorkflowInfoOrganization

Output string

Owners []string

Parent GetWorkflowWorkflowInfoParent

ParentTaskInfo GetWorkflowWorkflowInfoParentTaskInfo

PauseReason string

Permission GetWorkflowWorkflowInfoPermission

PermissionResources []GetWorkflowWorkflowInfoPermissionResource

Progress float64

Properties GetWorkflowWorkflowInfoProperties

RetryFromTaskName string

SharedScope string

Src string

StartTime string

Status string

SuccessWorkflowCleanupDuration float64

Tags []GetWorkflowWorkflowInfoTag

TaskInfoUpdate GetWorkflowWorkflowInfoTaskInfoUpdate

TaskInfos []GetWorkflowWorkflowInfoTaskInfo

TraceId string

Type string

UserActionRequired bool

UserId string

Variable string

VersionContext GetWorkflowWorkflowInfoVersionContext

WaitReason string

WorkflowCtx GetWorkflowWorkflowInfoWorkflowCtx

WorkflowDefinition GetWorkflowWorkflowInfoWorkflowDefinition

WorkflowStatus string

id String

results List<GetWorkflowWorkflowInfoResult>

account GetWorkflowWorkflowInfoAccount

accountMoid String

action String

additionalProperties String

ancestors List<GetWorkflowWorkflowInfoAncestor>

associatedObject GetWorkflowWorkflowInfoAssociatedObject

classId String

cleanupTime String

createTime String

domainGroupMoid String

email String

endTime String

failedWorkflowCleanupDuration Double

input String

instId String

internal Boolean

lastAction String

messages List<GetWorkflowWorkflowInfoMessage>

modTime String

moid String

name String

objectType String

organization GetWorkflowWorkflowInfoOrganization

output String

owners List<String>

parent GetWorkflowWorkflowInfoParent

parentTaskInfo GetWorkflowWorkflowInfoParentTaskInfo

pauseReason String

permission GetWorkflowWorkflowInfoPermission

permissionResources List<GetWorkflowWorkflowInfoPermissionResource>

progress Double

properties GetWorkflowWorkflowInfoProperties

retryFromTaskName String

sharedScope String

src String

startTime String

status String

successWorkflowCleanupDuration Double

tags List<GetWorkflowWorkflowInfoTag>

taskInfoUpdate GetWorkflowWorkflowInfoTaskInfoUpdate

taskInfos List<GetWorkflowWorkflowInfoTaskInfo>

traceId String

type String

userActionRequired Boolean

userId String

variable String

versionContext GetWorkflowWorkflowInfoVersionContext

waitReason String

workflowCtx GetWorkflowWorkflowInfoWorkflowCtx

workflowDefinition GetWorkflowWorkflowInfoWorkflowDefinition

workflowStatus String

id str

results Sequence[GetWorkflowWorkflowInfoResult]

account GetWorkflowWorkflowInfoAccount

account_moid str

action str

additional_properties str

ancestors Sequence[GetWorkflowWorkflowInfoAncestor]

associated_object GetWorkflowWorkflowInfoAssociatedObject

class_id str

cleanup_time str

create_time str

domain_group_moid str

email str

end_time str

failed_workflow_cleanup_duration float

input str

inst_id str

internal bool

last_action str

messages Sequence[GetWorkflowWorkflowInfoMessage]

mod_time str

moid str

name str

object_type str

organization GetWorkflowWorkflowInfoOrganization

output str

owners Sequence[str]

parent GetWorkflowWorkflowInfoParent

parent_task_info GetWorkflowWorkflowInfoParentTaskInfo

pause_reason str

permission GetWorkflowWorkflowInfoPermission

permission_resources Sequence[GetWorkflowWorkflowInfoPermissionResource]

progress float

properties GetWorkflowWorkflowInfoProperties

retry_from_task_name str

shared_scope str

src str

start_time str

status str

success_workflow_cleanup_duration float

tags Sequence[GetWorkflowWorkflowInfoTag]

task_info_update GetWorkflowWorkflowInfoTaskInfoUpdate

task_infos Sequence[GetWorkflowWorkflowInfoTaskInfo]

trace_id str

type str

user_action_required bool

user_id str

variable str

version_context GetWorkflowWorkflowInfoVersionContext

wait_reason str

workflow_ctx GetWorkflowWorkflowInfoWorkflowCtx

workflow_definition GetWorkflowWorkflowInfoWorkflowDefinition

workflow_status str

id String

results List<Property Map>

account Property Map

accountMoid String

action String

additionalProperties String

ancestors List<Property Map>

associatedObject Property Map

classId String

cleanupTime String

createTime String

domainGroupMoid String

email String

endTime String

failedWorkflowCleanupDuration Number

input String

instId String

internal Boolean

lastAction String

messages List<Property Map>

modTime String

moid String

name String

objectType String

organization Property Map

output String

owners List<String>

parent Property Map

parentTaskInfo Property Map

pauseReason String

permission Property Map

permissionResources List<Property Map>

progress Number

properties Property Map

retryFromTaskName String

sharedScope String

src String

startTime String

status String

successWorkflowCleanupDuration Number

tags List<Property Map>

taskInfoUpdate Property Map

taskInfos List<Property Map>

traceId String

type String

userActionRequired Boolean

userId String

variable String

versionContext Property Map

waitReason String

workflowCtx Property Map

workflowDefinition Property Map

workflowStatus String

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. 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.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. 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.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. 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.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Message string

An i18n message that can be translated into multiple languages to support internationalization.

ObjectType string

The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.

Severity string

The severity of the Task or Workflow message warning/error/info etc.

• Info - The enum represents the log level to be used to convey info message.
• Warning - The enum represents the log level to be used to convey warning message.
• Debug - The enum represents the log level to be used to convey debug message.
• Error - The enum represents the log level to be used to convey error message.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Message string

An i18n message that can be translated into multiple languages to support internationalization.

ObjectType string

The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.

Severity string

The severity of the Task or Workflow message warning/error/info etc.

• Info - The enum represents the log level to be used to convey info message.
• Warning - The enum represents the log level to be used to convey warning message.
• Debug - The enum represents the log level to be used to convey debug message.
• Error - The enum represents the log level to be used to convey error message.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

message String

An i18n message that can be translated into multiple languages to support internationalization.

objectType String

The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.

severity String

The severity of the Task or Workflow message warning/error/info etc.

• Info - The enum represents the log level to be used to convey info message.
• Warning - The enum represents the log level to be used to convey warning message.
• Debug - The enum represents the log level to be used to convey debug message.
• Error - The enum represents the log level to be used to convey error message.

additional_properties str

class_id str

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

message str

An i18n message that can be translated into multiple languages to support internationalization.

object_type str

The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.

severity str

The severity of the Task or Workflow message warning/error/info etc.

• Info - The enum represents the log level to be used to convey info message.
• Warning - The enum represents the log level to be used to convey warning message.
• Debug - The enum represents the log level to be used to convey debug message.
• Error - The enum represents the log level to be used to convey error message.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

message String

An i18n message that can be translated into multiple languages to support internationalization.

objectType String

The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.

severity String

The severity of the Task or Workflow message warning/error/info etc.

• Info - The enum represents the log level to be used to convey info message.
• Warning - The enum represents the log level to be used to convey warning message.
• Debug - The enum represents the log level to be used to convey debug message.
• Error - The enum represents the log level to be used to convey error message.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. 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.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. 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.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. 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.

1. If 'moid' is set this field is ignored.
2. 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'.