42 lines
23 KiB
HTML
42 lines
23 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>maintenance_job</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">maintenance_job</p>
|
|
<P>Configuration for Maintenance Job resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">type<span class="property_type"><String></span></p><p class="property_description">Device type for selected device_family.<br> Maximum length = 64</p>
|
|
<p class="property_name">slack_profile<span class="property_type"><String></span></p><p class="property_description">Slack profile.</p>
|
|
<p class="property_name">parent_id<span class="property_type"><String></span></p><p class="property_description">Parent Id of maintenance job..</p>
|
|
<p class="property_name">device_family<span class="property_type"><String></span></p><p class="property_description">Family of Devices for which config job was executed.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Name of maintenance job.<br> Minimum length = 1<br> Maximum length = 128</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 maintenance jobs.</p>
|
|
<p class="property_name">mail_profiles<span class="property_type"><String></span></p><p class="property_description">Comma separated list of Mail profiles.</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.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">task_name<span class="property_type"><String></span></p><p class="property_description">task name of maintenance job..</p>
|
|
<p class="property_name">scheduleTimesEpoch<span class="property_type"><String></span></p><p class="property_description">Schedule time epoch (string representation of 11 digit numbers)..</p>
|
|
<p class="property_name">failed_devices<span class="property_type"><String[]></span></p><p class="property_description">filter failed_devices:true to get list of failed devices as array in this property..</p>
|
|
<p class="property_name">failed_message<span class="property_type"><String[]></span></p><p class="property_description">Comma separated instances error details.</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">attached_maintenance_job<span class="property_type"><String></span></p><p class="property_description">Attached maintenance job.</p>
|
|
<p class="property_name">scheduleTime<span class="property_type"><String></span></p><p class="property_description">Comma separated times of the day(DD:HH:MM) on which Configuration Template is scheduled.</p>
|
|
<p class="property_name">additional_info<span class="property_type"><String[]></span></p><p class="property_description">Additional info Array.</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="heading">Read only properties</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">status<span class="property_type"><String></span></p><p class="property_description">Status of maintenance Job Started, In Progress, Scheduled, Failed, Completed.</p>
|
|
<p class="property_name">maintenance_job_username<span class="property_type"><String></span></p><p class="property_description">Name of user who created maintenance job.</p>
|
|
<p class="property_name">timestamp<span class="property_type"><Integer></span></p><p class="property_description">Time of Creation of Maintenance Job.</p>
|
|
<p class="property_name">username<span class="property_type"><String></span></p><p class="property_description">Name of user who created maintenance job.</p>
|
|
<p class="property_name">devices_completed_count<span class="property_type"><Integer></span></p><p class="property_description">Devices Completed Count.</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="#delete" class="operation">delete</a><a href="#get_all" class="operation">get (all)</a><a href="#modify" class="operation">modify</a><a href="#add" class="operation">add</a><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/maintenance_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><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/maintenance_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/maintenance_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 maintenance_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/maintenance_job<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the maintenance_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/maintenance_job<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of maintenance_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>, "maintenance_job":[{<br> "type":<String_value></font>,<br> "slack_profile":<String_value></font>,<br> "devices_db":<String_value></font>,<br> "resource_object":<String_value></font>,<br> "isADMResilienceJob":<Boolean_value></font>,<br> "tenant_id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "device_family":<String_value></font>,<br> "resilience_devices_db":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "isRetryForResilienceJob":<Boolean_value></font>,<br> "name":<String_value></font>,<br> "status":<String_value></font>,<br> "maintenance_job_username":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "additional_info_db":<String_value></font>,<br> "username":<String_value></font>,<br> "id":<String_value></font>,<br> "mail_profiles":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "task_name":<String_value></font>,<br> "action":<String_value></font>,<br> "resource":<String_value></font>,<br> "scheduleTimesEpoch":<String_value></font>,<br> "failed_devices":<String_value></font>,<br> "failed_message":<String_value></font>,<br> "device_groups":<String_value></font>,<br> "devices_completed_count":<Integer_value></font>,<br> "attached_maintenance_job":<String_value></font>,<br> "scheduleTime":<String_value></font>,<br> "additional_info":<String_value></font>,<br> "devices":<String_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/maintenance_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">{"maintenance_job":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "tasklog_id":<String_value></font>,<br><font color=#000000> "attached_maintenance_job":<String_value></font>,<br><font color=#000000> "scheduleTime":<String_value></font>,<br><font color=#000000> "additional_info":<String_value[]></font>,<br><font color=#000000> "devices":<String_value[]></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "task_name":<String_value></font>,<br><font color=#000000> "failed_devices":<String_value[]></font>,<br><font color=#000000> "scheduleTimesEpoch":<String_value></font>,<br><font color=#000000> "mail_profiles":<String_value></font>,<br><font color=#000000> "device_family":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "failed_message":<String_value[]></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "type":<String_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>, "maintenance_job":[{<br> "type":<String_value></font>,<br> "slack_profile":<String_value></font>,<br> "devices_db":<String_value></font>,<br> "resource_object":<String_value></font>,<br> "isADMResilienceJob":<Boolean_value></font>,<br> "tenant_id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "device_family":<String_value></font>,<br> "resilience_devices_db":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "isRetryForResilienceJob":<Boolean_value></font>,<br> "name":<String_value></font>,<br> "status":<String_value></font>,<br> "maintenance_job_username":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "additional_info_db":<String_value></font>,<br> "username":<String_value></font>,<br> "id":<String_value></font>,<br> "mail_profiles":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "task_name":<String_value></font>,<br> "action":<String_value></font>,<br> "resource":<String_value></font>,<br> "scheduleTimesEpoch":<String_value></font>,<br> "failed_devices":<String_value></font>,<br> "failed_message":<String_value></font>,<br> "device_groups":<String_value></font>,<br> "devices_completed_count":<Integer_value></font>,<br> "attached_maintenance_job":<String_value></font>,<br> "scheduleTime":<String_value></font>,<br> "additional_info":<String_value></font>,<br> "devices":<String_value></font>,<br> "devices_count":<Integer_value></font>}]}</p><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/maintenance_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">{"maintenance_job": {<br><font color=#000000> "mail_profiles":<String_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "failed_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> "task_name":<String_value></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "failed_message":<String_value[]></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "device_family":<String_value></font>,<br><font color=#000000> "scheduleTime":<String_value></font>,<br><font color=#000000> "additional_info":<String_value[]></font>,<br><font color=#000000> "tasklog_id":<String_value></font>,<br><font color=#000000> "attached_maintenance_job":<String_value></font>,<br><font color=#000000> "devices":<String_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>, "maintenance_job":[{<br> "type":<String_value></font>,<br> "slack_profile":<String_value></font>,<br> "devices_db":<String_value></font>,<br> "resource_object":<String_value></font>,<br> "isADMResilienceJob":<Boolean_value></font>,<br> "tenant_id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "device_family":<String_value></font>,<br> "resilience_devices_db":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "isRetryForResilienceJob":<Boolean_value></font>,<br> "name":<String_value></font>,<br> "status":<String_value></font>,<br> "maintenance_job_username":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "additional_info_db":<String_value></font>,<br> "username":<String_value></font>,<br> "id":<String_value></font>,<br> "mail_profiles":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "task_name":<String_value></font>,<br> "action":<String_value></font>,<br> "resource":<String_value></font>,<br> "scheduleTimesEpoch":<String_value></font>,<br> "failed_devices":<String_value></font>,<br> "failed_message":<String_value></font>,<br> "device_groups":<String_value></font>,<br> "devices_completed_count":<Integer_value></font>,<br> "attached_maintenance_job":<String_value></font>,<br> "scheduleTime":<String_value></font>,<br> "additional_info":<String_value></font>,<br> "devices":<String_value></font>,<br> "devices_count":<Integer_value></font>}]}</p>
|
|
</body>
|
|
</html>
|