Skip to content

Set-PveClusterSdnZones

Update sdn zone object configuration.

API: PUT /cluster/sdn/zones/{zone}, Proxmox VE API viewer

Set-PveClusterSdnZones
[-PveTicket <PveTicket>]
[-AdvertiseSubnets <bool>]
[-Bridge <string>]
[-BridgeDisableMacLearning <bool>]
[-Controller <string>]
[-Delete <string>]
[-Dhcp <string>]
[-Digest <string>]
[-DisableArpNdSuppression <bool>]
[-Dns <string>]
[-Dnszone <string>]
[-DpId <int>]
[-Exitnodes <string>]
[-ExitnodesLocalRouting <bool>]
[-ExitnodesPrimary <string>]
[-Fabric <string>]
[-Ipam <string>]
[-LockToken <string>]
[-Mac <string>]
[-Mtu <int>]
[-Nodes <string>]
[-Peers <string>]
[-Reversedns <string>]
[-RtImport <string>]
[-SecondaryControllers <array>]
[-Tag <int>]
[-VlanProtocol <string>]
[-VrfVxlan <int>]
[-VxlanPort <int>]
-Zone <string>
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-AdvertiseSubnets bool No Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes).
-Bridge string No The bridge for which VLANs should be managed.
-BridgeDisableMacLearning bool No Disable auto mac learning.
-Controller string No Controller for this zone.
-Delete string No A list of settings you want to delete.
-Dhcp string No Type of the DHCP backend for this zone. Values: dnsmasq.
-Digest string No Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
-DisableArpNdSuppression bool No Suppress IPv4 ARP && IPv6 Neighbour Discovery messages.
-Dns string No dns api server.
-Dnszone string No dns domain zone ex: mydomain.com.
-DpId int No Faucet dataplane id.
-Exitnodes string No List of cluster node names.
-ExitnodesLocalRouting bool No Allow exitnodes to connect to EVPN guests.
-ExitnodesPrimary string No Force traffic through this exitnode first.
-Fabric string No SDN fabric to use as underlay for this VXLAN zone.
-Ipam string No use a specific ipam.
-LockToken string No the token for unlocking the global SDN configuration.
-Mac string No Anycast logical router mac address.
-Mtu int No MTU of the zone, will be used for the created VNet bridges.
-Nodes string No List of cluster node names.
-Peers string No Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes.
-Reversedns string No reverse dns api server.
-RtImport string No List of Route Targets that should be imported into the VRF of the zone.
-SecondaryControllers array No Additional controllers.
-Tag int No Service-VLAN Tag (outer VLAN)
-VlanProtocol string No Which VLAN protocol should be used for the creation of the QinQ zone. Values: 802.1q, 802.1ad.
-VrfVxlan int No VNI for the zone VRF.
-VxlanPort int No UDP port that should be used for the VXLAN tunnel (default 4789).
-Zone string Yes The SDN zone object identifier.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.