Skip to content

lb_export_report

Configuration for Export or Schedule Citrix ADC Entities report resource.

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.
slack_profile <String> Read-write Slack Profile Name.
recurrence_type <String> Read-write Tenant recurrence type.

Maximum length = 255
enable_sslvpn <Boolean> Read-write Enable SSLVPN Report.
recurrence_options <String> Read-write Comma separated recurrence options of job that is scheduled.
enable_auth <Boolean> Read-write Enable Auth Report.
file_name <String> Read-write Export Report File name..
recurrence_times_epoch <String> Read-write Schedule time epoch (string representation of 11 digit numbers)..
export_now <Boolean> Read-write Load Balancing Export Now.
mail_profile <String> Read-write Mail Profile.
enable_cs <Boolean> Read-write Enable CS Report.

Operations

(click to see Properties )

  • ADD
  • GET (ALL)
  • 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

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

add

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

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"lb_export_report": {
      "slack_profile":<String_value>,
      "enable_auth":<Boolean_value>,
      "file_name":<String_value>,
      "mail_profile":<String_value>,
      "is_enabled":<Boolean_value>,
      "enable_lb":<Boolean_value>,
      "recurrence_options":<String_value>,
      "export_now":<Boolean_value>,
      "recurrence_times_epoch":<String_value>,
      "enable_cr":<Boolean_value>,
      "enable_gslb":<Boolean_value>,
      "recurrence_type":<String_value>,
      "enable_sslvpn":<Boolean_value>,
      "enable_cs":<Boolean_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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "lb_export_report":[{
      "is_enabled":<Boolean_value>,
      "enable_cr":<Boolean_value>,
      "enable_lb":<Boolean_value>,
      "enable_gslb":<Boolean_value>,
      "slack_profile":<String_value>,
      "recurrence_type":<String_value>,
      "enable_sslvpn":<Boolean_value>,
      "recurrence_options":<String_value>,
      "enable_auth":<Boolean_value>,
      "file_name":<String_value>,
      "recurrence_times_epoch":<String_value>,
      "export_now":<Boolean_value>,
      "mail_profile":<String_value>,
      "enable_cs":<Boolean_value>}]}

get (all)

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

Query-parameters:

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

Use this query-parameter to get the filtered set of lb_export_report 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/lb_export_report ?pagesize=#no;pageno=#no

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

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

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

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "lb_export_report":[{
      "is_enabled":<Boolean_value>,
      "enable_cr":<Boolean_value>,
      "enable_lb":<Boolean_value>,
      "enable_gslb":<Boolean_value>,
      "slack_profile":<String_value>,
      "recurrence_type":<String_value>,
      "enable_sslvpn":<Boolean_value>,
      "recurrence_options":<String_value>,
      "enable_auth":<Boolean_value>,
      "file_name":<String_value>,
      "recurrence_times_epoch":<String_value>,
      "export_now":<Boolean_value>,
      "mail_profile":<String_value>,
      "enable_cs":<Boolean_value>}]}

update

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

HTTPS Method: PUT

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"lb_export_report":{
      "slack_profile":<String_value>,
      "enable_auth":<Boolean_value>,
      "file_name":<String_value>,
      "mail_profile":<String_value>,
      "is_enabled":<Boolean_value>,
      "enable_lb":<Boolean_value>,
      "recurrence_options":<String_value>,
      "export_now":<Boolean_value>,
      "recurrence_times_epoch":<String_value>,
      "enable_cr":<Boolean_value>,
      "enable_gslb":<Boolean_value>,
      "recurrence_type":<String_value>,
      "enable_sslvpn":<Boolean_value>,
      "enable_cs":<Boolean_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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "lb_export_report":[{
      "is_enabled":<Boolean_value>,
      "enable_cr":<Boolean_value>,
      "enable_lb":<Boolean_value>,
      "enable_gslb":<Boolean_value>,
      "slack_profile":<String_value>,
      "recurrence_type":<String_value>,
      "enable_sslvpn":<Boolean_value>,
      "recurrence_options":<String_value>,
      "enable_auth":<Boolean_value>,
      "file_name":<String_value>,
      "recurrence_times_epoch":<String_value>,
      "export_now":<Boolean_value>,
      "mail_profile":<String_value>,
      "enable_cs":<Boolean_value>}]}
Was this article helpful?