F5 Logo MyF5
Search
  1. MyF5 Home
  2. F5 rSeries Systems: Administration and Configuration
  3. System Settings
Manual Chapter : System Settings

Applies To:

Show Versions Show Versions

F5OS-A

  • 1.1.1, 1.1.0
Manual Chapter

System Settings

System settings overview

You can access system settings in the webUI.

Display system alarms and events from the webUI

The Alarms & Events screen lists alert information for system components (such as PSU, firmware, and LCD) that have currently crossed a performance or health threshold. Use this screen to identify the specific component that is affected.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Alarm & Events
    .
  3. Choose from one of these actions:
    • To refresh the alarms or events list, click the
      Refresh
       icon on the right of the screen.
    • To display events result by time preference, click the down arrow next to the
      Refresh
       icon and select a value from the list. The default value is one hour. For example, select five minutes to display any event that occurred in the last five minutes.
    • To display events by severity, select a value from the
      Severity
       list. The default value is WARNING.
    Option
    Description
    Emergency
    Emergency system panic messages
    Alert
    Serious errors that require administrator intervention
    Critical
    Critical errors, including hardware and file system failures
    Error
    Non-critical, but possibly important, error messages
    Warning
    Warning messages that should be logged and reviewed
    Notice
    Messages that contain useful information, but might be ignored
    Informational
    Messages that contain useful information, but might be ignored
    Debug
    Detailed messages used for troubleshooting

Configure a management interface from the webUI

You can view or change settings for the management interface from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Management Interface
    .
  3. For
    DHCP
    , select either
    Enabled
     or
    Disabled
    .
  4. For
    Address
    , select either
    IPv4
    ,
    IPv6
    , or
    IPv4 & IPv6
    .
    Additional fields display, depending on which address type you selected.
  5. Under
    IPv4
     and
    IPv6
    , you can configure one or more management IP addresses for the system:
    1. For
      IP Address
      , type an IPv4 or IPv6 address.
    2. For
      Prefix Length
      , specify a number from 1-32.
    3. For
      Gateway
      , type the gateway IP address.
  6. Under
    Interface Settings
    , you can configure the management port:
    1. For
      State
      , select either
      Enabled
       or
      Disabled
      .
    2. For
      Auto-negotiation
      , select either
      Enabled
       or
      Disabled
      .
      If you enable auto-negotiation, port speed and duplex mode are set automatically.
    3. For
      Port Speed
      , select one of these options:
      SPEED_1GB
      ,
      SPEED_10MB
      , or
      SPEED_100MB
      .
    4. For
      Duplex Mode
      , select
      FULL
       or
      HALF
      .
  7. Click
    Save
    .

Allow list overview

An allow list enables you to add either an IPv4 or IPv6 address as an accepted source that can access the system.
When the IP address is configured and saved to your allow list, only traffic coming from that IP address and port is accepted by the system's management interface. You can also edit or delete entries in the allow list after you have configured them.

Add an IP address to the allow list from the webUI

You can add an IP address to the Allow List from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Allow List
    .
    The Allow List displays.
  3. Click
    Add
    .
  4. Type a name for the allow list entry.
  5. From the
    IPv4/ IPv6
     list, select an address type.
  6. In the
    Address
     field, type the IP address you want to add to the system allow list.
  7. For
    Port
    , select one of these options:
    Port
    Type
    443
    HTTPS
    80
    HTTP
    8888
    RESTCONF
    161
    SNMP
    7001
    VCONSOLE
  8. Click
    Save & Close
    .

Configure or delete the allow list from the webUI

You can configure or delete an IP address in the system allow list from the webUI.
You must have added an IP address to the allow list before you can edit or delete an entry.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Allow List
    .
    The
    Allow List
     displays.
  3. Select the IP address that you want to edit from the Allow List.
    The IP address details display. You cannot edit the designated name, but you can change all other fields.
  4. Click
    Save & Close
    .
  5. To delete the IP address, select an IP address and click
    Delete
    .
    When you are asked to confirm that you want to delete the IP address from the allow list, click
    OK
    .

Configure an allow list from the CLI

