lb_export_report
Configuration for Export or Schedule NS Entities report resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| is_enabled | <Boolean> | Read-write | Enable Scheduled Report (default is enabled). |
| enable_cr | <Boolean> | Read-write | Enable CR Report. |
| enable_lb | <Boolean> | Read-write | Enable LB Report. |
| enable_gslb | <Boolean> | Read-write | Enable GSLB Report. |
| recurrence_type | <String> | Read-write | Tenant. Maximum length = 255 |
| enable_sslvpn | <Boolean> | Read-write | Enable SSLVPN Report. |
| tz_offset | <Integer> | Read-write | Time zone offset.. |
| recurrence_options | <String> | Read-write | Comma Seperated recurrence options of job that is scheduled. |
| enable_auth | <Boolean> | Read-write | Enable Auth Report. |
| file_name | <String> | Read-write | Report File name.. |
| recurrence_times_epoch | <String> | Read-write | Schedule time epoch (string representation of 11 digit numbers).. |
| export_now | <Boolean> | Read-write | Export now. |
| enable_cs | <Boolean> | Read-write | Enable CS Report. |
| mail_profile | <String> | Read-write | Mail Profile. |
Operations
(click to see Properties)
ADD| GET (ALL)| UPDATE| DOWNLOAD
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/lb_export_report?onerror=<String_value>
HTTP Method: null
Request Payload:
{lb_export_report: {
"enable_auth":<Boolean_value>,
"recurrence_times_epoch":<String_value>,
"file_name":<String_value>,
"mail_profile":<String_value>,
"is_enabled":<Boolean_value>,
"enable_cr":<Boolean_value>,
"enable_lb":<Boolean_value>,
"enable_gslb":<Boolean_value>,
"recurrence_type":<String_value>,
"recurrence_options":<String_value>,
"tz_offset":<Integer_value>,
"enable_sslvpn":<Boolean_value>,
"export_now":<Boolean_value>,
"enable_cs":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "lb_export_report":[{
"is_enabled":<Boolean_value>,
"enable_cr":<Boolean_value>,
"enable_lb":<Boolean_value>,
"enable_gslb":<Boolean_value>,
"recurrence_type":<String_value>,
"enable_sslvpn":<Boolean_value>,
"tz_offset":<Integer_value>,
"recurrence_options":<String_value>,
"enable_auth":<Boolean_value>,
"file_name":<String_value>,
"recurrence_times_epoch":<String_value>,
"export_now":<Boolean_value>,
"enable_cs":<Boolean_value>,
"mail_profile":<String_value>}]}
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/lb_export_report
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "lb_export_report":[{
"is_enabled":<Boolean_value>,
"enable_cr":<Boolean_value>,
"enable_lb":<Boolean_value>,
"enable_gslb":<Boolean_value>,
"recurrence_type":<String_value>,
"enable_sslvpn":<Boolean_value>,
"tz_offset":<Integer_value>,
"recurrence_options":<String_value>,
"enable_auth":<Boolean_value>,
"file_name":<String_value>,
"recurrence_times_epoch":<String_value>,
"export_now":<Boolean_value>,
"enable_cs":<Boolean_value>,
"mail_profile":<String_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/lb_export_report/
HTTP Method: null
Request Payload:
{lb_export_report:{
"enable_auth":<Boolean_value>,
"recurrence_times_epoch":<String_value>,
"file_name":<String_value>,
"mail_profile":<String_value>,
"is_enabled":<Boolean_value>,
"enable_cr":<Boolean_value>,
"enable_lb":<Boolean_value>,
"enable_gslb":<Boolean_value>,
"recurrence_type":<String_value>,
"recurrence_options":<String_value>,
"tz_offset":<Integer_value>,
"enable_sslvpn":<Boolean_value>,
"export_now":<Boolean_value>,
"enable_cs":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "lb_export_report":[{
"is_enabled":<Boolean_value>,
"enable_cr":<Boolean_value>,
"enable_lb":<Boolean_value>,
"enable_gslb":<Boolean_value>,
"recurrence_type":<String_value>,
"enable_sslvpn":<Boolean_value>,
"tz_offset":<Integer_value>,
"recurrence_options":<String_value>,
"enable_auth":<Boolean_value>,
"file_name":<String_value>,
"recurrence_times_epoch":<String_value>,
"export_now":<Boolean_value>,
"enable_cs":<Boolean_value>,
"mail_profile":<String_value>}]}
download
URL: https://<MGMT-IP>/nitro/v1/download/lb_export_report/_value<>
HTTP Method: null