How to: Add a Provider for VE, VELOS, and rSeries from BIG-IP Next Central Manager

This document describes the creation of Providers for VE, VELOS and rSeries from the BIG-IP Next Central Manager.

For a full list of API endpoints for providers, see Providers in the OpenAPI documentation.

Create a Provider for VELOS

  1. Log in to BIG-IP Next Central Manager as admin, click the Workspace icon next to the F5 icon, and click Infrastructure.

  2. From the Left navigation, click the Providers.

  3. Click the Start Adding Providers button to add an Instance provider.

  4. From the Type dropdown, select VELOS to update the VELOS provider properties.

  5. Enter a name to identify this VELOS provider.

  6. Specify the IP address or Hostname along with its Port number. The default Port will be 8888.

  7. Click the Connect button.

Prerequisites

Authenticate with the BIG-IP Next Central Manager API. For details refer to How to: Authenticate with the BIG-IP Next Central Manager API.

To create a VELOS Provider using Central Manager APIs:

  1. Create a VELOS provider by sending a POST request to the /api/v1/spaces/default/providers/f5os endpoint. Identify the cert_fingerprint value from the response to use in the next request.

    POST https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers/f5os

    For the request payload, use the following example, modifying the values as required. The request will fail with a 500 response and generate a cert_fingerprint value.

    {
    "name": "myvelos",
    "type": "VELOS",
    "connection": {
        "host": "{{velos_partition_mgmt_ip}}:{{velos_partition_mgmt_port}}",
        "authentication": {
            "type": "basic",
            "username": "{{velos_partition_admin_user}}",
            "password": "{{velos_partition_admin_password}}"
        }
    }
}

    For more information about creating provider using BIG-IP Next Central Manager APIs, see OpenAPI documentation.

  2. Create a Provider by sending a POST request to /api/v1/spaces/default/providers/f5os endpoint including the certificate fingerprint, equivalent to trusting the certificate.

    POST https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers/f5os

    For the request payload, use the following example, modifying the values as required. Add the cert_fingerprint value which is generated from the previous request response.

    Click for payload ▶ 
    {
    "name": "myvelos",
    "type": "VELOS",
    "connection": {
        "host": "{{velos_partition_mgmt_ip}}:{{velos_partition_mgmt_port}}",
        "authentication": {
            "type": "basic",
            "username": "{{velos_partition_admin_user}}",
            "password": "{{velos_partition_admin_password}}"
        },
        "cert_fingerprint": "{{cert_fingerprint}}"
    }
}

  3. Optional: Verify the Provider by sending the GET request to /api/v1/spaces/default/providers endpoint.

    GET https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers

    For more information about VELOS providers information using BIG-IP Next Central Manager APIs, see OpenAPI documentation.

    Result: The VELOS provider is added successfully.

Create a Provider for rSeries

  1. Log in to BIG-IP Next Central Manager as admin, click the Workspace icon next to the F5 icon, and click Infrastructure.

  2. From the Left navigation, click the Providers.

  3. Click the Start Adding Providers button to add an Instance provider.

  4. From the Type dropdown, select rSeries to update the rSeries provider properties.

  5. Enter a name to identify this rSeries provider.

  6. Specify the IP Address or Hostname along with its Port number. The default Port will be 8888.

  7. Click the Connect button.

Prerequisites

Authenticate with the BIG-IP Next Central Manager API. For details refer to How to: Authenticate with the BIG-IP Next Central Manager API.

To create a rSeries Provider using Central Manager APIs:

  1. Create the rSeries Provider by sending a POST request to the /api/v1/spaces/default/providers/f5os endpoint. Identify the cert_fingerprint value from the response to use in the next request.

    POST https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers/f5os

    For the request payload, use the following example, modifying the values as required. The request will fail with a 500 response and generate a cert_fingerprint value.

    {
    "name": "rSeries",
    "type": "rSeries",
    "connection": {
        "host": "{{rSeries_partition_mgmt_ip}}:{{rSeries_partition_mgmt_port}}",
        "authentication": {
            "type": "basic",
            "username": "{{rSeries_partition_admin_user}}",
            "password": "{{rSeries_partition_admin_password}}"
        }
    }
}

    For more information about creating rSeries provider using BIG-IP Next Central Manager APIs, see OpenAPI documentation.

  2. Create the Provider by sending a POST request to /api/v1/spaces/default/providers/f5os endpoint, including the certificate fingerprint, equivalent to trusting the certificate.

    POST https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers/f5os

    For the request payload, use the following example, modifying the values as required. Add the cert_fingerprint value which is generated from the previous request response.

    {
    "name": "myrSeries",
    "type": "rSeries",
    "connection": {
        "host": "{{rSeries_partition_mgmt_ip}}:{{rSeries_partition_mgmt_port}}",
        "authentication": {
            "type": "basic",
            "username": "{{rSeries_partition_admin_user}}",
            "password": "{{rSeries_partition_admin_password}}"
        },
        "cert_fingerprint": "{{cert_fingerprint}}"
    }
}

  3. To verify the Provider, send a GET request to /api/v1/spaces/default/providers endpoint.

    GET https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers

    For more information about providers information using BIG-IP Next Central Manager APIs, see OpenAPI documentation.

