Citrix ADM NITRO API Reference

autoscalegroup_config

June 20, 2023

Contributed by:

Configuration for Auto-Scale Group configuration/stylebook parameters resource.

Properties

(click to see Operations )

Name	Permissions	Description
generated_domain_name	Read-write	Name of generated domain. Minimum length = 1 Maximum length = 40
autoscalegroup_id	Read-write	ID of autoscalegroup.
zone_name	Read-write	Name of zone. Minimum length = 1 Maximum length = 128
app_name	Read-write	Name of application. Minimum length = 1 Maximum length = 256
is_https_redirect	Read-write	Enabled for https redirect.
probe_port	Read-write	Probe Port. Maximum value =
url	Read-write	Stylebook URL which has namespace, version and stylebook_name. Minimum length = 1 Maximum length = 256
probe_protocol	Read-write	Probe Protocol. Minimum length = 1 Maximum length = 64
stylebook_name	Read-write	Stylebook Name. Minimum length = 1 Maximum length = 64
id	Read-write	Id is system generated key for all the auto-scale group config.
ip_address	Read-write	IP of VIP. Minimum length = 1 Maximum length = 64
frontend_ip	Read-write	The frontend IP of Azure ALB applications. Minimum length = 1 Maximum length = 64
last_modified_time	Read-write	last modified time in seconds.
service_type	Read-write	Service Type. Minimum length = 1 Maximum length = 64
activity_id	Read-write	Most recent activity_id of this autoscalegroup config. Maximum length = 128
version	Read-write	Stylebook version. Minimum length = 1 Maximum length = 16
redirect_port	Read-write	redirect_port. Maximum value =
access_type	Read-write	Access Type (0.External(public)/1.Internal(private)/2.None). Maximum value =
virtual_port	Read-write	Virtual Port. Maximum value =
domain_name	Read-write	Name of domain. Minimum length = 1 Maximum length = 256
frontend_name	Read-write	The frontend name of application. Minimum length = 1 Maximum length = 256
configpack_id	Read-write	ID of deployed configpack on autoscalegroup. Minimum length = 1 Maximum length = 64
backend_service_netprofile_name	Read-write	Name of the backend service netprofile.
autoscalegroup_name	Read-write	Name of autoscalegroup.
stylebook_namespace	Read-write	Stylebook Namespace.
is_migration	Read-write	Enabled for configpack migration.
probe_enabled	Read-write	This flag is set to true if the ADC version (13.0.76.0 and above) has support for probe port and protocol.
force_delete	Read-write	Option to delete the configpack forcefully.
ipset_name	Read-write	Name of IPSet.
stylebook_params	Read-write	Inlcudes all the Stylebook parameters.
frontend_vserver_netprofile_name	Read-write	Name of the frontend vserver netprofile.

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_config?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"autoscalegroup_config": {
"autoscalegroup_name":<String_value>,
"stylebook_namespace":<String_value>,
"autoscalegroup_id":<String_value>,
"zone_name":<String_value>,
"is_https_redirect":<Boolean_value>,
"url":<String_value>,
"id":<String_value>,
"probe_protocol":<String_value>,
"backend_service_netprofile_name":<String_value>,
"service_type":<String_value>,
"activity_id":<String_value>,
"virtual_port":<Integer_value>,
"frontend_name":<String_value>,
"generated_domain_name":<String_value>,
"is_migration":<Boolean_value>,
"probe_enabled":<Boolean_value>,
"app_name":<String_value>,
"ipset_name":<String_value>,
"probe_port":<Integer_value>,
"ip_address":<String_value>,
"stylebook_name":<String_value>,
"last_modified_time":<Double_value>,
"frontend_ip":<String_value>,
"version":<String_value>,
"access_type":<Integer_value>,
"redirect_port":<Integer_value>,
"domain_name":<String_value>,
"force_delete":<Boolean_value>,
"stylebook_params":<String_value>,
"frontend_vserver_netprofile_name":<String_value>,
"configpack_id":<String_value>}}

 

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_config":[{
"generated_domain_name":<String_value>,
"autoscalegroup_id":<String_value>,
"state":<String_value>,
"zone_name":<String_value>,
"app_name":<String_value>,
"is_https_redirect":<Boolean_value>,
"probe_port":<Integer_value>,
"url":<String_value>,
"probe_protocol":<String_value>,
"stylebook_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"frontend_ip":<String_value>,
"last_modified_time":<Double_value>,
"service_type":<String_value>,
"activity_id":<String_value>,
"version":<String_value>,
"redirect_port":<Integer_value>,
"access_type":<Integer_value>,
"virtual_port":<Integer_value>,
"domain_name":<String_value>,
"frontend_name":<String_value>,
"configpack_id":<String_value>,
"backend_service_netprofile_name":<String_value>,
"autoscalegroup_name":<String_value>,
"stylebook_namespace":<String_value>,
"is_migration":<Boolean_value>,
"probe_enabled":<Boolean_value>,
"force_delete":<Boolean_value>,
"ipset_name":<String_value>,
"stylebook_params":<String_value>,
"frontend_vserver_netprofile_name":<String_value>}]}

 

