Skip to content

device_group

Configuration for Device Group resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
static_device_list <String> Read-write Devices in the group.
device_family <String> Read-write Device Family.

Minimum length = 1

Maximum length = 64
lock_acquiring_device <String> Read-write Upgrade Lock acquiring device.

Maximum length = 255
name <String> Read-write Device Group Name.

Maximum length = 255
duration <Integer> Read-write Duration of Maintenance window for groups of category upgrade.

Minimum value = 1

Maximum value =
maintenance_window_start <String> Read-write Maintenance window start time for groups of category upgrade.

Maximum length = 255
criteria_type <String> Read-write Device Group Criteria.

Maximum length = 255
upgrade_version <String> Read-write New Available upgrade version for devices.

Maximum length = 255
criteria_condn <String> Read-write Tenant.

Maximum length = 255
upgrade_lock <Boolean> Read-write Lock to be acquired before upgrading device group.
id <String> Read-write Id is system generated key for agent registered with NMX Cloud..
category <String> Read-write Device group category. Will be default/upgrade..

Maximum length = 255
disable_upgrade <Boolean> Read-write Setting to disable agent upgrades.
lock_acquire_time <String> Read-write Upgrade Lock acquiring time.

Maximum length = 255
criteria_value <String> Read-write Criteria Value.

Maximum length = 255
static_device_list_arr <String[]> Read-write Static Device List.
tenant_id <String> Read-only Tenant Id.

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

{"device_group": {
<b>      "duration":<Integer_value></b>,
      "static_device_list":<String_value>,
      "lock_acquiring_device":<String_value>,
      "category":<String_value>,
      "name":<String_value>,
      "upgrade_version":<String_value>,
      "static_device_list_arr":<String_value[]>,
      "maintenance_window_start":<String_value>,
      "criteria_condn":<String_value>,
      "id":<String_value>,
      "criteria_value":<String_value>,
      "device_family":<String_value>,
      "upgrade_lock":<Boolean_value>,
      "disable_upgrade":<Boolean_value>,
      "lock_acquire_time":<String_value>,
      "criteria_type":<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, "device_group":[{
      "static_device_list":<String_value>,
      "device_family":<String_value>,
      "lock_acquiring_device":<String_value>,
      "name":<String_value>,
      "duration":<Integer_value>,
      "maintenance_window_start":<String_value>,
      "criteria_type":<String_value>,
      "upgrade_version":<String_value>,
      "criteria_condn":<String_value>,
      "upgrade_lock":<Boolean_value>,
      "tenant_id":<String_value>,
      "id":<String_value>,
      "category":<String_value>,
      "disable_upgrade":<Boolean_value>,
      "lock_acquire_time":<String_value>,
      "criteria_value":<String_value>,
      "static_device_list_arr":<String_value>}]}

delete

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

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/device_group ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of device_group 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/device_group ?pagesize=#no;pageno=#no

Use this query-parameter to get the device_group resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/device_group ?count=yes

Use this query-parameter to get the count of device_group 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, "device_group":[{
      "static_device_list":<String_value>,
      "device_family":<String_value>,
      "lock_acquiring_device":<String_value>,
      "name":<String_value>,
      "duration":<Integer_value>,
      "maintenance_window_start":<String_value>,
      "criteria_type":<String_value>,
      "upgrade_version":<String_value>,
      "criteria_condn":<String_value>,
      "upgrade_lock":<Boolean_value>,
      "tenant_id":<String_value>,
      "id":<String_value>,
      "category":<String_value>,
      "disable_upgrade":<Boolean_value>,
      "lock_acquire_time":<String_value>,
      "criteria_value":<String_value>,
      "static_device_list_arr":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/device_group/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, "device_group":[{
      "static_device_list":<String_value>,
      "device_family":<String_value>,
      "lock_acquiring_device":<String_value>,
      "name":<String_value>,
      "duration":<Integer_value>,
      "maintenance_window_start":<String_value>,
      "criteria_type":<String_value>,
      "upgrade_version":<String_value>,
      "criteria_condn":<String_value>,
      "upgrade_lock":<Boolean_value>,
      "tenant_id":<String_value>,
      "id":<String_value>,
      "category":<String_value>,
      "disable_upgrade":<Boolean_value>,
      "lock_acquire_time":<String_value>,
      "criteria_value":<String_value>,
      "static_device_list_arr":<String_value>}]}

update

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

{"device_group":{
<b>      "duration":<Integer_value></b>,
      "static_device_list":<String_value>,
      "lock_acquiring_device":<String_value>,
      "category":<String_value>,
      "name":<String_value>,
      "upgrade_version":<String_value>,
      "static_device_list_arr":<String_value[]>,
      "maintenance_window_start":<String_value>,
      "criteria_condn":<String_value>,
      "id":<String_value>,
      "criteria_value":<String_value>,
      "device_family":<String_value>,
      "upgrade_lock":<Boolean_value>,
      "disable_upgrade":<Boolean_value>,
      "lock_acquire_time":<String_value>,
      "criteria_type":<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, "device_group":[{
      "static_device_list":<String_value>,
      "device_family":<String_value>,
      "lock_acquiring_device":<String_value>,
      "name":<String_value>,
      "duration":<Integer_value>,
      "maintenance_window_start":<String_value>,
      "criteria_type":<String_value>,
      "upgrade_version":<String_value>,
      "criteria_condn":<String_value>,
      "upgrade_lock":<Boolean_value>,
      "tenant_id":<String_value>,
      "id":<String_value>,
      "category":<String_value>,
      "disable_upgrade":<Boolean_value>,
      "lock_acquire_time":<String_value>,
      "criteria_value":<String_value>,
      "static_device_list_arr":<String_value>}]}
Was this article helpful?