Planning for VELOS Guide Source |
VELOS API Workflows¶
There are three main points of management within the VELOS chassis: the system controllers, the chassis partitions, and the individual tenants. Each support their own CLI, webUI, and API access.
At the system controller level, initial configuration consists of defining static and floating IP addresses, optional Link Aggregation for the out-of-band management ports, routing, and other system parameters like DNS. Licensing is also configured at the system controller level and is similar to VIPRION in that it is applied at the chassis level and inherited by all chassis partitions and tenants.
For more information about configuring your system, see:
VELOS Systems: Getting Started and VELOS Systems: Administration and Configuration
Once network connectivity to the system controller has been setup, you can then use the F5OS-C API to deploy the rest of the VELOS system. These workflows assume that the initial system controller configuration has been completed. You can also download the VELOS Postman collection, which has many of the API workflows below.
VELOS F5OS-C Postman Collection
Workflows¶
Initial Setup of System Controllers¶
Creating Chassis Partitions¶
Configuring Networking¶
Configuring PortGroups from the API
Configuring Interfaces from the API
Tenant Deployments¶
Loading Tenant Images from a Remote Server via API
Uploading Tenant Images from a Client Machine via the API
Validating Tenant Status via API
F5OS-C Software Upgrades¶
Uploading Controller and Partition Images from a Remote Server via the API
Uploading Controller and Partition Images from a Client Machine via the API
Upgrading the System Controllers via API
Upgrading a Chassis Partition via the API
F5OS-C Backup and Restore¶
Backing Up the System Controller Database via API
Copying System Controller Database Backup to an External Location via API
Downloading System Controller Database Backup to a Client Machine via API
Backing Up Chassis Partition Databases via API
Export Backup From the Chassis Partition to a Remote Server via API
Download Backup From the Chassis Partition to a Client Machine via API
Remove Partitions and Reset Controller via API
Importing System Controller Backups via API
Restoring the System Controller from a Database Backup via API
Importing Archived Chassis Partition Configs via API
Uploading System Controller Backups from a Client Machine via API <https://clouddocs.f5.com/training/community/velos-training/html/velos_f5os_configuration_backup_and_restore.html#uploading-system-controller-backups-from-a-client-machine-via-api>
Diagnostics¶
Qkview Creation and Upload to iHealth via API
Qkview Download to Client via API
Viewing Event Logs from the API
Monitoring VELOS Health & Alert Status¶
Monitoring¶
System Inventory / Components from the API
API Monitoring of Chassis Cluster Status from the System Controller
API Monitoring of Chassis Partitions from the System Controller
VELOS F5OS-A SNMP Monitoring and Alerting¶
Exporting MIBs to a Remote Server via the API
Adding Allowed IPs for SNMP via API
Adding Out-of-Band Interface and LAG descriptions via API
Adding Interface and LAG Descriptions for Chassis Partitions via API
Configuring SNMP Access via API