Skip to content
Was this article helpful?

mas_license

Configuration for Citrix ADM License Information resource.

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.
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.
id <String> Read-write Id is system generated key.
snmp_traps <Integer> Read-write SNMP Traps, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
cpx_lic <Integer> Read-write CPX 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.
analytics <Integer> Read-write Analytics, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
fips_bw_lic <Integer> Read-write FIPS BW Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
mhc_lic <Integer> Read-write Multi Hybrid Cloud 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.
vpx_lic <Integer> Read-write VPX Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
fips_vcpu_lic <Integer> Read-write FIPS vCPU Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
pooled_lic <Integer> Read-write Pooled Licenses, 0=Unlicensed/Disabled, 1=Unlicensed/Enabled, 2=Licensed/Disabled, 3=Licensed/Enabled.
ns_vpnvserver_managed_count <Integer> Read-write Total licensed ns vpnvservers in MAS.
vpx_rule_max_limit <Integer> Read-write VPX rule policy max limit in MAS.
ns_vpnvserver_count <Integer> Read-write Total ns vpnvservers in the system.
ns_crvserver_count <Integer> Read-write Total ns crvservers in the system.
ns_lbvserver_count <Integer> Read-write Total ns lbvservers in the system.
ns_csvserver_managed_count <Integer> Read-write Total licensed ns csvservers in MAS.
get_consumed_db <Boolean> Read-write Get Consumed DB.
ns_gslbvserver_managed_count <Integer> Read-write Total licensed ns gslbvservers in MAS.
ns_authenticationvserver_managed_count <Integer> Read-write Total licensed ns authenticationvservers in MAS.
ns_authenticationvserver_count <Integer> Read-write Total ns authenticationvservers in the system.
total_licenses_consumed <Integer> Read-write Total licneses consumed(excluding free licenses).
cpx_rule_licensed_count <Integer> Read-write Total cpx-rule based licensed vservers in MAS.
ns_gslbvserver_count <Integer> Read-write Total ns gslbvservers in the system.
ns_lbvserver_managed_count <Integer> Read-write Total licensed ns lbvservers in MAS.
ns_csvserver_count <Integer> Read-write Total ns csvservers in the system.
ns_crvserver_managed_count <Integer> Read-write Total licensed ns crvservers in MAS.
auto_licensed_count <Integer> Read-write Total auto licensed vservers in MAS.
manual_licensed_count <Integer> Read-write Total manually licensed vservers in MAS.
vpx_rule_licensed_count <Integer> Read-write Total vpx-rule based licensed vservers in MAS.
cpx_rule_max_limit <Integer> Read-write CPX rule policy max limit in MAS.
node_id <String> Read-only Node ID.
max_vips <String> Read-only Maximum VIPs.
max_storage <String> Read-only Max Storage.
max_tp_vservers <String> Read-only Maximum Third Party Vservers.
rpt_sampletime <Double> Read-only Time Stamp.
total_managed_tp_vservers <Integer> Read-only Total managed Third Party Vservers.
entitled_db_storage <Double> Read-only Entitled DB storage in GB.
total_managed_vips <Integer> Read-only Total managed VIPs.
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.
total_discovered_tp_vservers <Integer> Read-only Total 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

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_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_license":[{
      "vcpu_lic":<Integer_value>,
      "adv_analytics":<Integer_value>,
      "perf":<Integer_value>,
      "node_id":<String_value>,
      "id":<String_value>,
      "snmp_traps":<Integer_value>,
      "cpx_lic":<Integer_value>,
      "lic_type":<Integer_value>,
      "max_vips":<String_value>,
      "max_storage":<String_value>,
      "analytics":<Integer_value>,
      "fips_bw_lic":<Integer_value>,
      "mhc_lic":<Integer_value>,
      "syslog":<Integer_value>,
      "max_tp_vservers":<String_value>,
      "vpx_lic":<Integer_value>,
      "fips_vcpu_lic":<Integer_value>,
      "rpt_sampletime":<Double_value>,
      "pooled_lic":<Integer_value>,
      "ns_vpnvserver_managed_count":<Integer_value>,
      "total_managed_tp_vservers":<Integer_value>,
      "vpx_rule_max_limit":<Integer_value>,
      "entitled_db_storage":<Double_value>,
      "ns_vpnvserver_count":<Integer_value>,
      "total_managed_vips":<Integer_value>,
      "total_allowed_tp_vservers":<Integer_value>,
      "ns_crvserver_count":<Integer_value>,
      "ns_lbvserver_count":<Integer_value>,
      "ns_csvserver_managed_count":<Integer_value>,
      "get_consumed_db":<Boolean_value>,
      "ns_gslbvserver_managed_count":<Integer_value>,
      "ns_authenticationvserver_managed_count":<Integer_value>,
      "ns_authenticationvserver_count":<Integer_value>,
      "total_licenses_consumed":<Integer_value>,
      "cpx_rule_licensed_count":<Integer_value>,
      "ns_gslbvserver_count":<Integer_value>,
      "ns_lbvserver_managed_count":<Integer_value>,
      "ns_csvserver_count":<Integer_value>,
      "total_discovered_vips":<Integer_value>,
      "ns_crvserver_managed_count":<Integer_value>,
      "auto_licensed_count":<Integer_value>,
      "manual_licensed_count":<Integer_value>,
      "consumed_db_storage":<String_value>,
      "vpx_rule_licensed_count":<Integer_value>,
      "total_allowed_vips":<Integer_value>,
      "cpx_rule_max_limit":<Integer_value>,
      "total_discovered_tp_vservers":<Integer_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/mas_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_license":{
      "vcpu_lic":<Integer_value>,
      "vpx_rule_max_limit":<Integer_value>,
      "adv_analytics":<Integer_value>,
      "ns_vpnvserver_count":<Integer_value>,
      "perf":<Integer_value>,
      "ns_crvserver_count":<Integer_value>,
      "id":<String_value>,
      "ns_csvserver_count":<Integer_value>,
      "ns_lbvserver_managed_count":<Integer_value>,
      "cpx_lic":<Integer_value>,
      "lic_type":<Integer_value>,
      "ns_crvserver_managed_count":<Integer_value>,
      "vpx_lic":<Integer_value>,
      "manual_licensed_count":<Integer_value>,
      "fips_vcpu_lic":<Integer_value>,
      "vpx_rule_licensed_count":<Integer_value>,
      "cpx_rule_max_limit":<Integer_value>,
      "ns_vpnvserver_managed_count":<Integer_value>,
      "ns_lbvserver_count":<Integer_value>,
      "ns_csvserver_managed_count":<Integer_value>,
      "get_consumed_db":<Boolean_value>,
      "ns_gslbvserver_managed_count":<Integer_value>,
      "ns_authenticationvserver_managed_count":<Integer_value>,
      "ns_authenticationvserver_count":<Integer_value>,
      "snmp_traps":<Integer_value>,
      "total_licenses_consumed":<Integer_value>,
      "cpx_rule_licensed_count":<Integer_value>,
      "ns_gslbvserver_count":<Integer_value>,
      "analytics":<Integer_value>,
      "fips_bw_lic":<Integer_value>,
      "mhc_lic":<Integer_value>,
      "auto_licensed_count":<Integer_value>,
      "syslog":<Integer_value>,
      "pooled_lic":<Integer_value>}}

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_license":[{
      "vcpu_lic":<Integer_value>,
      "adv_analytics":<Integer_value>,
      "perf":<Integer_value>,
      "node_id":<String_value>,
      "id":<String_value>,
      "snmp_traps":<Integer_value>,
      "cpx_lic":<Integer_value>,
      "lic_type":<Integer_value>,
      "max_vips":<String_value>,
      "max_storage":<String_value>,
      "analytics":<Integer_value>,
      "fips_bw_lic":<Integer_value>,
      "mhc_lic":<Integer_value>,
      "syslog":<Integer_value>,
      "max_tp_vservers":<String_value>,
      "vpx_lic":<Integer_value>,
      "fips_vcpu_lic":<Integer_value>,
      "rpt_sampletime":<Double_value>,
      "pooled_lic":<Integer_value>,
      "ns_vpnvserver_managed_count":<Integer_value>,
      "total_managed_tp_vservers":<Integer_value>,
      "vpx_rule_max_limit":<Integer_value>,
      "entitled_db_storage":<Double_value>,
      "ns_vpnvserver_count":<Integer_value>,
      "total_managed_vips":<Integer_value>,
      "total_allowed_tp_vservers":<Integer_value>,
      "ns_crvserver_count":<Integer_value>,
      "ns_lbvserver_count":<Integer_value>,
      "ns_csvserver_managed_count":<Integer_value>,
      "get_consumed_db":<Boolean_value>,
      "ns_gslbvserver_managed_count":<Integer_value>,
      "ns_authenticationvserver_managed_count":<Integer_value>,
      "ns_authenticationvserver_count":<Integer_value>,
      "total_licenses_consumed":<Integer_value>,
      "cpx_rule_licensed_count":<Integer_value>,
      "ns_gslbvserver_count":<Integer_value>,
      "ns_lbvserver_managed_count":<Integer_value>,
      "ns_csvserver_count":<Integer_value>,
      "total_discovered_vips":<Integer_value>,
      "ns_crvserver_managed_count":<Integer_value>,
      "auto_licensed_count":<Integer_value>,
      "manual_licensed_count":<Integer_value>,
      "consumed_db_storage":<String_value>,
      "vpx_rule_licensed_count":<Integer_value>,
      "total_allowed_vips":<Integer_value>,
      "cpx_rule_max_limit":<Integer_value>,
      "total_discovered_tp_vservers":<Integer_value>}]}
Was this article helpful?