Skip to content

csv_export

Configuration for CSV Export resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
report_end_time<Double>Read-writeReport end time..
order_by<String>Read-writeOrder By.
Maximum length = 32
args<String>Read-writeargs.
report_start_time<Double>Read-writeReport start time..
resource_id<String>Read-writeResource id.
Maximum length = 512
asc<String>Read-writeasc.
Maximum length = 32
duration_summary<String>Read-writeDuration summary..
Maximum length = 16
id<String>Read-writeId is CSV export Id.
Maximum length = 32
section_title<String>Read-writeSection title.
Maximum length = 512
attrs<String>Read-writeattrs.
is_count<String>Read-writeis_count.
Maximum length = 32
filter<String>Read-writefilter.
detailview<String>Read-writedetailview.
Maximum length = 64
duration<String>Read-writeDuration.
Maximum length = 64
cr_enabled<String>Read-writeCR Enabled..
Maximum length = 16
sla_enabled<String>Read-writeSLA Enabled..
Maximum length = 16
type<String>Read-writeType.
Maximum length = 32
resource_name<String>Read-writeResource name.
Minimum length = 1
Maximum length = 255
csv_mapping_id<String>Read-writeSchedule 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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/csv_export?onerror=<String_value>

HTTP Method: null

Request Payload:

{csv_export: {
"duration_summary":<String_value>,
"id":<String_value>,
"section_title":<String_value>,
"attrs":<String_value>,
"detailview":<String_value>,
"duration":<String_value>,
"cr_enabled":<String_value>,
"sla_enabled":<String_value>,
"resource_name":<String_value>,
"type":<String_value>,
"csv_mapping_id":<String_value>,
"report_end_time":<Double_value>,
"args":<String_value>,
"order_by":<String_value>,
"resource_id":<String_value>,
"report_start_time":<Double_value>,
"asc":<String_value>,
"is_count":<String_value>,
"filter":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "csv_export":[{
"report_end_time":<Double_value>,
"order_by":<String_value>,
"args":<String_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>,
"filter":<String_value>,
"detailview":<String_value>,
"duration":<String_value>,
"cr_enabled":<String_value>,
"sla_enabled":<String_value>,
"type":<String_value>,
"resource_name":<String_value>,
"csv_mapping_id":<String_value>}]}

delete

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

HTTP Method: null

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "csv_export":[{
"report_end_time":<Double_value>,
"order_by":<String_value>,
"args":<String_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>,
"filter":<String_value>,
"detailview":<String_value>,
"duration":<String_value>,
"cr_enabled":<String_value>,
"sla_enabled":<String_value>,
"type":<String_value>,
"resource_name":<String_value>,
"csv_mapping_id":<String_value>}]}