mas_license
Configuration for MAS License Information resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| vcpu_lic | <Integer> | Read-write | vCPU Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| lic_type | <Integer> | Read-write | 0 = Trial Period, 1 = Licensed, 2 = Grace period, 3 = unlicensed. |
| cpx_lic | <Integer> | Read-write | CPX Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| analytics | <Integer> | Read-write | Analytics, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| adv_analytics | <Integer> | Read-write | Advanced Analytics, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| perf | <Integer> | Read-write | Perf, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| vpx_lic | <Integer> | Read-write | VPX Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| syslog | <Integer> | Read-write | Syslog, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| id | <String> | Read-write | Id is system generated key. |
| pooled_lic | <Integer> | Read-write | Pooled Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| snmp_traps | <Integer> | Read-write | SNMP Traps, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled. |
| get_consumed_db | <Boolean> | Read-write | Get Consumed DB. |
| max_vips | <String> | Read-only | Maximum VIPs. |
| max_storage | <String> | Read-only | Max Storage. |
| node_id | <String> | Read-only | Node ID. |
| max_tp_vservers | <String> | Read-only | Maximum Third Party Vservers. |
| rpt_sampletime | <Double> | Read-only | Time Stamp. |
| total_managed_vips | <Integer> | Read-only | Total managed VIPs. |
| total_managed_tp_vservers | <Integer> | Read-only | Total managed Third Party Vservers. |
| total_allowed_tp_vservers | <Integer> | Read-only | Total Allowed Third Party Vservres. |
| total_discovered_vips | <Integer> | Read-only | Total discovered VIPs. |
| consumed_db_storage | <String> | Read-only | Consumed DB storage. |
| total_allowed_vips | <Integer> | Read-only | Total Allowed VIPs. |
| entitled_db_storage | <Integer> | Read-only | Entitled DB storage in GB. |
| total_discovered_tp_vservers | <Integer> | Read-only | Total discovered Third Party Vservres. |
Operations
(click to see Properties)
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_license
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mas_license":[{
"vcpu_lic":<Integer_value>,
"lic_type":<Integer_value>,
"cpx_lic":<Integer_value>,
"max_vips":<String_value>,
"max_storage":<String_value>,
"analytics":<Integer_value>,
"adv_analytics":<Integer_value>,
"perf":<Integer_value>,
"node_id":<String_value>,
"vpx_lic":<Integer_value>,
"max_tp_vservers":<String_value>,
"syslog":<Integer_value>,
"id":<String_value>,
"rpt_sampletime":<Double_value>,
"pooled_lic":<Integer_value>,
"snmp_traps":<Integer_value>,
"total_managed_vips":<Integer_value>,
"total_managed_tp_vservers":<Integer_value>,
"total_allowed_tp_vservers":<Integer_value>,
"total_discovered_vips":<Integer_value>,
"get_consumed_db":<Boolean_value>,
"consumed_db_storage":<String_value>,
"total_allowed_vips":<Integer_value>,
"entitled_db_storage":<Integer_value>,
"total_discovered_tp_vservers":<Integer_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/mas_license/id_value<String>
HTTP Method: null
Request Payload:
{mas_license:{
"vcpu_lic":<Integer_value>,
"cpx_lic":<Integer_value>,
"lic_type":<Integer_value>,
"analytics":<Integer_value>,
"adv_analytics":<Integer_value>,
"perf":<Integer_value>,
"get_consumed_db":<Boolean_value>,
"syslog":<Integer_value>,
"vpx_lic":<Integer_value>,
"id":<String_value>,
"pooled_lic":<Integer_value>,
"snmp_traps":<Integer_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mas_license":[{
"vcpu_lic":<Integer_value>,
"lic_type":<Integer_value>,
"cpx_lic":<Integer_value>,
"max_vips":<String_value>,
"max_storage":<String_value>,
"analytics":<Integer_value>,
"adv_analytics":<Integer_value>,
"perf":<Integer_value>,
"node_id":<String_value>,
"vpx_lic":<Integer_value>,
"max_tp_vservers":<String_value>,
"syslog":<Integer_value>,
"id":<String_value>,
"rpt_sampletime":<Double_value>,
"pooled_lic":<Integer_value>,
"snmp_traps":<Integer_value>,
"total_managed_vips":<Integer_value>,
"total_managed_tp_vservers":<Integer_value>,
"total_allowed_tp_vservers":<Integer_value>,
"total_discovered_vips":<Integer_value>,
"get_consumed_db":<Boolean_value>,
"consumed_db_storage":<String_value>,
"total_allowed_vips":<Integer_value>,
"entitled_db_storage":<Integer_value>,
"total_discovered_tp_vservers":<Integer_value>}]}