maintenance_job
Configuration for Maintenance Job resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| scheduleTimesEpoch | <String> | Read-write | Schedule time epoch (string representation of 11 digit numbers).. |
| 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 maintenance job. Minimum length = 1 Maximum length = 128 |
| task_name | <String> | Read-write | task name.. |
| parent_id | <String> | Read-write | . |
| mail_profiles | <String> | Read-write | Comma seperated list of Mail profiles. |
| resource | <String> | Read-write | resource name.. |
| action | <String> | Read-write | Schedule time epoch (string representation of 11 digit numbers).. |
| resource_object | <String> | Read-write | Resource object payload.. |
| id | <String> | Read-write | Id is system generated key for all the maintenance jobs. |
| attached_maintenance_job | <String> | Read-write | Attached maintenance job. |
| scheduleTime | <String> | Read-write | Comma Seperated times of the day(DD:HH:MM) on which Configuration Template is scheduled. |
| status | <String> | Read-only | Status of Config Job. |
| username | <String> | Read-only | Name of user who created maintenance job. |
| tenant_id | <String> | Read-only | Tenant Id of the Config Jobs. |
| timestamp | <Integer> | Read-only | Time of Creation of Maintenance 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/maintenance_job?onerror=<String_value>
HTTP Method: null
Request Payload:
{maintenance_job: {
"task_name":<String_value>,
"attached_maintenance_job":<String_value>,
"parent_id":<String_value>,
"resource_object":<String_value>,
"id":<String_value>,
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"mail_profiles":<String_value>,
"scheduleTime":<String_value>,
"resource":<String_value>,
"action":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "maintenance_job":[{
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"status":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"task_name":<String_value>,
"parent_id":<String_value>,
"username":<String_value>,
"mail_profiles":<String_value>,
"resource":<String_value>,
"tenant_id":<String_value>,
"timestamp":<Integer_value>,
"action":<String_value>,
"resource_object":<String_value>,
"id":<String_value>,
"devices_count":<Integer_value>,
"attached_maintenance_job":<String_value>,
"scheduleTime":<String_value>,
"devices_completed_count":<Integer_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/maintenance_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/maintenance_job
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "maintenance_job":[{
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"status":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"task_name":<String_value>,
"parent_id":<String_value>,
"username":<String_value>,
"mail_profiles":<String_value>,
"resource":<String_value>,
"tenant_id":<String_value>,
"timestamp":<Integer_value>,
"action":<String_value>,
"resource_object":<String_value>,
"id":<String_value>,
"devices_count":<Integer_value>,
"attached_maintenance_job":<String_value>,
"scheduleTime":<String_value>,
"devices_completed_count":<Integer_value>}]}
modify
URL: https://<MGMT-IP>/nitro/v1/config/maintenance_job/id_value<String>
HTTP Method: null
Request Payload:
{maintenance_job:{
<b>"id":<String_value></b>,
"task_name":<String_value>,
"attached_maintenance_job":<String_value>,
"parent_id":<String_value>,
"resource_object":<String_value>,
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"mail_profiles":<String_value>,
"scheduleTime":<String_value>,
"resource":<String_value>,
"action":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "maintenance_job":[{
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"status":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"task_name":<String_value>,
"parent_id":<String_value>,
"username":<String_value>,
"mail_profiles":<String_value>,
"resource":<String_value>,
"tenant_id":<String_value>,
"timestamp":<Integer_value>,
"action":<String_value>,
"resource_object":<String_value>,
"id":<String_value>,
"devices_count":<Integer_value>,
"attached_maintenance_job":<String_value>,
"scheduleTime":<String_value>,
"devices_completed_count":<Integer_value>}]}