proxmoxve.network.linux.Bond

Proxmox Virtual Environment (Proxmox VE) v8.1.0, Apr 26 26

Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

Create Bond Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Bond(name: string, args: BondArgs, opts?: CustomResourceOptions);

@overload
def Bond(resource_name: str,
         args: BondArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Bond(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         node_name: Optional[str] = None,
         slaves: Optional[Sequence[str]] = None,
         comment: Optional[str] = None,
         bond_mode: Optional[str] = None,
         bond_primary: Optional[str] = None,
         bond_xmit_hash_policy: Optional[str] = None,
         address: Optional[str] = None,
         gateway: Optional[str] = None,
         gateway6: Optional[str] = None,
         mtu: Optional[int] = None,
         name: Optional[str] = None,
         autostart: Optional[bool] = None,
         address6: Optional[str] = None,
         timeout_reload: Optional[int] = None)

func NewBond(ctx *Context, name string, args BondArgs, opts ...ResourceOption) (*Bond, error)

public Bond(string name, BondArgs args, CustomResourceOptions? opts = null)

public Bond(String name, BondArgs args)
public Bond(String name, BondArgs args, CustomResourceOptions options)

type: proxmoxve:network/linux/bond:Bond
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args BondArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args BondArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BondArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BondArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BondArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Bond Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Bond resource accepts the following input properties:

NodeName string: The name of the node.
Slaves List<string>: The interface bond slaves (member interfaces).
Address string: The interface IPv4/CIDR address.
Address6 string: The interface IPv6/CIDR address.
Autostart bool: Automatically start interface on boot (defaults to true).
BondMode string: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
BondPrimary string: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
BondXmitHashPolicy string: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
Comment string: Comment for the interface.
Gateway string: Default gateway address.
Gateway6 string: Default IPv6 gateway address.
Mtu int: The interface MTU.
Name string: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
TimeoutReload int: Timeout for network reload operations in seconds (defaults to 100).

NodeName string: The name of the node.
Slaves []string: The interface bond slaves (member interfaces).
Address string: The interface IPv4/CIDR address.
Address6 string: The interface IPv6/CIDR address.
Autostart bool: Automatically start interface on boot (defaults to true).
BondMode string: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
BondPrimary string: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
BondXmitHashPolicy string: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
Comment string: Comment for the interface.
Gateway string: Default gateway address.
Gateway6 string: Default IPv6 gateway address.
Mtu int: The interface MTU.
Name string: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
TimeoutReload int: Timeout for network reload operations in seconds (defaults to 100).

nodeName String: The name of the node.
slaves List<String>: The interface bond slaves (member interfaces).
address String: The interface IPv4/CIDR address.
address6 String: The interface IPv6/CIDR address.
autostart Boolean: Automatically start interface on boot (defaults to true).
bondMode String: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
bondPrimary String: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
bondXmitHashPolicy String: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
comment String: Comment for the interface.
gateway String: Default gateway address.
gateway6 String: Default IPv6 gateway address.
mtu Integer: The interface MTU.
name String: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
timeoutReload Integer: Timeout for network reload operations in seconds (defaults to 100).

nodeName string: The name of the node.
slaves string[]: The interface bond slaves (member interfaces).
address string: The interface IPv4/CIDR address.
address6 string: The interface IPv6/CIDR address.
autostart boolean: Automatically start interface on boot (defaults to true).
bondMode string: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
bondPrimary string: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
bondXmitHashPolicy string: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
comment string: Comment for the interface.
gateway string: Default gateway address.
gateway6 string: Default IPv6 gateway address.
mtu number: The interface MTU.
name string: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
timeoutReload number: Timeout for network reload operations in seconds (defaults to 100).

node_name str: The name of the node.
slaves Sequence[str]: The interface bond slaves (member interfaces).
address str: The interface IPv4/CIDR address.
address6 str: The interface IPv6/CIDR address.
autostart bool: Automatically start interface on boot (defaults to true).
bond_mode str: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
bond_primary str: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
bond_xmit_hash_policy str: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
comment str: Comment for the interface.
gateway str: Default gateway address.
gateway6 str: Default IPv6 gateway address.
mtu int: The interface MTU.
name str: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
timeout_reload int: Timeout for network reload operations in seconds (defaults to 100).

nodeName String: The name of the node.
slaves List<String>: The interface bond slaves (member interfaces).
address String: The interface IPv4/CIDR address.
address6 String: The interface IPv6/CIDR address.
autostart Boolean: Automatically start interface on boot (defaults to true).
bondMode String: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
bondPrimary String: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
bondXmitHashPolicy String: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
comment String: Comment for the interface.
gateway String: Default gateway address.
gateway6 String: Default IPv6 gateway address.
mtu Number: The interface MTU.
name String: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
timeoutReload Number: Timeout for network reload operations in seconds (defaults to 100).

Outputs

All input properties are implicitly available as output properties. Additionally, the Bond resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Bond Resource

Get an existing Bond resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BondState, opts?: CustomResourceOptions): Bond

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        address6: Optional[str] = None,
        autostart: Optional[bool] = None,
        bond_mode: Optional[str] = None,
        bond_primary: Optional[str] = None,
        bond_xmit_hash_policy: Optional[str] = None,
        comment: Optional[str] = None,
        gateway: Optional[str] = None,
        gateway6: Optional[str] = None,
        mtu: Optional[int] = None,
        name: Optional[str] = None,
        node_name: Optional[str] = None,
        slaves: Optional[Sequence[str]] = None,
        timeout_reload: Optional[int] = None) -> Bond

