Job

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.

Overview

assocEntityType string
command enum (APPLICATION_SIGNATURE_IMPORT | APPLY_POLICY_CHANGES | ASSIGN_SELF_REBOOTSTRAP_REQ | BATCH_CRUD_REQUEST | BEGIN_POLICY_CHANGES | CERTIFICATE_NSG_RENEW | CERTIFICATE_NSG_REVOKE | CLEAR_IPSEC_DATA | CLEAR_MAC_MOVE_ALARMS | CLOUD_FORCE_CONFIG | CLOUD_SYNC | 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_LIFT_QUARANTINE | NSG_NOTIFICATION_TEST | NSG_QUARANTINE | NSG_REGISTRATION_INFO | NSG_VALIDATE_CONFIGURATION | PUBSUBNODE_AUDIT | RECOVER_NSG | 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) required   filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
parameters object
progress float
result object
status enum (FAILED | RUNNING | SUCCESS)

API Resource

/jobs/id
delete get put

Parents

/azureclouds/id/jobs
get post
/enterprises/id/jobs
get post
/redundancygroups/id/jobs
get post
/jobs
get post
/ikegatewayconnections/id/jobs
get post
/vscs/id/jobs
post
/vports/id/jobs
get post
/vnfs/id/jobs
post
/vrss/id/jobs
post
/hscs/id/jobs
post
/ingressadvfwdtemplates/id/jobs
get post
/zfbrequests/id/jobs
post
/netconfgateways/id/jobs
get post
/vcenterhypervisors/id/jobs
post
/domains/id/jobs
post
/gateways/id/jobs
get post
/vcenters/id/jobs
post
/l2domains/id/jobs
post
/nsgateways/id/jobs
get post
/vsds/id/jobs
post
/aggregateddomains/id/jobs
post
/l2domaintemplates/id/jobs
post
/domaintemplates/id/jobs
post
/egressacltemplates/id/jobs
get post
/ethernetsegmentgwgroups/id/jobs
get post
/vcenterclusters/id/jobs
post
/ingressacltemplates/id/jobs
get post

Children

/jobs/id/permissions
delete get post put
/jobs/id/metadatas
get post
/jobs/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

assocEntityType string
Discussion

Entity with which this job is associated Refer to API section for supported types.

Charateristics

Format: free
SDK attribute: assocEntityType

command enum required   filterable   orderable  
Discussion

Name of the command.

Charateristics

Allowed values: APPLICATION_SIGNATURE_IMPORT, APPLY_POLICY_CHANGES, ASSIGN_SELF_REBOOTSTRAP_REQ, BATCH_CRUD_REQUEST, BEGIN_POLICY_CHANGES, CERTIFICATE_NSG_RENEW, CERTIFICATE_NSG_REVOKE, CLEAR_IPSEC_DATA, CLEAR_MAC_MOVE_ALARMS, CLOUD_FORCE_CONFIG, CLOUD_SYNC, 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_LIFT_QUARANTINE, NSG_NOTIFICATION_TEST, NSG_QUARANTINE, NSG_REGISTRATION_INFO, NSG_VALIDATE_CONFIGURATION, PUBSUBNODE_AUDIT, RECOVER_NSG, 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

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

parameters object
Discussion

Additional arguments required for the specific command. Differs based on types of command.

Charateristics

Format: free
SDK attribute: parameters

progress float
Discussion

Indicates the progress of the job as a faction. eg : 0.5 means 50% done.

Charateristics

SDK attribute: progress

result object
Discussion

Results from the execution of the job

Charateristics

Format: free
SDK attribute: result

status enum
Discussion

Current status of the job. Possible values are RUNNING, FAILED, SUCCESS, .

Charateristics

Allowed values: FAILED, RUNNING, SUCCESS
Format: free
SDK attribute: status