maintenance

maintenance_job

Configuration for Maintenance Job resource.

Read/write properties

type<String>

Device type for selected device_family.
Maximum length = 64

slack_profile<String>

Slack profile.

parent_id<String>

Parent Id of maintenance job..

device_family<String>

Family of Devices for which config job was executed.
Minimum length = 1
Maximum length = 64

name<String>

Name of maintenance job.
Minimum length = 1
Maximum length = 128

id<String>

Id is system generated key for all the maintenance jobs.

mail_profiles<String>

Comma separated list of Mail profiles.

tasklog_id<String>

Task Log Id of the Config Job.
Minimum length = 1
Maximum length = 128

task_name<String>

task name of maintenance job..

scheduleTimesEpoch<String>

Schedule time epoch (string representation of 11 digit numbers)..

failed_devices<String[]>

filter failed_devices:true to get list of failed devices as array in this property..

failed_message<String[]>

Comma separated instances error details.

device_groups<String[]>

Device Group Array on which for which job is run.

attached_maintenance_job<String>

Attached maintenance job.

scheduleTime<String>

Comma separated times of the day(DD:HH:MM) on which Configuration Template is scheduled.

additional_info<String[]>

Additional info Array.

devices<String[]>

Device IP Address Array on which job is run.

Read only properties

tenant_id<String>

Tenant Id of the Config Jobs.

status<String>

Status of maintenance Job Started, In Progress, Scheduled, Failed, Completed.

maintenance_job_username<String>

Name of user who created maintenance job.

timestamp<Integer>

Time of Creation of Maintenance Job.

username<String>

Name of user who created maintenance job.

devices_completed_count<Integer>

Devices Completed Count.

devices_count<Integer>

Number of Devices on which commands executed.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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

delete get (all)modify add

delete

URL:https://<MGMT-IP>/nitro/v2/config/maintenance_job/id_value<String>

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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 Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/maintenance_job

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/maintenance_job?filter=property-name1:property-value1,property-name2:property-value2

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.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/maintenance_job?pagesize=#no&pageno=#no

Use this query-parameter to get the maintenance_job resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/maintenance_job?count=yes

Use this query-parameter to get the count of maintenance_job resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "maintenance_job":[{
      "type":<String_value>,
      "slack_profile":<String_value>,
      "devices_db":<String_value>,
      "resource_object":<String_value>,
      "isADMResilienceJob":<Boolean_value>,
      "tenant_id":<String_value>,
      "parent_id":<String_value>,
      "device_family":<String_value>,
      "resilience_devices_db":<String_value>,
      "device_groups_db":<String_value>,
      "isRetryForResilienceJob":<Boolean_value>,
      "name":<String_value>,
      "status":<String_value>,
      "maintenance_job_username":<String_value>,
      "timestamp":<Integer_value>,
      "additional_info_db":<String_value>,
      "username":<String_value>,
      "id":<String_value>,
      "mail_profiles":<String_value>,
      "tasklog_id":<String_value>,
      "task_name":<String_value>,
      "action":<String_value>,
      "resource":<String_value>,
      "scheduleTimesEpoch":<String_value>,
      "failed_devices":<String_value>,
      "failed_message":<String_value>,
      "device_groups":<String_value>,
      "devices_completed_count":<Integer_value>,
      "attached_maintenance_job":<String_value>,
      "scheduleTime":<String_value>,
      "additional_info":<String_value>,
      "devices":<String_value>,
      "devices_count":<Integer_value>}]}

modify

URL:https://<MGMT-IP>/nitro/v2/config/maintenance_job/id_value<String>

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"maintenance_job":{
      "id":<String_value>,
      "tasklog_id":<String_value>,
      "attached_maintenance_job":<String_value>,
      "scheduleTime":<String_value>,
      "additional_info":<String_value[]>,
      "devices":<String_value[]>,
      "device_groups":<String_value[]>,
      "task_name":<String_value>,
      "failed_devices":<String_value[]>,
      "scheduleTimesEpoch":<String_value>,
      "mail_profiles":<String_value>,
      "device_family":<String_value>,
      "parent_id":<String_value>,
      "name":<String_value>,
      "failed_message":<String_value[]>,
      "slack_profile":<String_value>,
      "type":<String_value>}}

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 Payload:JSON

add

URL:https://<MGMT-IP>/nitro/v2/config/maintenance_job?onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"maintenance_job": {
      "mail_profiles":<String_value>,
      "id":<String_value>,
      "failed_devices":<String_value[]>,
      "scheduleTimesEpoch":<String_value>,
      "device_groups":<String_value[]>,
      "task_name":<String_value>,
      "slack_profile":<String_value>,
      "type":<String_value>,
      "failed_message":<String_value[]>,
      "name":<String_value>,
      "parent_id":<String_value>,
      "device_family":<String_value>,
      "scheduleTime":<String_value>,
      "additional_info":<String_value[]>,
      "tasklog_id":<String_value>,
      "attached_maintenance_job":<String_value>,
      "devices":<String_value[]>}}

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 Payload:JSON