### Example Installation Response JSON

Source: https://my.f5.com/manage/s/article/K85454683?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK85454683

This is an example of the JSON response received after a POST request to install a use case pack. It shows the status and other details of the installation task.

```json
{
  "filePath":  
"/var/config/rest/downloads/f5-iappslx-agc-usecase-pack-7.0-0.0.1139.tar.gz",
  "toBeInstalledAppRpmsIndex": -1,
  "id": "49c61e18-46e4-4501-bc2d-a4833e93833c",
  "status": "CREATED",
  "userReference": {
    "link": "https://localhost/mgmt/shared/authz/users/admin"
  },
  "identityReferences": [
    {
      "link": "https://localhost/mgmt/shared/authz/users/admin"
    }
  ],
  "ownerMachineId": "3f365fd8-81f8-4312-b837-f0080119635a",
  "generation": 1,
  "lastUpdateMicros": 1510767727481955,
  "kind": "tm:access:bundle-install-tasks:iappbundleinstalltaskstate",
  "selfLink":  
"https://localhost/mgmt/tm/access/bundle-install-tasks/49c61e18-46e4-4501-bc2d-a4833e93833c”
}
```

--------------------------------

### Example: Install BIGIP-13.1.1-0.0.4.iso to HD1.2

Source: https://my.f5.com/manage/s/article/K78200141

This example demonstrates installing a specific ISO image to a newly created volume on a BIG-IP system. The command prompt returns immediately after execution, but the installation continues in the background.

```bash
curl -sku admin:testing -H "Content-Type: application/json" -X POST https://LTM1.example.com/mgmt/tm/sys/software/image -d '{"command":"install","name":"BIGIP-13.1.1-0.0.4.iso","volume":"HD1.2","options":[{"create-volume":true}]}' | jq -M .
```

--------------------------------

### Example of installing license and add-on keys

Source: https://my.f5.com/manage/s/article/K15055?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK15055

This is an example demonstrating the command syntax for installing both a base registration key and add-on keys in tmsh.

```bash
install /sys license registration-key ABCDE-ABCDE-ABCDE-ABCDE-ABCDEFG add-on-keys { ABCDEFG-ABCDEFG }
```

--------------------------------

### Manufacturing Installation Dialog Example

Source: https://my.f5.com/manage/s/article/K11687

This example shows the initial manufacturing installation dialog that appears when booting a BIG-IP system from a USB drive.

```text
info: Using repository; /cdserver
info: manufacturing plan for C106:
info: --- boot volume set is HD1.1
info: --- HD1.1 => BIG-IP 10.2.0 LTM.ROS.SAM.TS.WA.WOC
info: --- HD1.2 => BIG-IP 10.2.0 LTM.ROS.SAM.TS.WA.WOC
This is the manufacturing installation!
If you want to retain ANY data present on this system, do not continue.
Use <ctrl-c> to enter a Bash shell.
Press [Enter] to begin installation.
```

--------------------------------

### Example: Install EPSEC Package

Source: https://my.f5.com/manage/s/article/K48955220?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK48955220

An example showing how to install an EPSEC package using its name.

```bash
install /apm epsec epsec-package EPSEC/Upload/epsec-1.0.0-540.0.iso
```

--------------------------------

### Example of Installing BIG-IQ Device Key

Source: https://my.f5.com/manage/s/article/K73105542

This example demonstrates how to use the f5mku -r command with a specific key value to install the device key on the target BIG-IQ VE system.

```bash
f5mku -r oruIVCHfmVBnwGaSR/+MAA==
```

--------------------------------

### Example: Install BIG-IP Software

Source: https://my.f5.com/manage/s/article/K14558

Example command to install a BIG-IP software ISO to a specific slot (e.g., HD1.2).

```bash
image2disk --nosaveconfig --instslot=HD1.2 BIGIP-11.2.1.797.0.iso
```

--------------------------------

### Software Installation Status Example

