grid:license_pool : Grid License Pool object.

This object represents the Grid license pool.

Object Reference

References to grid:license_pool are object references. The name part of a Grid License Pool object reference has the following components:

  • Type of License

  • Model of Appliance

  • License pool limit

Example: grid:license_pool/b25lLmxpY2Vuc2VfcG9vbCRkaGNwLjEw:DHCP/IB-VM-1410/100

Restrictions

The object does not support the following operations:

  • Create (insert)

  • Delete

  • 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.

assigned

assigned

The number of dynamic licenses allocated to vNIOS appliances.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The assigned cannot be updated.

assigned cannot be written.

expiration_status

expiration_status

The license expiration status.

  • DELETED - The temporary license has been deleted.

  • EXPIRED - License/Pool has reached the expiry date.

  • EXPIRING_SOON - License/Pool expires in 31-90 days.

  • EXPIRING_VERY_SOON - License/Pool expires in 30 days or earlier.

  • NOT_EXPIRED - License/Pool has not expired.

  • PERMANENT - License/Pool does not expire.

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.

installed

installed

The total number of dynamic licenses allowed for this license pool.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The installed cannot be updated.

installed cannot be written.

key

key

The license string for the license pool.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The key cannot be updated.

key cannot be written.

limit

limit

The limitation of dynamic license that can be allocated from the license pool.

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.

model

model

The supported vNIOS virtual appliance model.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The model cannot be updated.

model cannot be written.

subpools

subpools

The license pool subpools.

Type

A/An Licese sub-pool settings struct array.

Search

The field is not available for search.

Notes

The subpools cannot be updated.

subpools cannot be written.

temp_assigned

temp_assigned

The total number of temporary dynamic licenses allocated to vNIOS appliances.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The temp_assigned cannot be updated.

temp_assigned 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_INSIGHT

  • TP

  • TP_SUB

  • 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

assigned

Unsigned int

N

Y

N

N/A

expiration_status

String

N

Y

N

N/A

expiry_date

Timestamp

N

Y

N

N/A

installed

Unsigned int

N

Y

N

N/A

key

String

N

Y

N

=

limit

String

N

Y

N

=

limit_context

String

N

Y

N

N/A

model

String

N

Y

N

=

subpools

[struct]

N

Y

N

N/A

temp_assigned

Unsigned int

N

Y

N

N/A

type

String

N

Y

Y

=