Result: The rSeries provider is added successfully.

Create a Provider for VMware vSphere

  1. Log in to BIG-IP Next Central Manager as admin, click the Workspace icon next to the F5 icon, and click Infrastructure.

  2. From the left navigation, click Providers.

  3. Click the Start Adding Providers button to add an Instance provider.

  4. From the Type dropdown, select VMware vSphere to update the VMware Provider Properties.

  5. Enter a name or email address to identify this VMware provider.

  6. Specify the vCenter Hostname.

  7. Click the Connect button.

Prerequisites

Authenticate with the BIG-IP Next Central Manager API. For details refer to How to: Authenticate with the BIG-IP Next Central Manager API.

To create a VMware vSphere Provider using Central Manager APIs:

  1. Create the VMware vSphere Provider by sending a POST request to the /api/v1/spaces/default/providers/vsphere endpoint. Identify the cert_fingerprint value from the response to use in the next request.

    POST https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers/vsphere

    For the request payload, use the following example, modifying the values as required. The request will fail with a 500 response and generate a cert_fingerprint value.

    {
    "name": "myvsphere",
    "connection": {
        "host": "{{vsphere_partition_mgmt_ip_port_or_fqdn}}",
        "authentication": {
            "type": "basic",
            "username": "{{vsphere_admin_username}}",
            "password": "{{vsphere_admin_password}}"
        }
    }
}

    For more information about creating provider using BIG-IP Next Central Manager APIs, see OpenAPI documentation.

  2. Create a Provider by sending a POST request to /api/v1/spaces/default/providers/vsphere endpoint, including the certificate fingerprint, equivalent to trusting the certificate.

    POST https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers/vsphere

    For the request payload, use the following example, modifying the values as required. Add the cert_fingerprint value which is generated from the previous request response.

    {
    "name": "myvsphere",
    "connection": {
        "host": "{{vsphere_partition_mgmt_ip_port_or_fqdn}}",
        "authentication": {
            "type": "basic",
            "username": "{{vsphere_admin_username}}",
            "password": "{{vsphere_admin_password}}"
        },
        "cert_fingerprint": "{{cert_fingerprint}}"
    }
}

  3. Optional: Verify the Provider by sending a GET request to /api/v1/spaces/default/providers endpoint.

    GET https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers

    For more information about providers information using BIG-IP Next Central Manager APIs, see OpenAPI documentation.

Result: The VMware vSphere provider is added successfully.

Delete a Provider from the BIG-IP Next Central Manager

  1. Log in to BIG-IP Next Central Manager as admin, click the Workspace icon next to the F5 icon, and click Infrastructure.

  2. From the left navigation, click Providers.

  3. Select the checkbox next of the provider you want to remove, click the DELETE button located at the top right corner of the screen.

Prerequisites

Authenticate with the BIG-IP Next Central Manager API. For details refer to How to: Authenticate with the BIG-IP Next Central Manager API.

To delete Provider use the following BIG-IP Central Manager APIs:

  1. Get the Provider details by sending GET request to /api/v1/spaces/default/providers endpoint. Identify the Provider ID which you want to delete from the response.

    GET https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers

    For more information about providers information using BIG-IP Next Central Manager APIs, see OpenAPI documentation.

  2. Delete the VELOS or rSeries provider by sending a DELETE request to /api/v1/spaces/default/providers/f5os/{{provider_id}} endpoint. Modify the Provider ID with the ID from the previous response.

    DELETE https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers/f5os/{{provider_id}}

    For more information about deleting VELOS or rSeries providers using BIG-IP Next Central Manager APIs, see OpenAPI documentation.

  3. Delete the VMware vSphere provider by sending a DELETE request to /api/v1/spaces/default/providers/vsphere/{{provider_id}} endpoint. Modify the Provider ID with the ID from the previous response.

    DELETE https://{{bigip_next_cm_mgmt_ip}}/api/v1/spaces/default/providers/vsphere/{{provider_id}}

    For more information about deleting VMware providers using BIG-IP Next Central Manager APIs, see OpenAPI documentation.