Source: https://my.f5.com/manage/s/article/K78200141?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK78200141

This JSON output shows an example of the status when a software installation is in progress on a BIG-IP system.

```json
{
  "kind": "tm:sys:software:volume:volumestate",
  "name": "HD1.2",
  "fullPath": "HD1.2",
  "generation": 271,
  "selfLink": "https://localhost/mgmt/tm/sys/software/volume/HD1.2?ver=13.1.0",
  "basebuild": "0.0.4",
  "build": "0.0.4",
  "product": "BIG-IP",
  "status": "installing 36.000 pct",
  "version": "13.1.1"
}
```

--------------------------------

### Example: Install BIG-IP 10.0.0-10.2.3 on HD1.1

Source: https://my.f5.com/manage/s/article/K10819

Example command to install BIG-IP 10.0.0 through 10.2.3 on the 'HD1.1' slot from local media. The current configuration is not saved.

```bash
image2disk --instslot=HD1.1 --nosaveconfig
```

--------------------------------

### Example: Install BIG-IP Software from Mounted ISO

Source: https://my.f5.com/manage/s/article/K13117?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK13117

An example command to install BIG-IP software, specifying the path to the ISO file located on a mounted USB drive.

```bash
image2disk --format=volumes --nosaveconfig --nosavelicense /mnt/usb/BIGIP-RECOVERY-17.5.0-0.0.15.iso
```

--------------------------------

### Example: Install BIG-IP 10.2.4 using partitions

Source: https://my.f5.com/manage/s/article/K10819

Example command to install BIG-IP 10.2.4 using the 'partitions' disk format from local media. It ensures the current configuration and license are not saved.

```bash
image2disk --format=partitions --nosaveconfig --nosavelicense
```

--------------------------------

### Example Output of Client Installation

Source: https://my.f5.com/manage/s/article/K47922841

This is an example of the output you might see after successfully running the Install.sh script for older BIG-IP APM versions. It indicates the installation path and uninstaller location.

```text
Installation completed successfully  
--> f5fpc is installed in /usr/local/bin  
--> Please check f5fpc --help command to get started  
--> Uninstaller located in /usr/local/lib/F5Networks/uninstall_F5.sh
```

--------------------------------

### Example Verification Response JSON

Source: https://my.f5.com/manage/s/article/K85454683

This is an example of the JSON response received after a GET request to verify the installation of a use case pack. It details the status of installed RPMs and the use case pack version.

```json
{
   "filePath": "/var/config/rest/downloads/f5-iappslx-agc-usecase-pack-7.0-0.0.1139.tar.gz",
   "frameworkRpmInfo": {
   "name": "f5-iappslx-access-framework-1.4.0.0-0.0.876.noarch.rpm",
   "status": "INSTALLED",
   "error": ""
   },
   "appRpmsInfo": [
   {
   "name": "f5-iappslx-access-oauth-auth-server-4.1.0-0.0.876.noarch.rpm",
   "status": "INSTALLED",
   "error": ""
    },
    {
    "name": "f5-iappslx-access-oauth-client-rs-4.2.0-0.0.876.noarch.rpm",
    "status": "INSTALLED",
    "error": ""
    },
    {
    "name": "f5-iappslx-access-saml-idp-3.1.0-0.0.876.noarch.rpm",
     "status": "INSTALLED",
     "error": ""
     },
     {
     "name": "f5-iappslx-access-saml-sp-2.1.0-0.0.876.noarch.rpm",
     "status": "INSTALLED",
     "error": ""
     }
     ],
[...]
    **"usecasePackVersion": "7.0",**
[...]
}
```

--------------------------------

### Example: Add Rules to Startup File (Single System)

Source: https://my.f5.com/manage/s/article/K9143?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK9143

An example of the commands to add to the /config/startup file for a single system, using specific IP addresses and subnet.

```bash
ip rule add priority 245 from 10.10.10.10 lookup 245
ip route add 10.10.10.0/24 dev eth0 table 245
```

