BIG-IQ licensing - Purchased Pools¶
Overview¶
API used to license BIG-IP devices via a purchased licensed pool.
Version information¶
Version : 5.2, 5.3, 5.4, 6.0
URI scheme¶
BasePath : /mgmt/cm/device/licensing/pool/purchased-pool
Schemes : HTTPS
Consumes¶
application/json
Produces¶
application/json
Paths¶
GET the BIG-IQ purchased license pools.¶
GET /licenses
Description¶
Returns a BIG-IQ purchased license pools allowing an administrator to license BIG-IP devices.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | GET BIG-IQ purchased license pools. | properties_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response “Public URI path not registered.” | 404_error_collection |
Used to GET a purchased license pool.¶
GET /licenses/{objectId}
Description¶
Returns a purchased licensed pool object identified by id for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to purchased licensed pool object. required | string(UUID) | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Purchased license pool object returned. | properties_purchased_pool |
| 400 | Server error response “Bad Request”. | 400_error_collection |
| 404 | Error response “Public URI path not registered.” | 404_error_collection |
License a BIG-IP device and add to purchased license pool members.¶
POST /licenses/{objectId}/members
Description¶
Invoke a task to license a BIG-IP and add to this specific purchased license pool as a member to the pool.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to license purchased pool object. required | string(UUID) | None |
| Body-Unmanaged | Json string request body - unmanaged device. | Input parameter list in json format for an unmanaged device. Ex. {“deviceAddress”: “bigip_address”,”username”: “admin”,”password”: “admin”} required | post_purchased_pool_body_unmanaged | None |
| Body-Managed | Json string request body - managed device. | Input parameter list in json format for an managed device. Ex. {“deviceReference”:{“link”:”https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/2a2baaf0-b22f-49dc-81c6-4711fa189820”}} required | post_purchased_pool_body_managed | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST a device level task to license a BIG-IP device. | properties_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response “Public URI path not registered.” | 404_error_collection |
Used to GET purchased license pool members.¶
GET /pools/{objectId}/members
Description¶
Returns all members (BIG-IP) devices that are assigned to this purchased license pool. Each are identified by id/members for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | Unique id assigned to purchased license pool object. required | string(UUID) | None |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Purchased license pool members object returned. | properties_purchased_pool |
| 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 purchased license pool objects. optional | < object > array |
| kind | Type information for purchased license pools - cm:shared:licensing:pools:licensepoolworkerstate. 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 purchased license pool objects. optional | < object > array |
| kind | Type information for purchased license pools - cm:shared:licensing:pools:licensepoolworkerstate. 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_purchased_pool_body_unmanaged¶
| Name | Description | Schema |
|---|---|---|
| deviceAddress | IP Address of BIGIP you wish to license. required | string |
| username | Username of BIGIP you wish to license. required | string |
| password | Password of BIGIP you wish to license. required | string |
post_purchased_pool_body_managed¶
| Name | Description | Schema |
|---|---|---|
| deviceReference | Reference link to BIGIP device under management by BIGIQ. required | string |
properties_collection¶
| Name | Description | Schema |
|---|---|---|
| generation | A integer that will track change made to a purchased license pool collection object. generation. optional, read-only | integer(int64) |
| items | Collection of purchased license pool objects. optional | < object > array |
| kind | Type information for a purchased license pool collection object. optional, read-only | string |
| lastUpdateMicros | Update time (micros) for last change made to an purchased license pool collection object. time. optional, read-only | integer(int64) |
| selfLink | A reference link URI to a purchased license pool collection object. optional, read-only | string |
properties_purchased_pool¶
| Name | Description | Schema |
|---|---|---|
| baseRegKey | Based Registration Key used to (re) activate purchased license pool. optional | string |
| freeDeviceLicenses | Total number of free device licenses for this purchased license pool. optional | integer |
| generation | A integer that will track change made to a purchased license pool object. generation. optional, read-only | integer(int64) |
| isInternal | Is this purchased licensed pool internal to BIG-IQ. BIG-IQ use only | boolean |
| kind | Type information for this purchased license pool object. optional, read-only | string |
| lastUpdateMicros | Update time (micros) for last change made to an purchased license pool object. time. optional, read-only | integer(int64) |
| licenseState | State representation of what is returned from the license server. optional | licenseState |
| licenseText | Contents of licensed purchased pool. Spefices for purchased license pool such as Auth version, Tech support info, license tokens, keys etc. optional, read-only | string |
| method | Activation method used. (Example - MANUAL / AUTOMATIC) optional | string |
| name | Name of purchased license pool object. optional | string |
| privateKey | Private key cryptography keys which are known only to the owner. optional | string |
| publicKey | Public key cryptography which may be disseminated widely. optional | < integer > array |
| registeredKey | Registered key post cryptography response from server. optional | < integer > array |
| selfLink | Reference link to purchased licensed pool. optional, read-only | string |
| sortName | Sort string based on BIG-IQ licensing type. (Purchased Pool) optional | string |
| state | State of license for purchased license pool. (Example - LICENSED) optional | string |
| totalDeviceLicenses | Total number of device licenses for this purchased license pool. optional | integer |
| uuid | Unique id assigned to a purchased license pool object. optional, read-only | string |
licenseState
| Name | Description | Schema |
|---|---|---|
| activeModules | Modules activated for purchased license pool. optional (Example - VEP1, LTM, 1G, 4 Instances|V092327-5105381|IPV6 Gateway|Rate Shaping|Ram Cache) | < string > array |
| authVers | Version of authentication used by BIG-IQ. optional (Example - 5b) | string |
| authorization | Authorization string used by purchased license pool. Response from license server. optional | string |
| dossier | Dossier generated for this purchased license pool. optional Response from license server. | string |
| evaluationEndDateTime | End date and time a license server evaluate took place (Format - 2016-10-26T00:00:00-04:00) optional | string |
| evaluationStartDateTime | Start date and time a license server evaluate took place (Format - 2016-10-26T00:00:00-04:00) optional | string |
| exclusivePlatform | Platform description response from server. optional (Example - BIG-IQ Pool, Z100, Z100H, Z100K, Z100x) | < string > array |
| featureFlags | Descriptive flags available to purchased license pools. optional | < featureFlags > array |
| licenseDateTime | Date and time license was generated. (Format - 2016-10-26T00:00:00-04:00) optional | string |
| licenseEndDateTime | End date and time a license was instatiated on BIG-IQ (Format - 2016-10-26T00:00:00-04:00) optional | string |
| licenseStartDateTime | Start date and time a license was instatiated on BIG-IQ (Format - 2016-10-26T00:00:00-04:00) optional | string |
| licenseVersion | Version of BIG-IQ this license is generated for. (Example - 5.1.0) optional | string |
| optionalModules | Modules that are optional for purchased license pool. (Example - VEP1, LTM, 1G, Add 25 Instances) optional | < string > array |
| platformId | Type of BIG-IQ platform information. (Example - BIG-IQ Pool) optional | string |
| registrationKey | Registration Key used by this purchased license pool. Response from license server. optional | string |
| serviceCheckDateTime | Data and time the last service check status request / respose occur from server. (Format - 2016-10-26T00:00:00-04:00) optional | string |
| serviceStatus | Server response describing service status. (Example - As of 2016-10-26 this system has an active service contract.) optional | string |
| usage | Organization usage data. Example - F5 Internal Product Development optional | string |
| vendor | Company Name. optional Example F5 Networks, Inc. | string |
featureFlags
| Name | Description | Schema |
|---|---|---|
| featureName | Name of feature. (Example - purchased_license_pool_count, apm_urlf_limited_session, apm_web_applications) optional | string |
| featureValue | Weighted value for each feature. (Example - 10)*optional* | string |