Skip to content

Set-PveClusterSdnControllers

Update sdn controller object configuration.

API: PUT /cluster/sdn/controllers/{controller}, Proxmox VE API viewer

Set-PveClusterSdnControllers
[-PveTicket <PveTicket>]
[-Asn <long>]
[-BgpMode <string>]
[-BgpMultipathAsPathRelax <bool>]
-Controller <string>
[-Delete <string>]
[-Digest <string>]
[-Ebgp <bool>]
[-EbgpMultihop <int>]
[-Fabric <string>]
[-IsisDomain <string>]
[-IsisIfaces <string>]
[-IsisNet <string>]
[-LockToken <string>]
[-Loopback <string>]
[-Node <string>]
[-Nodes <string>]
[-PeerGroupName <string>]
[-Peers <string>]
[-RouteMapIn <string>]
[-RouteMapOut <string>]
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Asn long No autonomous system number.
-BgpMode string No Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. Values: auto, external, internal.
-BgpMultipathAsPathRelax bool No Consider different AS paths of equal length for multipath computation.
-Controller string Yes The SDN controller object identifier.
-Delete string No A list of settings you want to delete.
-Digest string No Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
-Ebgp bool No Enable eBGP (remote-as external).
-EbgpMultihop int No Set maximum amount of hops for eBGP peers.
-Fabric string No SDN fabric to use as underlay for this EVPN controller.
-IsisDomain string No Name of the IS-IS domain.
-IsisIfaces string No Comma-separated list of interfaces where IS-IS should be active.
-IsisNet string No Network Entity title for this node in the IS-IS network.
-LockToken string No the token for unlocking the global SDN configuration.
-Loopback string No Name of the loopback/dummy interface that provides the Router-IP.
-Node string No The cluster node name.
-Nodes string No List of cluster node names.
-PeerGroupName string No Name of the peer group for this EVPN controller.
-Peers string No peers address list.
-RouteMapIn string No Route Map that should be applied for incoming routes.
-RouteMapOut string No Route Map that should be applied for outgoing routes.

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.