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.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
platform_type<String>Read-writeplatform_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-writedevice_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-writeName of devicegroup..
id<String>Read-writeId is system generated key for devicegroup..
platforms<groupmember[]>Read-onlyPlatforms present in devicegroup..
devices<groupmember[]>Read-onlyDevices 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>.

add

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

HTTP Method: null

Request Payload:

{devicegroup: {
<b>"device_type":<String_value></b>,
<b>"name":<String_value></b>,
"platform_type":<String_value>,
"id":<String_value>}}

Response Payload:

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

HTTP Method: null

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

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

HTTP Method: null

Response Payload:

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

HTTP Method: null

Request Payload:

{devicegroup:{
<b>"device_type":<String_value></b>,
<b>"name":<String_value></b>,
"platform_type":<String_value>,
"id":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "devicegroup":[{
"platform_type":<String_value>,
"platforms":[{
"ref":<String_value>}],
"device_type":<String_value>,
"name":<String_value>,
"id":<String_value>,
"devices":[{
"ref":<String_value>}]}]}