rSeries API Workflows¶
There are two main points of management within the rSeries appliances: the F5OS-C platform layer, and the individual tenants. Both support their own CLI, webUI, and API access.
At the F5OS-A platform layer level, initial configuration consists of defining static management IP addresses, routing, and other system parameters like DNS and NTP. Licensing is also configured at the F5OS-A platform layer level and is similar to iSeries in that it is applied at the appliance level and inherited by all tenants.
For more information about configuring your system, see rSeries Systems: Getting Started and rSeries Systems: Administration and Configuration at support.f5.com.
You can use a RESTful API client like Postman to configure the F5 rSeries platform.
Download the F5 rSeries F5OS-A platform Postman Collection Coming Soon.
These workflows assume that the initial out-of-band management configuration has been completed.
Workflows¶
Initial Setup of rSeries F5OS Platform Layer¶
Initial Setup of the rSeries Network Layer¶
Configuring PortGroups via API
Deploying an rSeries Tenant¶
Loading Tenant Images from a Remote Server via API
Uploading Tenant Images from a Client Machine via the API
Deploying an rSeries BIG-IP Next Tenant¶
Loading BIG-IP Next Tenant Images from a Remote Server via F5OS API
Uploading BIG-IP Next Tenant Images from a Client Machine via the F5OS API
Securing / Hardening F5OS on rSeries¶
Adding Allow List Entries via API
Managing Device Certificates, Keys, CSRs, and CAs via API
Enabling F5OS Appliance Mode via the API
Enabling BIG-IP Tenant Appliance Mode via the API
Validating Tenant Status via API
Resource-Admin & Guest User Role via API
Configuring SSH and CLI Timeouts & Deny Root SSH Settings via API
Disabling Basic Auth via the API
Setting Password Policies via API
Configuring Login Banner / MoTD via API
Enabling NTP Authentication via API
Configuring Management Ciphers via API
Configuring Client Certificate Authentication via API
Proxy Server via API for Licensing and Qkview Uploads to iHealth
Configuration of Audit Logs via F5OS API (F5OS-A 1.4.0 and Later)
rSeries Software Upgrades¶
Importing F5OS-A Images from a Remote Server via the API
Uploading F5OS-A Images from a Client Machine via the API
rSeries Configuration Backup and Restore¶
Downloading an F5OS Backup via API
Changing the Default Password and Importing F5OS Backups via API
Importing an F5OS Backup from a Remote Server via API
Diagnostics¶
qkview Creation and Upload to iHealth via API
qkview Download to Client via API
Changing the Software Component Log Levels via API
Monitoring rSeries Health & Alert Status¶
Checking Active Alerts via API
Monitoring¶
Hardware and System Component Monitoring via API
Appliance Component Status via API
Trusted Protection Module Status via API
Software Health and Status via API
F5 Service Instances Status via API
rSeries F5OS-A SNMP Monitoring and Alerting¶
Exporting MIBs to a Remote Server via the API
Adding Allowed IPs for SNMP via API
Adding Interface and LAG descriptions via API
Configuring SNMP Access via API