Command

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.

Overview

assocEntityType string read only  
associatedParam string filterable  
associatedParamType string filterable  
command enum (NSG_APPLY_PATCH | NSG_DELETE_PATCH | NSG_DOWNLOAD_OS_IMAGE | NSG_UPGRADE_TO_IMAGE | UNKNOWN) required   creation only   filterable   orderable  
commandInformation string read only   autogenerated  
detail string read only  
detailedStatus string read only   autogenerated  
detailedStatusCode integer read only   autogenerated   filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
fullCommand string read only  
lastUpdatedBy string autogenerated  
override enum (ABANDON | UNSPECIFIED) filterable   orderable  
progress string read only  
status enum (ABANDONED | COMPLETED | FAILED | RUNNING | SKIPPED | STARTED | UNKNOWN) read only   autogenerated   filterable   orderable  
summary string read only  

API Resource

/commands/id
delete get put

Parents

/commands
get post
/nsgateways/id/commands
get post

Children

This object has no children.

Members

This object has no members.

Attributes documentation

assocEntityType string read only  
Discussion

Managed Object Type of the entity on which this Command is associated.

Charateristics

Format: free
SDK attribute: assocEntityType

associatedParam string filterable  
Discussion

Parameters to be supplied for execution of this command. This should be the ID of the object supplying parameters.

Charateristics

Format: free
Max length: 1023
SDK attribute: associatedParam

associatedParamType string filterable  
Discussion

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

Charateristics

Max length: 255
SDK attribute: associatedParamType

command enum required   creation only   filterable   orderable  
Discussion

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, ...

Charateristics

Allowed values: NSG_APPLY_PATCH, NSG_DELETE_PATCH, NSG_DOWNLOAD_OS_IMAGE, NSG_UPGRADE_TO_IMAGE, UNKNOWN
Default value: UNKNOWN
SDK attribute: command

commandInformation string read only   autogenerated  
Discussion

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, ...

Charateristics

Format: free
Max length: 1023
SDK attribute: commandInformation

detail string read only  
Discussion

Details about the command execution as reported directly from the NSG independent of status codes.

Charateristics

Format: free
Max length: 1023
SDK attribute: detail

detailedStatus string read only   autogenerated  
Discussion

A string representing the detailed status of the operation that was triggered by the execution of the Command instance.

Charateristics

Format: free
Max length: 255
SDK attribute: detailedStatus

detailedStatusCode integer read only   autogenerated   filterable   orderable  
Discussion

A numerical code mapping to a list of detailed statuses that can apply to a Command instance.

Charateristics

Default value: 0
Max value: 65535
SDK attribute: detailedStatusCode

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

fullCommand string read only  
Discussion

Full command including parameters that is to be executed.

Charateristics

Format: free
Max length: 1023
SDK attribute: fullCommand

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

override enum filterable   orderable  
Discussion

Operator specified action which overrides the normal life cycle of a command.

Charateristics

Allowed values: ABANDON, UNSPECIFIED
Default value: UNSPECIFIED
SDK attribute: override

progress string read only  
Discussion

JSON string detailing the progress of the command execution on Gateway.

Charateristics

Format: free
Max length: 1023
SDK attribute: progress

status enum read only   autogenerated   filterable   orderable  
Discussion

The status of the Command from a VSD perspective.

Charateristics

Allowed values: ABANDONED, COMPLETED, FAILED, RUNNING, SKIPPED, STARTED, UNKNOWN
Default value: UNKNOWN
SDK attribute: status

summary string read only  
Discussion

A generated summary for the action giving some general context on the command executed.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: summary