Skip to content

device_group

Configuration for Device Group resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
static_device_list<String>Read-writeDevices in the group.
device_family<String>Read-writeDevice Family.
Minimum length = 1
Maximum length = 64
lock_acquiring_device<String>Read-writeUpgrade Lock acquiring device.
Maximum length = 255
name<String>Read-writeDevice Group Name.
Maximum length = 255
duration<Integer>Read-writeDuration of Maintenance window for groups of category upgrade.
Minimum value = 1
Maximum value =
maintenance_window_start<String>Read-writeMaintenance window start time for groups of category upgrade.
Maximum length = 255
criteria_type<String>Read-writeDevice Group Criteria.
Maximum length = 255
upgrade_version<String>Read-writeNew Available upgrade version for devices.
Maximum length = 255
criteria_condn<String>Read-writeTenant.
Maximum length = 255
upgrade_lock<Boolean>Read-writeLock to be acquired before upgrading device group.
id<String>Read-writeId is system generated key for agent registered with NMX Cloud..
category<String>Read-writeDevice group category. Will be default/upgrade..
Maximum length = 255
disable_upgrade<Boolean>Read-writeSetting to disable agent upgrades.
lock_acquire_time<String>Read-writeUpgrade Lock acquiring time.
Maximum length = 255
criteria_value<String>Read-writeCriteria Value.
Maximum length = 255
static_device_list_arr<String[]>Read-writeStatic Device List.
tenant_id<String>Read-onlyTenant 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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/device_group?onerror=<String_value>

HTTP Method: null

Request Payload:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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/v1/config/device_group/id_value<String>

HTTP Method: null

Response Payload:

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

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/device_group

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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/v1/config/device_group/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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/v1/config/device_group/id_value<String>

HTTP Method: null

Request Payload:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}