--------------------------------

### Verify BIG-IP Guided Configuration 7.0 Use Case Pack Installation

Source: https://my.f5.com/manage/s/article/K85454683

Example of verifying the installation of a specific use case pack for BIG-IP Guided Configuration 7.0 using curl. This helps confirm the 'usecasePackVersion'.

```bash
curl -k -u admin:C0mPlicatedP@ssword -X GET -d '{"filePath": "/var/config/rest/downloads/f5-iappslx-agc-usecase-pack-7.0-0.0.1481.tar.gz"}' -H 'Content-Type: application/json' https://10.10.1.1/mgmt/tm/access/bundle-install-tasks | jq
```

--------------------------------

### Install BIG-IP Guided Configuration 7.0 Use Case Pack

Source: https://my.f5.com/manage/s/article/K85454683

Example of installing a specific use case pack for BIG-IP Guided Configuration 7.0 using curl. Includes authentication, file path, and content type.

```bash
curl -k -u admin:C0mPlicatedP@ssword -X POST -d '{"filePath": "/var/config/rest/downloads/f5-iappslx-agc-usecase-pack-7.0-0.0.1481.tar.gz"}' -H 'Content-Type: application/json' https://10.10.1.1/mgmt/tm/access/bundle-install-tasks | jq
```

--------------------------------

### Example: Install OPSWAT EPSEC package

Source: https://my.f5.com/manage/s/article/K10942?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK10942

An example of installing an EPSEC package using its specific name.

```bash
install /apm epsec epsec-package EPSEC/Images/epsec-1.0.0-420.0.iso
```

--------------------------------

### BIOS SETUP Screen Example

Source: https://my.f5.com/manage/s/article/K9399

This example shows the BIOS SETUP screen, specifically the 'Exit Options' and 'Load Optimal Defaults' sections. This screen is accessed by pressing the DEL key during boot after resetting the host.

```text
Main    Advanced    PCIPnP    Boot    Security    Chipset    Power    Exit*********************************************************************************
Exit Options                                        * Load Optimal Default   **
*************************************************** * values for all the     **
Save Changes and Exit                               * setup questions.       **
Discard Changes and Exit                            *                        **
Discard Changes                                     * F9 key can be used     **
                                                    * for this operation.    **
Load Optimal Defaults                               *                        **
                                                    *                        **
                                                    *                        **
                                                    *                        **
                                                    *                        **
                                                    *                        **
                                                    *                        **
                                                    *                        **
                                                    *                        **
                                                    *                        **
    Select Screen    **                                                     *
    Select Item      **                                                     *
Enter Go to Sub Screen **                                                     *
F1    General Help     **                                                     *
F10   Save and Exit    **                                                     *
ESC   Exit             **                                                     *
                                                    **
                                                    **
*********************************************************************************
           v02.57 (C)Copyright 1985-2004, American Megatrends, Inc.
```

--------------------------------

### MOS Installation Output Example

Source: https://my.f5.com/manage/s/article/K11774

This is an example of the output that the BIG-IP system may display during the MOS installation process.

```text
info: No MOS currently exists. Installing 2.6.0 - 234.0
```

--------------------------------

### BIG-IQ Live Install Log Example

Source: https://my.f5.com/manage/s/article/K40338232

An example of the '/var/log/liveinstall.log' file showing boot markers, indicating the system booted to an older version after the upgrade attempt.

```log
*** Live install end at 2016/06/07 14:40:01: succeeded ***  
2016-06-07T14:47:45-07:00 bigiq notice boot_marker : ---===[ MD1.2 - BIG-IQ 4.6.0 Build 0.0.119 <MD1.2> ]===---  
2016-06-07T14:52:13-07:00 localhost notice boot_marker : ---===[ MD1.3 - BIG-IQ 5.0.0 Build 0.0.3026 <MD1.3>]===---
```

--------------------------------

### Example: Hotfix Installation Status Output

Source: https://my.f5.com/manage/s/article/K13123

