BIG-IQ 6.0.1 Licensing Initial Activation¶
Overview¶
API used to activate BIG-IP licenses of varying types.
Version information¶
Version : BIG-IQ 6.0.0, 6.0.1
REST Endpoint: /mgmt/cm/device/licensing/pool/¶
Requests¶
POST /mgmt/cm/device/licensing/pool/initial-activation¶
This BIG-IQ API can be used to activate various types of BIG-IP licenses. The endpoint is a common starting point for activating a pool-style regkey (utility, volume, purchased, etc.)
Request Parameters¶
| Name | Type | Description |
|---|---|---|
| Json string for request body. | object | Input parameter list in json format. required ex. {“regkey”: “MY-REGISTRATION-KEY”, “name”: “freeform name”, “status”: “ACTIVATING_AUTOMATIC”} |
| name | string | Name of activation process. optional |
| regKey | string | Base registration key. optional |
| status | string | The state or type of activation process to use. ex. ACTIVATING_AUTOMATIC. optional |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Adds a properties_initial_activation and creates a license activation task.
| Name | Type | Description |
|---|---|---|
| items | < object > array | Activation task properties. optional |
| dossier | string | Auto-generated passphrase used for activation. optional |
| encryptedPrivateKey | < integer > array | Encrypted private key used during calculation. optional |
| generation | string | A integer that will track changes made. optional |
| internalPrivateKey | string | Internal encrypted key used during calculation. optional |
| kind | string | Type information for initial activation. cm:device:licensing:pool:initial-activation:initialactivationworkeritemstate. optional |
| lastUpdateMicros | integer | Update time (micros) for last change made to a activation task. optional |
| licenseReference | object | Reference link to pool license used for activation. optional |
| link | string | Reference link to license data. optional |
| licenseText | string | Contents of license file. optional |
| message | string | Status message to user. ex. License BASE-REG-KEY ready. optional |
| name | string | Name of initial activation task license type. optional ex. Purchased-Pools |
| publicKey | < integer > array | Public key used during calculation. optional |
| regKey | string | Base registration key. optional |
| selfLink | string | Reference link to activation task. optional |
| sortName | string | Name used to intentify sorting status. optional ex. Pending |
| status | string | Status of license key activation. optional ex. READY |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of activation task objects optional, read-only |
| kind | string | Type information for initial activation task - cm:device:licensing:pool:initial-activation:initialactivationworkercollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Error response Public URI path not registered.”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of activation task objects. optional |
| kind | string | Type information for initial activation task - cm:device:licensing:pool:initial-activation:initialactivationworkercollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Manager | Yes |
| License Manager | Yes |
GET /mgmt/cm/device/licensing/pool/initial-activation¶
Gets the collection of license activation tasks and is a common starting point for activating a pool-style regkey (utility, volume, purchased, etc.)
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Returns a properties_initial_activation_collection of license activation tasks.
| Name | Schema | Description |
|---|---|---|
| generation | string | A integer that will track changes made. optional |
| items | < object > array | Array of initial activation task properties. optional |
| kind | string | Type information for initial activation task. cm:device:licensing:pool:initial-activation:initialactivationworkeritemstate optional |
| lastUpdateMicros | string | Update time (micros) for last change made to a initial activation task object. optional |
| selfLink | string | Reference link to initial activation task object. optional |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of activation task objects optional, read-only |
| kind | string | Type information for initial activation task - cm:device:licensing:pool:initial-activation:initialactivationworkercollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Error response Public URI path not registered.”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of activation task objects. optional |
| kind | string | Type information for initial activation task - cm:device:licensing:pool:initial-activation:initialactivationworkercollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Viewer | Yes |
| Device Manager | Yes |
| License Manager | Yes |
GET /mgmt/cm/device/licensing/pool/initial-activation/{objectId}¶
Gets the activation task used for licensing. This enables a user to poll for status.
Request Parameters¶
None
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to activation task. required |
Response¶
HTTP/1.1 200 OK
Returns the properties_initial_activation representing a license activation task.
| Name | Type | Description |
|---|---|---|
| items | < object > array | Activation task properties. optional |
| dossier | string | Auto-generated passphrase used for activation. optional |
| encryptedPrivateKey | < integer > array | Encrypted private key used during calculation. optional |
| generation | string | A integer that will track changes made. optional |
| internalPrivateKey | string | Internal encrypted key used during calculation. optional |
| kind | string | Type information for initial activation. cm:device:licensing:pool:initial-activation:initialactivationworkeritemstate. optional |
| lastUpdateMicros | integer | Update time (micros) for last change made to a activation task. optional |
| licenseReference | object | Reference link to pool license used for activation. optional |
| link | string | Reference link to license data. optional |
| licenseText | string | Contents of license file. optional |
| message | string | Status message to user. ex. License BASE-REG-KEY ready. optional |
| name | string | Name of initial activation task license type. optional ex. Purchased-Pools |
| publicKey | < integer > array | Public key used during calculation. optional |
| regKey | string | Base registration key. optional |
| selfLink | string | Reference link to activation task. optional |
| sortName | string | Name used to intentify sorting status. optional ex. Pending |
| status | string | Status of license key activation. optional ex. READY |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of activation task objects optional, read-only |
| kind | string | Type information for initial activation task - cm:device:licensing:pool:initial-activation:initialactivationworkercollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404
Error response “Error response Public URI path not registered.”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of activation task objects. optional |
| kind | string | Type information for initial activation task - cm:device:licensing:pool:initial-activation:initialactivationworkercollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Viewer | Yes |
| Device Manager | Yes |
| License Manager | Yes |
Examples¶
None