Skip to content
Was this article helpful?


Configuration for Citrix ADM Orchestration allocates Citrix ADC instances according to the SLA that is defined as part this service package. resource.


(click to see Operations )

Name Data Type Permissions Description
partitionspec <groupmember> Read-write ID of a Partition Specification. The partition specification will be used while creating partition.
devicespec <groupmember> Read-write ID of a Device Specification. The device specification will be used while creating device instances.
device_type <String> Read-write The device type that has to be allocated. Possible values - 'Citrix ADC'.
placement_scheme <String> Read-write The allocation policy scheme which will help allocating a device when allocation policy is 'shared'. Possible values - 'roundrobin', 'leastentity'.
devicegroup <groupmember> Read-write Devicegroup from which devices will be allocated.
allocationpolicy <String> Read-write The allocation policy of the device instance. Possible values - 'shared', 'dedicated'.
device_allocation_type <String> Read-write The device instance that has to be allocated. Possible values - 'netScaler', 'partition'.


(click to see Properties )

  • 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

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

get (all)

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

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

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


Request Headers: Accept: application/json





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:


Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "allocationgroup":[{
Was this article helpful?