intersight.WorkflowWorkflowInfo
Explore with Pulumi AI
Contains information for a workflow which is an execution instance of the workflow definition given in the relationship. The workflow definition will provide the schema of the inputs taken to start the workflow execution and the schema of the outputs generated at the end of successful workflow execution. The sequence of tasks to be executed is also provided in the workflow definition. For a workflow to successfully start execution the following properties must be provided- Name, AssociatedObject that carries the relationship to Organization under which the workflow must be executed, WorkflowDefinition, and Inputs with all the required data in order to start workflow execution.
Usage Example
Resource Creation
import * as pulumi from "@pulumi/pulumi";
import * as intersight from "@pulumi/intersight";
const config = new pulumi.Config();
const workflowWorkflowDefinition = config.require("workflowWorkflowDefinition");
const workflowWorkflowInfo1 = new intersight.WorkflowWorkflowInfo("workflowWorkflowInfo1", {
action: "Create",
properties: [{
objectType: "workflow.WorkflowInfoProperties",
retryable: false,
}],
successWorkflowCleanupDuration: 2160,
organizations: [{
objectType: "organization.Organization",
moid: _var.organization,
}],
workflowDefinitions: [{
objectType: "workflow.WorkflowDefinition",
moid: workflowWorkflowDefinition,
}],
});
import pulumi
import pulumi_intersight as intersight
config = pulumi.Config()
workflow_workflow_definition = config.require("workflowWorkflowDefinition")
workflow_workflow_info1 = intersight.WorkflowWorkflowInfo("workflowWorkflowInfo1",
action="Create",
properties=[{
"object_type": "workflow.WorkflowInfoProperties",
"retryable": False,
}],
success_workflow_cleanup_duration=2160,
organizations=[{
"object_type": "organization.Organization",
"moid": var["organization"],
}],
workflow_definitions=[{
"object_type": "workflow.WorkflowDefinition",
"moid": workflow_workflow_definition,
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/intersight/intersight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
workflowWorkflowDefinition := cfg.Require("workflowWorkflowDefinition")
_, err := intersight.NewWorkflowWorkflowInfo(ctx, "workflowWorkflowInfo1", &intersight.WorkflowWorkflowInfoArgs{
Action: pulumi.String("Create"),
Properties: intersight.WorkflowWorkflowInfoPropertyArray{
&intersight.WorkflowWorkflowInfoPropertyArgs{
ObjectType: pulumi.String("workflow.WorkflowInfoProperties"),
Retryable: pulumi.Bool(false),
},
},
SuccessWorkflowCleanupDuration: pulumi.Float64(2160),
Organizations: intersight.WorkflowWorkflowInfoOrganizationArray{
&intersight.WorkflowWorkflowInfoOrganizationArgs{
ObjectType: pulumi.String("organization.Organization"),
Moid: pulumi.Any(_var.Organization),
},
},
WorkflowDefinitions: intersight.WorkflowWorkflowInfoWorkflowDefinitionArray{
&intersight.WorkflowWorkflowInfoWorkflowDefinitionArgs{
ObjectType: pulumi.String("workflow.WorkflowDefinition"),
Moid: pulumi.String(workflowWorkflowDefinition),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Intersight = Pulumi.Intersight;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var workflowWorkflowDefinition = config.Require("workflowWorkflowDefinition");
var workflowWorkflowInfo1 = new Intersight.WorkflowWorkflowInfo("workflowWorkflowInfo1", new()
{
Action = "Create",
Properties = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoPropertyArgs
{
ObjectType = "workflow.WorkflowInfoProperties",
Retryable = false,
},
},
SuccessWorkflowCleanupDuration = 2160,
Organizations = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoOrganizationArgs
{
ObjectType = "organization.Organization",
Moid = @var.Organization,
},
},
WorkflowDefinitions = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoWorkflowDefinitionArgs
{
ObjectType = "workflow.WorkflowDefinition",
Moid = workflowWorkflowDefinition,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.intersight.WorkflowWorkflowInfo;
import com.pulumi.intersight.WorkflowWorkflowInfoArgs;
import com.pulumi.intersight.inputs.WorkflowWorkflowInfoPropertyArgs;
import com.pulumi.intersight.inputs.WorkflowWorkflowInfoOrganizationArgs;
import com.pulumi.intersight.inputs.WorkflowWorkflowInfoWorkflowDefinitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var workflowWorkflowDefinition = config.get("workflowWorkflowDefinition");
var workflowWorkflowInfo1 = new WorkflowWorkflowInfo("workflowWorkflowInfo1", WorkflowWorkflowInfoArgs.builder()
.action("Create")
.properties(WorkflowWorkflowInfoPropertyArgs.builder()
.objectType("workflow.WorkflowInfoProperties")
.retryable(false)
.build())
.successWorkflowCleanupDuration(2160)
.organizations(WorkflowWorkflowInfoOrganizationArgs.builder()
.objectType("organization.Organization")
.moid(var_.organization())
.build())
.workflowDefinitions(WorkflowWorkflowInfoWorkflowDefinitionArgs.builder()
.objectType("workflow.WorkflowDefinition")
.moid(workflowWorkflowDefinition)
.build())
.build());
}
}
configuration:
workflowWorkflowDefinition:
type: string
resources:
workflowWorkflowInfo1:
type: intersight:WorkflowWorkflowInfo
properties:
action: Create
properties:
- objectType: workflow.WorkflowInfoProperties
retryable: false
successWorkflowCleanupDuration: 2160
organizations:
- objectType: organization.Organization
moid: ${var.organization}
workflowDefinitions:
- objectType: workflow.WorkflowDefinition
moid: ${workflowWorkflowDefinition}
Create WorkflowWorkflowInfo Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkflowWorkflowInfo(name: string, args?: WorkflowWorkflowInfoArgs, opts?: CustomResourceOptions);
@overload
def WorkflowWorkflowInfo(resource_name: str,
args: Optional[WorkflowWorkflowInfoArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def WorkflowWorkflowInfo(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_moid: Optional[str] = None,
accounts: Optional[Sequence[WorkflowWorkflowInfoAccountArgs]] = None,
action: Optional[str] = None,
additional_properties: Optional[str] = None,
ancestors: Optional[Sequence[WorkflowWorkflowInfoAncestorArgs]] = None,
associated_objects: Optional[Sequence[WorkflowWorkflowInfoAssociatedObjectArgs]] = None,
class_id: Optional[str] = None,
cleanup_time: Optional[str] = None,
create_time: Optional[str] = None,
domain_group_moid: Optional[str] = None,
email: Optional[str] = None,
end_time: Optional[str] = None,
failed_workflow_cleanup_duration: Optional[float] = None,
input: Optional[str] = None,
inst_id: Optional[str] = None,
internal: Optional[bool] = None,
last_action: Optional[str] = None,
messages: Optional[Sequence[WorkflowWorkflowInfoMessageArgs]] = None,
mod_time: Optional[str] = None,
moid: Optional[str] = None,
name: Optional[str] = None,
object_type: Optional[str] = None,
organizations: Optional[Sequence[WorkflowWorkflowInfoOrganizationArgs]] = None,
output: Optional[str] = None,
owners: Optional[Sequence[str]] = None,
parent_task_infos: Optional[Sequence[WorkflowWorkflowInfoParentTaskInfoArgs]] = None,
parents: Optional[Sequence[WorkflowWorkflowInfoParentArgs]] = None,
pause_reason: Optional[str] = None,
permission_resources: Optional[Sequence[WorkflowWorkflowInfoPermissionResourceArgs]] = None,
permissions: Optional[Sequence[WorkflowWorkflowInfoPermissionArgs]] = None,
progress: Optional[float] = None,
properties: Optional[Sequence[WorkflowWorkflowInfoPropertyArgs]] = None,
retry_from_task_name: Optional[str] = None,
shared_scope: Optional[str] = None,
src: Optional[str] = None,
start_time: Optional[str] = None,
status: Optional[str] = None,
success_workflow_cleanup_duration: Optional[float] = None,
tags: Optional[Sequence[WorkflowWorkflowInfoTagArgs]] = None,
task_info_updates: Optional[Sequence[WorkflowWorkflowInfoTaskInfoUpdateArgs]] = None,
task_infos: Optional[Sequence[WorkflowWorkflowInfoTaskInfoArgs]] = None,
trace_id: Optional[str] = None,
type: Optional[str] = None,
user_action_required: Optional[bool] = None,
user_id: Optional[str] = None,
variable: Optional[str] = None,
version_contexts: Optional[Sequence[WorkflowWorkflowInfoVersionContextArgs]] = None,
wait_reason: Optional[str] = None,
workflow_ctxes: Optional[Sequence[WorkflowWorkflowInfoWorkflowCtxArgs]] = None,
workflow_definitions: Optional[Sequence[WorkflowWorkflowInfoWorkflowDefinitionArgs]] = None,
workflow_status: Optional[str] = None,
workflow_workflow_info_id: Optional[str] = None)
func NewWorkflowWorkflowInfo(ctx *Context, name string, args *WorkflowWorkflowInfoArgs, opts ...ResourceOption) (*WorkflowWorkflowInfo, error)
public WorkflowWorkflowInfo(string name, WorkflowWorkflowInfoArgs? args = null, CustomResourceOptions? opts = null)
public WorkflowWorkflowInfo(String name, WorkflowWorkflowInfoArgs args)
public WorkflowWorkflowInfo(String name, WorkflowWorkflowInfoArgs args, CustomResourceOptions options)
type: intersight:WorkflowWorkflowInfo
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WorkflowWorkflowInfoArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WorkflowWorkflowInfoArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WorkflowWorkflowInfoArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkflowWorkflowInfoArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkflowWorkflowInfoArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var workflowWorkflowInfoResource = new Intersight.WorkflowWorkflowInfo("workflowWorkflowInfoResource", new()
{
AccountMoid = "string",
Accounts = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoAccountArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Action = "string",
AdditionalProperties = "string",
Ancestors = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoAncestorArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
AssociatedObjects = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoAssociatedObjectArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
ClassId = "string",
CleanupTime = "string",
CreateTime = "string",
DomainGroupMoid = "string",
Email = "string",
EndTime = "string",
FailedWorkflowCleanupDuration = 0,
Input = "string",
InstId = "string",
Internal = false,
LastAction = "string",
Messages = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoMessageArgs
{
AdditionalProperties = "string",
ClassId = "string",
Message = "string",
ObjectType = "string",
Severity = "string",
},
},
ModTime = "string",
Moid = "string",
Name = "string",
ObjectType = "string",
Organizations = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoOrganizationArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Output = "string",
Owners = new[]
{
"string",
},
ParentTaskInfos = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoParentTaskInfoArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Parents = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoParentArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
PauseReason = "string",
PermissionResources = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoPermissionResourceArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Permissions = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoPermissionArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Progress = 0,
Properties = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoPropertyArgs
{
AdditionalProperties = "string",
Cancelables = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoPropertyCancelableArgs
{
AdditionalProperties = "string",
CancelableStates = new[]
{
"string",
},
ClassId = "string",
Enabled = false,
Mode = "string",
ObjectType = "string",
},
},
ClassId = "string",
ObjectType = "string",
Retryable = false,
RollbackAction = "string",
RollbackOnCancel = false,
RollbackOnFailure = false,
},
},
RetryFromTaskName = "string",
SharedScope = "string",
Src = "string",
StartTime = "string",
Status = "string",
SuccessWorkflowCleanupDuration = 0,
Tags = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoTagArgs
{
AdditionalProperties = "string",
Key = "string",
Value = "string",
},
},
TaskInfoUpdates = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoTaskInfoUpdateArgs
{
AdditionalProperties = "string",
ClassId = "string",
Input = "string",
Name = "string",
ObjectType = "string",
Status = "string",
},
},
TaskInfos = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoTaskInfoArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
TraceId = "string",
Type = "string",
UserActionRequired = false,
UserId = "string",
Variable = "string",
VersionContexts = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoVersionContextArgs
{
AdditionalProperties = "string",
ClassId = "string",
InterestedMos = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoVersionContextInterestedMoArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
MarkedForDeletion = false,
NrVersion = "string",
ObjectType = "string",
RefMos = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoVersionContextRefMoArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Timestamp = "string",
VersionType = "string",
},
},
WaitReason = "string",
WorkflowCtxes = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoWorkflowCtxArgs
{
AdditionalProperties = "string",
ClassId = "string",
InitiatorCtxes = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoWorkflowCtxInitiatorCtxArgs
{
AdditionalProperties = "string",
ClassId = "string",
InitiatorMoid = "string",
InitiatorName = "string",
InitiatorType = "string",
ObjectType = "string",
},
},
ObjectType = "string",
TargetCtxLists = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoWorkflowCtxTargetCtxListArgs
{
AdditionalProperties = "string",
ClassId = "string",
ObjectType = "string",
TargetMoid = "string",
TargetName = "string",
TargetType = "string",
},
},
WorkflowSubtype = "string",
WorkflowType = "string",
},
},
WorkflowDefinitions = new[]
{
new Intersight.Inputs.WorkflowWorkflowInfoWorkflowDefinitionArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
WorkflowStatus = "string",
WorkflowWorkflowInfoId = "string",
});
example, err := intersight.NewWorkflowWorkflowInfo(ctx, "workflowWorkflowInfoResource", &intersight.WorkflowWorkflowInfoArgs{
AccountMoid: pulumi.String("string"),
Accounts: intersight.WorkflowWorkflowInfoAccountArray{
&intersight.WorkflowWorkflowInfoAccountArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Action: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
Ancestors: intersight.WorkflowWorkflowInfoAncestorArray{
&intersight.WorkflowWorkflowInfoAncestorArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
AssociatedObjects: intersight.WorkflowWorkflowInfoAssociatedObjectArray{
&intersight.WorkflowWorkflowInfoAssociatedObjectArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
ClassId: pulumi.String("string"),
CleanupTime: pulumi.String("string"),
CreateTime: pulumi.String("string"),
DomainGroupMoid: pulumi.String("string"),
Email: pulumi.String("string"),
EndTime: pulumi.String("string"),
FailedWorkflowCleanupDuration: pulumi.Float64(0),
Input: pulumi.String("string"),
InstId: pulumi.String("string"),
Internal: pulumi.Bool(false),
LastAction: pulumi.String("string"),
Messages: intersight.WorkflowWorkflowInfoMessageArray{
&intersight.WorkflowWorkflowInfoMessageArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Message: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Severity: pulumi.String("string"),
},
},
ModTime: pulumi.String("string"),
Moid: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Organizations: intersight.WorkflowWorkflowInfoOrganizationArray{
&intersight.WorkflowWorkflowInfoOrganizationArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Output: pulumi.String("string"),
Owners: pulumi.StringArray{
pulumi.String("string"),
},
ParentTaskInfos: intersight.WorkflowWorkflowInfoParentTaskInfoArray{
&intersight.WorkflowWorkflowInfoParentTaskInfoArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Parents: intersight.WorkflowWorkflowInfoParentArray{
&intersight.WorkflowWorkflowInfoParentArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
PauseReason: pulumi.String("string"),
PermissionResources: intersight.WorkflowWorkflowInfoPermissionResourceArray{
&intersight.WorkflowWorkflowInfoPermissionResourceArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Permissions: intersight.WorkflowWorkflowInfoPermissionArray{
&intersight.WorkflowWorkflowInfoPermissionArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Progress: pulumi.Float64(0),
Properties: intersight.WorkflowWorkflowInfoPropertyArray{
&intersight.WorkflowWorkflowInfoPropertyArgs{
AdditionalProperties: pulumi.String("string"),
Cancelables: intersight.WorkflowWorkflowInfoPropertyCancelableArray{
&intersight.WorkflowWorkflowInfoPropertyCancelableArgs{
AdditionalProperties: pulumi.String("string"),
CancelableStates: pulumi.StringArray{
pulumi.String("string"),
},
ClassId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Mode: pulumi.String("string"),
ObjectType: pulumi.String("string"),
},
},
ClassId: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Retryable: pulumi.Bool(false),
RollbackAction: pulumi.String("string"),
RollbackOnCancel: pulumi.Bool(false),
RollbackOnFailure: pulumi.Bool(false),
},
},
RetryFromTaskName: pulumi.String("string"),
SharedScope: pulumi.String("string"),
Src: pulumi.String("string"),
StartTime: pulumi.String("string"),
Status: pulumi.String("string"),
SuccessWorkflowCleanupDuration: pulumi.Float64(0),
Tags: intersight.WorkflowWorkflowInfoTagArray{
&intersight.WorkflowWorkflowInfoTagArgs{
AdditionalProperties: pulumi.String("string"),
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TaskInfoUpdates: intersight.WorkflowWorkflowInfoTaskInfoUpdateArray{
&intersight.WorkflowWorkflowInfoTaskInfoUpdateArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Input: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
TaskInfos: intersight.WorkflowWorkflowInfoTaskInfoArray{
&intersight.WorkflowWorkflowInfoTaskInfoArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
TraceId: pulumi.String("string"),
Type: pulumi.String("string"),
UserActionRequired: pulumi.Bool(false),
UserId: pulumi.String("string"),
Variable: pulumi.String("string"),
VersionContexts: intersight.WorkflowWorkflowInfoVersionContextArray{
&intersight.WorkflowWorkflowInfoVersionContextArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
InterestedMos: intersight.WorkflowWorkflowInfoVersionContextInterestedMoArray{
&intersight.WorkflowWorkflowInfoVersionContextInterestedMoArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
MarkedForDeletion: pulumi.Bool(false),
NrVersion: pulumi.String("string"),
ObjectType: pulumi.String("string"),
RefMos: intersight.WorkflowWorkflowInfoVersionContextRefMoArray{
&intersight.WorkflowWorkflowInfoVersionContextRefMoArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Timestamp: pulumi.String("string"),
VersionType: pulumi.String("string"),
},
},
WaitReason: pulumi.String("string"),
WorkflowCtxes: intersight.WorkflowWorkflowInfoWorkflowCtxArray{
&intersight.WorkflowWorkflowInfoWorkflowCtxArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
InitiatorCtxes: intersight.WorkflowWorkflowInfoWorkflowCtxInitiatorCtxArray{
&intersight.WorkflowWorkflowInfoWorkflowCtxInitiatorCtxArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
InitiatorMoid: pulumi.String("string"),
InitiatorName: pulumi.String("string"),
InitiatorType: pulumi.String("string"),
ObjectType: pulumi.String("string"),
},
},
ObjectType: pulumi.String("string"),
TargetCtxLists: intersight.WorkflowWorkflowInfoWorkflowCtxTargetCtxListArray{
&intersight.WorkflowWorkflowInfoWorkflowCtxTargetCtxListArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
ObjectType: pulumi.String("string"),
TargetMoid: pulumi.String("string"),
TargetName: pulumi.String("string"),
TargetType: pulumi.String("string"),
},
},
WorkflowSubtype: pulumi.String("string"),
WorkflowType: pulumi.String("string"),
},
},
WorkflowDefinitions: intersight.WorkflowWorkflowInfoWorkflowDefinitionArray{
&intersight.WorkflowWorkflowInfoWorkflowDefinitionArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
WorkflowStatus: pulumi.String("string"),
WorkflowWorkflowInfoId: pulumi.String("string"),
})
var workflowWorkflowInfoResource = new WorkflowWorkflowInfo("workflowWorkflowInfoResource", WorkflowWorkflowInfoArgs.builder()
.accountMoid("string")
.accounts(WorkflowWorkflowInfoAccountArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.action("string")
.additionalProperties("string")
.ancestors(WorkflowWorkflowInfoAncestorArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.associatedObjects(WorkflowWorkflowInfoAssociatedObjectArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.classId("string")
.cleanupTime("string")
.createTime("string")
.domainGroupMoid("string")
.email("string")
.endTime("string")
.failedWorkflowCleanupDuration(0)
.input("string")
.instId("string")
.internal(false)
.lastAction("string")
.messages(WorkflowWorkflowInfoMessageArgs.builder()
.additionalProperties("string")
.classId("string")
.message("string")
.objectType("string")
.severity("string")
.build())
.modTime("string")
.moid("string")
.name("string")
.objectType("string")
.organizations(WorkflowWorkflowInfoOrganizationArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.output("string")
.owners("string")
.parentTaskInfos(WorkflowWorkflowInfoParentTaskInfoArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.parents(WorkflowWorkflowInfoParentArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.pauseReason("string")
.permissionResources(WorkflowWorkflowInfoPermissionResourceArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.permissions(WorkflowWorkflowInfoPermissionArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.progress(0)
.properties(WorkflowWorkflowInfoPropertyArgs.builder()
.additionalProperties("string")
.cancelables(WorkflowWorkflowInfoPropertyCancelableArgs.builder()
.additionalProperties("string")
.cancelableStates("string")
.classId("string")
.enabled(false)
.mode("string")
.objectType("string")
.build())
.classId("string")
.objectType("string")
.retryable(false)
.rollbackAction("string")
.rollbackOnCancel(false)
.rollbackOnFailure(false)
.build())
.retryFromTaskName("string")
.sharedScope("string")
.src("string")
.startTime("string")
.status("string")
.successWorkflowCleanupDuration(0)
.tags(WorkflowWorkflowInfoTagArgs.builder()
.additionalProperties("string")
.key("string")
.value("string")
.build())
.taskInfoUpdates(WorkflowWorkflowInfoTaskInfoUpdateArgs.builder()
.additionalProperties("string")
.classId("string")
.input("string")
.name("string")
.objectType("string")
.status("string")
.build())
.taskInfos(WorkflowWorkflowInfoTaskInfoArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.traceId("string")
.type("string")
.userActionRequired(false)
.userId("string")
.variable("string")
.versionContexts(WorkflowWorkflowInfoVersionContextArgs.builder()
.additionalProperties("string")
.classId("string")
.interestedMos(WorkflowWorkflowInfoVersionContextInterestedMoArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.markedForDeletion(false)
.nrVersion("string")
.objectType("string")
.refMos(WorkflowWorkflowInfoVersionContextRefMoArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.timestamp("string")
.versionType("string")
.build())
.waitReason("string")
.workflowCtxes(WorkflowWorkflowInfoWorkflowCtxArgs.builder()
.additionalProperties("string")
.classId("string")
.initiatorCtxes(WorkflowWorkflowInfoWorkflowCtxInitiatorCtxArgs.builder()
.additionalProperties("string")
.classId("string")
.initiatorMoid("string")
.initiatorName("string")
.initiatorType("string")
.objectType("string")
.build())
.objectType("string")
.targetCtxLists(WorkflowWorkflowInfoWorkflowCtxTargetCtxListArgs.builder()
.additionalProperties("string")
.classId("string")
.objectType("string")
.targetMoid("string")
.targetName("string")
.targetType("string")
.build())
.workflowSubtype("string")
.workflowType("string")
.build())
.workflowDefinitions(WorkflowWorkflowInfoWorkflowDefinitionArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.workflowStatus("string")
.workflowWorkflowInfoId("string")
.build());
workflow_workflow_info_resource = intersight.WorkflowWorkflowInfo("workflowWorkflowInfoResource",
account_moid="string",
accounts=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
action="string",
additional_properties="string",
ancestors=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
associated_objects=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
class_id="string",
cleanup_time="string",
create_time="string",
domain_group_moid="string",
email="string",
end_time="string",
failed_workflow_cleanup_duration=0,
input="string",
inst_id="string",
internal=False,
last_action="string",
messages=[{
"additional_properties": "string",
"class_id": "string",
"message": "string",
"object_type": "string",
"severity": "string",
}],
mod_time="string",
moid="string",
name="string",
object_type="string",
organizations=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
output="string",
owners=["string"],
parent_task_infos=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
parents=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
pause_reason="string",
permission_resources=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
permissions=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
progress=0,
properties=[{
"additional_properties": "string",
"cancelables": [{
"additional_properties": "string",
"cancelable_states": ["string"],
"class_id": "string",
"enabled": False,
"mode": "string",
"object_type": "string",
}],
"class_id": "string",
"object_type": "string",
"retryable": False,
"rollback_action": "string",
"rollback_on_cancel": False,
"rollback_on_failure": False,
}],
retry_from_task_name="string",
shared_scope="string",
src="string",
start_time="string",
status="string",
success_workflow_cleanup_duration=0,
tags=[{
"additional_properties": "string",
"key": "string",
"value": "string",
}],
task_info_updates=[{
"additional_properties": "string",
"class_id": "string",
"input": "string",
"name": "string",
"object_type": "string",
"status": "string",
}],
task_infos=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
trace_id="string",
type="string",
user_action_required=False,
user_id="string",
variable="string",
version_contexts=[{
"additional_properties": "string",
"class_id": "string",
"interested_mos": [{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
"marked_for_deletion": False,
"nr_version": "string",
"object_type": "string",
"ref_mos": [{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
"timestamp": "string",
"version_type": "string",
}],
wait_reason="string",
workflow_ctxes=[{
"additional_properties": "string",
"class_id": "string",
"initiator_ctxes": [{
"additional_properties": "string",
"class_id": "string",
"initiator_moid": "string",
"initiator_name": "string",
"initiator_type": "string",
"object_type": "string",
}],
"object_type": "string",
"target_ctx_lists": [{
"additional_properties": "string",
"class_id": "string",
"object_type": "string",
"target_moid": "string",
"target_name": "string",
"target_type": "string",
}],
"workflow_subtype": "string",
"workflow_type": "string",
}],
workflow_definitions=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
workflow_status="string",
workflow_workflow_info_id="string")
const workflowWorkflowInfoResource = new intersight.WorkflowWorkflowInfo("workflowWorkflowInfoResource", {
accountMoid: "string",
accounts: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
action: "string",
additionalProperties: "string",
ancestors: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
associatedObjects: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
classId: "string",
cleanupTime: "string",
createTime: "string",
domainGroupMoid: "string",
email: "string",
endTime: "string",
failedWorkflowCleanupDuration: 0,
input: "string",
instId: "string",
internal: false,
lastAction: "string",
messages: [{
additionalProperties: "string",
classId: "string",
message: "string",
objectType: "string",
severity: "string",
}],
modTime: "string",
moid: "string",
name: "string",
objectType: "string",
organizations: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
output: "string",
owners: ["string"],
parentTaskInfos: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
parents: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
pauseReason: "string",
permissionResources: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
permissions: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
progress: 0,
properties: [{
additionalProperties: "string",
cancelables: [{
additionalProperties: "string",
cancelableStates: ["string"],
classId: "string",
enabled: false,
mode: "string",
objectType: "string",
}],
classId: "string",
objectType: "string",
retryable: false,
rollbackAction: "string",
rollbackOnCancel: false,
rollbackOnFailure: false,
}],
retryFromTaskName: "string",
sharedScope: "string",
src: "string",
startTime: "string",
status: "string",
successWorkflowCleanupDuration: 0,
tags: [{
additionalProperties: "string",
key: "string",
value: "string",
}],
taskInfoUpdates: [{
additionalProperties: "string",
classId: "string",
input: "string",
name: "string",
objectType: "string",
status: "string",
}],
taskInfos: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
traceId: "string",
type: "string",
userActionRequired: false,
userId: "string",
variable: "string",
versionContexts: [{
additionalProperties: "string",
classId: "string",
interestedMos: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
markedForDeletion: false,
nrVersion: "string",
objectType: "string",
refMos: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
timestamp: "string",
versionType: "string",
}],
waitReason: "string",
workflowCtxes: [{
additionalProperties: "string",
classId: "string",
initiatorCtxes: [{
additionalProperties: "string",
classId: "string",
initiatorMoid: "string",
initiatorName: "string",
initiatorType: "string",
objectType: "string",
}],
objectType: "string",
targetCtxLists: [{
additionalProperties: "string",
classId: "string",
objectType: "string",
targetMoid: "string",
targetName: "string",
targetType: "string",
}],
workflowSubtype: "string",
workflowType: "string",
}],
workflowDefinitions: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
workflowStatus: "string",
workflowWorkflowInfoId: "string",
});
type: intersight:WorkflowWorkflowInfo
properties:
accountMoid: string
accounts:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
action: string
additionalProperties: string
ancestors:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
associatedObjects:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
classId: string
cleanupTime: string
createTime: string
domainGroupMoid: string
email: string
endTime: string
failedWorkflowCleanupDuration: 0
input: string
instId: string
internal: false
lastAction: string
messages:
- additionalProperties: string
classId: string
message: string
objectType: string
severity: string
modTime: string
moid: string
name: string
objectType: string
organizations:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
output: string
owners:
- string
parentTaskInfos:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
parents:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
pauseReason: string
permissionResources:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
permissions:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
progress: 0
properties:
- additionalProperties: string
cancelables:
- additionalProperties: string
cancelableStates:
- string
classId: string
enabled: false
mode: string
objectType: string
classId: string
objectType: string
retryable: false
rollbackAction: string
rollbackOnCancel: false
rollbackOnFailure: false
retryFromTaskName: string
sharedScope: string
src: string
startTime: string
status: string
successWorkflowCleanupDuration: 0
tags:
- additionalProperties: string
key: string
value: string
taskInfoUpdates:
- additionalProperties: string
classId: string
input: string
name: string
objectType: string
status: string
taskInfos:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
traceId: string
type: string
userActionRequired: false
userId: string
variable: string
versionContexts:
- additionalProperties: string
classId: string
interestedMos:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
markedForDeletion: false
nrVersion: string
objectType: string
refMos:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
timestamp: string
versionType: string
waitReason: string
workflowCtxes:
- additionalProperties: string
classId: string
initiatorCtxes:
- additionalProperties: string
classId: string
initiatorMoid: string
initiatorName: string
initiatorType: string
objectType: string
objectType: string
targetCtxLists:
- additionalProperties: string
classId: string
objectType: string
targetMoid: string
targetName: string
targetType: string
workflowSubtype: string
workflowType: string
workflowDefinitions:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
workflowStatus: string
workflowWorkflowInfoId: string
WorkflowWorkflowInfo Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WorkflowWorkflowInfo resource accepts the following input properties:
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Accounts
List<Workflow
Workflow Info Account> - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Action string
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - Additional
Properties string - Ancestors
List<Workflow
Workflow Info Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Associated
Objects List<WorkflowWorkflow Info Associated Object> - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Cleanup
Time string - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- Create
Time string - (ReadOnly) The time when this managed object was created.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Email string
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- End
Time string - (ReadOnly) The time when the workflow reached a final state.
- Failed
Workflow doubleCleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Input string
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- Inst
Id string - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- Internal bool
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- Last
Action string - (ReadOnly) 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<Workflow
Workflow Info Message> - This complex property has following sub-properties:
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- A name of the workflow execution instance.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Organizations
List<Workflow
Workflow Info Organization> - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Output string
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- Owners List<string>
- (Array of schema.TypeString) -(ReadOnly)
- Parent
Task List<WorkflowInfos Workflow Info Parent Task Info> - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Parents
List<Workflow
Workflow Info Parent> - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Pause
Reason string - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - Permission
Resources List<WorkflowWorkflow Info Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Permissions
List<Workflow
Workflow Info Permission> - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Progress double
- (ReadOnly) This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- Properties
List<Workflow
Workflow Info Property> - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- Retry
From stringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- Src string
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- Start
Time string - (ReadOnly) The time when the workflow was started for execution.
- Status string
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- Success
Workflow doubleCleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- List<Workflow
Workflow Info Tag> - This complex property has following sub-properties:
- Task
Info List<WorkflowUpdates Workflow Info Task Info Update> - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- Task
Infos List<WorkflowWorkflow Info Task Info> - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- Trace
Id string - (ReadOnly) The trace id to keep track of workflow execution.
- Type string
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- User
Action boolRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- User
Id string - (ReadOnly) The user identifier which indicates the user that started this workflow.
- Variable string
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- Version
Contexts List<WorkflowWorkflow Info Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Wait
Reason string - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - Workflow
Ctxes List<WorkflowWorkflow Info Workflow Ctx> - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- Workflow
Definitions List<WorkflowWorkflow Info Workflow Definition> - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Workflow
Status string - (ReadOnly) 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. - Workflow
Workflow stringInfo Id
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Accounts
[]Workflow
Workflow Info Account Args - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Action string
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - Additional
Properties string - Ancestors
[]Workflow
Workflow Info Ancestor Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Associated
Objects []WorkflowWorkflow Info Associated Object Args - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Cleanup
Time string - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- Create
Time string - (ReadOnly) The time when this managed object was created.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Email string
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- End
Time string - (ReadOnly) The time when the workflow reached a final state.
- Failed
Workflow float64Cleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Input string
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- Inst
Id string - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- Internal bool
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- Last
Action string - (ReadOnly) 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
[]Workflow
Workflow Info Message Args - This complex property has following sub-properties:
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- A name of the workflow execution instance.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Organizations
[]Workflow
Workflow Info Organization Args - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Output string
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- Owners []string
- (Array of schema.TypeString) -(ReadOnly)
- Parent
Task []WorkflowInfos Workflow Info Parent Task Info Args - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Parents
[]Workflow
Workflow Info Parent Args - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Pause
Reason string - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - Permission
Resources []WorkflowWorkflow Info Permission Resource Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Permissions
[]Workflow
Workflow Info Permission Args - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Progress float64
- (ReadOnly) 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
[]Workflow
Workflow Info Property Args - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- Retry
From stringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- Src string
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- Start
Time string - (ReadOnly) The time when the workflow was started for execution.
- Status string
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- Success
Workflow float64Cleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- []Workflow
Workflow Info Tag Args - This complex property has following sub-properties:
- Task
Info []WorkflowUpdates Workflow Info Task Info Update Args - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- Task
Infos []WorkflowWorkflow Info Task Info Args - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- Trace
Id string - (ReadOnly) The trace id to keep track of workflow execution.
- Type string
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- User
Action boolRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- User
Id string - (ReadOnly) The user identifier which indicates the user that started this workflow.
- Variable string
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- Version
Contexts []WorkflowWorkflow Info Version Context Args - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Wait
Reason string - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - Workflow
Ctxes []WorkflowWorkflow Info Workflow Ctx Args - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- Workflow
Definitions []WorkflowWorkflow Info Workflow Definition Args - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Workflow
Status string - (ReadOnly) 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. - Workflow
Workflow stringInfo Id
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- accounts
List<Workflow
Workflow Info Account> - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- action String
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - additional
Properties String - ancestors
List<Workflow
Workflow Info Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- associated
Objects List<WorkflowWorkflow Info Associated Object> - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- cleanup
Time String - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- create
Time String - (ReadOnly) The time when this managed object was created.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- email String
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- end
Time String - (ReadOnly) The time when the workflow reached a final state.
- failed
Workflow DoubleCleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input String
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- inst
Id String - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- internal Boolean
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- last
Action String - (ReadOnly) 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<Workflow
Workflow Info Message> - This complex property has following sub-properties:
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- A name of the workflow execution instance.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- organizations
List<Workflow
Workflow Info Organization> - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- output String
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- owners List<String>
- (Array of schema.TypeString) -(ReadOnly)
- parent
Task List<WorkflowInfos Workflow Info Parent Task Info> - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- parents
List<Workflow
Workflow Info Parent> - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- pause
Reason String - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - permission
Resources List<WorkflowWorkflow Info Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
List<Workflow
Workflow Info Permission> - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- progress Double
- (ReadOnly) This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
List<Workflow
Workflow Info Property> - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- retry
From StringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- String
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- src String
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- start
Time String - (ReadOnly) The time when the workflow was started for execution.
- status String
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success
Workflow DoubleCleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- List<Workflow
Workflow Info Tag> - This complex property has following sub-properties:
- task
Info List<WorkflowUpdates Workflow Info Task Info Update> - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- task
Infos List<WorkflowWorkflow Info Task Info> - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- trace
Id String - (ReadOnly) The trace id to keep track of workflow execution.
- type String
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- user
Action BooleanRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- user
Id String - (ReadOnly) The user identifier which indicates the user that started this workflow.
- variable String
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- version
Contexts List<WorkflowWorkflow Info Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- wait
Reason String - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - workflow
Ctxes List<WorkflowWorkflow Info Workflow Ctx> - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- workflow
Definitions List<WorkflowWorkflow Info Workflow Definition> - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Status String - (ReadOnly) 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. - workflow
Workflow StringInfo Id
- account
Moid string - (ReadOnly) The Account ID for this managed object.
- accounts
Workflow
Workflow Info Account[] - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- action string
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - additional
Properties string - ancestors
Workflow
Workflow Info Ancestor[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- associated
Objects WorkflowWorkflow Info Associated Object[] - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- cleanup
Time string - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- create
Time string - (ReadOnly) The time when this managed object was created.
- domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- email string
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- end
Time string - (ReadOnly) The time when the workflow reached a final state.
- failed
Workflow numberCleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input string
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- inst
Id string - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- internal boolean
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- last
Action string - (ReadOnly) 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
Workflow
Workflow Info Message[] - This complex property has following sub-properties:
- mod
Time string - (ReadOnly) The time when this managed object was last modified.
- moid string
- The unique identifier of this Managed Object instance.
- name string
- A name of the workflow execution instance.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- organizations
Workflow
Workflow Info Organization[] - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- output string
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- owners string[]
- (Array of schema.TypeString) -(ReadOnly)
- parent
Task WorkflowInfos Workflow Info Parent Task Info[] - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- parents
Workflow
Workflow Info Parent[] - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- pause
Reason string - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - permission
Resources WorkflowWorkflow Info Permission Resource[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
Workflow
Workflow Info Permission[] - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- progress number
- (ReadOnly) 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
Workflow
Workflow Info Property[] - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- retry
From stringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- src string
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- start
Time string - (ReadOnly) The time when the workflow was started for execution.
- status string
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success
Workflow numberCleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Workflow
Workflow Info Tag[] - This complex property has following sub-properties:
- task
Info WorkflowUpdates Workflow Info Task Info Update[] - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- task
Infos WorkflowWorkflow Info Task Info[] - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- trace
Id string - (ReadOnly) The trace id to keep track of workflow execution.
- type string
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- user
Action booleanRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- user
Id string - (ReadOnly) The user identifier which indicates the user that started this workflow.
- variable string
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- version
Contexts WorkflowWorkflow Info Version Context[] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- wait
Reason string - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - workflow
Ctxes WorkflowWorkflow Info Workflow Ctx[] - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- workflow
Definitions WorkflowWorkflow Info Workflow Definition[] - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Status string - (ReadOnly) 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. - workflow
Workflow stringInfo Id
- account_
moid str - (ReadOnly) The Account ID for this managed object.
- accounts
Sequence[Workflow
Workflow Info Account Args] - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- 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[Workflow
Workflow Info Ancestor Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- associated_
objects Sequence[WorkflowWorkflow Info Associated Object Args] - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- 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.
- cleanup_
time str - (ReadOnly) 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 - (ReadOnly) The time when this managed object was created.
- domain_
group_ strmoid - (ReadOnly) The DomainGroup ID for this managed object.
- email str
- (ReadOnly) 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 - (ReadOnly) The time when the workflow reached a final state.
- failed_
workflow_ floatcleanup_ duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input str
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- inst_
id str - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- internal bool
- (ReadOnly) 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 - (ReadOnly) 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[Workflow
Workflow Info Message Args] - This complex property has following sub-properties:
- mod_
time str - (ReadOnly) The time when this managed object was last modified.
- moid str
- The unique identifier of this Managed Object instance.
- name str
- A name of the workflow execution instance.
- object_
type str - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- organizations
Sequence[Workflow
Workflow Info Organization Args] - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- output str
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- owners Sequence[str]
- (Array of schema.TypeString) -(ReadOnly)
- parent_
task_ Sequence[Workflowinfos Workflow Info Parent Task Info Args] - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- parents
Sequence[Workflow
Workflow Info Parent Args] - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- pause_
reason str - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - permission_
resources Sequence[WorkflowWorkflow Info Permission Resource Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
Sequence[Workflow
Workflow Info Permission Args] - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- progress float
- (ReadOnly) This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
Sequence[Workflow
Workflow Info Property Args] - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- retry_
from_ strtask_ name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- str
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- src str
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- start_
time str - (ReadOnly) The time when the workflow was started for execution.
- status str
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success_
workflow_ floatcleanup_ duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Sequence[Workflow
Workflow Info Tag Args] - This complex property has following sub-properties:
- task_
info_ Sequence[Workflowupdates Workflow Info Task Info Update Args] - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- task_
infos Sequence[WorkflowWorkflow Info Task Info Args] - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- trace_
id str - (ReadOnly) The trace id to keep track of workflow execution.
- type str
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- user_
action_ boolrequired - (ReadOnly) 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 - (ReadOnly) The user identifier which indicates the user that started this workflow.
- variable str
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- version_
contexts Sequence[WorkflowWorkflow Info Version Context Args] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- wait_
reason str - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - workflow_
ctxes Sequence[WorkflowWorkflow Info Workflow Ctx Args] - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- workflow_
definitions Sequence[WorkflowWorkflow Info Workflow Definition Args] - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow_
status str - (ReadOnly) 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. - workflow_
workflow_ strinfo_ id
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- accounts List<Property Map>
- A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- action String
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - additional
Properties String - ancestors List<Property Map>
- (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- associated
Objects List<Property Map> - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- cleanup
Time String - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- create
Time String - (ReadOnly) The time when this managed object was created.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- email String
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- end
Time String - (ReadOnly) The time when the workflow reached a final state.
- failed
Workflow NumberCleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input String
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- inst
Id String - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- internal Boolean
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- last
Action String - (ReadOnly) 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>
- This complex property has following sub-properties:
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- A name of the workflow execution instance.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- organizations List<Property Map>
- A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- output String
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- owners List<String>
- (Array of schema.TypeString) -(ReadOnly)
- parent
Task List<Property Map>Infos - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- parents List<Property Map>
- (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- pause
Reason String - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - permission
Resources List<Property Map> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions List<Property Map>
- A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- progress Number
- (ReadOnly) This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties List<Property Map>
- (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- retry
From StringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- String
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- src String
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- start
Time String - (ReadOnly) The time when the workflow was started for execution.
- status String
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success
Workflow NumberCleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- List<Property Map>
- This complex property has following sub-properties:
- task
Info List<Property Map>Updates - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- task
Infos List<Property Map> - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- trace
Id String - (ReadOnly) The trace id to keep track of workflow execution.
- type String
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- user
Action BooleanRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- user
Id String - (ReadOnly) The user identifier which indicates the user that started this workflow.
- variable String
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- version
Contexts List<Property Map> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- wait
Reason String - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - workflow
Ctxes List<Property Map> - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- workflow
Definitions List<Property Map> - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Status String - (ReadOnly) 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. - workflow
Workflow StringInfo Id
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkflowWorkflowInfo resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing WorkflowWorkflowInfo Resource
Get an existing WorkflowWorkflowInfo resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: WorkflowWorkflowInfoState, opts?: CustomResourceOptions): WorkflowWorkflowInfo
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_moid: Optional[str] = None,
accounts: Optional[Sequence[WorkflowWorkflowInfoAccountArgs]] = None,
action: Optional[str] = None,
additional_properties: Optional[str] = None,
ancestors: Optional[Sequence[WorkflowWorkflowInfoAncestorArgs]] = None,
associated_objects: Optional[Sequence[WorkflowWorkflowInfoAssociatedObjectArgs]] = None,
class_id: Optional[str] = None,
cleanup_time: Optional[str] = None,
create_time: Optional[str] = None,
domain_group_moid: Optional[str] = None,
email: Optional[str] = None,
end_time: Optional[str] = None,
failed_workflow_cleanup_duration: Optional[float] = None,
input: Optional[str] = None,
inst_id: Optional[str] = None,
internal: Optional[bool] = None,
last_action: Optional[str] = None,
messages: Optional[Sequence[WorkflowWorkflowInfoMessageArgs]] = None,
mod_time: Optional[str] = None,
moid: Optional[str] = None,
name: Optional[str] = None,
object_type: Optional[str] = None,
organizations: Optional[Sequence[WorkflowWorkflowInfoOrganizationArgs]] = None,
output: Optional[str] = None,
owners: Optional[Sequence[str]] = None,
parent_task_infos: Optional[Sequence[WorkflowWorkflowInfoParentTaskInfoArgs]] = None,
parents: Optional[Sequence[WorkflowWorkflowInfoParentArgs]] = None,
pause_reason: Optional[str] = None,
permission_resources: Optional[Sequence[WorkflowWorkflowInfoPermissionResourceArgs]] = None,
permissions: Optional[Sequence[WorkflowWorkflowInfoPermissionArgs]] = None,
progress: Optional[float] = None,
properties: Optional[Sequence[WorkflowWorkflowInfoPropertyArgs]] = None,
retry_from_task_name: Optional[str] = None,
shared_scope: Optional[str] = None,
src: Optional[str] = None,
start_time: Optional[str] = None,
status: Optional[str] = None,
success_workflow_cleanup_duration: Optional[float] = None,
tags: Optional[Sequence[WorkflowWorkflowInfoTagArgs]] = None,
task_info_updates: Optional[Sequence[WorkflowWorkflowInfoTaskInfoUpdateArgs]] = None,
task_infos: Optional[Sequence[WorkflowWorkflowInfoTaskInfoArgs]] = None,
trace_id: Optional[str] = None,
type: Optional[str] = None,
user_action_required: Optional[bool] = None,
user_id: Optional[str] = None,
variable: Optional[str] = None,
version_contexts: Optional[Sequence[WorkflowWorkflowInfoVersionContextArgs]] = None,
wait_reason: Optional[str] = None,
workflow_ctxes: Optional[Sequence[WorkflowWorkflowInfoWorkflowCtxArgs]] = None,
workflow_definitions: Optional[Sequence[WorkflowWorkflowInfoWorkflowDefinitionArgs]] = None,
workflow_status: Optional[str] = None,
workflow_workflow_info_id: Optional[str] = None) -> WorkflowWorkflowInfo
func GetWorkflowWorkflowInfo(ctx *Context, name string, id IDInput, state *WorkflowWorkflowInfoState, opts ...ResourceOption) (*WorkflowWorkflowInfo, error)
public static WorkflowWorkflowInfo Get(string name, Input<string> id, WorkflowWorkflowInfoState? state, CustomResourceOptions? opts = null)
public static WorkflowWorkflowInfo get(String name, Output<String> id, WorkflowWorkflowInfoState state, CustomResourceOptions options)
resources: _: type: intersight:WorkflowWorkflowInfo get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Accounts
List<Workflow
Workflow Info Account> - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Action string
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - Additional
Properties string - Ancestors
List<Workflow
Workflow Info Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Associated
Objects List<WorkflowWorkflow Info Associated Object> - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Cleanup
Time string - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- Create
Time string - (ReadOnly) The time when this managed object was created.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Email string
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- End
Time string - (ReadOnly) The time when the workflow reached a final state.
- Failed
Workflow doubleCleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Input string
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- Inst
Id string - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- Internal bool
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- Last
Action string - (ReadOnly) 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<Workflow
Workflow Info Message> - This complex property has following sub-properties:
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- A name of the workflow execution instance.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Organizations
List<Workflow
Workflow Info Organization> - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Output string
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- Owners List<string>
- (Array of schema.TypeString) -(ReadOnly)
- Parent
Task List<WorkflowInfos Workflow Info Parent Task Info> - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Parents
List<Workflow
Workflow Info Parent> - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Pause
Reason string - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - Permission
Resources List<WorkflowWorkflow Info Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Permissions
List<Workflow
Workflow Info Permission> - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Progress double
- (ReadOnly) This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- Properties
List<Workflow
Workflow Info Property> - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- Retry
From stringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- Src string
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- Start
Time string - (ReadOnly) The time when the workflow was started for execution.
- Status string
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- Success
Workflow doubleCleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- List<Workflow
Workflow Info Tag> - This complex property has following sub-properties:
- Task
Info List<WorkflowUpdates Workflow Info Task Info Update> - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- Task
Infos List<WorkflowWorkflow Info Task Info> - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- Trace
Id string - (ReadOnly) The trace id to keep track of workflow execution.
- Type string
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- User
Action boolRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- User
Id string - (ReadOnly) The user identifier which indicates the user that started this workflow.
- Variable string
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- Version
Contexts List<WorkflowWorkflow Info Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Wait
Reason string - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - Workflow
Ctxes List<WorkflowWorkflow Info Workflow Ctx> - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- Workflow
Definitions List<WorkflowWorkflow Info Workflow Definition> - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Workflow
Status string - (ReadOnly) 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. - Workflow
Workflow stringInfo Id
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Accounts
[]Workflow
Workflow Info Account Args - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Action string
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - Additional
Properties string - Ancestors
[]Workflow
Workflow Info Ancestor Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Associated
Objects []WorkflowWorkflow Info Associated Object Args - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- Cleanup
Time string - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- Create
Time string - (ReadOnly) The time when this managed object was created.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Email string
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- End
Time string - (ReadOnly) The time when the workflow reached a final state.
- Failed
Workflow float64Cleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Input string
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- Inst
Id string - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- Internal bool
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- Last
Action string - (ReadOnly) 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
[]Workflow
Workflow Info Message Args - This complex property has following sub-properties:
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Name string
- A name of the workflow execution instance.
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Organizations
[]Workflow
Workflow Info Organization Args - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Output string
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- Owners []string
- (Array of schema.TypeString) -(ReadOnly)
- Parent
Task []WorkflowInfos Workflow Info Parent Task Info Args - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Parents
[]Workflow
Workflow Info Parent Args - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Pause
Reason string - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - Permission
Resources []WorkflowWorkflow Info Permission Resource Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Permissions
[]Workflow
Workflow Info Permission Args - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Progress float64
- (ReadOnly) 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
[]Workflow
Workflow Info Property Args - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- Retry
From stringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- Src string
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- Start
Time string - (ReadOnly) The time when the workflow was started for execution.
- Status string
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- Success
Workflow float64Cleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- []Workflow
Workflow Info Tag Args - This complex property has following sub-properties:
- Task
Info []WorkflowUpdates Workflow Info Task Info Update Args - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- Task
Infos []WorkflowWorkflow Info Task Info Args - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- Trace
Id string - (ReadOnly) The trace id to keep track of workflow execution.
- Type string
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- User
Action boolRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- User
Id string - (ReadOnly) The user identifier which indicates the user that started this workflow.
- Variable string
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- Version
Contexts []WorkflowWorkflow Info Version Context Args - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Wait
Reason string - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - Workflow
Ctxes []WorkflowWorkflow Info Workflow Ctx Args - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- Workflow
Definitions []WorkflowWorkflow Info Workflow Definition Args - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Workflow
Status string - (ReadOnly) 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. - Workflow
Workflow stringInfo Id
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- accounts
List<Workflow
Workflow Info Account> - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- action String
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - additional
Properties String - ancestors
List<Workflow
Workflow Info Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- associated
Objects List<WorkflowWorkflow Info Associated Object> - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- cleanup
Time String - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- create
Time String - (ReadOnly) The time when this managed object was created.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- email String
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- end
Time String - (ReadOnly) The time when the workflow reached a final state.
- failed
Workflow DoubleCleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input String
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- inst
Id String - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- internal Boolean
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- last
Action String - (ReadOnly) 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<Workflow
Workflow Info Message> - This complex property has following sub-properties:
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- A name of the workflow execution instance.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- organizations
List<Workflow
Workflow Info Organization> - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- output String
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- owners List<String>
- (Array of schema.TypeString) -(ReadOnly)
- parent
Task List<WorkflowInfos Workflow Info Parent Task Info> - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- parents
List<Workflow
Workflow Info Parent> - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- pause
Reason String - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - permission
Resources List<WorkflowWorkflow Info Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
List<Workflow
Workflow Info Permission> - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- progress Double
- (ReadOnly) This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
List<Workflow
Workflow Info Property> - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- retry
From StringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- String
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- src String
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- start
Time String - (ReadOnly) The time when the workflow was started for execution.
- status String
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success
Workflow DoubleCleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- List<Workflow
Workflow Info Tag> - This complex property has following sub-properties:
- task
Info List<WorkflowUpdates Workflow Info Task Info Update> - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- task
Infos List<WorkflowWorkflow Info Task Info> - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- trace
Id String - (ReadOnly) The trace id to keep track of workflow execution.
- type String
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- user
Action BooleanRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- user
Id String - (ReadOnly) The user identifier which indicates the user that started this workflow.
- variable String
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- version
Contexts List<WorkflowWorkflow Info Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- wait
Reason String - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - workflow
Ctxes List<WorkflowWorkflow Info Workflow Ctx> - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- workflow
Definitions List<WorkflowWorkflow Info Workflow Definition> - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Status String - (ReadOnly) 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. - workflow
Workflow StringInfo Id
- account
Moid string - (ReadOnly) The Account ID for this managed object.
- accounts
Workflow
Workflow Info Account[] - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- action string
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - additional
Properties string - ancestors
Workflow
Workflow Info Ancestor[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- associated
Objects WorkflowWorkflow Info Associated Object[] - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id string - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- cleanup
Time string - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- create
Time string - (ReadOnly) The time when this managed object was created.
- domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- email string
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- end
Time string - (ReadOnly) The time when the workflow reached a final state.
- failed
Workflow numberCleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input string
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- inst
Id string - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- internal boolean
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- last
Action string - (ReadOnly) 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
Workflow
Workflow Info Message[] - This complex property has following sub-properties:
- mod
Time string - (ReadOnly) The time when this managed object was last modified.
- moid string
- The unique identifier of this Managed Object instance.
- name string
- A name of the workflow execution instance.
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- organizations
Workflow
Workflow Info Organization[] - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- output string
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- owners string[]
- (Array of schema.TypeString) -(ReadOnly)
- parent
Task WorkflowInfos Workflow Info Parent Task Info[] - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- parents
Workflow
Workflow Info Parent[] - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- pause
Reason string - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - permission
Resources WorkflowWorkflow Info Permission Resource[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
Workflow
Workflow Info Permission[] - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- progress number
- (ReadOnly) 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
Workflow
Workflow Info Property[] - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- retry
From stringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- string
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- src string
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- start
Time string - (ReadOnly) The time when the workflow was started for execution.
- status string
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success
Workflow numberCleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Workflow
Workflow Info Tag[] - This complex property has following sub-properties:
- task
Info WorkflowUpdates Workflow Info Task Info Update[] - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- task
Infos WorkflowWorkflow Info Task Info[] - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- trace
Id string - (ReadOnly) The trace id to keep track of workflow execution.
- type string
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- user
Action booleanRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- user
Id string - (ReadOnly) The user identifier which indicates the user that started this workflow.
- variable string
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- version
Contexts WorkflowWorkflow Info Version Context[] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- wait
Reason string - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - workflow
Ctxes WorkflowWorkflow Info Workflow Ctx[] - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- workflow
Definitions WorkflowWorkflow Info Workflow Definition[] - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Status string - (ReadOnly) 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. - workflow
Workflow stringInfo Id
- account_
moid str - (ReadOnly) The Account ID for this managed object.
- accounts
Sequence[Workflow
Workflow Info Account Args] - A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- 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[Workflow
Workflow Info Ancestor Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- associated_
objects Sequence[WorkflowWorkflow Info Associated Object Args] - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- 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.
- cleanup_
time str - (ReadOnly) 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 - (ReadOnly) The time when this managed object was created.
- domain_
group_ strmoid - (ReadOnly) The DomainGroup ID for this managed object.
- email str
- (ReadOnly) 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 - (ReadOnly) The time when the workflow reached a final state.
- failed_
workflow_ floatcleanup_ duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input str
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- inst_
id str - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- internal bool
- (ReadOnly) 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 - (ReadOnly) 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[Workflow
Workflow Info Message Args] - This complex property has following sub-properties:
- mod_
time str - (ReadOnly) The time when this managed object was last modified.
- moid str
- The unique identifier of this Managed Object instance.
- name str
- A name of the workflow execution instance.
- object_
type str - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- organizations
Sequence[Workflow
Workflow Info Organization Args] - A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- output str
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- owners Sequence[str]
- (Array of schema.TypeString) -(ReadOnly)
- parent_
task_ Sequence[Workflowinfos Workflow Info Parent Task Info Args] - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- parents
Sequence[Workflow
Workflow Info Parent Args] - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- pause_
reason str - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - permission_
resources Sequence[WorkflowWorkflow Info Permission Resource Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
Sequence[Workflow
Workflow Info Permission Args] - A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- progress float
- (ReadOnly) This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties
Sequence[Workflow
Workflow Info Property Args] - (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- retry_
from_ strtask_ name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- str
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- src str
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- start_
time str - (ReadOnly) The time when the workflow was started for execution.
- status str
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success_
workflow_ floatcleanup_ duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- Sequence[Workflow
Workflow Info Tag Args] - This complex property has following sub-properties:
- task_
info_ Sequence[Workflowupdates Workflow Info Task Info Update Args] - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- task_
infos Sequence[WorkflowWorkflow Info Task Info Args] - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- trace_
id str - (ReadOnly) The trace id to keep track of workflow execution.
- type str
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- user_
action_ boolrequired - (ReadOnly) 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 - (ReadOnly) The user identifier which indicates the user that started this workflow.
- variable str
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- version_
contexts Sequence[WorkflowWorkflow Info Version Context Args] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- wait_
reason str - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - workflow_
ctxes Sequence[WorkflowWorkflow Info Workflow Ctx Args] - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- workflow_
definitions Sequence[WorkflowWorkflow Info Workflow Definition Args] - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow_
status str - (ReadOnly) 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. - workflow_
workflow_ strinfo_ id
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- accounts List<Property Map>
- A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- action String
- The action of the workflow such as start, cancel, retry, pause.*
None
- No action is set, this is the default value for action field.*Create
- Create a new instance of the workflow but it does not start the execution of the workflow. Use the Start action to start execution of the workflow.*Start
- Start a new execution of the workflow.*Pause
- Pause the workflow, this can only be issued on workflows that are in running state. A workflow can be paused for a maximum of 180 days, after 180 days the workflow will be terminated by the system.*Resume
- Resume the workflow which was previously paused through pause action on the workflow.*Rerun
- Rerun the workflow that has previously reached a failed state. The workflow is run from the beginning using inputs from previous execution. Completed and currently running workflows cannot be rerun. Workflows do not have to be marked for retry to use this action.*Retry
- This action has been deprecated. Please use RetryFailed, Rerun or RetryFromTask action. Retry the workflow that has previously reached a final state and has the retryable property set to true. A running or waiting workflow cannot be retried. If the property retryFromTaskName is also passed along with this action, the workflow will be started from that specific task, otherwise the workflow will be restarted from the first task. The task name in retryFromTaskName must be one of the tasks that completed or failed in the previous run. It is not possible to retry a workflow from a task which wasn't run in the previous iteration.*RetryFailed
- Retry the workflow that has failed. A running or waiting workflow or a workflow that completed successfully cannot be retried. Only the tasks that failed in the previous run will be retried and the rest of workflow will be run. This action does not restart the workflow and also does not support retrying from a specific task.*RetryFromTask
- Retry the workflow that has previously reached a failed state and has the retryable property set to true. A running or waiting workflow cannot be retried. RetryFromTaskName must be passed along with this action, and the workflow will be started from that specific task. The task name in RetryFromTaskName must be one of the tasks that was executed in the previous attempt. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.*Cancel
- Cancel the workflow that is in running or waiting state. - additional
Properties String - ancestors List<Property Map>
- (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- associated
Objects List<Property Map> - A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- class
Id String - The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.
- cleanup
Time String - (ReadOnly) The time when the workflow info will be removed from the database. When WorkflowInfo is created, cleanup time will be set to 181 days. As the workflow progresses through different states the cleanup time can be updated. A cleanup time of 0 means the workflow is not scheduled for cleanup. An active workflow that continues to schedule & run tasks can run for any amount of time and there is no upper bound for such workflows. Workflows that are not actively running, say in Paused or Waiting states will be removed after 181 days.
- create
Time String - (ReadOnly) The time when this managed object was created.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- email String
- (ReadOnly) The email address of the user who started this workflow. In the case of LDAP users, this field can hold either a username or an email.
- end
Time String - (ReadOnly) The time when the workflow reached a final state.
- failed
Workflow NumberCleanup Duration - The duration in hours after which the workflow info for failed, terminated or timed out workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- input String
- All the given inputs for the workflow. The schema for the inputs is defined in the InputDefinition section of the WorkflowDefinition. The InputDefinition will provide a list of input fields to be accepted, the associated datatype of the inputs and any additional constraints on the inputs. For more information please refer to InputDefinition property in the the the WorkflowDefinition resource. The inputs for a workflow are provided as a collection of key-value pairs, where key is the name of the input and value is any valid JSON data which conforms to the datatype of the input as specified in the InputDefinition. When the input passed into a workflow does not match the datatype or the constraints specified in the workflow definition, it will not be accepted. For example, if the InputDefinition specified that workflow must accept a string name 'key' and the value passed for key must adhere to a regex pattern. If Workflow was started with input where 'key' is not a string matching the regex pattern, an error will be generated and workflow will not start execution. During workflow definition design, the input passed into the workflow will be referred using the format 'workflow.input.'. If the input is referred directly in a mapping it will be in the format '${workflow.input.}' or inside a template mapping in the format '{{.global.workflow.input.}}'.
- inst
Id String - (ReadOnly) A workflow instance Id which is the unique identified for the workflow execution.
- internal Boolean
- (ReadOnly) Denotes that an Intersight service started this workflow as internal and hence will not be shown in Intersight User Interface. Typically these are internal system maintenance workflows which are triggered by Intersight services.
- last
Action String - (ReadOnly) 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>
- This complex property has following sub-properties:
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- name String
- A name of the workflow execution instance.
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- organizations List<Property Map>
- A reference to a organizationOrganization resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- output String
- (ReadOnly) All the generated outputs for the workflow. The schema for the outputs are defined in the OutputDefinition section of the WorkflowDefinition. The OutputDefinition will provide a list of output fields that could be generated after workflow execution is completed and the associated datatype of the outputs. For more information please refer to OutputDefinition property in WorkflowDefinition resource. The output for the workflow is generated as a collection of key-value pairs, where key is the name of the output and value is any valid JSON data which conforms to the datatype of output as specified in the OutputDefinition. During workflow definition design, if a workflow is included as a sub-workflow inside a parent workflow then the outputs generated by the sub-workflow can be used in the workflow design. For example, if workflow was included into parent workflow as 'SubWorkflowSample1', then that output can be referred as 'SubWorkflowSample1.output.'. In the output is referred directly in a mapping it will be in the format '${SubWorkflowSample1.output.}' or inside a template mapping will be in the format '{{SubWorkflowSample1.output.}}'.
- owners List<String>
- (Array of schema.TypeString) -(ReadOnly)
- parent
Task List<Property Map>Infos - (ReadOnly) A reference to a workflowTaskInfo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- parents List<Property Map>
- (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- pause
Reason String - (ReadOnly) Denotes the reason workflow is in paused status.*
None
- Pause reason is none, which indicates there is no reason for the pause state.*TaskWithWarning
- Pause reason indicates the workflow is in this state due to a task that has a status as completed with warnings.*SystemMaintenance
- Pause reason indicates the workflow is in this state based on actions of system admin for maintenance. - permission
Resources List<Property Map> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions List<Property Map>
- A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- progress Number
- (ReadOnly) This field indicates percentage of workflow task completion based on the total number of tasks in the workflow. The total number of tasks in the workflow is calculated based on the longest path the workflow execution can take. So progress is calculated based on the percentage of tasks that completed out of the total number of tasks that could be executed. Progress is not a representation of the time taken to complete the workflow. A task is considered as completed if the task status is either \ NO_OP\ or \ COMPLETED\ . If the task status is \ SKIP_TO_FAIL\ , the workflow will be terminated and the progress of the workflow will be set to 100.
- properties List<Property Map>
- (ReadOnly) Type to capture all the properties for the workflow info passed on from workflow definition. This complex property has following sub-properties:
- retry
From StringTask Name - This field is required when RetryFromTask action is issued for a workflow that is in a 'final' state. The workflow will be retried from the specified task. This field must specify a task name which is the unique name of the task within the workflow. The task name must be one of the tasks that were completed or failed in the previous run. It is not possible to retry a workflow from a task that wasn't run in the previous execution attempt.
- String
- (ReadOnly) Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.
- src String
- (ReadOnly) The source service that started the workflow execution and hence represents the owning service for this workflow.
- start
Time String - (ReadOnly) The time when the workflow was started for execution.
- status String
- (ReadOnly) A status of the workflow (RUNNING, WAITING, COMPLETED, TIME_OUT, FAILED). The \ status\ field has been deprecated and is now replaced with the \ workflowStatus\ field.
- success
Workflow NumberCleanup Duration - The duration in hours after which the workflow info for successful workflow will be removed from database. The minimum is 1 hour, maximum is 365 days and default is 90 days.
- List<Property Map>
- This complex property has following sub-properties:
- task
Info List<Property Map>Updates - Used to update a TaskInfo instance in the WorkflowInfo, it is used as a way to update status and provide user inputs for a WaitTask. This complex property has following sub-properties:
- task
Infos List<Property Map> - (ReadOnly) An array of relationships to workflowTaskInfo resources. This complex property has following sub-properties:
- trace
Id String - (ReadOnly) The trace id to keep track of workflow execution.
- type String
- (ReadOnly) A type of the workflow (serverconfig, ansible_monitoring).
- user
Action BooleanRequired - (ReadOnly) Property will be set when a user action is required on the workflow. This can be because the workflow is waiting for a wait task to be updated, workflow is paused or workflow launched by a configuration object has failed and needs to be retried in order to complete successfully.
- user
Id String - (ReadOnly) The user identifier which indicates the user that started this workflow.
- variable String
- (ReadOnly) All the generated variables for the workflow. During workflow execution, the variables will be updated as per the variableParameters specified after each task execution.
- version
Contexts List<Property Map> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- wait
Reason String - (ReadOnly) Denotes the reason workflow is in waiting status.*
None
- Wait reason is none, which indicates there is no reason for the waiting state.*GatherTasks
- Wait reason is gathering tasks, which indicates the workflow is in this state in order to gather tasks.*Duplicate
- Wait reason is duplicate, which indicates the workflow is a duplicate of current running workflow.*RateLimit
- Wait reason is rate limit, which indicates the workflow is rate limited by account/instance level throttling threshold.*WaitTask
- Wait reason when there are one or more wait tasks in the workflow which are yet to receive a task status update.*PendingRetryFailed
- Wait reason when the workflow is pending a RetryFailed action.*WaitingToStart
- Workflow is waiting to start on workflow engine. - workflow
Ctxes List<Property Map> - The workflow context which contains initiator and target information. This complex property has following sub-properties:
- workflow
Definitions List<Property Map> - A reference to a workflowWorkflowDefinition resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- workflow
Status String - (ReadOnly) 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. - workflow
Workflow StringInfo Id
Supporting Types
WorkflowWorkflowInfoAccount, WorkflowWorkflowInfoAccountArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoAncestor, WorkflowWorkflowInfoAncestorArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoAssociatedObject, WorkflowWorkflowInfoAssociatedObjectArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoMessage, WorkflowWorkflowInfoMessageArgs
- Additional
Properties string - Class
Id string - Message string
- (ReadOnly) An i18n message that can be translated into multiple languages to support internationalization.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Severity string
- (ReadOnly) The severity of the Task or Workflow message warning/error/info etc.*
Info
- The enum represents the log level to be used to convey info message.*Warning
- The enum represents the log level to be used to convey warning message.*Debug
- The enum represents the log level to be used to convey debug message.*Error
- The enum represents the log level to be used to convey error message.
- Additional
Properties string - Class
Id string - Message string
- (ReadOnly) An i18n message that can be translated into multiple languages to support internationalization.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Severity string
- (ReadOnly) The severity of the Task or Workflow message warning/error/info etc.*
Info
- The enum represents the log level to be used to convey info message.*Warning
- The enum represents the log level to be used to convey warning message.*Debug
- The enum represents the log level to be used to convey debug message.*Error
- The enum represents the log level to be used to convey error message.
- additional
Properties String - class
Id String - message String
- (ReadOnly) An i18n message that can be translated into multiple languages to support internationalization.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- severity String
- (ReadOnly) The severity of the Task or Workflow message warning/error/info etc.*
Info
- The enum represents the log level to be used to convey info message.*Warning
- The enum represents the log level to be used to convey warning message.*Debug
- The enum represents the log level to be used to convey debug message.*Error
- The enum represents the log level to be used to convey error message.
- additional
Properties string - class
Id string - message string
- (ReadOnly) An i18n message that can be translated into multiple languages to support internationalization.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- severity string
- (ReadOnly) 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 - message str
- (ReadOnly) 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
- (ReadOnly) The severity of the Task or Workflow message warning/error/info etc.*
Info
- The enum represents the log level to be used to convey info message.*Warning
- The enum represents the log level to be used to convey warning message.*Debug
- The enum represents the log level to be used to convey debug message.*Error
- The enum represents the log level to be used to convey error message.
- additional
Properties String - class
Id String - message String
- (ReadOnly) An i18n message that can be translated into multiple languages to support internationalization.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- severity String
- (ReadOnly) 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.
WorkflowWorkflowInfoOrganization, WorkflowWorkflowInfoOrganizationArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoParent, WorkflowWorkflowInfoParentArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoParentTaskInfo, WorkflowWorkflowInfoParentTaskInfoArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoPermission, WorkflowWorkflowInfoPermissionArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoPermissionResource, WorkflowWorkflowInfoPermissionResourceArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoProperty, WorkflowWorkflowInfoPropertyArgs
- Additional
Properties string - Cancelables
List<Workflow
Workflow Info Property Cancelable> - (ReadOnly) Holds the parameters and conditions for a workflow to be cancelable. This complex property has following sub-properties:
- Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Retryable bool
- (ReadOnly) When true, this workflow can be retried within 2 weeks from the last failure.
- Rollback
Action string - (ReadOnly) Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.*
Disabled
- Status of the rollback action when workflow is disabled for rollback.*Enabled
- Status of the rollback action when workflow is enabled for rollback.*Completed
- Status of the rollback action once workflow completes the rollback for all eligible tasks. - Rollback
On boolCancel - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- Rollback
On boolFailure - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow fails to execute.
- Additional
Properties string - Cancelables
[]Workflow
Workflow Info Property Cancelable - (ReadOnly) Holds the parameters and conditions for a workflow to be cancelable. This complex property has following sub-properties:
- Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Retryable bool
- (ReadOnly) When true, this workflow can be retried within 2 weeks from the last failure.
- Rollback
Action string - (ReadOnly) Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.*
Disabled
- Status of the rollback action when workflow is disabled for rollback.*Enabled
- Status of the rollback action when workflow is enabled for rollback.*Completed
- Status of the rollback action once workflow completes the rollback for all eligible tasks. - Rollback
On boolCancel - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- Rollback
On boolFailure - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additional
Properties String - cancelables
List<Workflow
Workflow Info Property Cancelable> - (ReadOnly) Holds the parameters and conditions for a workflow to be cancelable. This complex property has following sub-properties:
- class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- retryable Boolean
- (ReadOnly) When true, this workflow can be retried within 2 weeks from the last failure.
- rollback
Action String - (ReadOnly) Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.*
Disabled
- Status of the rollback action when workflow is disabled for rollback.*Enabled
- Status of the rollback action when workflow is enabled for rollback.*Completed
- Status of the rollback action once workflow completes the rollback for all eligible tasks. - rollback
On BooleanCancel - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollback
On BooleanFailure - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additional
Properties string - cancelables
Workflow
Workflow Info Property Cancelable[] - (ReadOnly) Holds the parameters and conditions for a workflow to be cancelable. This complex property has following sub-properties:
- class
Id string - object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- retryable boolean
- (ReadOnly) When true, this workflow can be retried within 2 weeks from the last failure.
- rollback
Action string - (ReadOnly) Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.*
Disabled
- Status of the rollback action when workflow is disabled for rollback.*Enabled
- Status of the rollback action when workflow is enabled for rollback.*Completed
- Status of the rollback action once workflow completes the rollback for all eligible tasks. - rollback
On booleanCancel - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollback
On booleanFailure - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additional_
properties str - cancelables
Sequence[Workflow
Workflow Info Property Cancelable] - (ReadOnly) Holds the parameters and conditions for a workflow to be cancelable. This complex property has following sub-properties:
- class_
id str - object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- retryable bool
- (ReadOnly) When true, this workflow can be retried within 2 weeks from the last failure.
- rollback_
action str - (ReadOnly) Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.*
Disabled
- Status of the rollback action when workflow is disabled for rollback.*Enabled
- Status of the rollback action when workflow is enabled for rollback.*Completed
- Status of the rollback action once workflow completes the rollback for all eligible tasks. - rollback_
on_ boolcancel - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollback_
on_ boolfailure - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow fails to execute.
- additional
Properties String - cancelables List<Property Map>
- (ReadOnly) Holds the parameters and conditions for a workflow to be cancelable. This complex property has following sub-properties:
- class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- retryable Boolean
- (ReadOnly) When true, this workflow can be retried within 2 weeks from the last failure.
- rollback
Action String - (ReadOnly) Status of rollback for this workflow instance. The rollback action can be enabled, disabled or completed.*
Disabled
- Status of the rollback action when workflow is disabled for rollback.*Enabled
- Status of the rollback action when workflow is enabled for rollback.*Completed
- Status of the rollback action once workflow completes the rollback for all eligible tasks. - rollback
On BooleanCancel - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow execution is cancelled.
- rollback
On BooleanFailure - (ReadOnly) When set to true, the changes are automatically rolled back if the workflow fails to execute.
WorkflowWorkflowInfoPropertyCancelable, WorkflowWorkflowInfoPropertyCancelableArgs
- Additional
Properties string - Cancelable
States List<string> - (Array of schema.TypeString) -
- Class
Id string - Enabled bool
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- Mode string
- Mode controls how the workflow can be canceled.*
ApiOnly
- The workflow can only be canceled via API call.*All
- The workflow can be canceled from API or from the user interface. - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Additional
Properties string - Cancelable
States []string - (Array of schema.TypeString) -
- Class
Id string - Enabled bool
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- Mode string
- Mode controls how the workflow can be canceled.*
ApiOnly
- The workflow can only be canceled via API call.*All
- The workflow can be canceled from API or from the user interface. - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- additional
Properties String - cancelable
States List<String> - (Array of schema.TypeString) -
- class
Id String - enabled Boolean
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- mode String
- Mode controls how the workflow can be canceled.*
ApiOnly
- The workflow can only be canceled via API call.*All
- The workflow can be canceled from API or from the user interface. - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- additional
Properties string - cancelable
States string[] - (Array of schema.TypeString) -
- class
Id string - enabled boolean
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- mode string
- Mode controls how the workflow can be canceled.*
ApiOnly
- The workflow can only be canceled via API call.*All
- The workflow can be canceled from API or from the user interface. - object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- additional_
properties str - cancelable_
states Sequence[str] - (Array of schema.TypeString) -
- class_
id str - enabled bool
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- mode str
- Mode controls how the workflow can be canceled.*
ApiOnly
- The workflow can only be canceled via API call.*All
- The workflow can be canceled from API or from the user interface. - object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- additional
Properties String - cancelable
States List<String> - (Array of schema.TypeString) -
- class
Id String - enabled Boolean
- When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.
- mode String
- Mode controls how the workflow can be canceled.*
ApiOnly
- The workflow can only be canceled via API call.*All
- The workflow can be canceled from API or from the user interface. - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
WorkflowWorkflowInfoTag, WorkflowWorkflowInfoTagArgs
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
- additional
Properties string - key string
- The string representation of a tag key.
- value string
- The string representation of a tag value.
- additional_
properties str - key str
- The string representation of a tag key.
- value str
- The string representation of a tag value.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
WorkflowWorkflowInfoTaskInfo, WorkflowWorkflowInfoTaskInfoArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoTaskInfoUpdate, WorkflowWorkflowInfoTaskInfoUpdateArgs
- Additional
Properties string - Class
Id string - Input string
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- Name string
- Name of the task being updated and this name must match the task instance name included inside the workflow definition. This name is also captured in the RefName property of the TaskInfo object for the task.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Status string
- New status of the task being updated, only Failed and Completed statuses are supported, Completed is the default value in case no status is provided.*
Scheduled
- The enum represents the status when task is in scheduled state.*InProgress
- The enum represents the status when task is in-progress state.*NoOp
- The enum represents the status when task is a noop.*Timeout
- The enum represents the status when task has timed out.*Completed
- The enum represents the status when task has completed.*Failed
- The enum represents the status when task has failed.
- Additional
Properties string - Class
Id string - Input string
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- Name string
- Name of the task being updated and this name must match the task instance name included inside the workflow definition. This name is also captured in the RefName property of the TaskInfo object for the task.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Status string
- New status of the task being updated, only Failed and Completed statuses are supported, Completed is the default value in case no status is provided.*
Scheduled
- The enum represents the status when task is in scheduled state.*InProgress
- The enum represents the status when task is in-progress state.*NoOp
- The enum represents the status when task is a noop.*Timeout
- The enum represents the status when task has timed out.*Completed
- The enum represents the status when task has completed.*Failed
- The enum represents the status when task has failed.
- additional
Properties String - class
Id String - input String
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- name String
- Name of the task being updated and this name must match the task instance name included inside the workflow definition. This name is also captured in the RefName property of the TaskInfo object for the task.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- status String
- New status of the task being updated, only Failed and Completed statuses are supported, Completed is the default value in case no status is provided.*
Scheduled
- The enum represents the status when task is in scheduled state.*InProgress
- The enum represents the status when task is in-progress state.*NoOp
- The enum represents the status when task is a noop.*Timeout
- The enum represents the status when task has timed out.*Completed
- The enum represents the status when task has completed.*Failed
- The enum represents the status when task has failed.
- additional
Properties string - class
Id string - input string
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- name string
- Name of the task being updated and this name must match the task instance name included inside the workflow definition. This name is also captured in the RefName property of the TaskInfo object for the task.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- status string
- New status of the task being updated, only Failed and Completed statuses are supported, Completed is the default value in case no status is provided.*
Scheduled
- The enum represents the status when task is in scheduled state.*InProgress
- The enum represents the status when task is in-progress state.*NoOp
- The enum represents the status when task is a noop.*Timeout
- The enum represents the status when task has timed out.*Completed
- The enum represents the status when task has completed.*Failed
- The enum represents the status when task has failed.
- additional_
properties str - class_
id str - input str
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- name str
- Name of the task being updated and this name must match the task instance name included inside the workflow definition. This name is also captured in the RefName property of the TaskInfo object for the task.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- status str
- New status of the task being updated, only Failed and Completed statuses are supported, Completed is the default value in case no status is provided.*
Scheduled
- The enum represents the status when task is in scheduled state.*InProgress
- The enum represents the status when task is in-progress state.*NoOp
- The enum represents the status when task is a noop.*Timeout
- The enum represents the status when task has timed out.*Completed
- The enum represents the status when task has completed.*Failed
- The enum represents the status when task has failed.
- additional
Properties String - class
Id String - input String
- Inputs for the specified TaskInfo. Inputs must only be provided for tasks which has included an input definition and the inputs must match the constraints specified in the input definition.
- name String
- Name of the task being updated and this name must match the task instance name included inside the workflow definition. This name is also captured in the RefName property of the TaskInfo object for the task.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- status String
- New status of the task being updated, only Failed and Completed statuses are supported, Completed is the default value in case no status is provided.*
Scheduled
- The enum represents the status when task is in scheduled state.*InProgress
- The enum represents the status when task is in-progress state.*NoOp
- The enum represents the status when task is a noop.*Timeout
- The enum represents the status when task has timed out.*Completed
- The enum represents the status when task has completed.*Failed
- The enum represents the status when task has failed.
WorkflowWorkflowInfoVersionContext, WorkflowWorkflowInfoVersionContextArgs
- Additional
Properties string - Class
Id string - Interested
Mos List<WorkflowWorkflow Info Version Context Interested Mo> - This complex property has following sub-properties:
- Marked
For boolDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- Nr
Version string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Ref
Mos List<WorkflowWorkflow Info Version Context Ref Mo> - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- Timestamp string
- (ReadOnly) The time this versioned Managed Object was created.
- Version
Type string - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- Additional
Properties string - Class
Id string - Interested
Mos []WorkflowWorkflow Info Version Context Interested Mo - This complex property has following sub-properties:
- Marked
For boolDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- Nr
Version string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Ref
Mos []WorkflowWorkflow Info Version Context Ref Mo - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- Timestamp string
- (ReadOnly) The time this versioned Managed Object was created.
- Version
Type string - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- additional
Properties String - class
Id String - interested
Mos List<WorkflowWorkflow Info Version Context Interested Mo> - This complex property has following sub-properties:
- marked
For BooleanDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nr
Version String - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos List<WorkflowWorkflow Info Version Context Ref Mo> - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- timestamp String
- (ReadOnly) The time this versioned Managed Object was created.
- version
Type String - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- additional
Properties string - class
Id string - interested
Mos WorkflowWorkflow Info Version Context Interested Mo[] - This complex property has following sub-properties:
- marked
For booleanDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nr
Version string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos WorkflowWorkflow Info Version Context Ref Mo[] - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- timestamp string
- (ReadOnly) The time this versioned Managed Object was created.
- version
Type string - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- additional_
properties str - class_
id str - interested_
mos Sequence[WorkflowWorkflow Info Version Context Interested Mo] - This complex property has following sub-properties:
- marked_
for_ booldeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nr_
version str - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref_
mos Sequence[WorkflowWorkflow Info Version Context Ref Mo] - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- timestamp str
- (ReadOnly) The time this versioned Managed Object was created.
- version_
type str - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- additional
Properties String - class
Id String - interested
Mos List<Property Map> - This complex property has following sub-properties:
- marked
For BooleanDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nr
Version String - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos List<Property Map> - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- timestamp String
- (ReadOnly) The time this versioned Managed Object was created.
- version
Type String - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
WorkflowWorkflowInfoVersionContextInterestedMo, WorkflowWorkflowInfoVersionContextInterestedMoArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoVersionContextRefMo, WorkflowWorkflowInfoVersionContextRefMoArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
WorkflowWorkflowInfoWorkflowCtx, WorkflowWorkflowInfoWorkflowCtxArgs
- Additional
Properties string - Class
Id string - Initiator
Ctxes List<WorkflowWorkflow Info Workflow Ctx Initiator Ctx> - Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator. This complex property has following sub-properties:
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Target
Ctx List<WorkflowLists Workflow Info Workflow Ctx Target Ctx List> - This complex property has following sub-properties:
- Workflow
Subtype string - (ReadOnly) The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- Workflow
Type string - (ReadOnly) Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- Additional
Properties string - Class
Id string - Initiator
Ctxes []WorkflowWorkflow Info Workflow Ctx Initiator Ctx - Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator. This complex property has following sub-properties:
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Target
Ctx []WorkflowLists Workflow Info Workflow Ctx Target Ctx List - This complex property has following sub-properties:
- Workflow
Subtype string - (ReadOnly) The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- Workflow
Type string - (ReadOnly) Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- additional
Properties String - class
Id String - initiator
Ctxes List<WorkflowWorkflow Info Workflow Ctx Initiator Ctx> - Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator. This complex property has following sub-properties:
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- target
Ctx List<WorkflowLists Workflow Info Workflow Ctx Target Ctx List> - This complex property has following sub-properties:
- workflow
Subtype String - (ReadOnly) The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- workflow
Type String - (ReadOnly) Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- additional
Properties string - class
Id string - initiator
Ctxes WorkflowWorkflow Info Workflow Ctx Initiator Ctx[] - Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator. This complex property has following sub-properties:
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- target
Ctx WorkflowLists Workflow Info Workflow Ctx Target Ctx List[] - This complex property has following sub-properties:
- workflow
Subtype string - (ReadOnly) The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- workflow
Type string - (ReadOnly) Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- additional_
properties str - class_
id str - initiator_
ctxes Sequence[WorkflowWorkflow Info Workflow Ctx Initiator Ctx] - Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator. This complex property has following sub-properties:
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- target_
ctx_ Sequence[Workflowlists Workflow Info Workflow Ctx Target Ctx List] - This complex property has following sub-properties:
- workflow_
subtype str - (ReadOnly) The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- workflow_
type str - (ReadOnly) Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
- additional
Properties String - class
Id String - initiator
Ctxes List<Property Map> - Details about initiator of the workflow. Any Intersight object resource can be set as the initiator of the workflow. For workflows executed by an Intersight service, an applicable service object will be set as the initiator. For example, during server profile deployment workflow, the server profile object will be set as the initiator by the system. For user created workflows, this field is optional and for workflows executed from Intersight workflow execution page, the workflow definition object will be set as the Initiator. This complex property has following sub-properties:
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- target
Ctx List<Property Map>Lists - This complex property has following sub-properties:
- workflow
Subtype String - (ReadOnly) The subtype of the dynamic workflow. For example - Intersight services offer the following subtypes [Validate, Deploy, Import] for dynamic workflow of type serverconfig. This field is not applicable for user created workflows.
- workflow
Type String - (ReadOnly) Intersight services set the type of dynamic workflow that need to be built and executed. This field is not applicable for user created workflows. WorkflowType set as ServerConfig states that a dynamic workflow is executing tasks related to server configuration.
WorkflowWorkflowInfoWorkflowCtxInitiatorCtx, WorkflowWorkflowInfoWorkflowCtxInitiatorCtxArgs
- Additional
Properties string - Class
Id string - Initiator
Moid string - The moid of the Intersight managed object that initiated the workflow.
- Initiator
Name string - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- Initiator
Type string - Type of Intersight managed object that initiated the workflow.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Additional
Properties string - Class
Id string - Initiator
Moid string - The moid of the Intersight managed object that initiated the workflow.
- Initiator
Name string - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- Initiator
Type string - Type of Intersight managed object that initiated the workflow.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- additional
Properties String - class
Id String - initiator
Moid String - The moid of the Intersight managed object that initiated the workflow.
- initiator
Name String - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiator
Type String - Type of Intersight managed object that initiated the workflow.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- additional
Properties string - class
Id string - initiator
Moid string - The moid of the Intersight managed object that initiated the workflow.
- initiator
Name string - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiator
Type string - Type of Intersight managed object that initiated the workflow.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- additional_
properties str - class_
id str - initiator_
moid str - The moid of the Intersight managed object that initiated the workflow.
- initiator_
name str - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiator_
type str - Type of Intersight managed object that initiated the workflow.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- additional
Properties String - class
Id String - initiator
Moid String - The moid of the Intersight managed object that initiated the workflow.
- initiator
Name String - Name of the initiator who started the workflow. The initiator can be Intersight managed object that triggered the workflow.
- initiator
Type String - Type of Intersight managed object that initiated the workflow.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
WorkflowWorkflowInfoWorkflowCtxTargetCtxList, WorkflowWorkflowInfoWorkflowCtxTargetCtxListArgs
- Additional
Properties string - Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Target
Moid string - (ReadOnly) Moid of the target Intersight managed object.
- Target
Name string - (ReadOnly) Name of the target instance.
- Target
Type string - (ReadOnly) Object type of the target Intersight managed object.
- Additional
Properties string - Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Target
Moid string - (ReadOnly) Moid of the target Intersight managed object.
- Target
Name string - (ReadOnly) Name of the target instance.
- Target
Type string - (ReadOnly) Object type of the target Intersight managed object.
- additional
Properties String - class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- target
Moid String - (ReadOnly) Moid of the target Intersight managed object.
- target
Name String - (ReadOnly) Name of the target instance.
- target
Type String - (ReadOnly) Object type of the target Intersight managed object.
- additional
Properties string - class
Id string - object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- target
Moid string - (ReadOnly) Moid of the target Intersight managed object.
- target
Name string - (ReadOnly) Name of the target instance.
- target
Type string - (ReadOnly) Object type of the target Intersight managed object.
- additional_
properties str - class_
id str - object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- target_
moid str - (ReadOnly) Moid of the target Intersight managed object.
- target_
name str - (ReadOnly) Name of the target instance.
- target_
type str - (ReadOnly) Object type of the target Intersight managed object.
- additional
Properties String - class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- target
Moid String - (ReadOnly) Moid of the target Intersight managed object.
- target
Name String - (ReadOnly) Name of the target instance.
- target
Type String - (ReadOnly) Object type of the target Intersight managed object.
WorkflowWorkflowInfoWorkflowDefinition, WorkflowWorkflowInfoWorkflowDefinitionArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type string - The fully-qualified name of the remote type referred by this relationship.
- Selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type string - The fully-qualified name of the remote type referred by this relationship.
- selector string
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional_
properties str - class_
id str - moid str
- The Moid of the referenced REST resource.
- object_
type str - The fully-qualified name of the remote type referred by this relationship.
- selector str
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
- additional
Properties String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type String - The fully-qualified name of the remote type referred by this relationship.
- selector String
- An OData $filter expression which describes the REST resource to be referenced. This field maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance being inserted/updated to fulfill the REST request.An error is returned if the filter matches zero or more than one REST resource.An example filter string is: Serial eq '3AA8B7T11'.
Import
intersight_workflow_workflow_info
can be imported using the Moid of the object, e.g.
$ pulumi import intersight:index/workflowWorkflowInfo:WorkflowWorkflowInfo example 1234567890987654321abcde
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- intersight ciscodevnet/terraform-provider-intersight
- License
- Notes
- This Pulumi package is based on the
intersight
Terraform Provider.