Citrix ADM NITRO API Reference

autoscalegroup_profile_map

Configuration for Auto-Scale Group provision details for each availability zone resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
azure_resource_group_name <String> Read-write Resource group name for Azure.

Maximum length = 128
az_type <Integer> Read-write Type of availabilty_zone/cluster (1.ORIGINAL, 2.BACKUP).

Minimum value = 1

Maximum value =
cluster_id <String> Read-write ADC Cluster ID for the availability zone.

Maximum length = 128
parent_id <String> Read-write Parent Id of autoscalegroup.
node_id <String> Read-write The managed_device id which has reference to the node provisioned or to be deprovisioned.

Maximum length = 128
provision_profile_id <String> Read-write ID of provision profile.

Minimum length = 1
is_active_node_prov <Boolean> Read-write This is to refer if the provisioning inprogress/failed/success is on active/passive node.
id <String> Read-write Id is system generated key for all the profiles.
provision_request_id <String> Read-write The request id generated for provisoning of cluster from provisioning service.

Maximum length = 128
parent_name <String> Read-write Parent name of autoscale group.
activity_id <String> Read-write Most recent activity_id of this availability_zone/cluster.
provision_job_id <String> Read-write The job id generated for provisoning of failed node from provisioning service.

Maximum length = 128
retry_count <Integer> Read-write current auto retry count for a retryable error in a cluster..

Maximum value =
availability_zone <String> Read-write availability_zone of autoscalegroup.

Minimum length = 1

Maximum length = 128
is_availability_set <Boolean> Read-write Azure: If this profile belongs to availability set.
az_version <String> Read-write Version of availabilty_zone/cluster. Auto generated..
retry_err_type <String> Read-write Enable/Disable provisioning retry.

Maximum length = 50
node_count <Integer> Read-write Number of nodes to be provisioned in the cluster.

Minimum value = 1

Maximum value =
error_message <String> Read-write Provision error message.

Maximum length = 255
autoscalegroup_name <String> Read-write Auto-Scale Group Name.
delay <Integer> Read-write For mock test: Delay in seconds introduced to get the response..

Maximum value =
error_type <Integer> Read-write For mock test: simulates response type. 0-success,1-failed,2-validation failed with no delay.
cluster_ip_address <String> Read-only ADC Cluster IP Address.

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • UPDATE

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

{"autoscalegroup_profile_map": {
"azure_resource_group_name":<String_value>,
"cluster_id":<String_value>,
"az_type":<Integer_value>,
"autoscalegroup_name":<String_value>,
"parent_id":<String_value>,
"provision_profile_id":<String_value>,
"id":<String_value>,
"parent_name":<String_value>,
"activity_id":<String_value>,
"provision_job_id":<String_value>,
"availability_zone":<String_value>,
"retry_err_type":<String_value>,
"az_version":<String_value>,
"node_count":<Integer_value>,
"error_message":<String_value>,
"error_type":<Integer_value>,
"delay":<Integer_value>,
"node_id":<String_value>,
"is_active_node_prov":<Boolean_value>,
"provision_request_id":<String_value>,
"is_availability_set":<Boolean_value>,
"retry_count":<Integer_value>}}

<!--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", "severity": ;ltString_value;gt, "autoscalegroup_profile_map":[{
"azure_resource_group_name":<String_value>,
"az_type":<Integer_value>,
"cluster_id":<String_value>,
"provision_state":<String_value>,
"parent_id":<String_value>,
"last_updated_time":<Double_value>,
"node_id":<String_value>,
"provision_profile_id":<String_value>,
"is_active_node_prov":<Boolean_value>,
"id":<String_value>,
"cluster_ip_address":<String_value>,
"is_drain_connection_timeout_period":<Boolean_value>,
"provision_request_id":<String_value>,
"parent_name":<String_value>,
"activity_id":<String_value>,
"provision_job_id":<String_value>,
"retry_count":<Integer_value>,
"availability_zone":<String_value>,
"provision_failure_timeout":<Integer_value>,
"is_availability_set":<Boolean_value>,
"az_version":<String_value>,
"retry_err_type":<String_value>,
"node_count":<Integer_value>,
"error_message":<String_value>,
"is_cool_down_period":<Boolean_value>,
"bandwidth_limit":<Integer_value>,
"autoscalegroup_name":<String_value>,
"az_activity_id":<String_value>,
"delay":<Integer_value>,
"is_auto_upgrade":<Boolean_value>,
"error_type":<Integer_value>}]}

<!--NeedCopy-->

delete

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

<!--NeedCopy-->

get (all)

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

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

