Using DO on BIG-IQ

You can use the Declarative Onboarding endpoint on the BIG-IQ v7.0 and later to configure your BIG-IP devices. After you onboard the BIG-IPs using Declarative Onboarding, you can manage them from the BIG-IQ system, including using AS3 on BIG-IQ.

See K54909607 for information on BIG-IQ Centralized Management compatibility with F5 Declarative Onboarding.

See the BIG-IQ API documentation for information on DO and BIG-IQ.

Verifying DO is installed on the BIG-IQ

You can ensure DO is installed on the BIG-IQ device using the following methods:

  • From your RESTful client, after entering your credentials, use GET to send
    https://(IP address of BIG-IQ)/mgmt/shared/declarative-onboarding/info
  • Run the following cURL command:
    curl -sku $CREDS https://(IP address of BIG-IQ)/mgmt/shared/declarative-onboarding/info

In either case, you should see something similar to the following returned:

        "id": 0,
        "selfLink": "https://localhost/mgmt/shared/declarative-onboarding/info",
        "result": {
            "class": "Result",
            "code": 200,
            "status": "OK",
            "message": "",
            "errors": []
        "version": "1.5.1",
        "release": "1",
        "schemaCurrent": "1.5.0",
        "schemaMinimum": "1.0.0"

You can also GET to send https://(IP address of BIG-IQ)/mgmt/shared/declarative-onboarding/example to retrieve an example declaration.

Sending a DO declaration to BIG-IQ

The request to send a Declarative Onboarding declaration to BIG-IQ is the same as the request for BIG-IP, just the IP address is different:
https://(IP address of BIQ-IP)/mgmt/shared/declarative-onboarding/info

The JSON in the body of the POST request can include the parameters in the DO/BIG-IQ parameter table in the BIG-IQ API documentation.

See Onboarding a BIG-IP in AWS via BIG-IQ an example declaration for using DO on BIG-IQ.