export_report_job
Configuration for Scheduled export report job resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| recurrence_option | <String> | Read-write | Recurrence option (Weekly -> mon - sun, Monthly -> date in DD format).. |
| status | <String> | Read-write | Schedule Status. Minimum length = 1 Maximum length = 128 |
| export_format | <String> | Read-write | Report Export format (PDF/JPEG/PNG). Minimum length = 3 Maximum length = 4 |
| description | <String> | Read-write | Report Description.. Maximum length = 512 |
| mail_profile_name | <String> | Read-write | Mail profile name to send notification mail.. Minimum length = 1 Maximum length = 255 |
| recurrence | <String> | Read-write | Recurrence (Daily, Weekly, Monthly).. Maximum length = 16 |
| tz_offset | <Integer> | Read-write | Time zone offset.. |
| next_scheduletime | <Integer> | Read-write | Next Schedule Time. |
| export_time | <String> | Read-write | Report Export time GMT epoch (string representation of 10 digit numbers).. Minimum length = 5 Maximum length = 16 |
| job_name | <String> | Read-write | job name is ExportJob.. Maximum length = 16 |
| trigger_start | <String> | Read-write | Time at which the trigger should start.Format:YY:MM:DD:HH:MM. |
| report_name | <String> | Read-write | report name. Maximum length = 255 |
| id | <String> | Read-write | Id is job_schedule id for all the export_report_job details. |
Operations
(click to see Properties)
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>.
delete
URL: https://<MGMT-IP>/nitro/v1/config/export_report_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/export_report_job
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "export_report_job":[{
"recurrence_option":<String_value>,
"status":<String_value>,
"export_format":<String_value>,
"description":<String_value>,
"mail_profile_name":<String_value>,
"recurrence":<String_value>,
"tz_offset":<Integer_value>,
"next_scheduletime":<Integer_value>,
"export_time":<String_value>,
"job_name":<String_value>,
"trigger_start":<String_value>,
"report_name":<String_value>,
"id":<String_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/export_report_job/id_value<String>
HTTP Method: null
Request Payload:
{export_report_job:{
<b>"id":<String_value></b>,
"export_format":<String_value>,
"description":<String_value>,
"tz_offset":<Integer_value>,
"recurrence":<String_value>,
"recurrence_option":<String_value>,
"status":<String_value>,
"mail_profile_name":<String_value>,
"trigger_start":<String_value>,
"job_name":<String_value>,
"report_name":<String_value>,
"next_scheduletime":<Integer_value>,
"export_time":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "export_report_job":[{
"recurrence_option":<String_value>,
"status":<String_value>,
"export_format":<String_value>,
"description":<String_value>,
"mail_profile_name":<String_value>,
"recurrence":<String_value>,
"tz_offset":<Integer_value>,
"next_scheduletime":<Integer_value>,
"export_time":<String_value>,
"job_name":<String_value>,
"trigger_start":<String_value>,
"report_name":<String_value>,
"id":<String_value>}]}