You can configure your system to allow specific IP addresses from the CLI.
  1. Log in to the command line interface (CLI) of the system using an account with admin access.
    When you log in to the system, you are in user (operational) mode.
  2. Change to config mode.
    config
    The CLI prompt changes to include
    (config)
    .
  3. Configure the system to allow traffic only from specified IP addresses.
    This is applicable only for ports 161, 8888, 443, 80, and 7001.
    system allowed-ips allowed-ip <
    allowlist-profile-name
    > config [ ipv4 | ipv6 ] address <
    ip-address
    > port <
    port-number
    >
    This example adds a specified IPv4 address to the system allow list:
    appliance-1(config)# system allowed-ips allowed-ip test config ipv4 address 192.0.2.33 port 161
  4. Commit the configuration changes.
    commit

Software management overview

The Software Management screen on the webUI includes options for uploading, importing and updating Base OS software for the system.

Manage Base OS software images from the webUI

You can manage software images from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Software Management
    .
  3. To add a Base OS image by importing from the URL:
    1. Click
      Import
      .
    2. For
      URL
      , type the URL of the remote image server.
      F5 recommends that the remote host be an HTTPS server with PUT/POST enabled and have a valid CA-signed certificate. You can opt to select the
      Ignore Certificate Warnings
       check box if you want to skip the certificate check.
    3. For
      Username
      , type the user name for an account on the remote image server, if required.
    4. For
      Password
      , type the password for the account, if required.
    5. Select
      Ignore Certificate Warnings
       to skip the certificate check.
    6. Click
      Add Image
      .
    Depending on the image file size and network availability, the import might take a few minutes. When the import is successful, the software image is listed in the webUI.
  4. To add a Base OS image that you have downloaded to your local workstation:
    1. Click
      Upload
      .
    2. Navigate to the image file and select it.
    3. Click
      Open
      .
  5. To delete a Base OS image, select the image and click
    Delete
    .
    Software images that are in use cannot be deleted.
View the status of image imports under
Image Import Status
, which shows information about
Remote Host
,
File
,
Status
, and
Time
.

Update Base OS software images from the webUI

Before you begin, you must also have added or uploaded an updated software image before you can do the update.
You can update Base OS software while the system is up and running from the webUI.
During a software update, there is an interruption to traffic, so F5 recommends that you perform the update during a maintenance window
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Software Management
    .
  3. In the Update Base OS Software section, for
    Update Software
    :
    • To install a full F5OS-A version release, select
      Bundled
      .
    • To install F5OS-A and service version releases independently, select
      Unbundled
      .
  4. For
    ISO Image
    , select the full version release ISO image from the drop-down.
    This field is available when
    Bundled
     is selected.
  5. For
    Base OS Version
    , select the F5OS version from the drop-down.
    This field is available when
    Unbundled
     is selected.
  6. For
    Service Version
    , select the service version release from the drop-down.
    This field is available when
    Unbundled
     is selected.

Configure DNS from the webUI

You can configure DNS for the system from the webUI. This is used for name resolution such as when setting up the system.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    DNS
    .
  3. Under
    DNS Lookup Servers
    , specify the name servers that the system uses to validate DNS lookups, and resolve host names. For each name server you want to add:
    1. Click
      Add
      .
    2. For
      Lookup Server
      , type the IP address of the name server that you want to add to the list.
    3. Click
      Save & Close
      .
  4. Under
    DNS Search Domains
    , specify the domains that the system searches for local domain lookups and to resolve local host names. For each domain you want to add:
    1. Click
      Add
      .
    2. For
      Search Domain
      , type the domain name of the name server that you want to add to the list.
      For example, DNSsearch.com.
    3. Click
      Save & Close
      .
DNS lookup servers and search domains are now specified for the system.

Configure log settings from the webUI

