Skip to content

mas_service_license

Configuration for MAS Service License Information resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
entitlement_id<String>Read-writeEntitlement Id for the license file.
end_time<Double>Read-writeLicense expires at this timestamp.
customer_id<String>Read-writeCustomer Id for the tenant who has purchased the license.
serial_numbers<String>Read-writeSerialNumbers.
id<String>Read-writeId is system generated key.
start_date<String>Read-writeStart date of license subscription.
entitlement_type<String>Read-writeEntitlement Type eg. ProductionTrial.
lic_type<Integer>Read-write0 = Trial Period, 1 = Licensed, 2 = Grace period, 3 = Unlicensed, 4 = Canceled.
quantity<String>Read-writeNumber of Licenses of the type purchased.
start_time<Double>Read-writeLicense validity starts from this timestamp.
approved<Boolean>Read-writeApproved.
product_sku<String>Read-writeProduct SKU of the License which specifies the type of license : VIPs, Storage or ThirdParty VIPS.
end_date<String>Read-writeExpiry date of license subscription.
max_vips<String>Read-onlyMaximum VIPs.
max_storage<String>Read-onlyMaximum Storage for the license in GB.
max_tp_vservers<String>Read-onlyMaximum Third Party Vservers.
days_to_expire<Integer>Read-onlyDays to expire.
total_allowed_tp_vips<Integer>Read-onlyTotal Allowed Third Party Vservres.
total_allowed_vips<Integer>Read-onlyTotal Allowed VIPs.
entitled_db_storage<Integer>Read-onlyTotal entitled DB storage.

Operations

(click to see Properties)

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>.

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mas_service_license":[{
"entitlement_id":<String_value>,
"end_time":<Double_value>,
"customer_id":<String_value>,
"serial_numbers":<String_value>,
"id":<String_value>,
"start_date":<String_value>,
"entitlement_type":<String_value>,
"lic_type":<Integer_value>,
"max_vips":<String_value>,
"quantity":<String_value>,
"start_time":<Double_value>,
"max_storage":<String_value>,
"approved":<Boolean_value>,
"product_sku":<String_value>,
"end_date":<String_value>,
"max_tp_vservers":<String_value>,
"days_to_expire":<Integer_value>,
"total_allowed_tp_vips":<Integer_value>,
"total_allowed_vips":<Integer_value>,
"entitled_db_storage":<Integer_value>}]}

update

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

HTTP Method: null

Request Payload:

{mas_service_license:{
"end_time":<Double_value>,
"id":<String_value>,
"entitlement_type":<String_value>,
"lic_type":<Integer_value>,
"start_time":<Double_value>,
"end_date":<String_value>,
"product_sku":<String_value>,
"entitlement_id":<String_value>,
"customer_id":<String_value>,
"start_date":<String_value>,
"serial_numbers":<String_value>,
"quantity":<String_value>,
"approved":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mas_service_license":[{
"entitlement_id":<String_value>,
"end_time":<Double_value>,
"customer_id":<String_value>,
"serial_numbers":<String_value>,
"id":<String_value>,
"start_date":<String_value>,
"entitlement_type":<String_value>,
"lic_type":<Integer_value>,
"max_vips":<String_value>,
"quantity":<String_value>,
"start_time":<Double_value>,
"max_storage":<String_value>,
"approved":<Boolean_value>,
"product_sku":<String_value>,
"end_date":<String_value>,
"max_tp_vservers":<String_value>,
"days_to_expire":<Integer_value>,
"total_allowed_tp_vips":<Integer_value>,
"total_allowed_vips":<Integer_value>,
"entitled_db_storage":<Integer_value>}]}