Skip to content

devicegroup

Configuration for Device group consists of a details about type of devices and platforms present in the group, the references of devices and platforms. The devices added to any service package will be present in its device group. resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
platform_type <String> Read-write platform_type property hold the type of platform of the devices that are present in the device group. The possible values of platform are: 'netscalersdx', 'netscalermpx', 'netscalervpx', 'nova', 'cloudstack'..
device_type <String> Read-write device_type property hold the type of the devices present in the device group. The two values that are currently supported are 'netscaler' and 'partition'. .
name <String> Read-write Name of devicegroup..
id <String> Read-write Id is system generated key for devicegroup..
platforms <groupmember[]> Read-only Platforms present in devicegroup..
devices <groupmember[]> Read-only Devices present in devicegroup..

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

{"devicegroup": {
<b>"device_type":<String_value></b>,
<b>"name":<String_value></b>,
"platform_type":<String_value>,
"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, "devicegroup":[{
"platform_type":<String_value>,
"platforms":[{
"ref":<String_value>}],
"device_type":<String_value>,
"name":<String_value>,
"id":<String_value>,
"devices":[{
"ref":<String_value>}]}]}

delete

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

get (all)

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

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

count https://<MGMT-IP>/nitro/v2/config/devicegroup ?count=yes Use this query-parameter to get the count of devicegroup 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, "devicegroup":[{
"platform_type":<String_value>,
"platforms":[{
"ref":<String_value>}],
"device_type":<String_value>,
"name":<String_value>,
"id":<String_value>,
"devices":[{
"ref":<String_value>}]}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/devicegroup/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, "devicegroup":[{
"platform_type":<String_value>,
"platforms":[{
"ref":<String_value>}],
"device_type":<String_value>,
"name":<String_value>,
"id":<String_value>,
"devices":[{
"ref":<String_value>}]}]}

update

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

{"devicegroup":{
<b>"device_type":<String_value></b>,
<b>"name":<String_value></b>,
"platform_type":<String_value>,
"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, "devicegroup":[{
"platform_type":<String_value>,
"platforms":[{
"ref":<String_value>}],
"device_type":<String_value>,
"name":<String_value>,
"id":<String_value>,
"devices":[{
"ref":<String_value>}]}]}
Was this article helpful?