ADM NITRO APIs

config_job

June 20, 2023

Contributed by:

Configuration for Configuration Job resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
sms_profiles		Read-write	Comma separated list of SMS profiles. Maximum length = 128
slack_profile		Read-write	name of the slack_profile.
execute_sequentially		Read-write	True if configuration template is to be applied to devices sequentially.
is_internal		Read-write	True if internal action config job.
id		Read-write	Id is system generated key for all the configuration jobs.
scheduleTimesEpoch		Read-write	Schedule time UTC epoch (string representation of 11 digit numbers)..
credentials_required		Read-write	True if username/password need to be asked before configuration template is to applied on devices.
device_family		Read-write	Family of Devices ns,sdx, cbwanopt for which config job was executed. Minimum length = 1 Maximum length = 64
name		Read-write	Name of configuration job. Minimum length = 1 Maximum length = 128
template_info		Read-write	Configuration Template to be executed/scheduled.
on_error		Read-write	Behaviour on encountering error while applying configuration template on a device: CONTINUE\|EXIT\|ROLLBACK. Minimum length = 1 Maximum length = 16
devices	<String[]>	Read-write	Device IP Address Array on which job is run.
scheduleOptions		Read-write	Comma separated schedule options specific day(s) of week, specific date(s) of month.
tz_offset		Read-write	Time zone offset..
mail_profiles		Read-write	Comma separated list of Mail profiles. Maximum length = 128
execute_username		Read-write	Execute User Name for job. Maximum length = 127
status		Read-write	Status of Config Job Started, In Progress, Completed, Failed, Aborted, Scheduled . Maximum length = 128
variables	<config_variable[]>	Read-write	Values of Variables used in commands of the configuration template.
execute_batch		Read-write	True if config job commands execute as batch.
execute_password		Read-write	Execute Password for job. Maximum length = 127
execute_on_secondary		Read-write	True if configuration run on HA secondary instance.
device_groups	<String[]>	Read-write	Device Group Array on which for which job is run.
autoscale_groups	<String[]>	Read-write	Autoscale Group Array on which for which job is run.
auto_rollback		Read-write	True if auto_rollback enable for config job.
execute_on_primary		Read-write	True if configuration run on HA primary instance.
scheduleType		Read-write	Schedule Type fixed, daily, weekly, monthly of Configuration Template that is scheduled.
execute_again		Read-write	True if Execute again the config job.
executed_by		Read-only	Name of user who executed configuration job.
lastExecutionStatus		Read-only	Status of last Execution of Config Job - Started, In Progress, Completed, Failed, Aborted, Scheduled.
tasklog_id		Read-only	Task Log Id of the Config Job.
username		Read-only	Name of user who created configuration job.
tenant_id		Read-only	Tenant Id of the Config Jobs.
lastExecutedTimeEpoch		Read-only	Schedule time epoch at which job was last executed..
timestamp		Read-only	Time of Creation of Configuration Job.
preview_commands	<String[]>	Read-only	Preview of list of commands.
preview_rollback_commands	<String[]>	Read-only	Preview of list of rollback commands.
devices_count		Read-only	Number of Devices on which commands executed.
devices_completed_count		Read-only	Number of Devices on which commands execution completed.

Operations

(click to see Properties )

SAVE
ADD
DELETE
GET (ALL)
MODIFY

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:* Mandatory parameters are marked in red and placeholder content is marked in green

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

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:

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

<!--NeedCopy-->

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:

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

<!--NeedCopy-->

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:

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

<!--NeedCopy-->

Response Payload:

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

<!--NeedCopy-->

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 Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

<!--NeedCopy-->

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 Headers:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

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:

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

<!--NeedCopy-->

Response Payload:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

config_job

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

config_job

Properties

Operations

save

add

delete

get (all)

modify

In this article