ADC NITRO APIs

cloudparameter

August 17, 2023

Contributed by:

Configuration for cloud parameter resource.

Properties

(click to see Operations )

Name	Permissions	Description
controllerfqdn	Read-write	FQDN of the controller to which the Citrix ADC SDProxy Connects. Minimum length = 1
controllerport	Read-write	Port number of the controller to which the Citrix ADC SDProxy connects. Minimum value = 1 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
instanceid	Read-write	Instance ID of the customer provided by Trust. Minimum length = 1
customerid	Read-write	Customer ID of the citrix cloud customer. Minimum length = 1
resourcelocation	Read-write	Resource Location of the customer provided by Trust. Minimum length = 1
activationcode	Read-write	Activation code for the NGS Connector instance.
deployment	Read-write	Describes if the customer is a Staging/Production or Dev Citrix Cloud customer. Possible values = , Production, Staging, Dev
connectorresidence	Read-write	Identifies whether the connector is located Onprem, Aws or Azure. Possible values = None, Onprem, Aws, Azure, Cpx
controlconnectionstatus	Read-only	Status of the control connection: In case of successful registration to the controller, connection status will be shown as “Registered” else “Unregistered”.

Operations

(click to see Properties )

UPDATE
UNSET
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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/cloudparameter

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"cloudparameter":{
      "controllerfqdn":<String_value>,
      "controllerport":<Integer_value>,
      "instanceid":<String_value>,
      "customerid":<String_value>,
      "resourcelocation":<String_value>,
      "activationcode":<String_value>,
      "deployment":<String_value>,
      "connectorresidence":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/cloudparameter? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"cloudparameter":{
      "instanceid":true,
      "customerid":true,
      "resourcelocation":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/cloudparameter

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "cloudparameter": [ {
      "controllerfqdn":<String_value>,
      "controllerport":<Integer_value>,
      "instanceid":<String_value>,
      "customerid":<String_value>,
      "resourcelocation":<String_value>,
      "controlconnectionstatus":<String_value>,
      "deployment":<String_value>,
      "connectorresidence":<String_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

cloudparameter

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

cloudparameter

Properties

Operations

update

unset

get (all)

In this article