Schema Discovery

nbx groups --help

Command Output

nbx groups --help

nbx groups --help

 Usage: nbx groups [OPTIONS]                                                    

 List all available OpenAPI app groups.                                         

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

exit 0 3.824s

---

nbx resources --help

Command Output

nbx resources --help

nbx resources --help

 Usage: nbx resources [OPTIONS] GROUP                                           

 List resources available within a group.                                       

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    group      TEXT  OpenAPI app group, e.g. dcim [required]                │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

exit 0 3.502s

---

nbx ops --help

Command Output

nbx ops --help

nbx ops --help

 Usage: nbx ops [OPTIONS] GROUP RESOURCE                                        

 Show available HTTP operations for a resource.                                 

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    group         TEXT  [required]                                          │
│ *    resource      TEXT  [required]                                          │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

exit 0 3.565s

---

nbx groups

Command Output

nbx groups

nbx groups

circuits
core
dcim
extras
ipam
plugins
tenancy
users
virtualization
vpn
wireless

exit 0 3.592s

---

nbx resources dcim

Command Output

nbx resources dcim

nbx resources dcim

cable-terminations
cables
connected-device
console-port-templates
console-ports
console-server-port-templates
console-server-ports
device-bay-templates
device-bays
device-roles
device-types
devices
front-port-templates
front-ports
interface-templates
interfaces
inventory-item-roles
inventory-item-templates
inventory-items
locations
mac-addresses
manufacturers
module-bay-templates
module-bays
module-type-profiles
module-types
modules
platforms
power-feeds
power-outlet-templates
power-outlets
power-panels
power-port-templates
power-ports
rack-reservations
rack-roles
rack-types
racks
rear-port-templates
rear-ports
regions
site-groups
sites
virtual-chassis
virtual-device-contexts

exit 0 3.512s

---

nbx ops dcim devices

Command Output

nbx ops dcim devices

nbx ops dcim devices

                                  dcim/devices                                  
┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Method ┃ Path                             ┃ Operation ID                     ┃
┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ DELETE │ /api/dcim/devices/               │ dcim_devices_bulk_destroy        │
│ GET    │ /api/dcim/devices/               │ dcim_devices_list                │
│ PATCH  │ /api/dcim/devices/               │ dcim_devices_bulk_partial_update │
│ POST   │ /api/dcim/devices/               │ dcim_devices_create              │
│ PUT    │ /api/dcim/devices/               │ dcim_devices_bulk_update         │
│ DELETE │ /api/dcim/devices/{id}/          │ dcim_devices_destroy             │
│ GET    │ /api/dcim/devices/{id}/          │ dcim_devices_retrieve            │
│ PATCH  │ /api/dcim/devices/{id}/          │ dcim_devices_partial_update      │
│ PUT    │ /api/dcim/devices/{id}/          │ dcim_devices_update              │
│ POST   │ /api/dcim/devices/{id}/render-c… │ dcim_devices_render_config_crea… │
└────────┴──────────────────────────────────┴──────────────────────────────────┘

exit 0 3.549s

---

nbx resources ipam

Command Output

nbx resources ipam

nbx resources ipam

aggregates
asn-ranges
asns
fhrp-group-assignments
fhrp-groups
ip-addresses
ip-ranges
prefixes
rirs
roles
route-targets
service-templates
services
vlan-groups
vlan-translation-policies
vlan-translation-rules
vlans
vrfs

exit 0 3.543s

---