Class: BigIq54LicenseProvider

BigIq54LicenseProvider(bigIp, optionsopt)

Provides ability to get licenses from BIG-IQ 5.3 (and compatible versions).

Constructor

new BigIq54LicenseProvider(bigIp, optionsopt)

BigIq 5.3 license provider constructor

Parameters:
Name Type Attributes Description
bigIp Object

Base BigIp object.
options Object <optional>

Optional parameters.

Properties
Name Type Attributes Description
logger Object <optional>

Logger to use. Or, pass loggerOptions to get your own logger.
loggerOptions Object <optional>

Options for the logger. See module:logger.getLogger for details.

Methods

getLicenseTimeout()

Gets the license timeout to use

This is here so that it can be overridden by test code

Returns:

the license timeout

getUnmanagedDeviceLicense(bigIqControl, poolName, bigIpMgmtAddress, bigIpMgmtPort, options) → {Promise}

Gets a license from BIG-IQ for an unmanaged BIG-IP

Parameters:
Name Type Description
bigIqControl Object

iControl object for BIG-IQ
poolName String

Name of the BIG-IQ license pool to use
bigIpMgmtAddress String

IP address of BIG-IP management port. Unused only for display in this API. Default 192.0.2.1.
bigIpMgmtPort String

IP port of BIG-IP management port. Unused in this API, but here for consistency.
options Object

Optional parameters

Properties
Name Type Attributes Description
cloud String

Cloud environment. Accepted values are: aws, azure, gce, vmware, hyperv, kvm, xen
skuKeyword1 String <optional>

skuKeyword1 parameter for CLPv2 licensing. Default none.
skuKeyword2 String <optional>

skuKeyword2 parameter for CLPv2 licensing. Default none.
unitOfMeasure String <optional>

unitOfMeasure parameter for CLPv2 licensing. Default none.
noUnreachable Boolean <optional>

Do not use the unreachable API even on BIG-IQs that support it.
Returns:

A promise which is resolved when the BIG-IP has been licensed or rejected if an error occurs.

Type
Promise

revoke(bigIqControl, poolName, instance, options) → {Promise}

Revokes a license from a BIG-IP

Parameters:
Name Type Description
bigIqControl Object

iControl object for BIG-IQ
poolName String

Name of the BIG-IQ license pool to use
instance String

AutoscaleInstance to revoke license for
options Object

Optional parameters

Properties
Name Type Attributes Description
noUnreachable Boolean <optional>

Do not use the unreachable API even on BIG-IQs that support it.
Returns:

A promise which is resolved when the BIG-IP license has been revoked, or rejected if an error occurs.

Type
Promise