BIG-IQ Licensing initial activation¶

Overview¶

API used to activate BIG-IP licenses of varying types.

Version information¶

Version : 5.2, 5.3, 5.4, 6.0

URI scheme¶

BasePath : /mgmt/cm/device/licensing/pool/

Schemes : HTTPS

Consumes¶

application/json

Produces¶

application/json

Paths¶

BIG-IQ initial activation using API.¶

POST /initial-activation

Description¶

Using this BIG-IQ API you can activate a BIG-IP license of varying types. This endpoint is a common starting point for activating a pool-style regkey (utility, volume, purchased, etc..)

Parameters¶

Type	Name	Description	Schema	Default
Body	Json string for request body. required	Input parameter list in json format. ex. {“regkey”: “MY-REGISTRATION-KEY”, “name”: “freeform name”, “status”: “ACTIVATING_AUTOMATIC”}	post_initial_activation_body

Responses¶

HTTP Code	Description	Schema
200	POST to create license activation task.	properties_initial_activation
400	Error response Bad Request	400_error_collection
404	Error response Public URI path not registered.	404_error_collection

BIG-IQ initial activation using API.¶

GET /initial-activation

Description¶

Using this BIG-IQ API you can activate a BIG-IP license of varying types. This endpoint is a common starting point for activating a pool-style regkey (utility, volume, purchased, etc..)

Responses¶

HTTP Code	Description	Schema
200	POST to create license activation task.	properties_initial_activation_collection
400	Error response Bad Request	400_error_collection
404	Error response Public URI path not registered.	404_error_collection

BIG-IQ returns the activation task using for licensing.¶

GET /initial-activation/{objectId}

Description¶

Returns the activation task allowing the user to poll for status.

Parameters¶

Type	Name	Description	Schema	Default
Path	objectId	Unique id assigned to activation task. required	string(UUID)	None

Responses¶

HTTP Code	Description	Schema
200	BIG-IQ activation task.	properties_initial_activation
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 activation task objects optional, read-only	< object > array
kind	Type information for initial activation task - cm:device:licensing:pool:initial-activation:initialactivationworkercollectionstate 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 activation task objects. optional	< object > array
kind	Type information for initial activation task - cm:device:licensing:pool:initial-activation:initialactivationworkercollectionstate 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_initial_activation_body¶

Name	Description	Schema
name	Name of activation process. optional	string
regKey	Base registration key. optional	string
status	The state or type of activation process to use. ex. ACTIVATING_AUTOMATIC. optional	string

properties_initial_activation¶

Name	Description	Schema
items	Activation task properties. optional	< items > array

items

Name	Description	Schema
dossier	Auto-generated passphrase used for activation. optional	string
encryptedPrivateKey	Encrypted private key used during calculation. optional	< integer > array
generation	A integer that will track change made. optional	string
internalPrivateKey	Internal encrypted key used during calculation. optional	string
kind	Type information for initial activation. cm:device:licensing:pool:initial-activation:initialactivationworkeritemstate. optional	string
lastUpdateMicros	Update time (micros) for last change made to a activation task. optional	integer
licenseReference	Reference link to pool license used for activation. optional	licenseReference
licenseText	Contents of license file. optional	string
message	Status message to user. ex. License BASE-REG-KEY ready. optional	string
name	Name of initial activation task license type. optional ex. Purchased-Pools	string
publicKey	Public key used during calculation. optional	< integer > array
regKey	Base registration key. optional	string
selfLink	Reference link to activation task. optional	string
sortName	Name used to intentify sorting status. optional ex. Pending	string
status	Status of license key activation. optional ex. READY	string

licenseReference

Name	Description	Schema
link	Reference link to license data. optional	string

properties_initial_activation_collection¶

Name	Description	Schema
generation	A integer that will track change made. optional	string
items	Array of initial activation task properties. optional	< object > array
kind	Type information for initial activation task. cm:device:licensing:pool:initial-activation:initialactivationworkeritemstate optional	string
lastUpdateMicros	Update time (micros) for last change made to a initial activation task object. time. optional	string
selfLink	Reference link to initial activation task object. optional	string

Previous Next