config

config_job

Configuration for Configuration Job resource.

Read/write properties

device_groups<String[]>

Device Group Array on which for which job is run.

scheduleOptions<String>

Comma separated schedule options specific day(s) of week, specific date(s) of month.

scheduleTimesEpoch<String>

Schedule time UTC epoch (string representation of 11 digit numbers)..

credentials_required<Boolean>

True if username/password need to be asked before configuration template is to applied on devices.

id<String>

Id is system generated key for all the configuration jobs.

execute_on_primary<Boolean>

True if configuration run on HA primary instance.

mail_profiles<String>

Comma separated list of Mail profiles.
Maximum length = 128

device_family<String>

Family of Devices ns,sdx for which config job was executed.
Minimum length = 1
Maximum length = 64

status<String>

Status of Config Job Started, In Progress, Completed, Failed, Aborted, Scheduled .
Maximum length = 128

execute_username<String>

Execute User Name for job.
Maximum length = 127

name<String>

Name of configuration job.
Minimum length = 1
Maximum length = 128

execute_batch<Boolean>

True if config job commands execute as batch.

execute_on_secondary<Boolean>

True if configuration run on HA secondary instance.

slack_profile<String>

name of the slack_profile.

is_download_operation<Boolean>

True if job download file from device.

execute_sequentially<Boolean>

True if configuration template is to be applied to devices sequentially.

is_internal<Boolean>

True if internal action config job.

on_error<String>

Behaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT|ROLLBACK.
Minimum length = 1
Maximum length = 16

tz_offset<Integer>

Time zone offset..

autoscale_groups<String[]>

Autoscale Group Array on which for which job is run.

scheduleType<String>

Schedule Type fixed, daily, weekly, monthly of Configuration Template that is scheduled.

auto_rollback<Boolean>

True if auto_rollback enable for config job.

sms_profiles<String>

Comma separated list of SMS profiles.
Maximum length = 128

template_info<configuration_template>

Configuration Template to be executed/scheduled.

devices<String[]>

Device IP Address Array on which job is run.

execute_password<String>

Execute Password for job.
Maximum length = 127

variables<config_variable[]>

Values of Variables used in commands of the configuration template.

execute_again<Boolean>

True if Execute again the config job.

Read only properties

job_username_enc<String>

Name of user who created configuration job.

timestamp<Integer>

Time of Creation of Configuration Job.

username<String>

Name of user who created configuration job.

lastExecutionStatus<String>

Status of last Execution of Config Job - Started, In Progress, Completed, Failed, Aborted, Scheduled.

lastExecutedTimeEpoch<String>

Schedule time epoch at which job was last executed..

tenant_id<String>

Tenant Id of the Config Jobs.

tasklog_id<String>

Task Log Id of the Config Job.

executed_by<String>

Name of user who executed configuration job.

preview_commands<String[]>

Preview of list of commands.

preview_rollback_commands<String[]>

Preview of list of rollback commands.

devices_completed_count<Integer>

Number of Devices on which commands execution completed.

devices_count<Integer>

Number of Devices on which commands executed.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

add modify get (all)save delete

add

URL:https://<MGMT-IP>/nitro/v2/config/config_job?onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"config_job": {
      "slack_profile":<String_value>,
      "execute_on_secondary":<Boolean_value>,
      "execute_batch":<Boolean_value>,
      "execute_again":<Boolean_value>,
      "name":<String_value>,
      "execute_username":<String_value>,
      "status":<String_value>,
      "device_family":<String_value>,
      "mail_profiles":<String_value>,
      "execute_on_primary":<Boolean_value>,
      "id":<String_value>,
      "credentials_required":<Boolean_value>,
      "scheduleTimesEpoch":<String_value>,
      "scheduleOptions":<String_value>,
      "device_groups":<String_value[]>,
      "variables":[{
      "name":<String_value>,
      "device_values":[{
      "id":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>,
      "device":<String_value>,
      "value":<String_value>}],
      "id":<String_value>,
      "default_value":<String_value>,
      "display_name":<String_value>,
      "parent_name":<String_value>,
      "values_enum_db":<String_value>,
      "valuex":<String_value>,
      "type":<String_value>,
      "description":<String_value>,
      "parent_id":<String_value>,
      "value":<String_value>}],
      "devices":<String_value[]>,
      "execute_password":<String_value>,
      "template_info":<configuration_template_value>,
      "sms_profiles":<String_value>,
      "auto_rollback":<Boolean_value>,
      "scheduleType":<String_value>,
      "autoscale_groups":<String_value[]>,
      "tz_offset":<Integer_value>,
      "on_error":<String_value>,
      "is_internal":<Boolean_value>,
      "execute_sequentially":<Boolean_value>,
      "is_download_operation":<Boolean_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "config_job":[{
      "device_groups":<String_value>,
      "scheduleOptions":<String_value>,
      "scheduleTimesEpoch":<String_value>,
      "credentials_required":<Boolean_value>,
      "job_username_enc":<String_value>,
      "id":<String_value>,
      "execute_on_primary":<Boolean_value>,
      "timestamp":<Integer_value>,
      "username":<String_value>,
      "lastExecutionStatus":<String_value>,
      "lastExecutedTimeEpoch":<String_value>,
      "mail_profiles":<String_value>,
      "device_groups_db":<String_value>,
      "resilience_devices_db":<String_value>,
      "isRetryForResilienceJob":<Boolean_value>,
      "device_family":<String_value>,
      "scheduleTimes":<String_value>,
      "tenant_id":<String_value>,
      "status":<String_value>,
      "execute_username":<String_value>,
      "name":<String_value>,
      "autoscale_groups_db":<String_value>,
      "execute_batch":<Boolean_value>,
      "devices_db":<String_value>,
      "execute_on_secondary":<Boolean_value>,
      "slack_profile":<String_value>,
      "tasklog_id":<String_value>,
      "is_download_operation":<Boolean_value>,
      "node_id":<String_value>,
      "execute_sequentially":<Boolean_value>,
      "is_internal":<Boolean_value>,
      "executed_by":<String_value>,
      "on_error":<String_value>,
      "nextScheduleTimeEpoch":<String_value>,
      "tz_offset":<Integer_value>,
      "autoscale_groups":<String_value>,
      "scheduleType":<String_value>,
      "auto_rollback":<Boolean_value>,
      "sms_profiles":<String_value>,
      "template_info":<configuration_template_value>,
      "devices":<String_value>,
      "execute_password":<String_value>,
      "isADMResilienceJob":<Boolean_value>,
      "variables":[{
      "display_name":<String_value>,
      "parent_name":<String_value>,
      "name":<String_value>,
      "values_enum_db":<String_value>,
      "parent_id":<String_value>,
      "value":<String_value>,
      "type":<String_value>,
      "default_value":<String_value>,
      "description":<String_value>,
      "device_values_mapping":<String_value>,
      "valuex":<String_value>,
      "device_values":[{
      "valuex":<String_value>,
      "parent_id":<String_value>,
      "device_group":<String_value>,
      "value":<String_value>,
      "id":<String_value>,
      "device":<String_value>,
      "parent_name":<String_value>}],
      "id":<String_value>}],
      "preview_commands":<String_value>,
      "preview_rollback_commands":<String_value>,
      "devices_completed_count":<Integer_value>,
      "execute_again":<Boolean_value>,
      "devices_count":<Integer_value>}]}

