BIG-IP Examples

Below are examples of using the CLI to interact with a BIG-IP system.

Install package and post a declaration in one step

This example will send a declaration to AS3 and install the package if it is not already installed:

f5 bigip extension service create --component as3 --declaration as3.json --install-component

Response:

{
    "declaration":
  {        ...    }
}

Install or upgrade an extension package

The following are examples of how to install, uninstall, upgrade, and verify the AS3 package on a BIG-IP system.

Install

f5 bigip extension package install --component as3

Response:

{
    "message": "Extension component package 'as3' successfully installed version '3.17.0'"
}

The example below shows how to install a specific version:

$ f5 bigip extension package install --component as3 --version 3.17.0

Response:

{
    "message": "Extension component package 'as3' successfully installed version '3.17.0'"
}

This example installs the latest version available online:

$ f5 bigip extension package install --component as3 --use-latest-metadata

Response:

{
    "message": "Extension component package 'as3' successfully installed version 'x.x.x"
}

By default, the F5 CLI uses a local metadata file to query package components (AS3, DO, TS, etc.) information to perform an action. This local metadata file can become out of date with the latest version published. The example above checks for the latest version of a published component by using the flag --use-latest-metadata to fetch the latest metadata online.

Verify

This example verifies that the package is installed on the BIG-IP and shows you the latest version available online.

$ f5 bigip extension package verify --component as3

Response:

{
    "installed": true,
    "installed_version": "3.17.0",
    "latest_version": "3.17.1"
}

Upgrade

This example shows you how to upgrade to a specific version.

f5 bigip extension package upgrade --component as3 --version 3.17.1

Response:

{
    "message": "Successfully upgraded extension component package 'as3' to version '3.17.1'"
}

Note

To revert, uninstall and then reinstall the desired version.

Uninstall

f5 bigip extension package uninstall --component as3

Response:

{
    "message": "Successfully uninstalled extension component package 'as3' version '3.17.1'"
}

Post a declaration

The following is an example of how to configure a new service using AS3:

f5 bigip extension service create --component as3 --declaration as3_decl.json

Response:

{
    "declaration": {
        ...
    }
}

Note

The F5 CLI is currently in early development and we want to hear from you! To provide feedback on F5 CLI or this documentation, you can file a GitHub Issue.