Skip to content

ns_configtemplate_scheduler

Configuration for config audit template scheduler resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
scheduleTimesEpoch<String>Read-writeEpoch times for scheduling the job.
parent_name<String>Read-writeName of object which is adding this resource as embedded object .
daily_time<String>Read-writeDaily time details of scheduler.
recurrenceOptions<String>Read-writeComma Seperated recurrence options of job that is scheduled.
id<String>Read-writeId is system generated key for all the events.
recurrence_type<String>Read-writeDaily, Week or Monthly option.
Maximum length = 255
tz_offset<Integer>Read-writeTime zone offset..
parent_id<String>Read-writeParent id of object which is adding this resource as embedded object .

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

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/ns_configtemplate_scheduler?onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_configtemplate_scheduler: {
"parent_id":<String_value>,
"id":<String_value>,
"scheduleTimesEpoch":<String_value>,
"parent_name":<String_value>,
"daily_time":<String_value>,
"recurrence_type":<String_value>,
"tz_offset":<Integer_value>,
"recurrenceOptions":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate_scheduler":[{
"scheduleTimesEpoch":<String_value>,
"parent_name":<String_value>,
"daily_time":<String_value>,
"recurrenceOptions":<String_value>,
"id":<String_value>,
"recurrence_type":<String_value>,
"tz_offset":<Integer_value>,
"parent_id":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate_scheduler/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate_scheduler

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate_scheduler":[{
"scheduleTimesEpoch":<String_value>,
"parent_name":<String_value>,
"daily_time":<String_value>,
"recurrenceOptions":<String_value>,
"id":<String_value>,
"recurrence_type":<String_value>,
"tz_offset":<Integer_value>,
"parent_id":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate_scheduler/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate_scheduler":[{
"scheduleTimesEpoch":<String_value>,
"parent_name":<String_value>,
"daily_time":<String_value>,
"recurrenceOptions":<String_value>,
"id":<String_value>,
"recurrence_type":<String_value>,
"tz_offset":<Integer_value>,
"parent_id":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate_scheduler/id_value<String>

HTTP Method: null

Request Payload:

{ns_configtemplate_scheduler:{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"scheduleTimesEpoch":<String_value>,
"parent_name":<String_value>,
"daily_time":<String_value>,
"recurrence_type":<String_value>,
"tz_offset":<Integer_value>,
"recurrenceOptions":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate_scheduler":[{
"scheduleTimesEpoch":<String_value>,
"parent_name":<String_value>,
"daily_time":<String_value>,
"recurrenceOptions":<String_value>,
"id":<String_value>,
"recurrence_type":<String_value>,
"tz_offset":<Integer_value>,
"parent_id":<String_value>}]}