Skip to content

servicepackage

Configuration for NetScaler Control Center allocates NetScaler instances according to the SLA that is defined as part this service package. resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of service package..
cloudplatform_type<String>Read-writeCloudplatform registered on MAS.
max_devices_to_autoprovision<String>Read-writeMaximum number of devices to autoprovision.
description<String>Read-writeDescription for the service package.
isdefault<String>Read-writeIs this a default service package. Only one service package can be set as default service package. The default service package is used for allotment in any lb configuration that is not associated with any service package. Possible values - 'true', 'false'.
id<String>Read-writeId is system generated key for service package.
allocationgroups<allocationgroup[]>Read-writeDevice allocation policy for each device type.
tenantgroup<groupmember>Read-writeTenant group of the tenants which are part of the service package.

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/servicepackage?onerror=<String_value>

HTTP Method: null

Request Payload:

{servicepackage: {
"name":<String_value>,
"description":<String_value>,
"max_devices_to_autoprovision":<String_value>,
"cloudplatform_type":<String_value>,
"isdefault":<String_value>,
"id":<String_value>,
"allocationgroups":[{
"device_type":<String_value>,
"devicespec":<groupmember_value>,
"partitionspec":<groupmember_value>,
"placement_scheme":<String_value>,
"devicegroup":<groupmember_value>,
"device_allocation_type":<String_value>,
"allocationpolicy":<String_value>}],
"tenantgroup":<groupmember_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "servicepackage":[{
"name":<String_value>,
"cloudplatform_type":<String_value>,
"max_devices_to_autoprovision":<String_value>,
"description":<String_value>,
"isdefault":<String_value>,
"id":<String_value>,
"allocationgroups":[{
"partitionspec":<groupmember_value>,
"devicespec":<groupmember_value>,
"device_type":<String_value>,
"placement_scheme":<String_value>,
"devicegroup":<groupmember_value>,
"allocationpolicy":<String_value>,
"device_allocation_type":<String_value>}],
"tenantgroup":<groupmember_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/servicepackage/id_value<String>

HTTP Method: null

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "servicepackage":[{
"name":<String_value>,
"cloudplatform_type":<String_value>,
"max_devices_to_autoprovision":<String_value>,
"description":<String_value>,
"isdefault":<String_value>,
"id":<String_value>,
"allocationgroups":[{
"partitionspec":<groupmember_value>,
"devicespec":<groupmember_value>,
"device_type":<String_value>,
"placement_scheme":<String_value>,
"devicegroup":<groupmember_value>,
"allocationpolicy":<String_value>,
"device_allocation_type":<String_value>}],
"tenantgroup":<groupmember_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/servicepackage/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "servicepackage":[{
"name":<String_value>,
"cloudplatform_type":<String_value>,
"max_devices_to_autoprovision":<String_value>,
"description":<String_value>,
"isdefault":<String_value>,
"id":<String_value>,
"allocationgroups":[{
"partitionspec":<groupmember_value>,
"devicespec":<groupmember_value>,
"device_type":<String_value>,
"placement_scheme":<String_value>,
"devicegroup":<groupmember_value>,
"allocationpolicy":<String_value>,
"device_allocation_type":<String_value>}],
"tenantgroup":<groupmember_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/servicepackage/id_value<String>

HTTP Method: null

Request Payload:

{servicepackage:{
"name":<String_value>,
"description":<String_value>,
"max_devices_to_autoprovision":<String_value>,
"cloudplatform_type":<String_value>,
"isdefault":<String_value>,
"id":<String_value>,
"allocationgroups":[{
"device_type":<String_value>,
"devicespec":<groupmember_value>,
"partitionspec":<groupmember_value>,
"placement_scheme":<String_value>,
"devicegroup":<groupmember_value>,
"device_allocation_type":<String_value>,
"allocationpolicy":<String_value>}],
"tenantgroup":<groupmember_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "servicepackage":[{
"name":<String_value>,
"cloudplatform_type":<String_value>,
"max_devices_to_autoprovision":<String_value>,
"description":<String_value>,
"isdefault":<String_value>,
"id":<String_value>,
"allocationgroups":[{
"partitionspec":<groupmember_value>,
"devicespec":<groupmember_value>,
"device_type":<String_value>,
"placement_scheme":<String_value>,
"devicegroup":<groupmember_value>,
"allocationpolicy":<String_value>,
"device_allocation_type":<String_value>}],
"tenantgroup":<groupmember_value>}]}