You can add and display information about configured remote log servers from the webUI. You can also change the log severity level for individual software components and services.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Log Settings
    .
  3. To add access to a
    Remote Log Server
    , click
    Add
    .
  4. In the
    Server
     field, type the IPv4 address, IPv6 address, or Fully Qualified Domain Name (FQDN) of the remote server.
  5. In the
    Port
     field, type the port number of the remote server.
    The default port value is 514.
  6. For
    Protocol
    , select
    UDP
     or
    TCP
     to choose between TCP or UDP input.
  7. From the
    Facility
     list, select
    LOCAL0
    .
    F5OS supports only the LOCAL0 logging facility. All logs are directed to this facility, and it is the only one that you can use for remote logging.
  8. From the
    Severity
     list, select the severity level of the messages to log.
    Option
    Description
    Emergency
    Emergency system panic messages
    Alert
    Serious errors that require administrator intervention
    Critical
    Critical errors, including hardware and file system failures
    Error
    Non-critical, but possibly important, error messages
    Warning
    Warning messages that should be logged and reviewed
    Notice
    Messages that contain useful information, but might be ignored
    Informational
    Messages that contain useful information, but might be ignored
    Debug
    Verbose messages used for troubleshooting
  9. Click
    Save & Close
    .
  10. On the Log Settings screen, review the software component log levels for individual software components and adjust them as needed. Click
    Save
     if you made changes.
    The log levels determine at what level events (and all higher levels) are logged for each service.
    Informational
     is the default so all except debug-level events are logged.
  11. To delete a remote log server, select the server and click
    Delete
    .

File utilities overview

You can import, export, download, or delete files asynchronously depending on which directory you select to work in. All file transfers are done using the HTTPS protocol.

File import

You can import a file from an external server into the system from either the webUI or the CLI. HTTPS is the supported protocol. The remote host should be an HTTPS server with PUT/POST enabled and have a valid CA-signed certificate.
If you want to import the contents of a tar file, you need to extract the contents first before you can import them onto the
F5
 system.
You can import files into these directories on the system:
  • configs/
  • diags/shared
  • images/import
  • images/staging
  • images/tenant

File download

You can download files in these directories from the system to your local workstation from the webUI:
  • configs
  • diags/core
  • diags/crash
  • diags/shared
  • log/confd
  • log/system

File upload

You can upload files in these directories from your local workstation to the system from the webUI:
  • configs
  • images/staging
  • images/tenant

File export

You can export a file from the system to an external server from either the webUI or the CLI. HTTPS is the supported protocol. The remote host should be an HTTPS server with PUT/POST enabled and have a valid CA-signed certificate.
You can export files into these directories from the system:
  • configs
  • log/
  • log/confd
  • log/controller
  • log/host
  • log/system
  • diags/
  • diags/core
  • diags/crash
  • diags/shared
  • images/
  • images/import
  • images/staging
  • images/tenant

File deletion

You can delete files (to which you have file permissions) on the system only from the
diags/shared
 or
configs
 directories from either the webUI or the CLI.

Import or export files from the webUI

File Utilities are available in the webUI. You can use File Utilities to import, export, and/or delete files asynchronously depending on which directory you select to work in. All file transfers are done using HTTPS protocol.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    File Utilities
    .
  3. From the
    Base Directory
     list, browse the directories and click subfolders to view their contents and the commands that are available from each one.
    From a subfolder, click the left arrow next to the path to navigate back to the main folder.
  4. To import a file:
    1. Click
      Import
      .
    2. In the popup, type the
      URL
       of the file to import.
    3. Provide the
      Username
       and
      Password
       only if required by the remote host.
    4. Select
      Ignore Certificate Warnings
       if you want to skip warnings when importing files (such as if the remote host does not have a valid CA-signed certificate).
    5. Click
      Import File
       to begin the import.
  5. To export a file:
    1. Select the file and click
      Export
      .
    2. In the popup, type the
      Server URL
       for where to export the file.
    3. Provide the
      Username
       and
      Password
       only if required by the remote host.
    4. Select
      Ignore Certificate Warnings
       if you want to skip warnings when importing files.
    5. Click
      Export File
       to begin the export.
  6. To delete a file, select the file and click
    Delete
    .
    You can delete files from the
    diags/shared
     directory.
You can view the status of a file transfer operation to view its progress and see if it was successful. If an operation fails, hover over the warning icon to see the error that occurred.
A runtime error displays in the File Transfer status area, if an invalid operation is performed.

