Create BIG-IP VE¶

Overview¶

You can use the Create BIG-IP VE API to create a create-ve item state on BIG-IQ. To create the task, you can provide a reference to the cloud environment and a name for the BIG-IP VE. If the task is successful, this will create a BIG-IP VE in the cloud environment. You can use the Delete BIG-IP VE API to delete the create-ve item state from the BIG-IQ and remove the BIG-IP VE from the cloud environment.

NOTE: You cannot start multiple VE creation tasks from this API when using an Azure cloud environment.

REST Endpoint: /mgmt/cm/cloud/tasks/create-ve¶

Requests¶

GET /mgmt/cm/cloud/tasks/create-ve¶

To retrieve all tasks you can send a GET request to the collection.

Request Parameters¶

None

Query Parameters¶

None

Response¶

The JSON in the GET response can contain the following parameters.

HTTP/1.1 200 OK

Name	Type	Description
instanceId	string	Identifier for AWS BIG-IP VE. This is only used for a AWS Create VE task.
name	string	Name for a AWS Create VE task.
privateKeyFilename	string	Private key file name for AWS BIG-IP VE. This is only used for a AWS Create VE task. The API provides a path to the AWS Private key, the private key is not in the body of the response.
selfLink	string	A url to the task’s endpoint. You can poll for the state of this task by sending GET requests to this url.
state	string	The state of the task. The value will only be available after the state have transitioned to “FINISHED”.
veIPAddress	string	The IP address of the BIG-IP VE.
vmwUUID	string	Identifier for VMware BIG-IP VE.

Permissions¶

Role	Allow
admin	Yes

POST /mgmt/cm/cloud/tasks/create-ve¶

To add a task to create a BIG-IP VE you can send a POST request to the create-ve collection.

Request Parameters¶

The request parameters in a POST request can include the following. You can get a reference for the cloud environment using the Cloud Environments API.

Name	Type	Required	Description
azureAdminPassword	string	True	Admin password that will be assigned to the Azure BIG-IP VE.
environmentReference	object	True	Reference to a cloud environment.
link	string	True	The url for the cloud environment.
ipPoolAlias	string	False	User-defined alias for an IP pool that will be resolved in the cloud environment. This is only used for a VMware Create VE task.
ipPoolReference	object	False	Reference to an optional management IP pool. This is only used for a VMware Create VE task.
link	string	True	The url to the IP pool.
name	string	True	Name for a AWS Create VE task.
veName	string	True	A readable name for the BIG-IP VE.

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name	Type	Description
instanceId	string	Identifier for AWS BIG-IP VE. This is only used for a AWS Create VE task.
name	string	Name for a AWS Create VE task.
privateKeyFilename	string	Private key file name for AWS BIG-IP VE. This is only used for a AWS Create VE task.
selfLink	string	A url to the task’s endpoint. You can poll for the state of this task by sending GET requests to this url.
state	string	The state of the task. The value will only be available after the state have transitioned to “FINISHED”.
veIPAddress	string	The IP address of the BIG-IP VE.
vmwUUID	string	Identifier for VMware BIG-IP VE. This is only used for a VMware Create VE task.

Permissions¶

Role	Allow
admin	Yes

Examples¶

POST to create a BIG-IP VE¶

You can create a create-ve item state on BIG-IQ by sending a POST request.

POST https://<BIG-IQ>/mgmt/cm/cloud/tasks/create-ve

The JSON in the body of the POST can look similar to the following example.

{
    "name": "bigipvm-cluster01-task",
    "veName": "bigipvm-cluster01",
    "environmentReference": {
            "link": "https://localhost/mgmt/cm/cloud/environments/92963abd-36c8-36b9-ba36-b8e296ff3387"
    },
    "ipPoolReference": {
            "link": "https://localhost/mgmt/cm/device/ip-pool/pools/d10af457-daa1-3eed-94e2-c36b5f295e7e"
    }
}

Response¶

The response to the POST can look similar to the body of the POST request.

HTTP/1.1 200 OK

Note that the JSON in the body of the response can include the task’s id and an initial status of “STARTED”. All operations involve starting the task using a POST, after which you should send GET requests to the task’s endpoint and poll for the task’s status until the task completes. Polling for this example would look similar to the following.

GET https://<BIG-IQ>/mgmt/cm/cloud/tasks/create-ve/<id>

Previous Next