Cisco Nxos module

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

NX-OS REST API

Variable	Description	Status
NXOS_URL	Required for authentication.	required
NXOS_USERNAME	Required for authentication.	required
NXOS_PASSWORD	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave cisco_nxos --help
weave doctor   # reports NXOS_URL status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
bgp-peer	·	✓	·	·	·	·	·
interface	·	✓	·	·	·	·	·
inventory	·	·	·	·	✓	✓	✓
vlan	·	✓	·	·	·	·	·
vrf	·	✓	·	·	·	·	·

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

list (4)

list bgp-peers

read

List BGP peers.

weave cisco_nxos list bgp-peers <arg>

list interfaces

read

List interfaces.

weave cisco_nxos list interfaces <arg>

list vlans

read

List VLANs.

weave cisco_nxos list vlans <arg>

list vrfs

read

List VRFs.

weave cisco_nxos list vrfs <arg>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/cisco_nxos/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

inventory

snapshot diff apply

cisco_nxos inventory — field-level apply via REST.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: cisco_nxos
kind: inventory
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Inventory audit

Snapshot and diff inventory.

weave cisco_nxos snapshot inventory
$EDITOR .weave-state/cisco_nxos/inventory.yaml
weave cisco_nxos diff inventory
weave cisco_nxos apply inventory

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
cisco_nxos_inventory	weave cisco_nxos snapshot/diff/apply inventory Snapshot/diff for audit; confirm apply on the module page.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including NXOS_URL) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave cisco_nxos diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/cisco_nxos. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.