Import or export files from the CLI

You can import a file from an external server into the system or export a file to an external server from the system using the CLI.
  1. Log in to the command line interface (CLI) of the system using an account with admin access.
    When you log in to the system, you are in user (operational) mode.
  2. Import a file.
    file import remote-url <
    ip-address-and-file-path
    > local-file <
    local-file-path
    > username <
    user
    > password [ remote-port <
    port-number
    > ] [ protocol [ https | scp | sftp ]] [insecure]
    The
    insecure
     option ignores certificate warnings during the transfer.
    This example shows how to import a Base OS ISO to the system:
    appliance-1# file import remote-url https://files.company.com/images/F5OS-A-1.1.x-xxxxx.R5R10.iso 
  local-file images/staging username admin password
Enter the password at the prompt:
     Value for 'password' (<string>): ******** 
result File transfer is initiated.(images/staging/F5OS-A-1.1.x-xxxxx.R5R10.iso)
    If the file import doesn't work, you can alternatively use secure copy (SCP) to copy the image file to the
    images/staging
     directory of the system.
  3. Optionally, you can check the file transfer status.
     
    appliance-1# file transfer-status
    When the file transfer completes, the
    Status
     displays
    Complete
    .
  4. Export a file.
    file export remote-url <
    ip-address-and-file-path
    > local-file <
    local-file-path
    > username <
    user
    > password [ remote-port <
    port-number
    > ] [ protocol [ https | scp | sftp ]] [insecure]
    This example shows how to import a Base OS ISO to the system:
    appliance-1# file export local-file configs/backup1.xml remote-file /tmp/backup1.xml 
  remote-host 192.51.100.75 username root
    The system requests the password for the remote account. 
    Value for 'password' (<string>): *******
result File transfer is initiated.(configs/backup1.xml)
  5. Delete a file.
    file delete local-file diags/shared/<
    file-name.xml
    >
    This example shows how to delete a file:
    appliance-1# file delete local-file diags/shared/backup1.xml
    You can only delete files from the
    diags/shared
     or
    configs
    directory.

Configure time settings from the webUI

After the system license is activated, you can configure Network Time Protocol (NTP) servers and time zone. The NTP server ensures that the system clock is synchronized with Coordinated Universal Time (UTC). You can specify a list of servers that you want the system to use when updating the time on network systems. You can configure time settings for the system from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Time Settings
    .
  3. To synchronize the system clock with an NTP server, for
    NTP Service
    , click
    Enabled
    .
    The
    NTP Service
     is set to
    Disabled
    , by default.
  4. To specify an
    NTP server
    :
    1. Click
      Add
      .
    2. In the
      NTP Server
       field, type the IPv4 address, IPv6 or the Fully Qualified Domain Name (FQDN) of the NTP server.
      If specifying an FQDN, you must configure a resolvable DNS server for the system.
    3. Click
      Save & Close
      .
  5. To set the time zone, select the time zone area from the
    Locations
     list.
  6. Click
    Save
    .

Certificate management overview

Before
rSeries
 systems can exchange data with one another, they need to exchange device certificates, that is, digital certificates and keys used for secure communication.
If you are using LDAP with transport layer security (TLS) for user authentication, you can choose to require TLS Certificate Validation in the authentication settings. You can add a certificate and key into the system, and when you create a certificate signing request (CSR), it saves the generated key and certificate to these directories:
  • system/aaa/tls/config/key
  • system/aaa/tls/config/certificate

View a certificate from the webUI

Before you can install device certificates, you must enable LDAP as an authentication method in the system (
USER MANAGEMENT
Auth Settings
).
You can view a certificate from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Certificate Management
    .
  3. To display a
    TLS Certificate
    , a
    TLS Key
     that was previously installed, or the
    TLS Details
    , click
    Show
    .
    A text area opens and displays the certificate, key, or details.

Create a self-signed certificate from the webUI

