Management::LicenseAdministration

Introduced : BIG-IP_v9.0
The LicenseAdministration interface exposes methods that enable you to authorize the system, either manually or in an automated fashion. This interface allows you to generate license files, install previously generated licenses, and view other licensing characteristics. This interface does not support transactions.

Methods

Method Description Introduced
activate_license Activates the license for the specified registration keys. BIG-IP_v11.0.0
check_registration_key_crc Checks to see if the specified registration keys will pass the CRC validation. BIG-IP_v9.0
get_copyright_file Retrieves the copyright file. BIG-IP_v9.0
get_eula_file Retrieves the EULA agreement file. BIG-IP_v9.0
get_evaluation_license_expiration Gets information on when the evaluation license will expire. BIG-IP_v9.0
get_license_activation_status Checks to see whether the device has been licensed. BIG-IP_v9.0
get_license_file Retrieves the active license file. BIG-IP_v9.0
get_module_enabled_state Gets information indicating whether the given modules are enabled in the license. Caution! This enabled state is what is specified in the license for the modules without regard for whether the module is provisionable or provisioned under this hardware and configuration. See the Provision interface. BIG-IP_v10.0.1
get_module_expiry Gets information about expiry of the given modules. Caution! The expiry information does not indicate whether a module is provisionable or provisioned. See the Provision interface. Note: This returns the enabled state as well. When getting the module expiry information, we suggest making use of the enabled state returned here rather than getting enabled state separately. BIG-IP_v10.0.1
get_module_keys Gets the module keys used to license the device, including descriptive information about them. You will get active and inactive keys (and the record has a field describing whether it is active). See also get_time_limited_module_keys. BIG-IP_v10.0.1
get_registration_keys Gets the list of registration keys used to license the device. This returns the base key first, then add-on keys. As of v10.0.0, there are new add-on keys that are time limited; with this method you can tell they are there but not when they expire. If that matters, you should use the newer method get_time_limited_module_keys. All of the keys returned are active keys. BIG-IP_v9.0
get_system_dossier Gets the kernel dossier based on the specified registration keys. BIG-IP_v9.0
get_time_limited_module_keys Gets the time limited module keys used to license the device, including descriptive information about them. You will get active and inactive keys (and the record has a field describing whether it is active). BIG-IP_v10.0.1
get_version Gets the version information for this interface. BIG-IP_v9.0
install_license Installs and authorizes the device using the specified stream of license file data. BIG-IP_v9.0
install_license_from_file Installs and authorizes the device using the specified license file somewhere on the device. BIG-IP_v9.0
is_evaluation_license Checks to see whether the device is running with an evaluation license. BIG-IP_v9.0

Structures

Structure

Description

EvaluationExpiration

A struct that describes an evaluation license expiration date.

ModuleExpiry

A struct that describes expiry information for a module.

ModuleKey

A struct that describes a module key. Note: description fields in this structure are for information only and content in them is not guaranteed to remain constant. The primary programmatic use of this structure is to obtain license keys.

ModuleKeyTimeLimits

A struct that describes time limits for a module key.

TimeLimitedModuleKey

A struct that describes a time limited module key. Note: description fields in this structure are for information only and content in them is not guaranteed to remain constant. The primary programmatic use of this structure is to obtain license keys.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ModuleExpirySequence ModuleExpiry [] A sequence of module expiry items.
ModuleKeySequence ModuleKey [] A sequence of module keys.
TimeLimitedModuleKeySequence TimeLimitedModuleKey [] A sequence of time limited module keys.

See Also

iControl ::
iControl :: Management :: LicenseAdministration

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.