func GetBond(ctx *Context, name string, id IDInput, state *BondState, opts ...ResourceOption) (*Bond, error)

public static Bond Get(string name, Input<string> id, BondState? state, CustomResourceOptions? opts = null)

public static Bond get(String name, Output<String> id, BondState state, CustomResourceOptions options)

resources:  _:    type: proxmoxve:network/linux/bond:Bond    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Address string: The interface IPv4/CIDR address.
Address6 string: The interface IPv6/CIDR address.
Autostart bool: Automatically start interface on boot (defaults to true).
BondMode string: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
BondPrimary string: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
BondXmitHashPolicy string: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
Comment string: Comment for the interface.
Gateway string: Default gateway address.
Gateway6 string: Default IPv6 gateway address.
Mtu int: The interface MTU.
Name string: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
NodeName string: The name of the node.
Slaves List<string>: The interface bond slaves (member interfaces).
TimeoutReload int: Timeout for network reload operations in seconds (defaults to 100).

Address string: The interface IPv4/CIDR address.
Address6 string: The interface IPv6/CIDR address.
Autostart bool: Automatically start interface on boot (defaults to true).
BondMode string: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
BondPrimary string: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
BondXmitHashPolicy string: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
Comment string: Comment for the interface.
Gateway string: Default gateway address.
Gateway6 string: Default IPv6 gateway address.
Mtu int: The interface MTU.
Name string: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
NodeName string: The name of the node.
Slaves []string: The interface bond slaves (member interfaces).
TimeoutReload int: Timeout for network reload operations in seconds (defaults to 100).

address String: The interface IPv4/CIDR address.
address6 String: The interface IPv6/CIDR address.
autostart Boolean: Automatically start interface on boot (defaults to true).
bondMode String: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
bondPrimary String: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
bondXmitHashPolicy String: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
comment String: Comment for the interface.
gateway String: Default gateway address.
gateway6 String: Default IPv6 gateway address.
mtu Integer: The interface MTU.
name String: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
nodeName String: The name of the node.
slaves List<String>: The interface bond slaves (member interfaces).
timeoutReload Integer: Timeout for network reload operations in seconds (defaults to 100).

address string: The interface IPv4/CIDR address.
address6 string: The interface IPv6/CIDR address.
autostart boolean: Automatically start interface on boot (defaults to true).
bondMode string: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
bondPrimary string: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
bondXmitHashPolicy string: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
comment string: Comment for the interface.
gateway string: Default gateway address.
gateway6 string: Default IPv6 gateway address.
mtu number: The interface MTU.
name string: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
nodeName string: The name of the node.
slaves string[]: The interface bond slaves (member interfaces).
timeoutReload number: Timeout for network reload operations in seconds (defaults to 100).

address str: The interface IPv4/CIDR address.
address6 str: The interface IPv6/CIDR address.
autostart bool: Automatically start interface on boot (defaults to true).
bond_mode str: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
bond_primary str: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
bond_xmit_hash_policy str: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
comment str: Comment for the interface.
gateway str: Default gateway address.
gateway6 str: Default IPv6 gateway address.
mtu int: The interface MTU.
name str: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
node_name str: The name of the node.
slaves Sequence[str]: The interface bond slaves (member interfaces).
timeout_reload int: Timeout for network reload operations in seconds (defaults to 100).

address String: The interface IPv4/CIDR address.
address6 String: The interface IPv6/CIDR address.
autostart Boolean: Automatically start interface on boot (defaults to true).
bondMode String: The bonding mode. Possible values are balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
bondPrimary String: The primary interface for active-backup bond mode. Specifies which slave interface should be the active one.
bondXmitHashPolicy String: The transmit hash policy for balance-xor and 802.3ad bond modes. Possible values are layer2, layer2+3, layer3+4.
comment String: Comment for the interface.
gateway String: Default gateway address.
gateway6 String: Default IPv6 gateway address.
mtu Number: The interface MTU.
name String: The interface name. Must be bond[N], where 0 ≤ N (e.g. bond0, bond1), or any alphanumeric string that starts with a character and is at most 10 characters long.
nodeName String: The name of the node.
slaves List<String>: The interface bond slaves (member interfaces).
timeoutReload Number: Timeout for network reload operations in seconds (defaults to 100).

Package Details

Repository: proxmoxve muhlba91/pulumi-proxmoxve
License: Apache-2.0
Notes: This Pulumi package is based on the proxmox Terraform Provider.

Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

proxmoxve.network/linux.Bond

On this page

On this page

Create Bond Resource

Constructor syntax

Parameters

Bond Resource Properties

Inputs

Outputs

Look up Existing Bond Resource

Package Details

On this page

On this page