Before you can install device certificates, you must enable LDAP as an authentication method in the system (
USER MANAGEMENT
Auth Settings
).
You can create or view a self-signed certificate from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Certificate Management
    .
  3. Click
    Create Certificate
    .
    A form appears to enter certificate information.
  4. In the
    Name
     field, enter a name for the certificate. For example, the server's hostname.
  5. In the
    Email
     field, enter the email address for the certificate contact.
  6. In the
    City
     field, enter the city or locality name.
  7. In the
    State
     field, enter the state, county, or region.
  8. In the
    Country
     field, enter the two-letter country code. For example, US for United States.
  9. In the
    Organization
     field, enter the certificate originator name. For example, your company's name.
  10. In the
    Unit
     field, enter the organizational unit name. For example, IT.
  11. In the
    Version
     field, specify the version number for the certificate.
  12. In the
    Days Valid
     field, specify the number of days the certificate is valid.
  13. In the
    Key Type
     field, choose ECDSA or RSA as your key type.
  14. In the
    Store TLS
     field, choose whether to store your TLS information.
  15. Click
    Save
    .

Create a Certificate Signing Request (CSR) from the webUI

Before you can install device certificates, you must enable LDAP as an authentication method in the system (
USER MANAGEMENT
Auth Settings
).
You can create and view certificate signing requests (CSRs) from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Certificate Management
    .
  3. To create a
    Certificate Signing Request
    , click
    Create CSR
    .
    A form appears to enter certificate information.
  4. In the
    Name
     field, enter a name for the certificate. For example, the server's hostname.
  5. In the
    Email
     field, enter the email address for the certificate contact.
  6. In the
    City
     field, enter the city or locality name.
  7. In the
    State
     field, enter the state, county, or region.
  8. In the
    Country
     field, enter the two-letter country code.
    For example, US for United States.
  9. In the
    Organization
     field, enter the certificate originator name.
    For example, your company's name.
  10. In the
    Unit
     field, enter the organizational unit name.
    For example, IT.
  11. In the
    Version
     field, specify the version number for the certificate.
  12. Click
    Save
    .

Generate system reports (QKView) from the webUI

If you have any concerns about your system operation, you can use the
qkview
 utility to generate a system report to collect configuration and diagnostic information from the
rSeries
 system. The QKView report contains machine-readable (JSON) diagnostic data and combines the data into a single compressed tar.gz format file. You can upload the QKView file to F5 iHealth where you can get help verifying proper operation of the system, understanding and troubleshooting any issues you might be having, and ensuring that the system is operating at its maximum efficiency.
You can generate a QKView report from the webUI. The report contains diagnostic information, such as configuration data, log files, and platform information.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    System Reports
    .
    The System Reports screen displays. A list of QKView reports that were previously generated are shown with any reports that were uploaded to iHealth.
  3. To generate a system report, click
    Generate QKView
     in the upper right corner of the screen.
    The Generate QKView box displays these additional options:
    Option
    Description
    Filename
    Specify a name for the file to which QKView report data is written. The default filename is <
    system-name
    >.qkview.
    Timeout Value
    Specify the time in seconds after which to stop QKView report data collection. The default value is 0, which indicates no timeout.
    Max File Size
    Exclude all files greater than the specified size (in MB). The range is from 2 MB to 1000 MB. The default value for maximum file size is 500 MB.
    Max Core Size
    Exclude core files greater than this size (in MB). The range is from 2 MB to 1000 MB. The default value for maximum core size is 25 MB.
    Exclude Cores
    Specify whether core files should be excluded from the QKView report. The default is to include core files.
    The system runs many commands to collect the diagnostic information, so generating the report might affect its performance.
    It takes a few minutes for the system to finish creating the report and list it on the screen. The QKView Status changes to
    File generated successfully
     when it is done.
  4. If you want to upload the report to the F5 iHealth server, select the check box next to the QKView name, and click
    Upload to iHealth
    .
    To do the upload, the system must have DNS configured, and have Internet access to these services using the HTTPS/443 remote service/port:
    • api.f5.com
    • ihealth-api.f5.com
    The QKView tar file uploads to iHealth, where you can get help to diagnose the health and proper operation of the system.
  5. To delete a QKView report, select it and click
    Delete
    .

