nodes / sdn
12 operations.
GET /nodes/{node}/sdn
ts
proxmox.nodes.$(node).sdn.$get()SDN index.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/sdn/fabrics/{fabric}
ts
proxmox.nodes.$(node).sdn.fabrics.$(fabric).$get()Directory index for SDN fabric status.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
fabric | string | yes | Identifier for SDN fabrics — format pve-sdn-fabric-id, ≤ 8 chars |
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/sdn/fabrics/{fabric}/interfaces
ts
proxmox.nodes.$(node).sdn.fabrics.$(fabric).interfaces.$get()Get all interfaces for a fabric.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
fabric | string | yes | Identifier for SDN fabrics — format pve-sdn-fabric-id, ≤ 8 chars |
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/sdn/fabrics/{fabric}/neighbors
ts
proxmox.nodes.$(node).sdn.fabrics.$(fabric).neighbors.$get()Get all neighbors for a fabric.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
fabric | string | yes | Identifier for SDN fabrics — format pve-sdn-fabric-id, ≤ 8 chars |
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/sdn/fabrics/{fabric}/routes
ts
proxmox.nodes.$(node).sdn.fabrics.$(fabric).routes.$get()Get all routes for a fabric.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
fabric | string | yes | Identifier for SDN fabrics — format pve-sdn-fabric-id, ≤ 8 chars |
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/sdn/vnets/{vnet}
ts
proxmox.nodes.$(node).sdn.vnets.$(vnet).$get()Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
vnet | string | yes | The SDN vnet object identifier. — ≤ 8 chars |
GET /nodes/{node}/sdn/vnets/{vnet}/mac-vrf
ts
proxmox.nodes.$(node).sdn.vnets.$(vnet)["mac-vrf"].$get()Get the MAC VRF for a VNet in an EVPN zone.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
vnet | string | yes | The SDN vnet object identifier. — ≤ 8 chars |
GET /nodes/{node}/sdn/zones
ts
proxmox.nodes.$(node).sdn.zones.$get()Get status for all zones.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/sdn/zones/{zone}
ts
proxmox.nodes.$(node).sdn.zones.$(zone).$get()Directory index for SDN zone status.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
zone | string | yes | The SDN zone object identifier. — ≤ 8 chars |
GET /nodes/{node}/sdn/zones/{zone}/bridges
ts
proxmox.nodes.$(node).sdn.zones.$(zone).bridges.$get()Get a list of all bridges (vnets) that are part of a zone, as well as the ports that are members of that bridge.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
zone | string | yes | zone name or "localnetwork" |
GET /nodes/{node}/sdn/zones/{zone}/content
ts
proxmox.nodes.$(node).sdn.zones.$(zone).content.$get()List zone content.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
zone | string | yes | The SDN zone object identifier. — ≤ 8 chars |
GET /nodes/{node}/sdn/zones/{zone}/ip-vrf
ts
proxmox.nodes.$(node).sdn.zones.$(zone)["ip-vrf"].$get()Get the IP VRF of an EVPN zone.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
zone | string | yes | Name of an EVPN zone. |