IP Fabric

https://docs.ipfabric.io/latest/
Admin
IP Fabric is an automated network assurance and infrastructure management platform that provides...
Tokens:648,210
Snippets:4,921
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Configure Extension Environment Variables

Source: https://docs.ipfabric.io/latest/IP_Fabric_GUI/extensions?q=

Example format for defining environment variables in the Extension Setup form, using KEY=VALUE pairs on separate lines.

```text
API_KEY=your-secret-key
DATABASE_URL=postgresql://localhost:5432/mydb
DEBUG=true
```

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

### upgrade-local example

Source: https://docs.ipfabric.io/latest/System_Administration/Command_Line_Interface/How_to/upgrade_CLI

Example of the upgrade-local command with a specific package path.

```bash
/opt/ipf-system-upgrade/bin/cli upgrade-local /tmp/ipfabric-update-7-11-10.tar.zst.sig

```

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

### Snapshot List Output Example

Source: https://docs.ipfabric.io/latest/System_Administration/Command_Line_Interface/How_to/backup_restore_CLI

Example output when listing snapshots.

```bash
root@system-backup:/# sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l snapshots
Nov 18 13:54:14 [INFO] Backup destination: local
Nov 18 13:54:14 [INFO] Storage status: OK
Nov 18 13:54:14 [INFO] Removing temp backup files.
Nov 18 13:54:15 [INFO] Local backup DB same as online list

## LIST ##
snapshot-e71519b9-b7fc-488d-841f-67983a12f6af; 2024-11-18T13:49:28
snapshot-e09c6b70-b232-4dd1-bec9-97ad1f96d40c; 2024-11-18T13:49:28
snapshot-d49e9715-3eb3-4b21-b41f-1ef9b6c5bead; 2024-11-18T13:49:28
snapshot-ab7e4ed6-e07f-47d0-8d95-a7581ec29acc; 2024-11-18T13:49:28
snapshot-45cf7507-ab1e-42f2-a18d-0ae26d5f4e61; 2024-11-18T13:49:28
snapshot-41844ce8-cc7a-4b60-b4a5-c59149e42d69; 2024-11-18T13:49:28
snapshot-12dd8c61-129c-431a-b98b-4c9211571f89; 2024-11-18T13:49:28
## LIST END ##
```

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

### Full Backup List Output Example

Source: https://docs.ipfabric.io/latest/System_Administration/Command_Line_Interface/How_to/backup_restore_CLI

Example output when listing full backups.

```bash
root@system-backup:/# sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l backup
Nov 18 13:54:02 [INFO] Backup destination: local
Nov 18 13:54:02 [INFO] Storage status: OK
Nov 18 13:54:02 [INFO] Removing temp backup files.

## LIST ##
backup-Full; 2024-11-18T13:49:28
## LIST END ##
```

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

### Database Backup List Output Example

Source: https://docs.ipfabric.io/latest/System_Administration/Command_Line_Interface/How_to/backup_restore_CLI

Example output when listing database backups.

```bash
root@system-backup:/# sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -l postgresdb
Nov 18 13:54:30 [INFO] Backup destination: local
Nov 18 13:54:30 [INFO] Storage status: OK
Nov 18 13:54:30 [INFO] Removing temp backup files.
Nov 18 13:54:31 [INFO] Local backup DB same as online list

## LIST ##
postgresdb-test-10640358365-20250711-1026-7_5_0+0; 2025-07-11T10:26:46
## LIST END ##
```

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

### Restore Database Command Example

Source: https://docs.ipfabric.io/latest/System_Administration/Command_Line_Interface/How_to/backup_restore_CLI

Example command to restore the database.

```bash
sudo -u autoboss /opt/nimpee/sys-backup-duplicity.sh -r postgresdb-test-10640358365-20250711-1026-7_5_0+0 -d 2025-07-11T10:26:46
```

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

### Full backup file example

Source: https://docs.ipfabric.io/latest/IP_Fabric_Settings/system/Backup_and_Maintenance/system_backup?q=

Example of the files generated during a full backup process.

```text
-rw-r--r-- 1 root root  54M Sep 27 11:14 ipfabric-94c370c9-duplicity-full.20230927T111440Z.vol1.difftar.gpg
-rw-r--r-- 1 root root 3.3M Sep 27 11:14 ipfabric-94c370c9-duplicity-full-signatures.20230927T111440Z.sigtar.gpg
-rw-r--r-- 1 root root  62K Sep 27 11:14 ipfabric-94c370c9-duplicity-full.20230927T111440Z.manifest.gpg
```

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

### Establish Support VPN: Start VPN with nimpee-support-vpn

Source: https://docs.ipfabric.io/latest/support/support_vpn?q=

Final step of the CLI workflow to establish the support VPN. Run the command as the autoboss user to start the VPN connection. This command must be executed after switching to root.

```bash
sudo -u autoboss nimpee-support-vpn start
```

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

### Example: show vlan and show spanning-tree vlan detail output

Source: https://docs.ipfabric.io/latest/support/known_issues/Vendors/arista

Example output from Arista EOS showing VLANs and spanning tree details. The 'show spanning-tree vlan detail' command stops when it encounters VLAN 2 (BAD_VLAN) which is not assigned to any ports, resulting in incomplete path lookups.

