ADM NITRO APIs

config_job_details

Configuration for Configuration Job Details resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
sms_profiles Read-write Comma separated list of SMS profiles.

Maximum length = 128
execute_sequentially Read-write True if configuration template is to be applied to devices sequentially.
credentials_required Read-write True if username/password need to be asked before configuration template is to applied on devices.
name Read-write Name of configuration job.

Minimum length = 1

Maximum length = 128
template_info Read-write Configuration Template to be executed/scheduled.
tz_offset Read-write Time zone offset..
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.
auto_rollback Read-write True if auto_rollback enable for config job.
slack_profile Read-write name of the slack_profile.
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)..
device_family Read-write Family of Devices ns,sdx, cbwanopt for which config job was executed.

Minimum length = 1

Maximum length = 64
on_error Read-write Behaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT|ROLLBACK.

Minimum length = 1

Maximum length = 16
scheduleOptions Read-write Comma separated schedule options specific day(s) of week, specific date(s) of month.
devices <String[]> Read-write Device IP Address Array on which job is run.
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
commands <config_command[]> Read-write Array of commands part of the configuration template.
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.
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.
filename Read-write Config job details export output Filename.
commands_count Read-only Number of Commands to be executed on each device.
username Read-only Name of user who created configuration job.
devices_info <task_device_log[]> Read-only Array of device task logs.
lastExecutedTimeEpoch Read-only Schedule time epoch at which job was last executed..
tenant_id Read-only Tenant Id of the Config Jobs.
timestamp Read-only Time of Creation of Configuration Job.
lastExecutionStatus Read-only Status of last Execution of Config Job - Started, In Progress, Completed, Failed, Aborted, Scheduled.
executed_by Read-only Name of user who executed configuration job.
tasklog_id Read-only Task Log Id of the Config Job.
variables_count Read-only Number of Variables used in config commands.
devices_count Read-only Number of Devices on which commands executed.
preview_rollback_commands <String[]> Read-only Preview of list of rollback commands.
devices_completed_count Read-only Number of Devices on which commands execution completed.
preview_commands <String[]> Read-only Preview of list of commands.

Operations

(click to see Properties )

  • GET (ALL)

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

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/config_job_details Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/config_job_details ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of config_job_details 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_details ?pagesize=#no;pageno=#no Use this query-parameter to get the config_job_details resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/config_job_details ?count=yes Use this query-parameter to get the count of config_job_details resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "config_job_details":[{
"commands_count":<Integer_value>,
"scheduleTimes":<String_value>,
"sms_profiles":<String_value>,
"execute_sequentially":<Boolean_value>,
"credentials_required":<Boolean_value>,
"name":<String_value>,
"template_info":<configuration_template_value>,
"username":<String_value>,
"tz_offset":<Integer_value>,
"devices_info":[{
"parent_name":<String_value>,
"status":<String_value>,
"task_id":<String_value>,
"parent_id":<String_value>,
"starttime":<Integer_value>,
"device_user":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"endtime":<Integer_value>
"cmds_completed_fraction":<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>}],
"execute_batch":<Boolean_value>,
"lastExecutedTimeEpoch":<String_value>,
"tenant_id":<String_value>,
"execute_password":<String_value>,
"timestamp":<Integer_value>,
"devices_db":<String_value>,
"execute_on_secondary":<Boolean_value>,
"auto_rollback":<Boolean_value>,
"nextScheduleTimeEpoch":<String_value>,
"autoscale_groups_db":<String_value>,
"slack_profile":<String_value>,
"is_internal":<Boolean_value>,
"id":<String_value>,
"scheduleTimesEpoch":<String_value>,
"lastExecutionStatus":<String_value>,
"executed_by":<String_value>,
"device_family":<String_value>,
"tasklog_id":<String_value>,
"on_error":<String_value>,
"scheduleOptions":<String_value>,
"devices":<String_value>,
"device_groups_db":<String_value>,
"mail_profiles":<String_value>,
"execute_username":<String_value>,
"status":<String_value>,
"commands":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"index":<Integer_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"command":<String_value>}],
"node_id":<String_value>,
"variables_count":<Integer_value>,
"device_groups":<String_value>,
"autoscale_groups":<String_value>,
"execute_on_primary":<Boolean_value>,
"scheduleType":<String_value>,
"devices_count":<Integer_value>,
"preview_rollback_commands":<String_value>,
"devices_completed_count":<Integer_value>,
"execute_again":<Boolean_value>,
"preview_commands":<String_value>,
"filename":<String_value>}]}

<!--NeedCopy-->
config_job_details