Back up system configuration from the webUI

You can back up the system configuration from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Configuration Backup
    .
  3. Click
    Create
    .
    The Create Configuration Backup popup opens.
  4. In the
    Name
     field, type a name for the backup (for example, system-12-21-21).
  5. Click
    Create
    .
    The backup is created and added to the list.
  6. To delete a backup file, select the file and click
    Delete
    .
System configuration backups are stored in
configs/
. Backups should be stored on off the system.
You can restore configurations from the CLI. For more information on saving and restoring the configuration, see the
Complete backup and restore overview
 section.

System licensing overview

You can activate a license for the
rSeries
 system from either the CLI or webUI. There is one license per
rSeries
 system, which is also used by any tenants.
There are two ways to license the system:
Automatically
If your system is connected to the Internet, use the Automatic method to prompt the system to contact the F5 license server and activate the license.
Manually
If your system is not connected to the Internet, use a management workstation that is connected to the Internet to retrieve an activation key from
F5
 and then transfer it to the system.
Adding or reactivating a license on an active
rSeries
 system might impact traffic on tenants. Traffic processing will stop briefly on the tenants, and then restart automatically. This occurs when the tenant receives a new or reactivated license causing a configuration reload on the tenants. For more information, see these other references:

System licensing from the webUI

License the system automatically from the webUI

You can license a system using the automatic method from the webUI, as long as the system has Internet access.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Licensing
    .
  3. For the
    Base Registration Key
     field, the registration key is auto-populated.
    You can choose to overwrite this field with a new registration key by clicking
    Reactivate
     and overwriting the field.
  4. For the
    Add-On Keys
     field, the associated add-on keys are auto-populated.
    You can choose to change these keys by clicking
    Reactivate
     and then click
    +
     or
    x
     to add or remove additional add-on keys.
  5. For the
    Activation Method
    , select
    Automatic
    .
  6. Click
    Activate
    .
    The End User License Agreement (EULA) displays.
  7. Click
    Agree
     to accept the EULA.
The system is now licensed. If a base registration key or add-on key fails to activate, try re-activating the license or contact F5 Support at support.f5.com.

License the system manually from the webUI

You can license a system without access to the Internet using the manual activation method from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    Licensing
    .
  3. For the
    Base Registration Key
     field, the registration key is auto-populated.
    You can choose to overwrite this field with a new registration key by clicking
    Reactivate
     and overwriting the field.
  4. For the
    Add-On Keys
     field, the associated add-on keys are auto-populated.
    You can choose to change these keys by clicking
    Reactivate
     and then click
    +
     or
    x
     to add or remove additional add-on keys.
  5. For the
    Activation Method
    , select
    Manual.
  6. For the
    Device Dossier,
     click
    Get Dossier
    .
    The system refreshes and displays the dossier.
  7. Copy the dossier text in the
    Device Dossier
     field.
  8. Click
    Click here to access F5 Licensing Server
    .
    The Activate F5 Product page displays.
  9. Paste the dossier in the
    Enter Your Dossier
     field.
  10. Click
    Next
    .
    The license key text displays.
  11. Copy the license key text.
    Alternatively, you can use the F5 license activation portal at activate.f5.com/license.
  12. In the
    License Text
     field, paste the license key text.
  13. Click
    Activate
    .
    The End User License Agreement (EULA) displays.
  14. Click
    Agree
     to accept the EULA.
The system is now licensed. If a base registration key or add-on key fails to activate, try re-activating the license or contact F5 Support at support.f5.com.

System licensing from the CLI

License the system manually from the CLI

You can activate the
rSeries
 system license manually from the system CLI.
  1. Log in to the command line interface (CLI) of the system using an account with admin access.
    When you log in to the system, you are in user (operational) mode.
  2. Change to config mode.
    config
    The CLI prompt changes to include
    (config)
    .
  3. Get the system dossier.
    system licensing get-dossier [registration-key XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX]
    The registration key is optional. If it is not included, the system uses the one already pre-installed. If no registration key is found, you receive an error.
    The dossier for the system displays.
  4. Get the license file using the dossier output you just received by going to the F5 site activate.f5.com/license/dossier.jsp.
  5. Copy the license file text.
  6. Install the license.
    system licensing manual-install license
  7. Paste the license file content in multiline mode, then press Ctrl+D.
     
    appliance-1(config)# system licensing manual-install license 
