F5 Product Documentation

https://my.f5.com
Admin
This repository contains documentation, release notes, and download information for various F5...
Tokens:14,277,307
Snippets:92,755
Trust Score:10
Update:19 hours ago
Show doc for...
Tokens:
Raw
### Example output for installed component update files

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

Example JSON output from the installations endpoint, showing two items with statuses 'new' and 'install-complete'.

```json
{ 
  "kind": "tm:live-update:browser-challenges:installations-collectionstate", 
  "totalItems": 2, 
  "selfLink": "https://localhost/mgmt/tm/live-update/browser-challenges/installations", 
  "items": [ 
    { 
      "id": "ff8080817145a0b7017145a1800b0003", 
      "lastUpdateMicros": 1586011144194000, 
      "updateFileReference": { 
        "link": "https://localhost/mgmt/tm/live-update/browser-challenges/update-files/ff8080817145a0b7017145a17fee0002" 
      }, 
      "status": "new", 
      "kind": "tm:live-update:browser-challenges:installationsstate", 
      "selfLink": "https://localhost/mgmt/tm/live-update/browser-challenges/installations/ff8080817145a0b7017145a1800b0003" 
    }, 
    { 
      "id": "ff8080817141275f01714127646f0017", 
      "lastUpdateMicros": 1585936032877000, 
      "loadDateTime": "2020-01-10T19:46:53Z", 
      "updateFileReference": { 
        "link": "https://localhost/mgmt/tm/live-update/browser-challenges/update-files/ff8080817141275f0171412762c50011" 
      }, 
      "status": "install-complete", 
      "kind": "tm:live-update:browser-challenges:installationsstate", 
      "selfLink": "https://localhost/mgmt/tm/live-update/browser-challenges/installations/ff8080817141275f01714127646f0017" 
    } 
  ] 
}
```

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

### Example start f5fpc connection with certificate validation (long form)

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

Example using the long form with https://example.com.

```bash
f5fpc --start --host https://example.com
```

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

### Example: Install host ISO image using tmsh

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

Example command to install the BIG-IP 11.3.0.2806.0 ISO image on volume HD1.1.

```tmsh
(tmos) # install sys software block-device-image BIGIP-11.3.0.2806.0.iso volume HD1.1
```

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

### tmsh install /sys software image example

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

Example command to install BIG-IP 17.5.1.3 to new volume HD1.2. The 'create-volume' option creates a new boot location.

```bash
install /sys software image BIGIP-17.5.1.3-0.0.19.iso volume HD1.2 create-volume
```

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

### Example output of installed packages

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

Example output showing the 'release' attribute with the software version (e.g., 3.0.260).

```text
mgmt shared iapp installed-packages 9beb912b-4f1c-3f95-94c3-eb1cbac4ab99 { 
     appName "f5-iappslx-ssl-orchestrator" 
     arch "noarch" 
     generation 4 
     id "9beb912b-4f1c-3f95-94c3-eb1cbac4ab99" 
     kind "shared:iapp:installed-packages:installedpackagestate" 
     lastUpdateMicros 1552292670128245 
     packageName "f5-iappslx-ssl-orchestrator-13.1.0-3.0.260.noarch" 
     **release "3.0.260"** 
     selfLink "[https://localhost/mgmt/shared/iapp/installed-packages/9beb912b-4f1c-3f95-94c3-eb1cbac4ab99](https://localhost/mgmt/shared/iapp/installed-packages/9beb912b-4f1c-3f95-94c3-eb1cbac4ab99)" 
     status "READY" 
     tags { 
         "IAPP" 
     } 
     version "13.1.0" 
 }
```

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

### Example: Install base registration key and add-on key

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

Example command showing how to install a base registration key and an add-on key together.

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

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

### curl GET request example for BIG-IP Guided Configuration 7.0

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

Example curl command to verify the installation of the use case pack for BIG-IP Guided Configuration 7.0. Replace the admin password and IP address with your own credentials and BIG-IP address.

```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
```

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

### Example: Install license with registration key and add-on key

Source: https://my.f5.com/manage/MyF5_KnowledgeArticlePDF?article=K15055

Example command showing how to install a license with a registration key and an add-on key.

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

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

### Example curl command for BIG-IP Guided Configuration 7.0

Source: https://my.f5.com/manage/MyF5_KnowledgeArticlePDF?article=K85454683

Concrete example that installs the use case pack for BIG-IP Guided Configuration 7.0. Replace the admin credentials and IP address with your own.

```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
```

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

### curl POST example for BIG-IP Guided Configuration 7.0

Source: https://my.f5.com/manage/MyF5_KnowledgeArticlePDF?article=K85454683

Example curl command to install the use case pack for BIG-IP Guided Configuration 7.0. Replace the admin credentials and IP address with your own.

```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
```

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

### Installation output example

Source: https://my.f5.com/manage/MyF5_KnowledgeArticlePDF?article=K47922841

Example output after running Install.sh, indicating successful installation and the location of f5fpc.

```text
Installation completed successfully
--> f5fpc is installed in /usr/local/bin
```

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

### Install example_2017.crt

Source: https://my.f5.com/manage/MyF5_KnowledgeArticlePDF?article=K15462

Example command to import the SSL certificate and name it example_2017.crt.

```bash
install sys crypto cert example_2017.crt from-editor
```

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

### Output of listing Browser Challenges installations

Source: https://my.f5.com/manage/MyF5_KnowledgeArticlePDF?article=K58021531

Example JSON output from the GET installations command, showing two installed update files with statuses 'new' and 'install-complete'.

```json
{
"kind": "tm:live-update:browser-challenges:installations-collectionstate",
"totalItems": 2,
"selfLink": "https://localhost/mgmt/tm/live-update/browser-challenges/installations",
"items": [
{
"id": "ff8080817145a0b7017145a1800b0003",
"lastUpdateMicros": 1586011144194000,
"updateFileReference": {
"link": "https://localhost/mgmt/tm/live-update/browser-challenges/update-files/ff8080817145a0b7017145a17fee0002"
},
"status": "new",
"kind": "tm:live-update:browser-challenges:installationsstate",
"selfLink": "https://localhost/mgmt/tm/live-update/browser-challenges/installations/ff8080817145a0b7017145a1800b0003"
},
{
"id": "ff8080817141275f01714127646f0017",
"lastUpdateMicros": 1585936032877000,
"loadDateTime": "2020-01-10T19:46:53Z",
"updateFileReference": {
"link": "https://localhost/mgmt/tm/live-update/browser-challenges/update-files/ff8080817141275f0171412762c50011"
},
"status": "install-complete",
"kind": "tm:live-update:browser-challenges:installationsstate",
"selfLink": "https://localhost/mgmt/tm/live-update/browser-challenges/installations/ff8080817141275f01714127646f0017"
}
]
}
```

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

### Example startup entries for single system

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

Example of the startup entries with specific IP addresses.

```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
```

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

### Sample JSON response from bundle-install-tasks

Source: https://my.f5.com/manage/MyF5_KnowledgeArticlePDF?article=K85454683

Example response showing installation status of framework and app RPMs, and the usecasePackVersion field to verify the installed version of BIG-IP Guided Configuration.

```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",
[...]

}
```
Tokens:
Raw