mas_service_license
Configuration for Citrix ADM Service License Information resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| entitlement_id | <String> | Read-write | Entitlement Id for the license file. |
| end_time | <Double> | Read-write | License expires at this timestamp. |
| customer_id | <String> | Read-write | Customer Id for the tenant who has purchased the license. |
| serial_numbers | <String> | Read-write | SerialNumbers. |
| id | <String> | Read-write | Id is system generated key. |
| start_date | <String> | Read-write | Start date of license subscription. |
| entitlement_type | <String> | Read-write | Entitlement Type eg. ProductionTrial. |
| lic_type | <Integer> | Read-write | 0 = Trial Period, 1 = Licensed, 2 = Grace period, 3 = Unlicensed, 4 = Canceled. |
| quantity | <String> | Read-write | Number of Licenses of the type purchased. |
| start_time | <Double> | Read-write | License validity starts from this timestamp. |
| approved | <Boolean> | Read-write | Approved. |
| product_sku | <String> | Read-write | Product SKU of the License which specifies the type of license : VIPs, Storage or ThirdParty VIPS. |
| end_date | <String> | Read-write | Expiry date of license subscription. |
| max_vips | <String> | Read-only | Maximum VIPs. |
| max_storage | <String> | Read-only | Maximum Storage for the license in GB. |
| max_tp_vservers | <String> | Read-only | Maximum Third Party Vservers. |
| days_to_expire | <Integer> | Read-only | Days to expire. |
| total_allowed_tp_vips | <Integer> | Read-only | Total Allowed Third Party Vservres. |
| total_allowed_vips | <Integer> | Read-only | Total Allowed VIPs. |
| entitled_db_storage | <Double> | Read-only | Total 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
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
get
URL: https://<MGMT-IP>/nitro/v2/config/mas_service_license 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, "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":<Double_value>}]}
<!--NeedCopy-->
update
URL: https://<MGMT-IP>/nitro/v2/config/mas_service_license/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:
{"mas_service_license":{
"entitlement_type":<String_value>,
"lic_type":<Integer_value>,
"start_time":<Double_value>,
"product_sku":<String_value>,
"end_time":<Double_value>,
"id":<String_value>,
"end_date":<String_value>,
"entitlement_id":<String_value>,
"customer_id":<String_value>,
"start_date":<String_value>,
"serial_numbers":<String_value>,
"quantity":<String_value>,
"approved":<Boolean_value>}}
<!--NeedCopy-->
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, "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":<Double_value>}]}
<!--NeedCopy-->