Represents JOB entity. The job API accepts a command and parameters and executes the job and returns the results. Jobs API are typically used for long running tasks.
assocEntityType |
command |
entityScope |
externalID |
lastUpdatedBy |
parameters |
progress |
result |
status |
This object has no members.
Entity with which this job is associated Refer to API section for supported types.
Format: free
SDK attribute: assocEntityType
Name of the command.
Allowed values: APPLY_POLICY_CHANGES, BATCH_CRUD_REQUEST, BEGIN_POLICY_CHANGES, CERTIFICATE_NSG_RENEW, CERTIFICATE_NSG_REVOKE, CLEAR_IPSEC_DATA, CLEAR_MAC_MOVE_ALARMS, DEPLOY, DISCARD_POLICY_CHANGES, EXPORT, FORCE_KEYSERVER_UPDATE, FORCE_KEYSERVER_UPDATE_ACK, FORCE_KEYSERVER_VSD_RESYNC, GATEWAY_AUDIT, GET_ZFB_INFO, IMPORT, KEYSERVER_NOTIFICATION_TEST, NETCONF_FORCE_DEPLOY, NETCONF_SYNC, NOTIFY_NSG_REGISTRATION, NOTIFY_NSG_REGISTRATION_ACK, NOTIFY_NSG_REGISTRATION_TEST, NSG_NOTIFICATION_TEST, NSG_REGISTRATION_INFO, REDEPLOY, REJECT_ZFB_REQUEST, RELOAD, RELOAD_GEO_REDUNDANT_INFO, RELOAD_NSG_CONFIG, RESTART, RETRIEVE_ACTIVE_NSGS, SAAS_APPLICATION_TYPE, START, STATUS, STOP, SYNC, UNDEPLOY, VCENTER_ADD_COMPUTERESOURCE_INSCOPE, VCENTER_DELETE_AGENCY, VCENTER_MARK_AGENT_VM_AVAILABLE, VCENTER_RECONNECT, VCENTER_RELOAD, VCENTER_REMOVE_COMPUTERESOURCE_INSCOPE, VCENTER_SCRIPT_UPGRADE_VRS, VCENTER_SYNC, VCENTER_UPGRADE_VRS
SDK attribute: command
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
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Additional arguments required for the specific command. Differs based on types of command.
Format: free
SDK attribute: parameters
Indicates the progress of the job as a faction. eg : 0.5 means 50% done.
SDK attribute: progress
Results from the execution of the job
Format: free
SDK attribute: result
Current status of the job. Possible values are RUNNING, FAILED, SUCCESS, .
Allowed values: FAILED, RUNNING, SUCCESS
Format: free
SDK attribute: status