Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Manages a Linux Bridge network interface in a Proxmox VE node.
Create Bridge Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Bridge(name: string, args: BridgeArgs, opts?: CustomResourceOptions);@overload
def Bridge(resource_name: str,
args: BridgeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Bridge(resource_name: str,
opts: Optional[ResourceOptions] = None,
node_name: Optional[str] = None,
address: Optional[str] = None,
address6: Optional[str] = None,
autostart: Optional[bool] = None,
comment: Optional[str] = None,
gateway: Optional[str] = None,
gateway6: Optional[str] = None,
mtu: Optional[int] = None,
name: Optional[str] = None,
ports: Optional[Sequence[str]] = None,
timeout_reload: Optional[int] = None,
vlan_aware: Optional[bool] = None)func NewBridge(ctx *Context, name string, args BridgeArgs, opts ...ResourceOption) (*Bridge, error)public Bridge(string name, BridgeArgs args, CustomResourceOptions? opts = null)
public Bridge(String name, BridgeArgs args)
public Bridge(String name, BridgeArgs args, CustomResourceOptions options)
type: proxmoxve:network/linux/bridge:Bridge
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 BridgeArgs
- 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 BridgeArgs
- 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 BridgeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BridgeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BridgeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Bridge 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 Bridge resource accepts the following input properties:
- Node
Name string - The name of the node.
- Address string
- The interface IPv4/CIDR address.
- Address6 string
- The interface IPv6/CIDR address.
- Autostart bool
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- Ports List<string>
- The interface bridge ports.
- Timeout
Reload int - Timeout for network reload operations in seconds (defaults to
100). - Vlan
Aware bool - Whether the interface bridge is VLAN aware (defaults to
false).
- Node
Name string - The name of the node.
- Address string
- The interface IPv4/CIDR address.
- Address6 string
- The interface IPv6/CIDR address.
- Autostart bool
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- Ports []string
- The interface bridge ports.
- Timeout
Reload int - Timeout for network reload operations in seconds (defaults to
100). - Vlan
Aware bool - Whether the interface bridge is VLAN aware (defaults to
false).
- node
Name String - The name of the node.
- address String
- The interface IPv4/CIDR address.
- address6 String
- The interface IPv6/CIDR address.
- autostart Boolean
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- ports List<String>
- The interface bridge ports.
- timeout
Reload Integer - Timeout for network reload operations in seconds (defaults to
100). - vlan
Aware Boolean - Whether the interface bridge is VLAN aware (defaults to
false).
- node
Name string - The name of the node.
- address string
- The interface IPv4/CIDR address.
- address6 string
- The interface IPv6/CIDR address.
- autostart boolean
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- ports string[]
- The interface bridge ports.
- timeout
Reload number - Timeout for network reload operations in seconds (defaults to
100). - vlan
Aware boolean - Whether the interface bridge is VLAN aware (defaults to
false).
- node_
name str - The name of the node.
- address str
- The interface IPv4/CIDR address.
- address6 str
- The interface IPv6/CIDR address.
- autostart bool
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- ports Sequence[str]
- The interface bridge ports.
- timeout_
reload int - Timeout for network reload operations in seconds (defaults to
100). - vlan_
aware bool - Whether the interface bridge is VLAN aware (defaults to
false).
- node
Name String - The name of the node.
- address String
- The interface IPv4/CIDR address.
- address6 String
- The interface IPv6/CIDR address.
- autostart Boolean
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- ports List<String>
- The interface bridge ports.
- timeout
Reload Number - Timeout for network reload operations in seconds (defaults to
100). - vlan
Aware Boolean - Whether the interface bridge is VLAN aware (defaults to
false).
Outputs
All input properties are implicitly available as output properties. Additionally, the Bridge 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 Bridge Resource
Get an existing Bridge 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?: BridgeState, opts?: CustomResourceOptions): Bridge@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
address: Optional[str] = None,
address6: Optional[str] = None,
autostart: Optional[bool] = 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,
ports: Optional[Sequence[str]] = None,
timeout_reload: Optional[int] = None,
vlan_aware: Optional[bool] = None) -> Bridgefunc GetBridge(ctx *Context, name string, id IDInput, state *BridgeState, opts ...ResourceOption) (*Bridge, error)public static Bridge Get(string name, Input<string> id, BridgeState? state, CustomResourceOptions? opts = null)public static Bridge get(String name, Output<String> id, BridgeState state, CustomResourceOptions options)resources: _: type: proxmoxve:network/linux/bridge:Bridge 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.
- Address string
- The interface IPv4/CIDR address.
- Address6 string
- The interface IPv6/CIDR address.
- Autostart bool
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- Node
Name string - The name of the node.
- Ports List<string>
- The interface bridge ports.
- Timeout
Reload int - Timeout for network reload operations in seconds (defaults to
100). - Vlan
Aware bool - Whether the interface bridge is VLAN aware (defaults to
false).
- Address string
- The interface IPv4/CIDR address.
- Address6 string
- The interface IPv6/CIDR address.
- Autostart bool
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- Node
Name string - The name of the node.
- Ports []string
- The interface bridge ports.
- Timeout
Reload int - Timeout for network reload operations in seconds (defaults to
100). - Vlan
Aware bool - Whether the interface bridge is VLAN aware (defaults to
false).
- address String
- The interface IPv4/CIDR address.
- address6 String
- The interface IPv6/CIDR address.
- autostart Boolean
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- node
Name String - The name of the node.
- ports List<String>
- The interface bridge ports.
- timeout
Reload Integer - Timeout for network reload operations in seconds (defaults to
100). - vlan
Aware Boolean - Whether the interface bridge is VLAN aware (defaults to
false).
- address string
- The interface IPv4/CIDR address.
- address6 string
- The interface IPv6/CIDR address.
- autostart boolean
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- node
Name string - The name of the node.
- ports string[]
- The interface bridge ports.
- timeout
Reload number - Timeout for network reload operations in seconds (defaults to
100). - vlan
Aware boolean - Whether the interface bridge is VLAN aware (defaults to
false).
- address str
- The interface IPv4/CIDR address.
- address6 str
- The interface IPv6/CIDR address.
- autostart bool
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- node_
name str - The name of the node.
- ports Sequence[str]
- The interface bridge ports.
- timeout_
reload int - Timeout for network reload operations in seconds (defaults to
100). - vlan_
aware bool - Whether the interface bridge is VLAN aware (defaults to
false).
- address String
- The interface IPv4/CIDR address.
- address6 String
- The interface IPv6/CIDR address.
- autostart Boolean
- Automatically start interface on boot (defaults to
true). - 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. Commonly vmbr[N], where 0 ≤ N ≤ 4094 (vmbr0 - vmbr4094), but can be any alphanumeric string that starts with a character and is at most 10 characters long.
- node
Name String - The name of the node.
- ports List<String>
- The interface bridge ports.
- timeout
Reload Number - Timeout for network reload operations in seconds (defaults to
100). - vlan
Aware Boolean - Whether the interface bridge is VLAN aware (defaults to
false).
Package Details
- Repository
- proxmoxve muhlba91/pulumi-proxmoxve
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
proxmoxTerraform Provider.
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
