Skip to content

csv_export

Configuration for CSV Export resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
report_end_time <Double> Read-write Report end time..
order_by <String> Read-write Order By.

Maximum length = 32
args <String> Read-write args.
pageno <Integer> Read-write Page no..
report_start_time <Double> Read-write Report start time..
resource_id <String> Read-write Resource id.

Maximum length = 512
asc <String> Read-write asc.

Maximum length = 32
duration_summary <String> Read-write Duration summary..

Maximum length = 16
id <String> Read-write Id is CSV export Id.

Maximum length = 32
section_title <String> Read-write Section title.

Maximum length = 512
attrs <String> Read-write attrs.
is_count <String> Read-write is_count.

Maximum length = 32
report_type <String> Read-write report_type 'active' in case active report.
filter <String> Read-write filter.
detailview <String> Read-write detailview.

Maximum length = 64
duration <String> Read-write Duration.

Maximum length = 64
cr_enabled <String> Read-write CR Enabled..

Maximum length = 16
sla_enabled <String> Read-write SLA Enabled..

Maximum length = 16
type <String> Read-write Type.

Maximum length = 32
resource_name <String> Read-write Resource name.

Minimum length = 1

Maximum length = 255
pagesize <Integer> Read-write Page size.
csv_mapping_id <String> Read-write Schedule export csv_mapping_id.

Maximum length = 32

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET (ALL)

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/csv_export?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:

{"csv_export": {
      "pageno":<Integer_value>,
      "section_title":<String_value>,
      "cr_enabled":<String_value>,
      "sla_enabled":<String_value>,
      "csv_mapping_id":<String_value>,
      "report_start_time":<Double_value>,
      "asc":<String_value>,
      "filter":<String_value>,
      "pagesize":<Integer_value>,
      "duration_summary":<String_value>,
      "id":<String_value>,
      "attrs":<String_value>,
      "report_type":<String_value>,
      "detailview":<String_value>,
      "duration":<String_value>,
      "resource_name":<String_value>,
      "type":<String_value>,
      "report_end_time":<Double_value>,
      "args":<String_value>,
      "order_by":<String_value>,
      "resource_id":<String_value>,
      "is_count":<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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "csv_export":[{
      "report_end_time":<Double_value>,
      "order_by":<String_value>,
      "args":<String_value>,
      "pageno":<Integer_value>,
      "report_start_time":<Double_value>,
      "resource_id":<String_value>,
      "asc":<String_value>,
      "duration_summary":<String_value>,
      "id":<String_value>,
      "section_title":<String_value>,
      "attrs":<String_value>,
      "is_count":<String_value>,
      "report_type":<String_value>,
      "filter":<String_value>,
      "detailview":<String_value>,
      "duration":<String_value>,
      "cr_enabled":<String_value>,
      "sla_enabled":<String_value>,
      "type":<String_value>,
      "resource_name":<String_value>,
      "pagesize":<Integer_value>,
      "csv_mapping_id":<String_value>}]}

delete

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

HTTPS Method: DELETE

Request Headers:

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

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

get (all)

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

Query-parameters:

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

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

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

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

Use this query-parameter to get the count of csv_export 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, "csv_export":[{
      "report_end_time":<Double_value>,
      "order_by":<String_value>,
      "args":<String_value>,
      "pageno":<Integer_value>,
      "report_start_time":<Double_value>,
      "resource_id":<String_value>,
      "asc":<String_value>,
      "duration_summary":<String_value>,
      "id":<String_value>,
      "section_title":<String_value>,
      "attrs":<String_value>,
      "is_count":<String_value>,
      "report_type":<String_value>,
      "filter":<String_value>,
      "detailview":<String_value>,
      "duration":<String_value>,
      "cr_enabled":<String_value>,
      "sla_enabled":<String_value>,
      "type":<String_value>,
      "resource_name":<String_value>,
      "pagesize":<Integer_value>,
      "csv_mapping_id":<String_value>}]}
Was this article helpful?