This output example illustrates the status of hotfix installations, showing details like volume, product version, build, and installation status.

```text
-----------------------------------------------------------------------------
Sys::Software Status  
Volume Product Version Build Active Status Allowed Version  
-----------------------------------------------------------------------------
HD1.1 BIG-IP 16.1.4 0.0.2 yes complete yes  
HD1.2 BIG-IP 16.1.4.1 0.50.5 no complete yes  
HD1.3 BIG-IP 16.1.4.1 0.50.5 no installing hotfix yes
```

--------------------------------

### Complete NTP Configuration Example

Source: https://my.f5.com/manage/s/article/K98582354?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK98582354

A fully configured NTP setup example, demonstrating the correct syntax for specifying NTPv3 servers and timezone.

```bash
modify sys ntp {
description none
include "
server 10.1.1.1 version 3
server 10.1.1.2 version 3
server 10.1.1.3 version 3
"
restrict none
servers { none}
timezone America/Los_Angeles
}
```

--------------------------------

### Example: Install BIG-IP Hotfix

Source: https://my.f5.com/manage/s/article/K14558

Example command to install a BIG-IP hotfix ISO to a specific slot (e.g., HD1.1).

```bash
image2disk --hotfix --nosaveconfig --instslot=HD1.1 Hotfix-BIGIP-11.1.0-2027.0-HF2.iso
```

--------------------------------

### Example: Create Configuration Backup

Source: https://my.f5.com/manage/s/article/K50135154?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK50135154

An example of how to back up the configuration data to a file named 'mybackup.backup' using the command line.

```bash
system database config-backup name mybackup.backup
```

--------------------------------

### GRUB Configuration Example

Source: https://my.f5.com/manage/s/article/K14663

This is an example of a GRUB configuration file, showing how boot options are defined using menuentry stanzas.

```grub
set default=0
set timeout=5

menuentry "BIG-IP 11.3.0 Build 2806.0 <MD1.1>" {
  set root='(hd0,gpt1)'
  linux /boot/1/vmlinuz ro root=/dev/mapper/vg--system-lv--root console=ttyS0 panic=1 platform=D110 quiet
  initrd /boot/1/initrd
}

menuentry "BIG-IP 11.4.0 Build 2384.0 <MD1.2>" {
  set root='(hd0,gpt1)'
  linux /boot/2/vmlinuz ro root=/dev/mapper/vg--system-lv--root console=ttyS0 panic=1 platform=D110 quiet
  initrd /boot/2/initrd
}

menuentry "End User Diagnostics" {
  set root='(hd0,gpt1)'
  linux /boot/diag/vmlinuz ""
  initrd /boot/diag/initrd
}

menuentry "TMOS maintenance" {
  set root='(hd0,gpt1)'
  linux /boot/tm-maintenance/vmlinuz ""
  initrd /boot/tm-maintenance/initrd
}
```

--------------------------------

### Example: Install Hotfix on HD1.1

Source: https://my.f5.com/manage/s/article/K13123

This example shows the command syntax for installing a specific hotfix ISO to the HD1.1 volume.

```bash
install sys software hotfix Hotfix-BIGIP-16.1.4.1.0.50.5-ENG.iso volume HD1.1
```

--------------------------------

### Example: Create Network Access Webtop

Source: https://my.f5.com/manage/s/article/K41512047?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK41512047

An example of creating a Network Access webtop named 'simple-vpn' in the Common partition.

```bash
POST /mgmt/tm/apm/resource/webtop -d '{"name":"simple-vpn","customizationGroup":"/Common/simple-vpn_customization","webtopType":"network-access"}'
```

--------------------------------

### GRUB Boot Menu Example

Source: https://my.f5.com/manage/s/article/K000134739?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK000134739

This example shows the GRUB boot menu where you can select an entry to edit its boot options.