```text
arista#show vlan
VLAN  Name                             Status    Ports
----- -------------------------------- --------- -------------------------------
1     default                          active
2     BAD_VLAN                         active
5     GOOD_VLAN                        active    Et1, Et2
arista#sho span vlan det
Spanning tree instance for vlan 1
 VL1 is executing the rapid-pvst Spanning Tree protocol
  Bridge Identifier has priority 4096, sysid 1, address 0000.0000.0000
  Configured hello time 2.000, max age 20, forward delay 15, transmit hold-count 6
  We are the root of the spanning tree


No spanning tree information available for vlan 2

```

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

### Expected output of grep http2 (SA-495)

Source: https://docs.ipfabric.io/latest/support/security_bulletins

Example output from the grep command, showing the nginx configuration lines that contain 'http2'.

```bash
osadmin@ipfabric-632:~$ sudo grep "http2" /etc/nginx/sites-enabled/*
/etc/nginx/sites-enabled/ipf-frontend:    listen 443 ssl http2;
/etc/nginx/sites-enabled/ipf-nimpee-update: listen 8443 ssl http2;

```

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

### Check OMP route counts with show sdwan omp summary

Source: https://docs.ipfabric.io/latest/support/known_issues/Vendors/cisco/Viptela_cEdge_omp_limit?q=

Use this command on a cEdge device to verify if the router exceeded the 4000-route limit. The output shows the number of routes received, installed, and sent, along with multicast route counts.

```bash
cEdge1#show sdwan omp summary | inc routes-
routes-received 4144
routes-installed 40
routes-sent 4084
mcast-routes-received 0
mcast-routes-installed 0
mcast-routes-sent 0

```

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

### show vlan and show spanning-tree vlan detail output for unassigned VLAN

Source: https://docs.ipfabric.io/latest/support/known_issues/Vendors/arista?q=

Example output from Arista EOS showing a VLAN (2) not assigned to any ports, and the spanning-tree detail command returning 'No spanning tree information available' for that VLAN. This triggers the discovery task stop issue.

```text
arista#show vlan
VLAN  Name                             Status    Ports
----- -------------------------------- --------- -------------------------------
1     default                          active
2     BAD_VLAN                         active
5     GOOD_VLAN                         active    Et1, Et2
arista#sho span vlan det
Spanning tree instance for vlan 1
 VL1 is executing the rapid-pvst Spanning Tree protocol
  Bridge Identifier has priority 4096, sysid 1, address 0000.0000.0000
  Configured hello time 2.000, max age 20, forward delay 15, transmit hold-count 6
  We are the root of the spanning tree


No spanning tree information available for vlan 2

```

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

### URL configuration example

Source: https://docs.ipfabric.io/latest/IP_Fabric_Settings/administration/sso?q=

Example showing the required URL updates for the app, web, and dex sections using the system FQDN.

```json
{
  "app": {
    "url": "https://demo.ipfabric.io/api"
  },
  "web": {
    "url": "https://demo.ipfabric.io"
  },
  "dex": {
    "url": "https://demo.ipfabric.io/dex"
  }
}
```

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

### Run ipf-sso-setup-helper script

Source: https://docs.ipfabric.io/latest/IP_Fabric_Settings/administration/sso

Start the automated SSO setup script from the CLI. It is pre-installed on IP Fabric version 7.2.X and guides through the configuration process.

```bash
ipf-sso-setup-helper
```

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

### Install ipfabric with optional dependencies

Source: https://docs.ipfabric.io/latest/integrations/python

Installs the ipfabric SDK with optional dependencies. `pd` enables Pandas DataFrame support, `cli` adds requirements for CLI tools, `examples` adds requirements for example scripts. Multiple extras can be specified.

```bash
pip install "ipfabric[pd]~=6.8"

```

```bash
pip install "ipfabric[cli]~=6.8"

```

```bash
pip install "ipfabric[examples]~=6.8"

```

```bash
pip install "ipfabric[pd,cli]~=6.8"

```

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

### Enable Debian system repositories

Source: https://docs.ipfabric.io/latest/System_Administration/Command_Line_Interface/How_to/add_system_repositories

Run this script to prepare /etc/apt/sources.list with the Debian system repositories configuration. The default content of /etc/apt/sources.list is either empty or a banner asking the user to place configuration in /etc/apt/sources.list.d/ depending on the first version deployed.

```bash
/opt/ipf-debian-repositories/bin/ipf-debian-repositories.sh
```

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

### Install python-ipfabric matching IP Fabric version

Source: https://docs.ipfabric.io/latest/IP_Fabric_API/Path_Lookup?q=

Use pip to install the ipfabric package with a version matching your IP Fabric release. For example, for IP Fabric 6.4, use `pip install -U ipfabric==6.4.*`.

```bash
pip install -U ipfabric==6.4.*
```

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

### Example .env file with token authentication

Source: https://docs.ipfabric.io/latest/integrations/nornir

Sample .env file contents for token-based authentication. Replace values with your environment.

```ini
IPF_URL="https://demo3.ipfabric.io"
IPF_TOKEN=TOKEN
IPF_VERIFY=true

```

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

### Example response from API version endpoint

Source: https://docs.ipfabric.io/latest/integrations/python

Example JSON response showing `apiVersion` and `releaseVersion` fields. Used to confirm the API version before installing a matching SDK.

```json
{
  "apiVersion": "v6.8",
  "releaseVersion": "6.8.6+0"
}

```

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

### Unicast Path Lookup Example Prompts

Source: https://docs.ipfabric.io/latest/IP_Fabric_Settings/integration/mcp

Example prompts for the ipf_pathlookup_unicast tool. Use these to trace the path between two IP addresses and get structured path data.

```text
Show me the path from 10.0.1.5 to 10.0.2.10
Why can't 192.168.1.100 reach 172.16.0.50?
```
Tokens:
Raw