F5 CLI

Welcome to the F5 CLI User Guide. To provide feedback on this documentation, you can file a GitHub Issue.

Introduction

The F5 CLI provides a command-line interface (CLI) to various F5 products and services. It focuses primarily on facilitating the consumption of our most popular APIs and services, currently including BIG-IP (via Automation Tool Chain) and F5 Cloud Services.

Similar to popular cloud shells (AWS CLI, Azure CLI, Google gcloud), it is built on a python client library. For those looking to write custom automation scripts or workloads, you may choose to leverage the same python library it is built on:

https://github.com/f5devcentral/f5-sdk-python

Benefits:

  • Quickly access and consume F5’s APIs and Services with familiar remote CLI UX
  • Configurable settings
  • Include common actions in Continuous Deployment (CD) pipelines
  • Prototyping
    • Test calls that may be used in more complex custom integrations using the underlying SDK
    • Supports discovery activities/querying of command-line results (for example, “list accounts” to find the desired account which will be used as an input to final automation)
  • Support quick one-off automation activities (for example, leveraging a bash loop to create/delete large lists of objects)
user ~ $ user ~ $ f user ~ $ f5 user ~ $ f5 user ~ $ f5 - user ~ $ f5 -- user ~ $ f5 --h user ~ $ f5 --he user ~ $ f5 --hel user ~ $ f5 --help user ~ $ f5 --help Usage: f5 [OPTIONS] COMMAND [ARGS]... Welcome to the F5 command line interface.Options: --version Show the version and exit. --help Show this message and exit.Commands: login Login to F5 BIG-IP, BIG-IQ, Cloud Services, etc. bigip Manage BIG-IP cs Manage F5 Cloud Services config Configure CLI authentication and configuration user ~ $ user ~ $ f user ~ $ f5 user ~ $ f5 user ~ $ f5 l user ~ $ f5 lo user ~ $ f5 log user ~ $ f5 logi user ~ $ f5 login user ~ $ f5 login user ~ $ f5 login - user ~ $ f5 login -- user ~ $ f5 login --a user ~ $ f5 login --au user ~ $ f5 login --aut user ~ $ f5 login --auth user ~ $ f5 login --authe user ~ $ f5 login --authen user ~ $ f5 login --authent user ~ $ f5 login --authenti user ~ $ f5 login --authentic user ~ $ f5 login --authentica user ~ $ f5 login --authenticat user ~ $ f5 login --authenticati user ~ $ f5 login --authenticatio user ~ $ f5 login --authentication user ~ $ f5 login --authentication- user ~ $ f5 login --authentication-p user ~ $ f5 login --authentication-pr user ~ $ f5 login --authentication-pro user ~ $ f5 login --authentication-prov user ~ $ f5 login --authentication-provi user ~ $ f5 login --authentication-provid user ~ $ f5 login --authentication-provide user ~ $ f5 login --authentication-provider user ~ $ f5 login --authentication-provider user ~ $ f5 login --authentication-provider b user ~ $ f5 login --authentication-provider bi user ~ $ f5 login --authentication-provider big user ~ $ f5 login --authentication-provider bigi user ~ $ f5 login --authentication-provider bigip user ~ $ f5 login --authentication-provider bigip user ~ $ f5 login --authentication-provider bigip - user ~ $ f5 login --authentication-provider bigip -- user ~ $ f5 login --authentication-provider bigip --h user ~ $ f5 login --authentication-provider bigip --ho user ~ $ f5 login --authentication-provider bigip --hos user ~ $ f5 login --authentication-provider bigip --host user ~ $ f5 login --authentication-provider bigip --host user ~ $ f5 login --authentication-provider bigip --host 1 user ~ $ f5 login --authentication-provider bigip --host 19 user ~ $ f5 login --authentication-provider bigip --host 192 user ~ $ f5 login --authentication-provider bigip --host 192. user ~ $ f5 login --authentication-provider bigip --host 192.1 user ~ $ f5 login --authentication-provider bigip --host 192.16 user ~ $ f5 login --authentication-provider bigip --host 192.168 user ~ $ f5 login --authentication-provider bigip --host 192.168. user ~ $ f5 login --authentication-provider bigip --host 192.168.1 user ~ $ f5 login --authentication-provider bigip --host 192.168.1. user ~ $ f5 login --authentication-provider bigip --host 192.168.1.2 user ~ $ f5 login --authentication-provider bigip --host 192.168.1.24 user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 - user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 -- user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --p user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --po user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --por user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --port user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --port user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --port 4 user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --port 44 user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --port 443 user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --port 443 user ~ $ f5 login --authentication-provider bigip --host 192.168.1.245 --port 443 - -- --u --us --use --user --user --user c --user cu --user cus --user cust --user custo --user custom --user custom- --user custom-a --user custom-ad --user custom-adm --user custom-admi --user custom-admin --user custom-admin Password: Password: { "message": "Logged in successfully"} user ~ $ user ~ $ user ~ $ h user ~ $ he user ~ $ hea user ~ $ head user ~ $ head user ~ $ head - user ~ $ head -n user ~ $ head -n user ~ $ head -n 1 user ~ $ head -n 15 user ~ $ head -n 15 user ~ $ head -n 15 a user ~ $ head -n 15 as user ~ $ head -n 15 as3 user ~ $ head -n 15 as3. user ~ $ head -n 15 as3.j user ~ $ head -n 15 as3.js user ~ $ head -n 15 as3.jso user ~ $ head -n 15 as3.json user ~ $ head -n 15 as3.json { "Sample_app_sec_Tenant": { "HTTPS_Service": { "Pool1": { "class": "Pool", "members": [ { "serverAddresses": [ "10.0.1.11" ], "servicePort": 80 } ], "monitors": [ "http" user ~ $ f user ~ $ f5 user ~ $ f5 user ~ $ f5 b user ~ $ f5 bi user ~ $ f5 big user ~ $ f5 bigi user ~ $ f5 bigip user ~ $ f5 bigip user ~ $ f5 bigip e user ~ $ f5 bigip ex user ~ $ f5 bigip ext user ~ $ f5 bigip exte user ~ $ f5 bigip exten user ~ $ f5 bigip extens user ~ $ f5 bigip extensi user ~ $ f5 bigip extensio user ~ $ f5 bigip extension user ~ $ f5 bigip extension user ~ $ f5 bigip extension a user ~ $ f5 bigip extension as user ~ $ f5 bigip extension as3 user ~ $ f5 bigip extension as3 user ~ $ f5 bigip extension as3 c user ~ $ f5 bigip extension as3 cr user ~ $ f5 bigip extension as3 cre user ~ $ f5 bigip extension as3 crea user ~ $ f5 bigip extension as3 creat user ~ $ f5 bigip extension as3 create user ~ $ f5 bigip extension as3 create user ~ $ f5 bigip extension as3 create - user ~ $ f5 bigip extension as3 create -- user ~ $ f5 bigip extension as3 create --d user ~ $ f5 bigip extension as3 create --de user ~ $ f5 bigip extension as3 create --dec user ~ $ f5 bigip extension as3 create --decl user ~ $ f5 bigip extension as3 create --decla user ~ $ f5 bigip extension as3 create --declar user ~ $ f5 bigip extension as3 create --declara user ~ $ f5 bigip extension as3 create --declarat user ~ $ f5 bigip extension as3 create --declarati user ~ $ f5 bigip extension as3 create --declaratio user ~ $ f5 bigip extension as3 create --declaration user ~ $ f5 bigip extension as3 create --declaration user ~ $ f5 bigip extension as3 create --declaration a user ~ $ f5 bigip extension as3 create --declaration as user ~ $ f5 bigip extension as3 create --declaration as3 user ~ $ f5 bigip extension as3 create --declaration as3. user ~ $ f5 bigip extension as3 create --declaration as3.j user ~ $ f5 bigip extension as3 create --declaration as3.js user ~ $ f5 bigip extension as3 create --declaration as3.jso user ~ $ f5 bigip extension as3 create --declaration as3.json user ~ $ f5 bigip extension as3 create --declaration as3.json "servicePort": 80 } ], "monitors": [ "http" ] }, "WAFPolicy": { "class": "WAF_Policy", "ignoreChanges": true, "url": "https://raw.githubusercontent.com/f5devcentral/f5-asm-policy-templates/master/owasp_ready_template/owasp-no-auto-tune-v1.1.xml" "class": "Application", "serviceMain": { "class": "Service_HTTPS", "policyWAF": { "use": "WAFPolicy" }, "controls": { "archiveTimestamp": "2020-04-30T23:00:12.651Z" }, "id": "autogen_46998151-9dee-4144-a84e-2d91b2e7c900", "label": "ASM_VS1", "remark": "ASM_VS1", "schemaVersion": "3.0.0", "updateMode": "selective" }, "results": [ { "code": 200, "host": "localhost", "message": "no change", "runTime": 803, "tenant": "Sample_app_sec_Tenant" } ]}

Use the following links, the navigation on the left, and/or the Next and Previous buttons to explore the documentation.