BIG-IQ licensing - Registration Key Pools¶
Overview¶
API used to license BIG-IP devices referencing a registration licensed key.
Version information¶
Version : 5.2, 5.3, 5.4, 6.0
URI scheme¶
BasePath : /mgmt/cm/device/licensing/pool/regkey
Schemes : HTTPS
Consumes¶
application/json
Produces¶
application/json
Paths¶
GET the BIG-IQ licensing registration key pool collection of license registration keys.¶
GET /licenses
Description¶
Returns a BIG-IQ licensed registration key allowing an administrator to license BIG-IP managed / unmanaged devices.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | GET BIG-IQ licensed registration keys that make up a registration key pool. | properties_regkey_collection |
| 400 | Error response Bad Request | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Used to GET a license pool.¶
GET /licenses/{objectId}
Description¶
Returns a licensed pool object identified by id for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to licensed registration key pool object. required | string(UUID) | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | License pool object returned. | properties_regkey |
| 400 | Server error response Bad Request. | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Create a new registration license key.¶
POST /licenses/{objectId}/offerings
Description¶
Add a new registration license key adding to BIG-IQ license regkey pool.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to licensed registration key pool object. required | string(UUID) | None |
| Body | Json string request body. | Input parameter list in json format. ex. {regKey: U0151-71761-41002-45076-9552496, status: ACTIVATING_AUTOMATIC, name: RegKey1} required | post_regkey_body | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST a device level task to license a BIG-IP device. | properties_regkey_offerings_collection |
| 400 | Error response Bad Request | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Used to GET license pool members.¶
GET /licenses/{objectId}/offerings
Description¶
Returns all members (BIG-IP) devices that make up the license pool identified by id/members for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to licensed registration key pool object. required | string(UUID) | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | License pool members object returned. | properties_regkey_offerings_collection |
| 400 | Server error response Bad Request. | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Used to GET a specific license registration key.¶
GET /licenses/{objectId}/offerings/{registrationKey}
Description¶
Returns a registration key license identified by id for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to licensed registration key pool object. required | string(UUID) | None |
| Path | registrationKey | Generated registration key used when licensing BIG-IP. required | string(string) | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | License registration key object returned. | properties_offering |
| 400 | Server error response Bad Request. | 400_error_collection |
| 404 | Error response “Public URI path not registered.” | 404_error_collection |
Add, or license, a device as a member of a BIG-IQ license registration key pool.¶
POST /licenses/{objectId}/offerings/{registrationKey}/members
Description¶
Will license a device and add as a member of a BIG-IQ license registration key pool.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to licensed registration key pool object. required | string(UUID) | None |
| Path | registrationKey | Generated registration key used when licensing BIG-IP. required | string(string) | None |
| Body | Json string request body. | Input parameter list in json format. ex. {deviceAddress: 10.44.100.25, username: admin, password: admin} required | post_regkey_members_body | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST a device level task to license a BIG-IP device. | properties_regkey_members_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response “Public URI path not registered.” | 404_error_collection |
Used to GET a collection of device licenses that make up registration key pool members.¶
GET /licenses/{objectId}/offerings/{registrationKey}/members
Description¶
Returns all members (BIG-IP) devices that make up the registration key license pool identified by key for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to licensed registration key pool object. required | string(UUID) | None |
| Path | registrationKey | Generated registration key used when licensing BIG-IP. required | string(string) | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | License pool members object returned. | properties_regkey_members_collection |
| 400 | Server error response Bad Request. | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Used to GET license pool members.¶
GET /licenses/{objectId}/offerings/{registrationKey}/members/{memberObjectId}
Description¶
Returns all members (BIG-IP) devices that make up the license pool identified by id/members for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to licensed registration key pool object. required | string(UUID) | None |
| Path | registrationKey | Generated registration key used when licensing BIG-IP. required | string(string) | None |
| Path | memberObjectId | Unique id assigned to a member device licensed to a registration key pool. required | string(string) | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | License pool members object returned. | properties_regkey_member |
| 400 | Server error response “Bad Request”. | 400_error_collection |
| 404 | Error response “Public URI path not registered.” | 404_error_collection |
Used to DEL license pool members.¶
DEL /licenses/{objectId}/offerings/{registrationKey}/members/{memberObjectId}
Description¶
DELETES a member (BIG-IP) device that is part of a license pool identified by id/members/memberObjectId for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to licensed registration key pool object. required | string(UUID) | None |
| Path | registrationKey | Generated registration key used when licensing BIG-IP. required | string(string) | None |
| Path | memberObjectId | Unique id assigned to a member device licensed to a registration key pool. required | string(string) | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | License pool member object deleted returned. | properties_regkey_member |
| 400 | Server error response “Bad Request”. | 400_error_collection |
| 404 | Error response “Public URI path not registered.” | 404_error_collection |
Definitions¶
400_error_collection¶
| Name | Description | Schema |
|---|---|---|
| errorStack | Error stack trace returned by java. optional, read-only | string |
| items | Collection of license registration key pool objects. Error 400 optional, read-only | < object > array |
| kind | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only | string |
| message | Error message returned from server. optional, read-only | string |
| requestBody | The data in the request body. GET (None) optional, read-only | string |
| requestOperationId | Unique id assigned to rest operation. optional, read-only | integer(int64) |
404_error_collection¶
| Name | Description | Schema |
|---|---|---|
| errorStack | Error stack trace returned by java. optional, read-only | string |
| items | Collection of license registration key pool objects. Error 404 optional, read-only | < object > array |
| kind | Type information for license purchased pools - cm:device:licensing:pool:regkey:licenses:item:offerings:regkeypoollicenseofferingcollectionstate. optional, read-only | string |
| message | Error message returned from server. optional, read-only | string |
| requestBody | The data in the request body. GET (None) optional, read-only | string |
| requestOperationId | Unique id assigned to rest operation. optional, read-only | integer(int64) |
post_regkey_body¶
| Name | Description | Schema |
|---|---|---|
| name | Name of license registration key. | string |
| regKey | Registration Key | string |
| status | ACTIVATING_AUTOMATIC, ACTIVATING_MANUAL_LICENSE_TEXT_PROVIDED. Please consult SA for activating manually, additional steps may be requested for generating dossier and retriving license txt file for POST. | string |
post_regkey_members_body¶
| Name | Description | Schema |
|---|---|---|
| deviceAddress | IP address of device to be licensed. optional | string |
| password | Password of device to be licensed. optional | string |
| username | Username of device to be licensed. optional | string |
properties_offering¶
| Name | Description | Schema |
|---|---|---|
| dossier | The dossier is an encrypted list of key characteristics used to identify the platform. https://support.f5.com/kb/en-us/solutions/public/7000/700/sol7752.html optional | string |
| encryptedPrivateKey | Encypted private key used for decrypt / encrypt of data. optional | < integer > array |
| generation | A integer that will track change made to a license registration key object. generation. optional, read-only | integer(int64) |
| internalPrivateKey | Internal private key used for encryption. optional | string |
| kind | Type information for this license registration key object. optional, read-only | string |
| lastUpdateMicros | Update time (micros) for last change made to an license registration key object. time. optional, read-only | integer(int64) |
| licenseState | State object of license registration key. optional | object |
| licenseText | Text base string for licence registration key proivded during activation process. optional | string |
| message | The message provided to the user of this licensing. optional ex. Activated. | string |
| name | General name for license registration key. optional ex. License for Q0168-94118-59282-63288-2594214 | string |
| publicKey | Public key used for encryption. optional | < integer > array |
| regKey | License registration key generated. optional | string |
| selfLink | Reference link to license registration key object. optional, read-only | string |
| sortName | Sort by unique name of registration key pool used to (re) activate license devices using registration key. optional | string |
| status | License registration key status. optional ex. READY | string |
properties_regkey¶
| Name | Description | Schema |
|---|---|---|
| generation | A integer that will track change made to a license registration key pool object. generation. optional, read-only | integer(int64) |
| id | Unique id assigned to a license registration key pool object. optional, read-only | string |
| kind | Type information for this license registration key pool object. optional, read-only | string |
| lastUpdateMicros | Update time (micros) for last change made to an license registration key pool object. time. optional, read-only | integer(int64) |
| name | Name of registration key pool used to (re) activate license devices using registration key. optional | string |
| selfLink | Reference link to license registration key pool object. optional, read-only | string |
| sortName | Sort by unique name of registration key pool used to (re) activate license devices using registration key. optional, read-only | string |
properties_regkey_collection¶
| Name | Description | Schema |
|---|---|---|
| generation | A integer that will track change made to a license registration keys pool collection object. generation. optional, read-only | integer(int64) |
| items | Collection of license registration key pool object. optional, read-only | < object > array |
| kind | Type information for a license registration key pool collection object. optional, read-only | string |
| lastUpdateMicros | Update time (micros) for last change made to an license registration key pool collection object. time. optional, read-only | integer(int64) |
| selfLink | A reference link URI to a license registration key pool collection object. optional, read-only | string |
properties_regkey_member¶
| Name | Description | Schema |
|---|---|---|
| auditRecordReference | A reference link to the license audit object. Will provide audit logs id, regKey, offering, machineId, address, hostname, type, grantDateTime, status. optional | auditRecordReference |
| deviceAddress | Device (BIG-IP) IP address. optional | string |
| deviceMachineId | Unique device id assigned to BIG-IP that is a member of this registration key pool. optional | string |
| generation | A integer that will track change made to a license registration key pool memeber object. generation. optional, read-only | integer(int64) |
| healthCheckFailureCount | Count of last check or poll for health failed. optional | integer |
| id | Unique id assigned to a registration key license pool device (member) object. optional, read-only | string |
| kind | Type information for this license registration key pool member (device) object, cm:device:licensing:pool:regkey:licenses:item:offerings:regkey:members:regkeypoollicensememberstate. optional, read-only | string |
| lastGoodHealthCheckDateTime | Last date/time for device license health. 2016-11-16T21:20:49.368Z optional | string |
| lastUpdateMicros | Update time (micros) for last change made to an license registration key pool member object. optional | integer(int64) |
| message | The message provided to the user of this licensing task state. ex. Device licensed. optional, read-only | string |
| selfLink | Reference link to license registration key pool member (device) object. optional, read-only | string |
| status | The status of this licensing task. optional ex INSTALLING, LICENSED. | string |
auditRecordReference
| Name | Description | Schema |
|---|---|---|
| link | Reference link to audit record for license registration key. optional | string |
properties_regkey_members_collection¶
| Name | Description | Schema |
|---|---|---|
| generation | A integer that will track change made to a license registration key for a device member collection object. generation. optional, read-only | integer(int64) |
| items | Collection of license registration key member objects optional, read-only | < object > array |
| kind | Type information for a license registration key for a device member collection object. optional, read-only | string |
| lastUpdateMicros | Update time (micros) for last change made to an license registration key device object collection object. time. optional, read-only | integer(int64) |
| selfLink | A reference link URI to a license registration key for a device member collection object. optional, read-only | string |
properties_regkey_offerings_collection¶
| Name | Description | Schema |
|---|---|---|
| generation | A integer that will track change made to a license registration keys properties collection object. generation. optional, read-only | < object > array |
| items | Collection of license registration key objects. optional, read-only | integer(int64) |
| kind | Type information for a license registration keys properties collection object. optional, read-only | string |
| lastUpdateMicros | Update time (micros) for last change made to an license registration keys collection object. time. optional, read-only | integer(int64) |
| selfLink | A reference link URI to a license registration keys properties collection object. optional, read-only | string |