# ApiCommandStep Data Model

Provides detailed information about a step of a command.

Properties
name | data type | description
--- | --- | ---
description | string | The command step description.
startTime | string | The start time.
endTime | string | The end time, if the command step is finished.
state | State | Current state of the command step
resultMessage | string | If the command step is finished, the result message.
ignoreError | boolean | Whether the step will continue even upon error.
parallel | boolean | Whether the children are scattered simultaneously, i.e. parallel. If not they would execute one after another, i.e. serially.
processes | array of ApiCommandStepProcess | List of processes executed by the command step.
clientConfigs | array of ApiCommandStepProcess | List of command step client configs.
roles | array of ApiRoleRef | List of command step roles.
clusters | array of ApiClusterRef | List of clusters associated with command step.
hosts | array of ApiHostRef | List of hosts associated with command step.
services | array of ApiServiceRef | List of services associated with command step.
children | array of ApiCommandStep | List of child command steps.
commands | array of ApiCommand | List of subcommands. The list contains only the summary view of the commands.
remoteCommand | ApiRemoteCommand | Remote command executed by the current step on a peer cluster.

Example

    {
      "description" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "state" : "FAILED",
      "resultMessage" : "...",
      "ignoreError" : true,
      "parallel" : true,
      "processes" : [ {
        "name" : "...",
        "id" : 12345,
        "program" : "...",
        "args" : "...",
        "stdout" : "...",
        "stderr" : "...",
        "exitCode" : 12345
      }, {
        "name" : "...",
        "id" : 12345,
        "program" : "...",
        "args" : "...",
        "stdout" : "...",
        "stderr" : "...",
        "exitCode" : 12345
      } ],
      "clientConfigs" : [ {
        "name" : "...",
        "id" : 12345,
        "program" : "...",
        "args" : "...",
        "stdout" : "...",
        "stderr" : "...",
        "exitCode" : 12345
      }, {
        "name" : "...",
        "id" : 12345,
        "program" : "...",
        "args" : "...",
        "stdout" : "...",
        "stderr" : "...",
        "exitCode" : 12345
      } ],
      "roles" : [ {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "HISTORY_NOT_AVAILABLE",
        "roleStatus" : "STARTING"
      }, {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "BAD",
        "roleStatus" : "STOPPED"
      } ],
      "clusters" : [ {
        "clusterName" : "...",
        "displayName" : "..."
      }, {
        "clusterName" : "...",
        "displayName" : "..."
      } ],
      "hosts" : [ {
        "hostId" : "...",
        "hostname" : "..."
      }, {
        "hostId" : "...",
        "hostname" : "..."
      } ],
      "services" : [ {
        "peerName" : "...",
        "clusterName" : "...",
        "clusterDisplayName" : "...",
        "serviceName" : "...",
        "serviceDisplayName" : "...",
        "serviceType" : "..."
      }, {
        "peerName" : "...",
        "clusterName" : "...",
        "clusterDisplayName" : "...",
        "serviceName" : "...",
        "serviceDisplayName" : "...",
        "serviceType" : "..."
      } ],
      "children" : [ {
        "description" : "...",
        "startTime" : "...",
        "endTime" : "...",
        "state" : "SUCCEEDED",
        "resultMessage" : "...",
        "ignoreError" : true,
        "parallel" : true,
        "processes" : [ {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        }, {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        } ],
        "clientConfigs" : [ {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        }, {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        } ],
        "roles" : [ {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "DISABLED",
          "roleStatus" : "STARTING"
        }, {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "DISABLED",
          "roleStatus" : "STOPPING"
        } ],
        "clusters" : [ {
          "clusterName" : "...",
          "displayName" : "..."
        }, {
          "clusterName" : "...",
          "displayName" : "..."
        } ],
        "hosts" : [ {
          "hostId" : "...",
          "hostname" : "..."
        }, {
          "hostId" : "...",
          "hostname" : "..."
        } ],
        "services" : [ {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        }, {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        } ],
        "children" : [ { }, { } ],
        "commands" : [ {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        }, {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        } ],
        "remoteCommand" : {
          "id" : 12345,
          "peerName" : "..."
        }
      }, {
        "description" : "...",
        "startTime" : "...",
        "endTime" : "...",
        "state" : "SUCCEEDED",
        "resultMessage" : "...",
        "ignoreError" : true,
        "parallel" : true,
        "processes" : [ {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        }, {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        } ],
        "clientConfigs" : [ {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        }, {
          "name" : "...",
          "id" : 12345,
          "program" : "...",
          "args" : "...",
          "stdout" : "...",
          "stderr" : "...",
          "exitCode" : 12345
        } ],
        "roles" : [ {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "HISTORY_NOT_AVAILABLE",
          "roleStatus" : "BUSY"
        }, {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "BAD",
          "roleStatus" : "STARTING"
        } ],
        "clusters" : [ {
          "clusterName" : "...",
          "displayName" : "..."
        }, {
          "clusterName" : "...",
          "displayName" : "..."
        } ],
        "hosts" : [ {
          "hostId" : "...",
          "hostname" : "..."
        }, {
          "hostId" : "...",
          "hostname" : "..."
        } ],
        "services" : [ {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        }, {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        } ],
        "children" : [ { }, { } ],
        "commands" : [ {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        }, {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        } ],
        "remoteCommand" : {
          "id" : 12345,
          "peerName" : "..."
        }
      } ],
      "commands" : [ {
        "id" : 12345,
        "name" : "...",
        "startTime" : "...",
        "endTime" : "...",
        "active" : true,
        "success" : true,
        "resultMessage" : "...",
        "resultDataUrl" : "...",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "serviceRef" : {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        },
        "roleRef" : {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "CONCERNING",
          "roleStatus" : "STARTED"
        },
        "hostRef" : {
          "hostId" : "...",
          "hostname" : "..."
        },
        "parent" : { },
        "children" : {
          "items" : [ { }, { } ]
        },
        "canRetry" : true
      }, {
        "id" : 12345,
        "name" : "...",
        "startTime" : "...",
        "endTime" : "...",
        "active" : true,
        "success" : true,
        "resultMessage" : "...",
        "resultDataUrl" : "...",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "serviceRef" : {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        },
        "roleRef" : {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "BAD",
          "roleStatus" : "NA"
        },
        "hostRef" : {
          "hostId" : "...",
          "hostname" : "..."
        },
        "parent" : { },
        "children" : {
          "items" : [ { }, { } ]
        },
        "canRetry" : true
      } ],
      "remoteCommand" : {
        "id" : 12345,
        "peerName" : "..."
      }
    }