config_job
Configuration for Configuration Job resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| scheduleTimes | <String> | Read-write | Comma Seperated times of the day(HH:MM) on which Configuration Template is scheduled. |
| sms_profiles | <String> | Read-write | Comma seperated list of SMS profiles. |
| execute_sequentially | <Boolean> | Read-write | True if configuration template is to be applied to devices sequentially. |
| id | <String> | Read-write | Id is system generated key for all the configuration jobs. |
| scheduleTimesEpoch | <String> | Read-write | Schedule time epoch (string representation of 11 digit numbers).. |
| credentials_required | <Boolean> | Read-write | True if username/password need to be asked before configuration template is to applied on devices. |
| device_family | <String> | Read-write | Family of Devices for which config job was executed. Minimum length = 1 Maximum length = 64 |
| tasklog_id | <String> | Read-write | Task Log Id of the Config Job. Minimum length = 1 Maximum length = 128 |
| name | <String> | Read-write | Name of configuration job. Minimum length = 1 Maximum length = 128 |
| template_info | <configuration_template> | Read-write | Configuration Template to be executed/scheduled. |
| on_error | <String> | 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 | <String> | Read-write | Comma Seperated Options for scheduling Configuration Template. |
| tz_offset | <Integer> | Read-write | Time zone offset.. |
| mail_profiles | <String> | Read-write | Comma seperated list of Mail profiles. |
| device_groups_db | <String> | Read-write | Device Groups List Comma Seperated on which job is run. |
| execute_username | <String> | Read-write | Execute User Name for job. Maximum length = 127 |
| variables | <config_variable[]> | Read-write | Values of Variables used in commands of the configuration template. |
| lastExecutedTimeEpoch | <String> | Read-write | Schedule time epoch at which job was last executed.. |
| execute_batch | <Boolean> | Read-write | True if config job commands execute as batch. |
| node_id | <String> | Read-write | Node id of the node executing the task in a Multinode / HA deployment. |
| execute_password | <String> | Read-write | Execute Password for job. Maximum length = 127 |
| devices_db | <String> | Read-write | Device IP Address List Comma Seperated on which job is run. |
| device_groups | <String[]> | Read-write | Device Group Array on which for which job is run. |
| scheduleType | <String> | Read-write | Schedule Type of Configuration Template that is scheduled. |
| nextScheduleTimeEpoch | <String> | Read-write | Schedule time epoch at which job is scheduled to be run next.. |
| preview_commands | <String[]> | Read-write | Preview of list of commands. |
| preview_rollback_commands | <String[]> | Read-write | Preview of list of rollback commands. |
| executed_by | <String> | Read-only | Name of user who executed configuration job. |
| lastExecutionStatus | <String> | Read-only | Status of last Execution of Config Job. |
| username | <String> | Read-only | Name of user who created configuration job. |
| status | <String> | Read-only | Status of Config Job. |
| tenant_id | <String> | Read-only | Tenant Id of the Config Jobs. |
| timestamp | <Integer> | Read-only | Time of Creation of Configuration Job. |
| devices_count | <Integer> | Read-only | Number of Devices on which commands executed. |
| devices_completed_count | <Integer> | Read-only | Devices Completed Count. |
Operations
(click to see Properties)
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>.
add
URL: https://<MGMT-IP>/nitro/v1/config/config_job?onerror=<String_value>
HTTP Method: null
Request Payload:
{config_job: {
"scheduleTimes":<String_value>,
"sms_profiles":<String_value>,
"execute_sequentially":<Boolean_value>,
"preview_rollback_commands":<String_value[]>,
"id":<String_value>,
"credentials_required":<Boolean_value>,
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"template_info":<configuration_template_value>,
"on_error":<String_value>,
"tz_offset":<Integer_value>,
"scheduleOptions":<String_value>,
"devices":<String_value[]>,
"device_groups_db":<String_value>,
"mail_profiles":<String_value>,
"execute_username":<String_value>,
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"parent_id":<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>,
"lastExecutedTimeEpoch":<String_value>,
"execute_password":<String_value>,
"node_id":<String_value>,
"devices_db":<String_value>,
"device_groups":<String_value[]>,
"scheduleType":<String_value>,
"preview_commands":<String_value[]>,
"nextScheduleTimeEpoch":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "config_job":[{
"scheduleTimes":<String_value>,
"sms_profiles":<String_value>,
"execute_sequentially":<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>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>,
"device_groups":<String_value>,
"scheduleType":<String_value>,
"nextScheduleTimeEpoch":<String_value>,
"preview_commands":<String_value>,
"preview_rollback_commands":<String_value>,
"devices_count":<Integer_value>,
"devices_completed_count":<Integer_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/config_job/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/config_job
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "config_job":[{
"scheduleTimes":<String_value>,
"sms_profiles":<String_value>,
"execute_sequentially":<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>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>,
"device_groups":<String_value>,
"scheduleType":<String_value>,
"nextScheduleTimeEpoch":<String_value>,
"preview_commands":<String_value>,
"preview_rollback_commands":<String_value>,
"devices_count":<Integer_value>,
"devices_completed_count":<Integer_value>}]}
modify
URL: https://<MGMT-IP>/nitro/v1/config/config_job/id_value<String>
HTTP Method: null
Request Payload:
{config_job:{
<b>"id":<String_value></b>,
"scheduleTimes":<String_value>,
"sms_profiles":<String_value>,
"execute_sequentially":<Boolean_value>,
"preview_rollback_commands":<String_value[]>,
"credentials_required":<Boolean_value>,
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"template_info":<configuration_template_value>,
"on_error":<String_value>,
"tz_offset":<Integer_value>,
"scheduleOptions":<String_value>,
"devices":<String_value[]>,
"device_groups_db":<String_value>,
"mail_profiles":<String_value>,
"execute_username":<String_value>,
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"parent_id":<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>,
"lastExecutedTimeEpoch":<String_value>,
"execute_password":<String_value>,
"node_id":<String_value>,
"devices_db":<String_value>,
"device_groups":<String_value[]>,
"scheduleType":<String_value>,
"preview_commands":<String_value[]>,
"nextScheduleTimeEpoch":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "config_job":[{
"scheduleTimes":<String_value>,
"sms_profiles":<String_value>,
"execute_sequentially":<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>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>,
"device_groups":<String_value>,
"scheduleType":<String_value>,
"nextScheduleTimeEpoch":<String_value>,
"preview_commands":<String_value>,
"preview_rollback_commands":<String_value>,
"devices_count":<Integer_value>,
"devices_completed_count":<Integer_value>}]}