58 lines
52 KiB
HTML
58 lines
52 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>config_job</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">config_job</p>
|
|
<P>Configuration for Configuration Job resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">device_groups<span class="property_type"><String[]></span></p><p class="property_description">Device Group Array on which for which job is run.</p>
|
|
<p class="property_name">scheduleOptions<span class="property_type"><String></span></p><p class="property_description">Comma separated schedule options specific day(s) of week, specific date(s) of month.</p>
|
|
<p class="property_name">scheduleTimesEpoch<span class="property_type"><String></span></p><p class="property_description">Schedule time UTC epoch (string representation of 11 digit numbers)..</p>
|
|
<p class="property_name">credentials_required<span class="property_type"><Boolean></span></p><p class="property_description">True if username/password need to be asked before configuration template is to applied on devices.</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the configuration jobs.</p>
|
|
<p class="property_name">execute_on_primary<span class="property_type"><Boolean></span></p><p class="property_description">True if configuration run on HA primary instance.</p>
|
|
<p class="property_name">mail_profiles<span class="property_type"><String></span></p><p class="property_description">Comma separated list of Mail profiles.<br> Maximum length = 128</p>
|
|
<p class="property_name">device_family<span class="property_type"><String></span></p><p class="property_description">Family of Devices ns,sdx for which config job was executed.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">status<span class="property_type"><String></span></p><p class="property_description">Status of Config Job Started, In Progress, Completed, Failed, Aborted, Scheduled .<br> Maximum length = 128</p>
|
|
<p class="property_name">execute_username<span class="property_type"><String></span></p><p class="property_description">Execute User Name for job.<br> Maximum length = 127</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Name of configuration job.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">execute_batch<span class="property_type"><Boolean></span></p><p class="property_description">True if config job commands execute as batch.</p>
|
|
<p class="property_name">execute_on_secondary<span class="property_type"><Boolean></span></p><p class="property_description">True if configuration run on HA secondary instance.</p>
|
|
<p class="property_name">slack_profile<span class="property_type"><String></span></p><p class="property_description">name of the slack_profile.</p>
|
|
<p class="property_name">is_download_operation<span class="property_type"><Boolean></span></p><p class="property_description">True if job download file from device.</p>
|
|
<p class="property_name">execute_sequentially<span class="property_type"><Boolean></span></p><p class="property_description">True if configuration template is to be applied to devices sequentially.</p>
|
|
<p class="property_name">is_internal<span class="property_type"><Boolean></span></p><p class="property_description">True if internal action config job.</p>
|
|
<p class="property_name">on_error<span class="property_type"><String></span></p><p class="property_description">Behaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT|ROLLBACK.<br> Minimum length = 1<br> Maximum length = 16</p>
|
|
<p class="property_name">tz_offset<span class="property_type"><Integer></span></p><p class="property_description">Time zone offset..</p>
|
|
<p class="property_name">autoscale_groups<span class="property_type"><String[]></span></p><p class="property_description">Autoscale Group Array on which for which job is run.</p>
|
|
<p class="property_name">scheduleType<span class="property_type"><String></span></p><p class="property_description">Schedule Type fixed, daily, weekly, monthly of Configuration Template that is scheduled.</p>
|
|
<p class="property_name">auto_rollback<span class="property_type"><Boolean></span></p><p class="property_description">True if auto_rollback enable for config job.</p>
|
|
<p class="property_name">sms_profiles<span class="property_type"><String></span></p><p class="property_description">Comma separated list of SMS profiles.<br> Maximum length = 128</p>
|
|
<p class="property_name">template_info<span class="property_type"><configuration_template></span></p><p class="property_description">Configuration Template to be executed/scheduled.</p>
|
|
<p class="property_name">devices<span class="property_type"><String[]></span></p><p class="property_description">Device IP Address Array on which job is run.</p>
|
|
<p class="property_name">execute_password<span class="property_type"><String></span></p><p class="property_description">Execute Password for job.<br> Maximum length = 127</p>
|
|
<p class="property_name">variables<span class="property_type"><config_variable[]></span></p><p class="property_description">Values of Variables used in commands of the configuration template.</p>
|
|
<p class="property_name">execute_again<span class="property_type"><Boolean></span></p><p class="property_description">True if Execute again the config job.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">job_username_enc<span class="property_type"><String></span></p><p class="property_description">Name of user who created configuration job.</p>
|
|
<p class="property_name">timestamp<span class="property_type"><Integer></span></p><p class="property_description">Time of Creation of Configuration Job.</p>
|
|
<p class="property_name">username<span class="property_type"><String></span></p><p class="property_description">Name of user who created configuration job.</p>
|
|
<p class="property_name">lastExecutionStatus<span class="property_type"><String></span></p><p class="property_description">Status of last Execution of Config Job - Started, In Progress, Completed, Failed, Aborted, Scheduled.</p>
|
|
<p class="property_name">lastExecutedTimeEpoch<span class="property_type"><String></span></p><p class="property_description">Schedule time epoch at which job was last executed..</p>
|
|
<p class="property_name">tenant_id<span class="property_type"><String></span></p><p class="property_description">Tenant Id of the Config Jobs.</p>
|
|
<p class="property_name">tasklog_id<span class="property_type"><String></span></p><p class="property_description">Task Log Id of the Config Job.</p>
|
|
<p class="property_name">executed_by<span class="property_type"><String></span></p><p class="property_description">Name of user who executed configuration job.</p>
|
|
<p class="property_name">preview_commands<span class="property_type"><String[]></span></p><p class="property_description">Preview of list of commands.</p>
|
|
<p class="property_name">preview_rollback_commands<span class="property_type"><String[]></span></p><p class="property_description">Preview of list of rollback commands.</p>
|
|
<p class="property_name">devices_completed_count<span class="property_type"><Integer></span></p><p class="property_description">Number of Devices on which commands execution completed.</p>
|
|
<p class="property_name">devices_count<span class="property_type"><Integer></span></p><p class="property_description">Number of Devices on which commands executed.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#add" class="operation">add</a><a href="#modify" class="operation">modify</a><a href="#get_all" class="operation">get (all)</a><a href="#save" class="operation">save</a><a href="#delete" class="operation">delete</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/config_job?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"config_job": {<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "execute_on_secondary":<Boolean_value></font>,<br><font color=#000000> "execute_batch":<Boolean_value></font>,<br><font color=#000000> "execute_again":<Boolean_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "execute_username":<String_value></font>,<br><font color=#000000> "status":<String_value></font>,<br><font color=#000000> "device_family":<String_value></font>,<br><font color=#000000> "mail_profiles":<String_value></font>,<br><font color=#000000> "execute_on_primary":<Boolean_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "credentials_required":<Boolean_value></font>,<br><font color=#000000> "scheduleTimesEpoch":<String_value></font>,<br><font color=#000000> "scheduleOptions":<String_value></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "variables":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "device_values":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "device_group":<String_value></font>,<br><font color=#000000> "device":<String_value></font>,<br><font color=#000000> "value":<String_value></font>}]</font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "value":<String_value></font>}]</font>,<br><font color=#000000> "devices":<String_value[]></font>,<br><font color=#000000> "execute_password":<String_value></font>,<br><font color=#000000> "template_info":<configuration_template_value></font>,<br><font color=#000000> "sms_profiles":<String_value></font>,<br><font color=#000000> "auto_rollback":<Boolean_value></font>,<br><font color=#000000> "scheduleType":<String_value></font>,<br><font color=#000000> "autoscale_groups":<String_value[]></font>,<br><font color=#000000> "tz_offset":<Integer_value></font>,<br><font color=#000000> "on_error":<String_value></font>,<br><font color=#000000> "is_internal":<Boolean_value></font>,<br><font color=#000000> "execute_sequentially":<Boolean_value></font>,<br><font color=#000000> "is_download_operation":<Boolean_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "config_job":[{<br> "device_groups":<String_value></font>,<br> "scheduleOptions":<String_value></font>,<br> "scheduleTimesEpoch":<String_value></font>,<br> "credentials_required":<Boolean_value></font>,<br> "job_username_enc":<String_value></font>,<br> "id":<String_value></font>,<br> "execute_on_primary":<Boolean_value></font>,<br> "timestamp":<Integer_value></font>,<br> "username":<String_value></font>,<br> "lastExecutionStatus":<String_value></font>,<br> "lastExecutedTimeEpoch":<String_value></font>,<br> "mail_profiles":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "resilience_devices_db":<String_value></font>,<br> "isRetryForResilienceJob":<Boolean_value></font>,<br> "device_family":<String_value></font>,<br> "scheduleTimes":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "status":<String_value></font>,<br> "execute_username":<String_value></font>,<br> "name":<String_value></font>,<br> "autoscale_groups_db":<String_value></font>,<br> "execute_batch":<Boolean_value></font>,<br> "devices_db":<String_value></font>,<br> "execute_on_secondary":<Boolean_value></font>,<br> "slack_profile":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "is_download_operation":<Boolean_value></font>,<br> "node_id":<String_value></font>,<br> "execute_sequentially":<Boolean_value></font>,<br> "is_internal":<Boolean_value></font>,<br> "executed_by":<String_value></font>,<br> "on_error":<String_value></font>,<br> "nextScheduleTimeEpoch":<String_value></font>,<br> "tz_offset":<Integer_value></font>,<br> "autoscale_groups":<String_value></font>,<br> "scheduleType":<String_value></font>,<br> "auto_rollback":<Boolean_value></font>,<br> "sms_profiles":<String_value></font>,<br> "template_info":<configuration_template_value></font>,<br> "devices":<String_value></font>,<br> "execute_password":<String_value></font>,<br> "isADMResilienceJob":<Boolean_value></font>,<br> "variables":[{<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "name":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "value":<String_value></font>,<br> "type":<String_value></font>,<br> "default_value":<String_value></font>,<br> "description":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values":[{<br> "valuex":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "device_group":<String_value></font>,<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>}],<br> "id":<String_value></font>}],<br> "preview_commands":<String_value></font>,<br> "preview_rollback_commands":<String_value></font>,<br> "devices_completed_count":<Integer_value></font>,<br> "execute_again":<Boolean_value></font>,<br> "devices_count":<Integer_value></font>}]}</p><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/config_job/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"config_job":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "execute_sequentially":<Boolean_value></font>,<br><font color=#000000> "is_download_operation":<Boolean_value></font>,<br><font color=#000000> "on_error":<String_value></font>,<br><font color=#000000> "is_internal":<Boolean_value></font>,<br><font color=#000000> "scheduleType":<String_value></font>,<br><font color=#000000> "autoscale_groups":<String_value[]></font>,<br><font color=#000000> "tz_offset":<Integer_value></font>,<br><font color=#000000> "variables":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "device_values":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "device_group":<String_value></font>,<br><font color=#000000> "device":<String_value></font>,<br><font color=#000000> "value":<String_value></font>}]</font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "value":<String_value></font>}]</font>,<br><font color=#000000> "execute_password":<String_value></font>,<br><font color=#000000> "devices":<String_value[]></font>,<br><font color=#000000> "template_info":<configuration_template_value></font>,<br><font color=#000000> "sms_profiles":<String_value></font>,<br><font color=#000000> "auto_rollback":<Boolean_value></font>,<br><font color=#000000> "scheduleTimesEpoch":<String_value></font>,<br><font color=#000000> "scheduleOptions":<String_value></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "mail_profiles":<String_value></font>,<br><font color=#000000> "execute_on_primary":<Boolean_value></font>,<br><font color=#000000> "credentials_required":<Boolean_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "execute_username":<String_value></font>,<br><font color=#000000> "status":<String_value></font>,<br><font color=#000000> "device_family":<String_value></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "execute_on_secondary":<Boolean_value></font>,<br><font color=#000000> "execute_batch":<Boolean_value></font>,<br><font color=#000000> "execute_again":<Boolean_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "config_job":[{<br> "device_groups":<String_value></font>,<br> "scheduleOptions":<String_value></font>,<br> "scheduleTimesEpoch":<String_value></font>,<br> "credentials_required":<Boolean_value></font>,<br> "job_username_enc":<String_value></font>,<br> "id":<String_value></font>,<br> "execute_on_primary":<Boolean_value></font>,<br> "timestamp":<Integer_value></font>,<br> "username":<String_value></font>,<br> "lastExecutionStatus":<String_value></font>,<br> "lastExecutedTimeEpoch":<String_value></font>,<br> "mail_profiles":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "resilience_devices_db":<String_value></font>,<br> "isRetryForResilienceJob":<Boolean_value></font>,<br> "device_family":<String_value></font>,<br> "scheduleTimes":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "status":<String_value></font>,<br> "execute_username":<String_value></font>,<br> "name":<String_value></font>,<br> "autoscale_groups_db":<String_value></font>,<br> "execute_batch":<Boolean_value></font>,<br> "devices_db":<String_value></font>,<br> "execute_on_secondary":<Boolean_value></font>,<br> "slack_profile":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "is_download_operation":<Boolean_value></font>,<br> "node_id":<String_value></font>,<br> "execute_sequentially":<Boolean_value></font>,<br> "is_internal":<Boolean_value></font>,<br> "executed_by":<String_value></font>,<br> "on_error":<String_value></font>,<br> "nextScheduleTimeEpoch":<String_value></font>,<br> "tz_offset":<Integer_value></font>,<br> "autoscale_groups":<String_value></font>,<br> "scheduleType":<String_value></font>,<br> "auto_rollback":<Boolean_value></font>,<br> "sms_profiles":<String_value></font>,<br> "template_info":<configuration_template_value></font>,<br> "devices":<String_value></font>,<br> "execute_password":<String_value></font>,<br> "isADMResilienceJob":<Boolean_value></font>,<br> "variables":[{<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "name":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "value":<String_value></font>,<br> "type":<String_value></font>,<br> "default_value":<String_value></font>,<br> "description":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values":[{<br> "valuex":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "device_group":<String_value></font>,<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>}],<br> "id":<String_value></font>}],<br> "preview_commands":<String_value></font>,<br> "preview_rollback_commands":<String_value></font>,<br> "devices_completed_count":<Integer_value></font>,<br> "execute_again":<Boolean_value></font>,<br> "devices_count":<Integer_value></font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/config_job</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/config_job<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">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.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/config_job<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the config_job resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/config_job<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of config_job resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "config_job":[{<br> "device_groups":<String_value></font>,<br> "scheduleOptions":<String_value></font>,<br> "scheduleTimesEpoch":<String_value></font>,<br> "credentials_required":<Boolean_value></font>,<br> "job_username_enc":<String_value></font>,<br> "id":<String_value></font>,<br> "execute_on_primary":<Boolean_value></font>,<br> "timestamp":<Integer_value></font>,<br> "username":<String_value></font>,<br> "lastExecutionStatus":<String_value></font>,<br> "lastExecutedTimeEpoch":<String_value></font>,<br> "mail_profiles":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "resilience_devices_db":<String_value></font>,<br> "isRetryForResilienceJob":<Boolean_value></font>,<br> "device_family":<String_value></font>,<br> "scheduleTimes":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "status":<String_value></font>,<br> "execute_username":<String_value></font>,<br> "name":<String_value></font>,<br> "autoscale_groups_db":<String_value></font>,<br> "execute_batch":<Boolean_value></font>,<br> "devices_db":<String_value></font>,<br> "execute_on_secondary":<Boolean_value></font>,<br> "slack_profile":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "is_download_operation":<Boolean_value></font>,<br> "node_id":<String_value></font>,<br> "execute_sequentially":<Boolean_value></font>,<br> "is_internal":<Boolean_value></font>,<br> "executed_by":<String_value></font>,<br> "on_error":<String_value></font>,<br> "nextScheduleTimeEpoch":<String_value></font>,<br> "tz_offset":<Integer_value></font>,<br> "autoscale_groups":<String_value></font>,<br> "scheduleType":<String_value></font>,<br> "auto_rollback":<Boolean_value></font>,<br> "sms_profiles":<String_value></font>,<br> "template_info":<configuration_template_value></font>,<br> "devices":<String_value></font>,<br> "execute_password":<String_value></font>,<br> "isADMResilienceJob":<Boolean_value></font>,<br> "variables":[{<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "name":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "value":<String_value></font>,<br> "type":<String_value></font>,<br> "default_value":<String_value></font>,<br> "description":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values":[{<br> "valuex":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "device_group":<String_value></font>,<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>}],<br> "id":<String_value></font>}],<br> "preview_commands":<String_value></font>,<br> "preview_rollback_commands":<String_value></font>,<br> "devices_completed_count":<Integer_value></font>,<br> "execute_again":<Boolean_value></font>,<br> "devices_count":<Integer_value></font>}]}</p><p class="heading"><a name="save">save</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/config_job?action=save&onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"config_job": {<br><font color=#000000> "execute_sequentially":<Boolean_value></font>,<br><font color=#000000> "is_download_operation":<Boolean_value></font>,<br><font color=#000000> "on_error":<String_value></font>,<br><font color=#000000> "is_internal":<Boolean_value></font>,<br><font color=#000000> "autoscale_groups":<String_value[]></font>,<br><font color=#000000> "scheduleType":<String_value></font>,<br><font color=#000000> "tz_offset":<Integer_value></font>,<br><font color=#000000> "variables":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "device_values":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "device_group":<String_value></font>,<br><font color=#000000> "device":<String_value></font>,<br><font color=#000000> "value":<String_value></font>}]</font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "value":<String_value></font>}]</font>,<br><font color=#000000> "auto_rollback":<Boolean_value></font>,<br><font color=#000000> "sms_profiles":<String_value></font>,<br><font color=#000000> "template_info":<configuration_template_value></font>,<br><font color=#000000> "execute_password":<String_value></font>,<br><font color=#000000> "devices":<String_value[]></font>,<br><font color=#000000> "scheduleTimesEpoch":<String_value></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "scheduleOptions":<String_value></font>,<br><font color=#000000> "mail_profiles":<String_value></font>,<br><font color=#000000> "credentials_required":<Boolean_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "execute_on_primary":<Boolean_value></font>,<br><font color=#000000> "status":<String_value></font>,<br><font color=#000000> "execute_username":<String_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "device_family":<String_value></font>,<br><font color=#000000> "execute_on_secondary":<Boolean_value></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "execute_again":<Boolean_value></font>,<br><font color=#000000> "execute_batch":<Boolean_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "config_job":[{<br> "device_groups":<String_value></font>,<br> "scheduleOptions":<String_value></font>,<br> "scheduleTimesEpoch":<String_value></font>,<br> "credentials_required":<Boolean_value></font>,<br> "job_username_enc":<String_value></font>,<br> "id":<String_value></font>,<br> "execute_on_primary":<Boolean_value></font>,<br> "timestamp":<Integer_value></font>,<br> "username":<String_value></font>,<br> "lastExecutionStatus":<String_value></font>,<br> "lastExecutedTimeEpoch":<String_value></font>,<br> "mail_profiles":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "resilience_devices_db":<String_value></font>,<br> "isRetryForResilienceJob":<Boolean_value></font>,<br> "device_family":<String_value></font>,<br> "scheduleTimes":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "status":<String_value></font>,<br> "execute_username":<String_value></font>,<br> "name":<String_value></font>,<br> "autoscale_groups_db":<String_value></font>,<br> "execute_batch":<Boolean_value></font>,<br> "devices_db":<String_value></font>,<br> "execute_on_secondary":<Boolean_value></font>,<br> "slack_profile":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "is_download_operation":<Boolean_value></font>,<br> "node_id":<String_value></font>,<br> "execute_sequentially":<Boolean_value></font>,<br> "is_internal":<Boolean_value></font>,<br> "executed_by":<String_value></font>,<br> "on_error":<String_value></font>,<br> "nextScheduleTimeEpoch":<String_value></font>,<br> "tz_offset":<Integer_value></font>,<br> "autoscale_groups":<String_value></font>,<br> "scheduleType":<String_value></font>,<br> "auto_rollback":<Boolean_value></font>,<br> "sms_profiles":<String_value></font>,<br> "template_info":<configuration_template_value></font>,<br> "devices":<String_value></font>,<br> "execute_password":<String_value></font>,<br> "isADMResilienceJob":<Boolean_value></font>,<br> "variables":[{<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "name":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "value":<String_value></font>,<br> "type":<String_value></font>,<br> "default_value":<String_value></font>,<br> "description":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values":[{<br> "valuex":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "device_group":<String_value></font>,<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>}],<br> "id":<String_value></font>}],<br> "preview_commands":<String_value></font>,<br> "preview_rollback_commands":<String_value></font>,<br> "devices_completed_count":<Integer_value></font>,<br> "execute_again":<Boolean_value></font>,<br> "devices_count":<Integer_value></font>}]}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/config_job/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p>
|
|
</body>
|
|
</html>
|