count https://<MGMT-IP>/nitro/v2/config/autoscalegroup_profile_map ?count=yes Use this query-parameter to get the count of autoscalegroup_profile_map 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, "autoscalegroup_profile_map":[{
"azure_resource_group_name":<String_value>,
"az_type":<Integer_value>,
"cluster_id":<String_value>,
"provision_state":<String_value>,
"parent_id":<String_value>,
"last_updated_time":<Double_value>,
"node_id":<String_value>,
"provision_profile_id":<String_value>,
"is_active_node_prov":<Boolean_value>,
"id":<String_value>,
"cluster_ip_address":<String_value>,
"is_drain_connection_timeout_period":<Boolean_value>,
"provision_request_id":<String_value>,
"parent_name":<String_value>,
"activity_id":<String_value>,
"provision_job_id":<String_value>,
"retry_count":<Integer_value>,
"availability_zone":<String_value>,
"provision_failure_timeout":<Integer_value>,
"is_availability_set":<Boolean_value>,
"az_version":<String_value>,
"retry_err_type":<String_value>,
"node_count":<Integer_value>,
"error_message":<String_value>,
"is_cool_down_period":<Boolean_value>,
"bandwidth_limit":<Integer_value>,
"autoscalegroup_name":<String_value>,
"az_activity_id":<String_value>,
"delay":<Integer_value>,
"is_auto_upgrade":<Boolean_value>,
"error_type":<Integer_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/autoscalegroup_profile_map/id_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, "autoscalegroup_profile_map":[{
"azure_resource_group_name":<String_value>,
"az_type":<Integer_value>,
"cluster_id":<String_value>,
"provision_state":<String_value>,
"parent_id":<String_value>,
"last_updated_time":<Double_value>,
"node_id":<String_value>,
"provision_profile_id":<String_value>,
"is_active_node_prov":<Boolean_value>,
"id":<String_value>,
"cluster_ip_address":<String_value>,
"is_drain_connection_timeout_period":<Boolean_value>,
"provision_request_id":<String_value>,
"parent_name":<String_value>,
"activity_id":<String_value>,
"provision_job_id":<String_value>,
"retry_count":<Integer_value>,
"availability_zone":<String_value>,
"provision_failure_timeout":<Integer_value>,
"is_availability_set":<Boolean_value>,
"az_version":<String_value>,
"retry_err_type":<String_value>,
"node_count":<Integer_value>,
"error_message":<String_value>,
"is_cool_down_period":<Boolean_value>,
"bandwidth_limit":<Integer_value>,
"autoscalegroup_name":<String_value>,
"az_activity_id":<String_value>,
"delay":<Integer_value>,
"is_auto_upgrade":<Boolean_value>,
"error_type":<Integer_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/autoscalegroup_profile_map/id_value<String> HTTPS Method: PUT

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:

{"autoscalegroup_profile_map":{
"azure_resource_group_name":<String_value>,
"cluster_id":<String_value>,
"az_type":<Integer_value>,
"autoscalegroup_name":<String_value>,
"parent_id":<String_value>,
"provision_profile_id":<String_value>,
"id":<String_value>,
"parent_name":<String_value>,
"activity_id":<String_value>,
"provision_job_id":<String_value>,
"availability_zone":<String_value>,
"retry_err_type":<String_value>,
"az_version":<String_value>,
"node_count":<Integer_value>,
"error_message":<String_value>,
"error_type":<Integer_value>,
"delay":<Integer_value>,
"node_id":<String_value>,
"is_active_node_prov":<Boolean_value>,
"provision_request_id":<String_value>,
"is_availability_set":<Boolean_value>,
"retry_count":<Integer_value>}}

<!--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", "severity": ;ltString_value;gt, "autoscalegroup_profile_map":[{
"azure_resource_group_name":<String_value>,
"az_type":<Integer_value>,
"cluster_id":<String_value>,
"provision_state":<String_value>,
"parent_id":<String_value>,
"last_updated_time":<Double_value>,
"node_id":<String_value>,
"provision_profile_id":<String_value>,
"is_active_node_prov":<Boolean_value>,
"id":<String_value>,
"cluster_ip_address":<String_value>,
"is_drain_connection_timeout_period":<Boolean_value>,
"provision_request_id":<String_value>,
"parent_name":<String_value>,
"activity_id":<String_value>,
"provision_job_id":<String_value>,
"retry_count":<Integer_value>,
"availability_zone":<String_value>,
"provision_failure_timeout":<Integer_value>,
"is_availability_set":<Boolean_value>,
"az_version":<String_value>,
"retry_err_type":<String_value>,
"node_count":<Integer_value>,
"error_message":<String_value>,
"is_cool_down_period":<Boolean_value>,
"bandwidth_limit":<Integer_value>,
"autoscalegroup_name":<String_value>,
"az_activity_id":<String_value>,
"delay":<Integer_value>,
"is_auto_upgrade":<Boolean_value>,
"error_type":<Integer_value>}]}

<!--NeedCopy-->
autoscalegroup_profile_map