libvirt.Network

configuration of DNS specific settings for the network

routes List<NetworkRoute>

domain String

The domain used by the DNS server.

mode String

One of:

"none": the guests can talk to each other and the host OS, but cannot reach any other machines on the LAN.
"nat": it is the default network mode. This is a configuration that allows guest OS to get outbound connectivity regardless of whether the host uses ethernet, wireless, dialup, or VPN networking without requiring any specific admin configuration. In the absence of host networking, it at least allows guests to talk directly to each other.
"route": this is a variant on the default network which routes traffic from the virtual network to the LAN without applying any NAT. It requires that the IP address range be pre-configured in the routing tables of the router on the host network.
"open": similar to route, but no firewall rules are added.
"bridge": use a pre-existing host bridge. The guests will effectively be directly connected to the physical network (i.e. their IP addresses will all be on the subnet of the physical network, and there will be no restrictions on inbound or outbound connections). The bridge network attribute is mandatory in this case.

mtu Integer

name String

A unique name for the resource, required by libvirt. Changing this forces a new resource to be created.

a list of static routes. A cidr and a gateway must be provided. The gateway must be reachable via the bridge interface.

addresses string[]

autostart boolean

Set to true to start the network on host boot up. If not specified false is assumed.

bridge string

configuration of DNS specific settings for the network

routes NetworkRoute[]

domain string

The domain used by the DNS server.

mode string

One of:

"none": the guests can talk to each other and the host OS, but cannot reach any other machines on the LAN.
"nat": it is the default network mode. This is a configuration that allows guest OS to get outbound connectivity regardless of whether the host uses ethernet, wireless, dialup, or VPN networking without requiring any specific admin configuration. In the absence of host networking, it at least allows guests to talk directly to each other.
"route": this is a variant on the default network which routes traffic from the virtual network to the LAN without applying any NAT. It requires that the IP address range be pre-configured in the routing tables of the router on the host network.
"open": similar to route, but no firewall rules are added.
"bridge": use a pre-existing host bridge. The guests will effectively be directly connected to the physical network (i.e. their IP addresses will all be on the subnet of the physical network, and there will be no restrictions on inbound or outbound connections). The bridge network attribute is mandatory in this case.

mtu number

name string

A unique name for the resource, required by libvirt. Changing this forces a new resource to be created.

a list of static routes. A cidr and a gateway must be provided. The gateway must be reachable via the bridge interface.

dnsmasq_options NetworkDnsmasqOptionsArgs

addresses Sequence[str]

autostart bool

Set to true to start the network on host boot up. If not specified false is assumed.

bridge str

dhcp NetworkDhcpArgs

dns NetworkDnsArgs

configuration of DNS specific settings for the network

domain str

The domain used by the DNS server.

mode str

One of:

"none": the guests can talk to each other and the host OS, but cannot reach any other machines on the LAN.
"nat": it is the default network mode. This is a configuration that allows guest OS to get outbound connectivity regardless of whether the host uses ethernet, wireless, dialup, or VPN networking without requiring any specific admin configuration. In the absence of host networking, it at least allows guests to talk directly to each other.
"route": this is a variant on the default network which routes traffic from the virtual network to the LAN without applying any NAT. It requires that the IP address range be pre-configured in the routing tables of the router on the host network.
"open": similar to route, but no firewall rules are added.
"bridge": use a pre-existing host bridge. The guests will effectively be directly connected to the physical network (i.e. their IP addresses will all be on the subnet of the physical network, and there will be no restrictions on inbound or outbound connections). The bridge network attribute is mandatory in this case.

mtu int

name str

A unique name for the resource, required by libvirt. Changing this forces a new resource to be created.

routes Sequence[NetworkRouteArgs]

a list of static routes. A cidr and a gateway must be provided. The gateway must be reachable via the bridge interface.

xml NetworkXmlArgs

addresses List<String>

autostart Boolean

Set to true to start the network on host boot up. If not specified false is assumed.

bridge String

dhcp Property Map

dns Property Map

configuration of DNS specific settings for the network

dnsmasqOptions Property Map

domain String

The domain used by the DNS server.

mode String

One of:

"none": the guests can talk to each other and the host OS, but cannot reach any other machines on the LAN.
"nat": it is the default network mode. This is a configuration that allows guest OS to get outbound connectivity regardless of whether the host uses ethernet, wireless, dialup, or VPN networking without requiring any specific admin configuration. In the absence of host networking, it at least allows guests to talk directly to each other.
"route": this is a variant on the default network which routes traffic from the virtual network to the LAN without applying any NAT. It requires that the IP address range be pre-configured in the routing tables of the router on the host network.
"open": similar to route, but no firewall rules are added.
"bridge": use a pre-existing host bridge. The guests will effectively be directly connected to the physical network (i.e. their IP addresses will all be on the subnet of the physical network, and there will be no restrictions on inbound or outbound connections). The bridge network attribute is mandatory in this case.

mtu Number

name String

A unique name for the resource, required by libvirt. Changing this forces a new resource to be created.

routes List<Property Map>

a list of static routes. A cidr and a gateway must be provided. The gateway must be reachable via the bridge interface.

xml Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the Network 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 Network Resource

Get an existing Network 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?: NetworkState, opts?: CustomResourceOptions): Network

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[str]] = None,
        autostart: Optional[bool] = None,
        bridge: Optional[str] = None,
        dhcp: Optional[NetworkDhcpArgs] = None,
        dns: Optional[NetworkDnsArgs] = None,
        dnsmasq_options: Optional[NetworkDnsmasqOptionsArgs] = None,
        domain: Optional[str] = None,
        mode: Optional[str] = None,
        mtu: Optional[int] = None,
        name: Optional[str] = None,
        routes: Optional[Sequence[NetworkRouteArgs]] = None,
        xml: Optional[NetworkXmlArgs] = None) -> Network