Value for 'license' (<string>): 
[Multiline mode, exit with ctrl-D.]
>
The
rSeries
 system is licensed. The license applies to the system and tenants.

License the system automatically from the CLI

For automatic
rSeries
 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
rSeries
 system.
You can activate the
rSeries
 system license automatically from the CLI.
  1. Log in to the command line interface (CLI) of the system using an account with admin access.
    When you log in to the system, you are in user (operational) mode.
  2. Change to config mode.
    config
    The CLI prompt changes to include
    (config)
    .
  3. Apply a license to the system.
    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: 
    appliance-1(config)# system licensing install registration-key 
 I1234-12345-12345-12345-1234567
result License installed successfully.
  4. 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: 
    appliance-1(config)# system licensing install 
 add-on-keys [1234567-1234567 2345678-2345678 3456789-3456789]
result License installed successfully.
The
rSeries
 system is licensed. The license and any add-on keys apply to the system and all tenants.

Display the system license from the CLI

You can display the license and associated information of an
rSeries
 system from the CLI.
  1. Log in to the command line interface (CLI) of the system using an account with admin access.
    When you log in to the system, you are in user (operational) mode.
  2. Display the system license.
    show system licensing
    A summary similar to this example displays: 
    appliance-1# show system licensing
 system licensing license   Licensed version    1.1.0
       Registration Key    I1234-12345-12345-12345-1234567
       Licensed date       2022/02/08
       License start       2022/02/07
       License end         2022/03/11
       Service check date  2022/02/08
       Platform ID         C128
       Appliance SN        f5-nhlh-lule

       Active Modules
        Local Traffic Manager, r10900 (S680352-1548257)
          LTM to Best Upgrade, r109XX
          Rate Shaping
          DNSSEC
          Anti-Virus Checks
          Base Endpoint Security Checks
          Firewall Checks
          Machine Certificate Checks
          Network Access
          Protected Workspace
          Secure Virtual Keyboard
          APM, Web Application
          App Tunnel
          Remote Desktop
          DNS Rate Fallback, Unlimited
          DNS Licensed Objects, Unlimited
          DNS Rate Limit, Unlimited QPS
          GTM Rate Fallback, (UNLIMITED)
          GTM Licensed Objects, Unlimited
          GTM Rate, Unlimited
          Carrier Grade NAT (AFM ONLY)
          APM, Limited
          Routing Bundle
          Protocol Security Manager
          Access Policy Manager, Base, r109XX
          Advanced Web Application Firewall, r10XXX
          Max SSL, r10900
          Max Compression, r10900
          DNS Max, rSeries
          Advanced Firewall Manager, r10XXX
  3. Display the entire license file content received from the F5 license server.
    show running-config system licensing
The
rSeries
 system is licensed. The license applies to the system and tenants.

RAID overview

F5
 r10000 platforms include two storage drives that support drive mirroring using a redundant array of independent disks (RAID) by default. You can manage the software RAID array from either the CLI or the webUI.
If you need to swap out a faulty drive, you must first remove the drive from the software RAID array before physically removing the drive from the platform.

Configure RAID from the webUI

You can configure a software RAID (redundant array of independent disks) for the system from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    RAID Configuration
    .
  3. To remove a drive from the software RAID array:
    1. Select the drive to remove.
    2. Click
      Remove
      .
      When prompted, click
      OK
       to confirm drive removal.
  4. To add a drive to the software RAID array:
    1. Select the drive to add.
    2. Click
      Add
      .
      When prompted, click
      OK
       to confirm drive addition.

Configure RAID from the CLI

