member:license : Member License object.

This object represents the member license.

Object Reference

References to member:license are object references. The name part of a Member License object reference has the following components:

  • Type of license e.g. DNS, DHCP.
  • Kind of license - Static/Dynamic.

Example: member:license/b25lLnByb2R1Y3RfbGljZW5zZSQwLGRoY3AsMA:DHCP/Static

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Modify (update)
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): type.

expiration_status

expiration_status

The license expiration status.

Type

String.

Valid values are:
  • DELETED
  • EXPIRED
  • EXPIRING_SOON
  • EXPIRING_VERY_SOON
  • NOT_EXPIRED
  • PERMANENT

Search

The field is not available for search.

Notes

The expiration_status cannot be updated.

expiration_status cannot be written.

expiry_date

expiry_date

The expiration timestamp of the license.

Type

Timestamp.

Search

The field is not available for search.

Notes

The expiry_date cannot be updated.

expiry_date cannot be written.

hwid

hwid

The hardware ID of the physical node on which the license is installed.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The hwid cannot be updated.

hwid cannot be written.

key

key

License string.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The key cannot be updated.

key cannot be written.

kind

kind

The overall type of license: static or dynamic.

Type

String.

Valid values are:
  • Dynamic
  • Gridwide
  • Payg
  • Static

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The kind cannot be updated.

kind cannot be written.

limit

limit

The license limit value.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The limit cannot be updated.

limit cannot be written.

limit_context

limit_context

The license limit context.

Type

String.

Valid values are:
  • LEASES
  • MODEL
  • NONE
  • TIER

Search

The field is not available for search.

Notes

The limit_context cannot be updated.

limit_context cannot be written.

type

type

The license type.

Type

String.

Valid values are:
  • ANYCAST
  • CLOUD
  • CLOUD_API
  • DCA
  • DDI_TRIAL
  • DHCP
  • DISCOVERY
  • DNS
  • DNSQRW
  • DNS_CACHE_ACCEL
  • DTC
  • FIREEYE
  • FLEX_GRID_ACTIVATION
  • FLEX_GRID_ACTIVATION_MS
  • FREQ_CONTROL
  • GRID
  • GRID_MAINTENANCE
  • IPAM
  • IPAM_FREEWARE
  • LDAP
  • LOAD_BALANCER
  • MGM
  • MSMGMT
  • NIOS
  • NIOS_MAINTENANCE
  • NTP
  • OEM
  • QRD
  • REPORTING
  • REPORTING_SUB
  • RPZ
  • SECURITY_ECOSYSTEM
  • SW_TP
  • TAE
  • TFTP
  • THREAT_ANALYTICS
  • TP
  • TP_SUB
  • UNBOUND
  • VNIOS

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The type is part of the base object.

The type cannot be updated.

type cannot be written.

Fields List

Field Type Req R/O Base Search
expiration_status String N Y N N/A
expiry_date Timestamp N Y N N/A
hwid String N Y N =
key String N Y N =
kind String N Y N =
limit String N Y N =
limit_context String N Y N N/A
type String N Y Y =