func GetNetwork(ctx *Context, name string, id IDInput, state *NetworkState, opts ...ResourceOption) (*Network, error)

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

public static Network get(String name, Output<String> id, NetworkState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

Addresses List<string>

Autostart bool

Set to true to start the network on host boot up. If not specified false is assumed.

Bridge string

Dhcp NetworkDhcp

Dns NetworkDns

configuration of DNS specific settings for the network

DnsmasqOptions NetworkDnsmasqOptions

Domain string

The domain used by the DNS server.

Mode string

One of:

"none": the guests can talk to each other and the host OS, but cannot reach any other machines on the LAN.
"nat": it is the default network mode. This is a configuration that allows guest OS to get outbound connectivity regardless of whether the host uses ethernet, wireless, dialup, or VPN networking without requiring any specific admin configuration. In the absence of host networking, it at least allows guests to talk directly to each other.
"route": this is a variant on the default network which routes traffic from the virtual network to the LAN without applying any NAT. It requires that the IP address range be pre-configured in the routing tables of the router on the host network.
"open": similar to route, but no firewall rules are added.
"bridge": use a pre-existing host bridge. The guests will effectively be directly connected to the physical network (i.e. their IP addresses will all be on the subnet of the physical network, and there will be no restrictions on inbound or outbound connections). The bridge network attribute is mandatory in this case.

Mtu int

Name string

A unique name for the resource, required by libvirt. Changing this forces a new resource to be created.

Routes List<NetworkRoute>

a list of static routes. A cidr and a gateway must be provided. The gateway must be reachable via the bridge interface.

Xml NetworkXml

Addresses []string

Autostart bool

Set to true to start the network on host boot up. If not specified false is assumed.

Bridge string

Dhcp NetworkDhcpArgs

Dns NetworkDnsArgs

configuration of DNS specific settings for the network

DnsmasqOptions NetworkDnsmasqOptionsArgs

Domain string

The domain used by the DNS server.

Mode string

One of:

"none": the guests can talk to each other and the host OS, but cannot reach any other machines on the LAN.
"nat": it is the default network mode. This is a configuration that allows guest OS to get outbound connectivity regardless of whether the host uses ethernet, wireless, dialup, or VPN networking without requiring any specific admin configuration. In the absence of host networking, it at least allows guests to talk directly to each other.
"route": this is a variant on the default network which routes traffic from the virtual network to the LAN without applying any NAT. It requires that the IP address range be pre-configured in the routing tables of the router on the host network.
"open": similar to route, but no firewall rules are added.
"bridge": use a pre-existing host bridge. The guests will effectively be directly connected to the physical network (i.e. their IP addresses will all be on the subnet of the physical network, and there will be no restrictions on inbound or outbound connections). The bridge network attribute is mandatory in this case.

Mtu int

Name string

A unique name for the resource, required by libvirt. Changing this forces a new resource to be created.

Routes []NetworkRouteArgs

a list of static routes. A cidr and a gateway must be provided. The gateway must be reachable via the bridge interface.

Xml NetworkXmlArgs

addresses List<String>

autostart Boolean

Set to true to start the network on host boot up. If not specified false is assumed.

bridge String

configuration of DNS specific settings for the network

routes List<NetworkRoute>

domain String

The domain used by the DNS server.

mode String

One of:

"none": the guests can talk to each other and the host OS, but cannot reach any other machines on the LAN.
"nat": it is the default network mode. This is a configuration that allows guest OS to get outbound connectivity regardless of whether the host uses ethernet, wireless, dialup, or VPN networking without requiring any specific admin configuration. In the absence of host networking, it at least allows guests to talk directly to each other.
"route": this is a variant on the default network which routes traffic from the virtual network to the LAN without applying any NAT. It requires that the IP address range be pre-configured in the routing tables of the router on the host network.
"open": similar to route, but no firewall rules are added.
"bridge": use a pre-existing host bridge. The guests will effectively be directly connected to the physical network (i.e. their IP addresses will all be on the subnet of the physical network, and there will be no restrictions on inbound or outbound connections). The bridge network attribute is mandatory in this case.

mtu Integer

name String

A unique name for the resource, required by libvirt. Changing this forces a new resource to be created.

a list of static routes. A cidr and a gateway must be provided. The gateway must be reachable via the bridge interface.

addresses string[]

autostart boolean

Set to true to start the network on host boot up. If not specified false is assumed.

bridge string

configuration of DNS specific settings for the network

routes NetworkRoute[]

domain string

The domain used by the DNS server.

mode string

One of:

"none": the guests can talk to each other and the host OS, but cannot reach any other machines on the LAN.
"nat": it is the default network mode. This is a configuration that allows guest OS to get outbound connectivity regardless of whether the host uses ethernet, wireless, dialup, or VPN networking without requiring any specific admin configuration. In the absence of host networking, it at least allows guests to talk directly to each other.
"route": this is a variant on the default network which routes traffic from the virtual network to the LAN without applying any NAT. It requires that the IP address range be pre-configured in the routing tables of the router on the host network.
"open": similar to route, but no firewall rules are added.
"bridge": use a pre-existing host bridge. The guests will effectively be directly connected to the physical network (i.e. their IP addresses will all be on the subnet of the physical network, and there will be no restrictions on inbound or outbound connections). The bridge network attribute is mandatory in this case.

mtu number

name string

A unique name for the resource, required by libvirt. Changing this forces a new resource to be created.

a list of static routes. A cidr and a gateway must be provided. The gateway must be reachable via the bridge interface.