Skip to content

New-PveNodesNetwork

Create network device configuration

API: POST /nodes/{node}/network, Proxmox VE API viewer

New-PveNodesNetwork
[-PveTicket <PveTicket>]
[-Address <string>]
[-Address6 <string>]
[-Autostart <bool>]
[-BondPrimary <string>]
[-BondMode <string>]
[-BondXmitHashPolicy <string>]
[-BridgePorts <string>]
[-BridgeVids <string>]
[-BridgeVlanAware <bool>]
[-Cidr <string>]
[-Cidr6 <string>]
[-Comments <string>]
[-Comments6 <string>]
[-Gateway <string>]
[-Gateway6 <string>]
-Iface <string>
[-Mtu <int>]
[-Netmask <string>]
[-Netmask6 <int>]
-Node <string>
[-OvsBonds <string>]
[-OvsBridge <string>]
[-OvsOptions <string>]
[-OvsPorts <string>]
[-OvsTag <int>]
[-Slaves <string>]
-Type <string>
[-VlanId <int>]
[-VlanRawDevice <string>]
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Address string No IP address.
-Address6 string No IP address.
-Autostart bool No Automatically start interface on boot.
-BondPrimary string No Specify the primary interface for active-backup bond.
-BondMode string No Bonding mode. Values: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb, balance-slb, lacp-balance-slb, lacp-balance-tcp.
-BondXmitHashPolicy string No Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Values: layer2, layer2+3, layer3+4.
-BridgePorts string No Specify the interfaces you want to add to your bridge.
-BridgeVids string No Specify the allowed VLANs. For example: ‘2 4 100-200’. Only used if the bridge is VLAN aware.
-BridgeVlanAware bool No Enable bridge vlan support.
-Cidr string No IPv4 CIDR.
-Cidr6 string No IPv6 CIDR.
-Comments string No Comments.
-Comments6 string No Comments.
-Gateway string No Default gateway address.
-Gateway6 string No Default ipv6 gateway address.
-Iface string Yes Network interface name.
-Mtu int No MTU.
-Netmask string No Network mask.
-Netmask6 int No Network mask.
-Node string Yes The cluster node name.
-OvsBonds string No Specify the interfaces used by the bonding device.
-OvsBridge string No The OVS bridge associated with a OVS port. This is required when you create an OVS port.
-OvsOptions string No OVS interface options.
-OvsPorts string No Specify the interfaces you want to add to your bridge.
-OvsTag int No Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)
-Slaves string No Specify the interfaces used by the bonding device.
-Type string Yes Network interface type. Values: bridge, bond, eth, alias, vlan, fabric, OVSBridge, OVSBond, OVSPort, OVSIntPort, vnet, unknown.
-VlanId int No vlan-id for a custom named vlan interface (ifupdown2 only).
-VlanRawDevice string No Specify the raw interface for the vlan interface.

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.