You can configure a software RAID (redundant array of independent disks) for the system from the CLI.
  1. Log in to the command line interface (CLI) of the system using an account with admin access.
    When you log in to the system, you are in user (operational) mode.
  2. Change to config mode.
    config
    The CLI prompt changes to include
    (config)
    .
  3. Remove a drive from the software RAID array.
    system raid remove drive ssd2
    A summary similar to this example displays:
    appliance-1(config)# system raid remove drive ssd2
status Remove of RAID SSD2 initiated.
[11084.434517] md/raid1:md121: Disk failure on nvme1n1p3, disabling device.
[11084.434517] md/raid1:md121: Operation continuing on 1 devices.
[11084.449528] md/raid1:md122: Disk failure on nvme1n1p4, disabling device.
[11084.449528] md/raid1:md122: Operation continuing on 1 devices.
[11084.464098] md/raid1:md123: Disk failure on nvme1n1p5, disabling device.
[11084.464098] md/raid1:md123: Operation continuing on 1 devices.
[11084.478342] md/raid1:md124: Disk failure on nvme1n1p1, disabling device.
[11084.478342] md/raid1:md124: Operation continuing on 1 devices.
[11084.492509] md/raid1:md127: Disk failure on nvme1n1p2, disabling device.
[11084.492509] md/raid1:md127: Operation continuing on 1 devices.
status Remove of RAID SSD2 initiated.
  4. Add the replacement drive to the array.
    system raid add drive ssd2
    A summary similar to this example displays:
    appliance-1(config)# system raid add drive ssd2   
status Add RAID SSD2 initiated.
    The array status for the new drive should change to
    replicating
    , and the STAT LED should change to solid green. The replication process typically takes between 15 and 45 minutes.

General system configuration overview

You can configure general system settings for the
rSeries
 system, such as system hostname, login banner, message of the day (MOTD) banner, and appliance mode. Depending on which setting you want to configure, you can use either the CLI or the webUI.

Configure hostname, login banner, and MOTD from the webUI

You can configure the hostname, login banner, and a message of the day (MOTD) banner for the system from the webUI.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    General
    .
  3. For
    Hostname
    , enter a custom hostname for the system.
  4. For
    Login Banner
    , enter any text to be shown when users log in to the system.
  5. For
    MOTD Banner
    , enter any text to be used as a MOTD when users log in to the system.
  6. Click
    Save
    .

Appliance mode overview

You can run the system in
appliance mode
. Appliance mode adds a layer of security removing user access to Root and Bash. Enabling appliance mode disables all Root and Bash shell access for the system.
You can enable appliance mode at each of these levels:
  • System
  • Tenant
Appliance mode is disabled at all levels, by default. You can enable it from the webUI or the CLI. The appliance mode option for the system is available to users with admin access under
SYSTEM SETTINGS
General
 in the webUI. For tenants, it is available in the webUI under
TENANT MANAGEMENT
Tenant Deployments
.
These are the effects of enabling appliance mode at each of the different levels.
System-level appliance mode
  • Root or Bash access is disabled on the system.
  • Console access: Root or Bash access is disabled on the system. Users can log in to the system CLI from the console using an admin account.
Tenant appliance mode
  • Root access to the tenant is disabled by all means. Bash access is disabled for users (with a terminal shell flag enabled) inside the tenant.
  • Users can access the tenant only through the webUI or the CLI.
  • Tenant console access: Users can log in to the CLI from the virtual console using an admin account (with a terminal shell flag enabled).

Configure appliance mode from the webUI

You can enable or disable appliance mode from the webUI. Enable appliance mode to disable all root and Bash shell access.
The appliance mode option for tenants is available in the webUI under
TENANT MANAGEMENT
Tenant Deployments
.
  1. Log in to the webUI using an account with admin access.
  2. On the left, click
    SYSTEM SETTINGS
    General
    .
  3. For
    Appliance Mode
    , select
    Enabled
     to enable it, or
    Disabled
     to disable it.
    The default value is
    Disabled
    .
  4. Click
    Save
    .
Contact Support Contact Support

Have a Question?

Support and Sales >

About F5

Education

F5 Sites

Support Tasks




©2023 F5, Inc. All rights reserved.


Trademarks Policies Privacy California Privacy Do Not Sell My Personal Information