Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

cloudparameter

August 17, 2023
Contributed by: 
C

Configuration for cloud parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
controllerfqdn <String> Read-write FQDN of the controller to which the Citrix ADC SDProxy Connects.

Minimum length = 1
controllerport <Integer> 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 <String> Read-write Instance ID of the customer provided by Trust.

Minimum length = 1
customerid <String> Read-write Customer ID of the citrix cloud customer.

Minimum length = 1
resourcelocation <String> Read-write Resource Location of the customer provided by Trust.

Minimum length = 1
activationcode <String> Read-write Activation code for the NGS Connector instance.
deployment <String> Read-write Describes if the customer is a Staging/Production or Dev Citrix Cloud customer.

Possible values = , Production, Staging, Dev
connectorresidence <String> Read-write Identifies whether the connector is located Onprem, Aws or Azure.

Possible values = None, Onprem, Aws, Azure, Cpx
controlconnectionstatus <String> 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-->
cloudparameter
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

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