delete

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

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Payload:

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

 

get (all)

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

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

count https://<MGMT-IP>/nitro/v2/config/autoscalegroup_config ?count=yes Use this query-parameter to get the count of autoscalegroup_config resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "autoscalegroup_config":[{
"generated_domain_name":<String_value>,
"autoscalegroup_id":<String_value>,
"state":<String_value>,
"zone_name":<String_value>,
"app_name":<String_value>,
"is_https_redirect":<Boolean_value>,
"probe_port":<Integer_value>,
"url":<String_value>,
"probe_protocol":<String_value>,
"stylebook_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"frontend_ip":<String_value>,
"last_modified_time":<Double_value>,
"service_type":<String_value>,
"activity_id":<String_value>,
"version":<String_value>,
"redirect_port":<Integer_value>,
"access_type":<Integer_value>,
"virtual_port":<Integer_value>,
"domain_name":<String_value>,
"frontend_name":<String_value>,
"configpack_id":<String_value>,
"backend_service_netprofile_name":<String_value>,
"autoscalegroup_name":<String_value>,
"stylebook_namespace":<String_value>,
"is_migration":<Boolean_value>,
"probe_enabled":<Boolean_value>,
"force_delete":<Boolean_value>,
"ipset_name":<String_value>,
"stylebook_params":<String_value>,
"frontend_vserver_netprofile_name":<String_value>}]}

 

get

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

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "autoscalegroup_config":[{
"generated_domain_name":<String_value>,
"autoscalegroup_id":<String_value>,
"state":<String_value>,
"zone_name":<String_value>,
"app_name":<String_value>,
"is_https_redirect":<Boolean_value>,
"probe_port":<Integer_value>,
"url":<String_value>,
"probe_protocol":<String_value>,
"stylebook_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"frontend_ip":<String_value>,
"last_modified_time":<Double_value>,
"service_type":<String_value>,
"activity_id":<String_value>,
"version":<String_value>,
"redirect_port":<Integer_value>,
"access_type":<Integer_value>,
"virtual_port":<Integer_value>,
"domain_name":<String_value>,
"frontend_name":<String_value>,
"configpack_id":<String_value>,
"backend_service_netprofile_name":<String_value>,
"autoscalegroup_name":<String_value>,
"stylebook_namespace":<String_value>,
"is_migration":<Boolean_value>,
"probe_enabled":<Boolean_value>,
"force_delete":<Boolean_value>,
"ipset_name":<String_value>,
"stylebook_params":<String_value>,
"frontend_vserver_netprofile_name":<String_value>}]}

 

update

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

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"autoscalegroup_config":{
<b>"id":<String_value></b>,
"autoscalegroup_name":<String_value>,
"stylebook_namespace":<String_value>,
"autoscalegroup_id":<String_value>,
"zone_name":<String_value>,
"is_https_redirect":<Boolean_value>,
"url":<String_value>,
"probe_protocol":<String_value>,
"backend_service_netprofile_name":<String_value>,
"service_type":<String_value>,
"activity_id":<String_value>,
"virtual_port":<Integer_value>,
"frontend_name":<String_value>,
"generated_domain_name":<String_value>,
"is_migration":<Boolean_value>,
"probe_enabled":<Boolean_value>,
"app_name":<String_value>,
"ipset_name":<String_value>,
"probe_port":<Integer_value>,
"ip_address":<String_value>,
"stylebook_name":<String_value>,
"last_modified_time":<Double_value>,
"frontend_ip":<String_value>,
"version":<String_value>,
"access_type":<Integer_value>,
"redirect_port":<Integer_value>,
"domain_name":<String_value>,
"force_delete":<Boolean_value>,
"stylebook_params":<String_value>,
"frontend_vserver_netprofile_name":<String_value>,
"configpack_id":<String_value>}}

 

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "autoscalegroup_config":[{
"generated_domain_name":<String_value>,
"autoscalegroup_id":<String_value>,
"state":<String_value>,
"zone_name":<String_value>,
"app_name":<String_value>,
"is_https_redirect":<Boolean_value>,
"probe_port":<Integer_value>,
"url":<String_value>,
"probe_protocol":<String_value>,
"stylebook_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"frontend_ip":<String_value>,
"last_modified_time":<Double_value>,
"service_type":<String_value>,
"activity_id":<String_value>,
"version":<String_value>,
"redirect_port":<Integer_value>,
"access_type":<Integer_value>,
"virtual_port":<Integer_value>,
"domain_name":<String_value>,
"frontend_name":<String_value>,
"configpack_id":<String_value>,
"backend_service_netprofile_name":<String_value>,
"autoscalegroup_name":<String_value>,
"stylebook_namespace":<String_value>,
"is_migration":<Boolean_value>,
"probe_enabled":<Boolean_value>,
"force_delete":<Boolean_value>,
"ipset_name":<String_value>,
"stylebook_params":<String_value>,
"frontend_vserver_netprofile_name":<String_value>}]}

 

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

autoscalegroup_config

June 20, 2023

Contributed by:

autoscalegroup_config

Properties

Operations

add

delete

get (all)

get

update

In this article