Manual Chapter :
Prerequisites
Applies To:
Show VersionsF5OS-C
- 1.5.1, 1.5.0
Prerequisites
Before you upgrade or install
Before you install or upgrade
F5OS
on your system:- Ensure that you complete or verify the listed prerequisites for installation/upgrade tasks.
- Verify that your network settings are configured.
- Back up your system controller, chassis partition, and tenant configurations.
- Export your backups to a safe, off-unit location.
- Upload system controller and chassis partition image files to each chassis before the scheduled maintenance window to minimize the time needed to upgrade.
- Upload tenant image files to all tenants before the scheduled maintenance window to minimize the time needed to upgrade.
- Check the health and availability of virtual servers and pool members to determine their status before the upgrade.
Prerequisites for installation/upgrade
This lists a high-level overview of tasks that you should
complete before you install or upgrade the
F5OS
software on your VELOS
system.Task |
Action |
---|---|
Configure the front-panel management
port on the system. |
For more information, see the platform guide for your VELOS platform at techdocs.f5.com. |
Connect the system controller to a
serial console server. |
Use these default serial port
settings:
|
Configure basic management settings. |
For more information, see the
Network settings reference section. |
Verify that an rsync server is reachable from the
system for import of installation images onto the system controller . |
For more information, see the rsync
documentation (rsync.samba.org). |
Update/reactivate your system
license, if needed, to ensure that you have a valid service
check date. |
For more information, see K7727: License activation may
be required before a software upgrade for BIG-IP. Additional information about
BIG-IP Next licensing may be available on the F5 Beta
portal. |
Get a USB flash drive (minimum 8GB);
only needed if using the USB method for performing a clean
installation. |
Verify that the drive is fully seated and flush in the USB
port. For security purposes, the USB port
on the system controller is disabled by default. You can use Always-On
Management (AOM) to enable the front panel USB port. For more
information about AOM, see the platform guide for your VELOS platform at techdocs.f5.com. |
Network settings reference
Before you perform a software
installation/upgrade, verify that you have configured network settings by logging
in to the system from a management console using an admin account and
running these commands on the CLI. When you log in to the
system, you are in user mode. Before you can complete configuration tasks, you
must first change to config mode by typing
config
. You can type a
question mark (?
) or
press the Tab key to see possible command completions in the CLI.Be sure to commit all
changes.
Task |
Configuration example |
Verify configuration |
---|---|---|
Enable DHCP If you do not enable DHCP, you
must manually configure the system IP address, prefix,
gateway, and DNS. |
system mgmt-ip config
dhcp-enabled true |
show running-config
system mgmt-ip config dhcp-enabled |
Configure a static IPv4 management address for
controller-1 |
system mgmt-ip config
ipv4 controller-1 address 192.0.2.10 |
show
running-config system mgmt-ip |
Configure a static IPv4 management address for
controller-2 |
system mgmt-ip config
ipv4 controller-2 address 192.0.2.11 |
|
Configure a static floating IPv4 management
address |
system mgmt-ip config
ipv4 floating address 192.0.2.15
|
|
Configure a prefix length for a static floating IPv4
address |
system
mgmt-ip config ipv4 prefix-length
24 |
|
Configure a gateway for a static floating IPv4
address |
system mgmt-ip config
ipv4 gateway 192.0.2.254 |
|
Configure a static IPv6 management address for
controller-1 |
system
mgmt-ip config ipv6 controller-1 address
2001:db8:ffff:100::1 |
show
running-config system mgmt-ip |
Configure a static IPv6 management address for
controller-2 |
system
mgmt-ip config ipv6 controller-2 address
2001:db8:ffff:101::1 |
|
Configure a static floating IPv6 management
address |
system
mgmt-ip config ipv6 floating address
2001:db8:ffff:103::1
|
|
Configure a prefix length for a static floating IPv6
address |
system
mgmt-ip config ipv6 prefix-length
64 |
|
Configure a gateway for a static floating IPv6
address |
system
mgmt-ip config ipv6 gateway
2001:db8:ffff:100::fffe |
|
Configure an IPv4 DNS server |
system
dns servers server 192.0.2.1 config address
192.0.2.1 |
show running-config
system dns |
Configure an NTP server |
system
ntp servers server pool.ntp.org config address
pool.ntp.org |
show running-config
system ntp |
VELOS system backups
VELOS
system backupsCreating a backup of your
VELOS
system is highly
recommended, as it helps ensure that your active configuration files are
retained, and you can restore from a known, stable environment if your upgrade
is unsuccessful.For more information, see K50135154: Back up and restore the F5OS-C configuration on a
VELOS system.
Back up and export system controller
configuration
Before you perform an upgrade, it
is a good idea to save and export a backup of the system controller
configuration from the system controller CLI.
- Log in to the command line interface (CLI) of the system controller using an account with admin access.When you log in to the system, you are in user (operational) mode.
- Change to config mode.configThe CLI prompt changes to include(config).
- Create a backup of the system controller configuration.system database config-backup name <filename>In this example, you create a backup file of the system controller configuration namedcontroller-backup1.xml:system database config-backup name controller-backup1.xmlSystem controller configuration backup files are located inconfigs.
- Verify that the backup file was created successfully.file list path configs/
- Export the configuration backup file to a safe location, such as an HTTPS server.file export local-file configs/<filename> protocol [ https | scp | sftp ] remote-file /tmp/<filename>.xml remote-host <ip-address> username rootIn this example, you connect as the root user to IP address192.0.2.75and export a backup file namedcontroller-backup1.xmlto the/tmpdirectory:file export local-file configs/<filename> remote-file /tmp/controller-backup1.xml remote-host 192.0.2.75 username rootThe system requests the password for the remote root account.Value for 'password' (<string>): ******* result File transfer is initiated.(configs/backup1.xml)
- Check the status of the file transfer.file transfer-statusWhen the file transfer completes, theStatusdisplaysComplete.
You now have a backup of the system
configuration on the system controller that you can restore on the system if
needed.
Back up and export chassis partition
configuration
Before you perform an upgrade, it
is a good idea to save and export a backup of the chassis partition
configuration from the chassis partition CLI.
- Log in to the command line interface (CLI) of the chassis partition using an account with admin access.When you log in to the system, you are in user (operational) mode.
- Change to config mode.configThe CLI prompt changes to include(config).
- Create a backup of the chassis partition configuration.system database config-backup name <filename>.xmlIn this example, you create a backup file of the chassis partition configuration namedchassis-partition-backup1.xml:system database config-backup name chassis-partition-backup1.xmlChassis partition configuration backup files are located inconfigs/.
- Verify that the backup file was created successfully.file list path configs/
- Export the configuration backup file to a safe location, such as an HTTPS server.file export local-file configs/<filename>.xml protocol [ https | scp | sftp ] remote-file /tmp/<filename>.xml remote-host <ip-address> username <username>In this example, you connect as the root user to IP address192.0.2.75and export a backup file namedchassis-partition-backup1.xmlto the/tmpdirectory:file export local-file configs/chassis-partition-backup1.xml protocol scp remote-file /tmp/chassis-partition-backup1.xml remote-host 192.0.2.75 username rootThe system requests the password for the remote root account.Value for 'password' (<string>): ******* result File transfer is initiated.(configs/chassis-partition-backup1.xml)
- Check the status of the file transfer.file transfer-statusWhen the file transfer completes, theStatusdisplaysComplete.
You now have a backup of the chassis
partition configuration that you can restore on the system if needed.
Tenant configuration backups
Before you perform an upgrade, it is a good idea to
save and export a backup of the tenant configuration using that tenant's backup
mechanism.
Tenant |
Summary |
Additional References |
---|---|---|
BIG-IP |
For BIG-IP tenants: Create a backup for each running tenant: tmsh save sys ucs
<filename> Move these
backup files to a safe location off of the tenant:
Consider naming the files to
associate them with the appropriate tenants. |
|
BIG-IP Next |
For BIG-IP Next tenants: Information is available on the F5 beta portal. |
License the system automatically from the CLI
For automatic
VELOS
system licensing,
the system needs to be able to connect to the F5 licensing server either
through the internet or another means of networking. You need to have the Base
Registration Key (five sets of characters separated by hyphens) provided by
F5, and any add-on keys (two sets of 7 characters separated by a hyphen) that
you have purchased. The Base Registration Key with associated add-on keys are
pre-installed on a new VELOS
system.You can activate the
VELOS
system license automatically
from the system controller CLI.- Connect using SSH to the system controller floating management IP address.
- Log in to the command line interface (CLI) of the system controller using an account with admin access.When you log in to the system, you are in user (operational) mode.
- Change to config mode.configThe CLI prompt changes to include(config).
- Apply a license to the chassis.system licensing install registration-key <key>The registration key is optional. If it is not included, the system uses the one that is already pre-installed. If no registration key is found, you receive an error.This example applies a specified base registration license to the system:syscon-1-active(config)# system licensing install registration-key I1234-12345-12345-12345-1234567 result License installed successfully.
- Apply any add-on keys.system licensing install add-on-keys <add-on-keys>This example enables the additional features associated with the three specified add-on-keys, along with the entitlements of the base registration key:syscon-1-active(config)# system licensing install add-on-keys [1234567-1234567 2345678-2345678 3456789-3456789] result License installed successfully.
The
VELOS
system is licensed. The license and any add-on keys apply to all partitions and
tenants.