Developer Documentation
NetScaler SDX 14.1 NITRO API Reference

xen_bluecatvpx_image

March 20, 2024
Contributed by: 
C

Configuration for XVA images of bluecat Instance resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
file_location_path Read-write File Location on Client for upload/download.

Minimum length = 1
file_name Read-write File Name.

Minimum length = 1

Maximum length = 256
file_size Read-only file_size.
file_last_modified Read-only Last Modified.
file_last_modified_epoch Read-only Last Modified (Epoch).

Operations

(click to see Properties )

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

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

delete

URL: https://<MGMT-IP>/nitro/v2/config/xen_bluecatvpx_image/file_name_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 }

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/xen_bluecatvpx_image Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/xen_bluecatvpx_image ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of xen_bluecatvpx_image 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/xen_bluecatvpx_image ?pagesize=#no;pageno=#no Use this query-parameter to get the xen_bluecatvpx_image resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/xen_bluecatvpx_image ?count=yes Use this query-parameter to get the count of xen_bluecatvpx_image 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, "xen_bluecatvpx_image":[{
"file_size":<Integer_value>,
"file_last_modified":<String_value>,
"file_last_modified_epoch":<Double_value>,
"file_location_path":<String_value>,
"is_dir":<Boolean_value>,
"file_name":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/xen_bluecatvpx_image/file_name_value<String> 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, "xen_bluecatvpx_image":[{
"file_size":<Integer_value>,
"file_last_modified":<String_value>,
"file_last_modified_epoch":<Double_value>,
"file_location_path":<String_value>,
"is_dir":<Boolean_value>,
"file_name":<String_value>}]}

<!--NeedCopy-->

upload

URL: https://<MGMT-IP>/nitro/v2/upload/xen_bluecatvpx_image 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: 

Multi-part form data with File Stream
<!--NeedCopy-->

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 }

<!--NeedCopy-->
xen_bluecatvpx_image
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.