A Command represents an operation that needs to be executed on an entity (NSG, Gateway, ...) which requires little processing by VSD, but may result in a long activity on the external entity. An example would be to trigger an action on VSD so that a Gateway download a new image. VSDs handling of the request is limited to generating a message to be sent to the device on which the download process is expected. The device then acts on the request and proceeds with the download... That may be a long process. The commands API is similar to the Jobs API with regards to triggering operations on objects.
This object has no children.
This object has no members.
Managed Object Type of the entity on which this Command is associated.
Format: free
SDK attribute: assocEntityType
Parameters to be supplied for execution of this command. This should be the ID of the object supplying parameters.
Format: free
Max length: 1023
SDK attribute: associatedParam
Type of the object which supplies parameters for this command. For NSG_APPLY_PATCH command this should be NSG_PATCH_PROFILE. For NSG_DELETE_PATCH it should be PATCH
Max length: 255
SDK attribute: associatedParamType
Specifies the type of command that is stated for execution on the system receiving the operation request. A request for download, a request for upgrade, a request for revocation, ...
Allowed values: NSG_APPLY_PATCH, NSG_CONTAINER_TEST_SUITE_RUN, NSG_DELETE_PATCH, NSG_DOWNLOAD_OS_IMAGE, NSG_OVERLAY_SYSLOG_CONTAINER_RESTART, NSG_OVERLAY_SYSLOG_CONTAINER_START, NSG_OVERLAY_SYSLOG_CONTAINER_STOP, NSG_REBOOT, NSG_RENEW_CERT, NSG_UPDATE_INFO, NSG_UPGRADE_TO_IMAGE, UNKNOWN
Default value: UNKNOWN
SDK attribute: command
Informative details on what command is to be executed. It complements the commandType attribute. An example of a value could be a URL, a version number, a UUID of another object, ...
Format: free
Max length: 1023
SDK attribute: commandInformation
Time stamp when this object was created.
SDK attribute: creationDate
Details about the command execution as reported directly from the NSG independent of status codes.
Format: free
Max length: 1023
SDK attribute: detail
A string representing the detailed status of the operation that was triggered by the execution of the Command instance.
Format: free
Max length: 255
SDK attribute: detailedStatus
A numerical code mapping to a list of detailed statuses that can apply to a Command instance.
Default value: 0
Max value: 65535
SDK attribute: detailedStatusCode
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
Full command including parameters that is to be executed.
Format: free
Max length: 1023
SDK attribute: fullCommand
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Time stamp when this object was last updated.
SDK attribute: lastUpdatedDate
Operator specified action which overrides the normal life cycle of a command.
Allowed values: ABANDON, UNSPECIFIED
Default value: UNSPECIFIED
SDK attribute: override
Identifies the user that has created this object.
Format: free
SDK attribute: owner
JSON string detailing the progress of the command execution on Gateway.
Format: free
Max length: 1023
SDK attribute: progress
The status of the Command from a VSD perspective.
Allowed values: ABANDONED, COMPLETED, FAILED, RUNNING, SKIPPED, STARTED, UNKNOWN
Default value: UNKNOWN
SDK attribute: status
A generated summary for the action giving some general context on the command executed.
Format: free
Min length: 1
Max length: 255
SDK attribute: summary