```text
CentOS Linux 7 (Core) (ostree:0) <---enter **e** to edit this first boot image  
CentOS Linux 7 (Core) (ostree:1)  


Use the ^ and v keys to change the selection.  
Press 'e' to edit the selected item, or 'c' for a command prompt.
```

--------------------------------

### HTTP 1.0 GET Request Example

Source: https://my.f5.com/manage/s/article/K13397?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK13397

Example of an HTTP 1.0 GET request line for a BIG-IP DNS monitor Send String.

```http
GET /index.html HTTP/1.0

```

--------------------------------

### GRUB Kernel Command Example

Source: https://my.f5.com/manage/s/article/K10452

This example shows a typical kernel command line with parameters for booting the BIG-IP system.

```text
kernel /boot/1/vmlinuz ro root=UUID=2c3f024c-ff84-499b-8466-0a189963c55d console=ttyS0 panic=1 platform=Mercury quiet
```

--------------------------------

### Example of EPSEC Image Installation Failure

Source: https://my.f5.com/manage/s/article/K61214360

This example shows the command that triggers the error when the EPSEC image installation fails due to a missing folder.

```bash
(Active)(/Common)(tmos)# install /apm epsec epsec-package epsec-1.0.0-840.0.iso
```

--------------------------------

### Example UCS Install Error Message

Source: https://my.f5.com/manage/s/article/K3499?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK3499

This is an example of an error message that may appear during UCS archive installation, particularly related to licensing or decryption failures.

```text
b config install /var/local/ucs/backup.ucs
Installing full configuration on host bigip1.askf5.com
Saving active configuration...
Creating UCS for config save request...
Dec 8 12:00:00 bigip1 mcpd[2395]: 01070608:0: License is not operational  
(expired or digital signature does not match contents).
Loading the new /config/BigDB.dat failed.
01080023:3: Error return while getting reply from mcpd: 0x1070370,  
01070370:3: Failover (redundant mode) is not licensed.  
After updating your license, run  
loaddb -local /config/BigDB.dat.cs
```

--------------------------------

### Example SSH Public Key Installation

Source: https://my.f5.com/manage/s/article/K13454

An example of using the ssh-copy-id command to install a public key for 'user1' on a remote system with IP address 192.0.2.121.

```bash
ssh-copy-id user1@192.0.2.121
```

--------------------------------

### Software Installation Status Example 2

Source: https://my.f5.com/manage/s/article/K24826954?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK24826954

This output provides an updated view of software installation statuses, showing varying percentages of completion for ongoing installations.

```text
+------------------------------------------------------------------------------+
| Volume Slot Product Version Build Active Status |
+------------------------------------------------------------------------------+
| HD1.1 1 BIG-IP 11.1.0 1943.0 no complete |
| HD1.1 2 BIG-IP 11.1.0 1943.0 no complete |
| HD1.1 3 BIG-IP 11.1.0 1943.0 yes complete |
| HD1.2 1 BIG-IP 11.2.1 797.0 yes complete |
| HD1.2 2 BIG-IP 11.2.1 797.0 no complete |
| HD1.2 3 BIG-IP 11.2.1 797.0 no installing  
10.000 pct |
| HD1.3 1 BIG-IP 10.2.4 577.0 no complete |
| HD1.3 2 BIG-IP 10.2.4 577.0 no complete |
| HD1.3 3 BIG-IP 10.2.4 577.0 no complete |
+------------------------------------------------------------------------------+
```

--------------------------------

### Example: Get F5OS-C Software Version for blade-1

Source: https://my.f5.com/manage/s/article/K62132391?nocache=https%3A%2F%2Fmy.f5.com%2Fmanage%2Fs%2Farticle%2FK62132391

This is an example of the `curl` command to get the F5OS-C version for 'blade-1' on a VELOS partition with management IP '192.168.8.81'.

```bash
curl -X GET -H "Content-Type: application/yang-data+json" -sku admin:admin "https**:** //192.168.8.81/api/data/openconfig-platform:components/component=blade-1/f5-platform:software"
```