Skip to content

mas_license

Configuration for MAS License Information resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
vcpu_lic<Integer>Read-writevCPU Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
lic_type<Integer>Read-write0 = Trial Period, 1 = Licensed, 2 = Grace period, 3 = unlicensed.
cpx_lic<Integer>Read-writeCPX Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
analytics<Integer>Read-writeAnalytics, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
adv_analytics<Integer>Read-writeAdvanced Analytics, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
perf<Integer>Read-writePerf, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
vpx_lic<Integer>Read-writeVPX Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
syslog<Integer>Read-writeSyslog, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
id<String>Read-writeId is system generated key.
pooled_lic<Integer>Read-writePooled Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
snmp_traps<Integer>Read-writeSNMP Traps, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
get_consumed_db<Boolean>Read-writeGet Consumed DB.
max_vips<String>Read-onlyMaximum VIPs.
max_storage<String>Read-onlyMax Storage.
node_id<String>Read-onlyNode ID.
max_tp_vservers<String>Read-onlyMaximum Third Party Vservers.
rpt_sampletime<Double>Read-onlyTime Stamp.
total_managed_vips<Integer>Read-onlyTotal managed VIPs.
total_managed_tp_vservers<Integer>Read-onlyTotal managed Third Party Vservers.
total_allowed_tp_vservers<Integer>Read-onlyTotal Allowed Third Party Vservres.
total_discovered_vips<Integer>Read-onlyTotal discovered VIPs.
consumed_db_storage<String>Read-onlyConsumed DB storage.
total_allowed_vips<Integer>Read-onlyTotal Allowed VIPs.
entitled_db_storage<Integer>Read-onlyEntitled DB storage in GB.
total_discovered_tp_vservers<Integer>Read-onlyTotal discovered Third Party Vservres.

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_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>}]}