modify

URL:https://<MGMT-IP>/nitro/v2/config/config_job/id_value<String>

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"config_job":{
      "id":<String_value>,
      "execute_sequentially":<Boolean_value>,
      "is_download_operation":<Boolean_value>,
      "on_error":<String_value>,
      "is_internal":<Boolean_value>,
      "scheduleType":<String_value>,
      "autoscale_groups":<String_value[]>,
      "tz_offset":<Integer_value>,
      "variables":[{
      "name":<String_value>,
      "device_values":[{
      "id":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>,
      "device":<String_value>,
      "value":<String_value>}],
      "id":<String_value>,
      "default_value":<String_value>,
      "display_name":<String_value>,
      "parent_name":<String_value>,
      "values_enum_db":<String_value>,
      "valuex":<String_value>,
      "type":<String_value>,
      "description":<String_value>,
      "parent_id":<String_value>,
      "value":<String_value>}],
      "execute_password":<String_value>,
      "devices":<String_value[]>,
      "template_info":<configuration_template_value>,
      "sms_profiles":<String_value>,
      "auto_rollback":<Boolean_value>,
      "scheduleTimesEpoch":<String_value>,
      "scheduleOptions":<String_value>,
      "device_groups":<String_value[]>,
      "mail_profiles":<String_value>,
      "execute_on_primary":<Boolean_value>,
      "credentials_required":<Boolean_value>,
      "name":<String_value>,
      "execute_username":<String_value>,
      "status":<String_value>,
      "device_family":<String_value>,
      "slack_profile":<String_value>,
      "execute_on_secondary":<Boolean_value>,
      "execute_batch":<Boolean_value>,
      "execute_again":<Boolean_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/config_job

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/config_job?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of config_job resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/config_job?pagesize=#no&pageno=#no

Use this query-parameter to get the config_job resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/config_job?count=yes

Use this query-parameter to get the count of config_job resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

save

URL:https://<MGMT-IP>/nitro/v2/config/config_job?action=save&onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"config_job": {
      "execute_sequentially":<Boolean_value>,
      "is_download_operation":<Boolean_value>,
      "on_error":<String_value>,
      "is_internal":<Boolean_value>,
      "autoscale_groups":<String_value[]>,
      "scheduleType":<String_value>,
      "tz_offset":<Integer_value>,
      "variables":[{
      "name":<String_value>,
      "device_values":[{
      "id":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>,
      "device":<String_value>,
      "value":<String_value>}],
      "id":<String_value>,
      "default_value":<String_value>,
      "display_name":<String_value>,
      "parent_name":<String_value>,
      "values_enum_db":<String_value>,
      "valuex":<String_value>,
      "type":<String_value>,
      "description":<String_value>,
      "parent_id":<String_value>,
      "value":<String_value>}],
      "auto_rollback":<Boolean_value>,
      "sms_profiles":<String_value>,
      "template_info":<configuration_template_value>,
      "execute_password":<String_value>,
      "devices":<String_value[]>,
      "scheduleTimesEpoch":<String_value>,
      "device_groups":<String_value[]>,
      "scheduleOptions":<String_value>,
      "mail_profiles":<String_value>,
      "credentials_required":<Boolean_value>,
      "id":<String_value>,
      "execute_on_primary":<Boolean_value>,
      "status":<String_value>,
      "execute_username":<String_value>,
      "name":<String_value>,
      "device_family":<String_value>,
      "execute_on_secondary":<Boolean_value>,
      "slack_profile":<String_value>,
      "execute_again":<Boolean_value>,
      "execute_batch":<Boolean_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

delete

URL:https://<MGMT-IP>/nitro/v2/config/config_job/id_value<String>

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }