1. Pulumi Registry
  2. Unifi
  3. API Docs
  4. Network
unifi logo
Unifi v0.0.3, Dec 5 22

unifi.Network

unifi.Network manages WAN/LAN/VLAN networks.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Unifi = Pulumiverse.Unifi;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var vlanId = config.GetNumber("vlanId") ?? 10;
    var vlan = new Unifi.Network("vlan", new()
    {
        Purpose = "corporate",
        Subnet = "10.0.0.1/24",
        VlanId = vlanId,
        DhcpStart = "10.0.0.6",
        DhcpStop = "10.0.0.254",
        DhcpEnabled = true,
    });

    var wan = new Unifi.Network("wan", new()
    {
        Purpose = "wan",
        WanNetworkgroup = "WAN",
        WanType = "pppoe",
        WanIp = "192.168.1.1",
        WanEgressQos = 1,
        WanUsername = "username",
        XWanPassword = "password",
    });

});

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		vlanId := float64(10)
		if param := cfg.GetFloat64("vlanId"); param != 0 {
			vlanId = param
		}
		_, err := unifi.NewNetwork(ctx, "vlan", &unifi.NetworkArgs{
			Purpose:     pulumi.String("corporate"),
			Subnet:      pulumi.String("10.0.0.1/24"),
			VlanId:      pulumi.Float64(vlanId),
			DhcpStart:   pulumi.String("10.0.0.6"),
			DhcpStop:    pulumi.String("10.0.0.254"),
			DhcpEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = unifi.NewNetwork(ctx, "wan", &unifi.NetworkArgs{
			Purpose:         pulumi.String("wan"),
			WanNetworkgroup: pulumi.String("WAN"),
			WanType:         pulumi.String("pppoe"),
			WanIp:           pulumi.String("192.168.1.1"),
			WanEgressQos:    pulumi.Int(1),
			WanUsername:     pulumi.String("username"),
			XWanPassword:    pulumi.String("password"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.unifi.Network;
import com.pulumi.unifi.NetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var vlanId = config.get("vlanId").orElse(10);
        var vlan = new Network("vlan", NetworkArgs.builder()        
            .purpose("corporate")
            .subnet("10.0.0.1/24")
            .vlanId(vlanId)
            .dhcpStart("10.0.0.6")
            .dhcpStop("10.0.0.254")
            .dhcpEnabled(true)
            .build());

        var wan = new Network("wan", NetworkArgs.builder()        
            .purpose("wan")
            .wanNetworkgroup("WAN")
            .wanType("pppoe")
            .wanIp("192.168.1.1")
            .wanEgressQos(1)
            .wanUsername("username")
            .xWanPassword("password")
            .build());

    }
}

import pulumi
import pulumiverse_unifi as unifi

config = pulumi.Config()
vlan_id = config.get_float("vlanId")
if vlan_id is None:
    vlan_id = 10
vlan = unifi.Network("vlan",
    purpose="corporate",
    subnet="10.0.0.1/24",
    vlan_id=vlan_id,
    dhcp_start="10.0.0.6",
    dhcp_stop="10.0.0.254",
    dhcp_enabled=True)
wan = unifi.Network("wan",
    purpose="wan",
    wan_networkgroup="WAN",
    wan_type="pppoe",
    wan_ip="192.168.1.1",
    wan_egress_qos=1,
    wan_username="username",
    x_wan_password="password")

import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumiverse/unifi";

const config = new pulumi.Config();
const vlanId = config.getNumber("vlanId") || 10;
const vlan = new unifi.Network("vlan", {
    purpose: "corporate",
    subnet: "10.0.0.1/24",
    vlanId: vlanId,
    dhcpStart: "10.0.0.6",
    dhcpStop: "10.0.0.254",
    dhcpEnabled: true,
});
const wan = new unifi.Network("wan", {
    purpose: "wan",
    wanNetworkgroup: "WAN",
    wanType: "pppoe",
    wanIp: "192.168.1.1",
    wanEgressQos: 1,
    wanUsername: "username",
    xWanPassword: "password",
});

configuration:
  vlanId:
    type: number
    default: 10
resources:
  vlan:
    type: unifi:Network
    properties:
      purpose: corporate
      subnet: 10.0.0.1/24
      vlanId: ${vlanId}
      dhcpStart: 10.0.0.6
      dhcpStop: 10.0.0.254
      dhcpEnabled: true
  wan:
    type: unifi:Network
    properties:
      purpose: wan
      wanNetworkgroup: WAN
      wanType: pppoe
      wanIp: 192.168.1.1
      wanEgressQos: 1
      wanUsername: username
      xWanPassword: password

Create Network Resource

new Network(name: string, args: NetworkArgs, opts?: CustomResourceOptions);
@overload
def Network(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            dhcp_dns: Optional[Sequence[str]] = None,
            dhcp_enabled: Optional[bool] = None,
            dhcp_lease: Optional[int] = None,
            dhcp_relay_enabled: Optional[bool] = None,
            dhcp_start: Optional[str] = None,
            dhcp_stop: Optional[str] = None,
            dhcp_v6_dns: Optional[Sequence[str]] = None,
            dhcp_v6_dns_auto: Optional[bool] = None,
            dhcp_v6_enabled: Optional[bool] = None,
            dhcp_v6_lease: Optional[int] = None,
            dhcp_v6_start: Optional[str] = None,
            dhcp_v6_stop: Optional[str] = None,
            dhcpd_boot_enabled: Optional[bool] = None,
            dhcpd_boot_filename: Optional[str] = None,
            dhcpd_boot_server: Optional[str] = None,
            domain_name: Optional[str] = None,
            igmp_snooping: Optional[bool] = None,
            internet_access_enabled: Optional[bool] = None,
            intra_network_access_enabled: Optional[bool] = None,
            ipv6_interface_type: Optional[str] = None,
            ipv6_pd_interface: Optional[str] = None,
            ipv6_pd_prefixid: Optional[str] = None,
            ipv6_pd_start: Optional[str] = None,
            ipv6_pd_stop: Optional[str] = None,
            ipv6_ra_enable: Optional[bool] = None,
            ipv6_ra_preferred_lifetime: Optional[int] = None,
            ipv6_ra_priority: Optional[str] = None,
            ipv6_ra_valid_lifetime: Optional[int] = None,
            ipv6_static_subnet: Optional[str] = None,
            name: Optional[str] = None,
            network_group: Optional[str] = None,
            purpose: Optional[str] = None,
            site: Optional[str] = None,
            subnet: Optional[str] = None,
            vlan_id: Optional[int] = None,
            wan_dhcp_v6_pd_size: Optional[int] = None,
            wan_dns: Optional[Sequence[str]] = None,
            wan_egress_qos: Optional[int] = None,
            wan_gateway: Optional[str] = None,
            wan_gateway_v6: Optional[str] = None,
            wan_ip: Optional[str] = None,
            wan_ipv6: Optional[str] = None,
            wan_netmask: Optional[str] = None,
            wan_networkgroup: Optional[str] = None,
            wan_prefixlen: Optional[int] = None,
            wan_type: Optional[str] = None,
            wan_type_v6: Optional[str] = None,
            wan_username: Optional[str] = None,
            x_wan_password: Optional[str] = None)
@overload
def Network(resource_name: str,
            args: NetworkArgs,
            opts: Optional[ResourceOptions] = None)
func NewNetwork(ctx *Context, name string, args NetworkArgs, opts ...ResourceOption) (*Network, error)
public Network(string name, NetworkArgs args, CustomResourceOptions? opts = null)
public Network(String name, NetworkArgs args)
public Network(String name, NetworkArgs args, CustomResourceOptions options)

type: unifi:Network
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NetworkArgs
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 NetworkArgs
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 NetworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args NetworkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Network Resource Properties

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

Inputs

The Network resource accepts the following input properties:

Purpose string

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

DhcpDns List<string>

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

DhcpEnabled bool

Specifies whether DHCP is enabled or not on this network.

DhcpLease int

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

DhcpRelayEnabled bool

Specifies whether DHCP relay is enabled or not on this network.

DhcpStart string

The IPv4 address where the DHCP range of addresses starts.

DhcpStop string

The IPv4 address where the DHCP range of addresses stops.

DhcpV6Dns List<string>

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

DhcpV6DnsAuto bool

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

DhcpV6Enabled bool

Enable stateful DHCPv6 for static configuration.

DhcpV6Lease int

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

DhcpV6Start string

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

DhcpV6Stop string

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

DhcpdBootEnabled bool

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

DhcpdBootFilename string

Specifies the file to PXE boot from on the dhcpdbootserver.

DhcpdBootServer string

Specifies the IPv4 address of a TFTP server to network boot from.

DomainName string

The domain name of this network.

IgmpSnooping bool

Specifies whether IGMP snooping is enabled or not.

InternetAccessEnabled bool

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

IntraNetworkAccessEnabled bool

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

Ipv6InterfaceType string

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

Ipv6PdInterface string

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

Ipv6PdPrefixid string

Specifies the IPv6 Prefix ID.

Ipv6PdStart string

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

Ipv6PdStop string

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

Ipv6RaEnable bool

Specifies whether to enable router advertisements or not.

Ipv6RaPreferredLifetime int

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

Ipv6RaPriority string

IPv6 router advertisement priority. Must be one of either high, medium, or low

Ipv6RaValidLifetime int

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

Ipv6StaticSubnet string

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

Name string

The name of the network.

NetworkGroup string

The group of the network. Defaults to LAN.

Site string

The name of the site to associate the network with.

Subnet string

The subnet of the network. Must be a valid CIDR address.

VlanId int

The VLAN ID of the network.

WanDhcpV6PdSize int

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

WanDns List<string>

DNS servers IPs of the WAN.

WanEgressQos int

Specifies the WAN egress quality of service. Defaults to 0.

WanGateway string

The IPv4 gateway of the WAN.

WanGatewayV6 string

The IPv6 gateway of the WAN.

WanIp string

The IPv4 address of the WAN.

WanIpv6 string

The IPv6 address of the WAN.

WanNetmask string

The IPv4 netmask of the WAN.

WanNetworkgroup string

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

WanPrefixlen int

The IPv6 prefix length of the WAN. Must be between 1 and 128.

WanType string

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

WanTypeV6 string

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

WanUsername string

Specifies the IPV4 WAN username.

XWanPassword string

Specifies the IPV4 WAN password.

Purpose string

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

DhcpDns []string

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

DhcpEnabled bool

Specifies whether DHCP is enabled or not on this network.

DhcpLease int

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

DhcpRelayEnabled bool

Specifies whether DHCP relay is enabled or not on this network.

DhcpStart string

The IPv4 address where the DHCP range of addresses starts.

DhcpStop string

The IPv4 address where the DHCP range of addresses stops.

DhcpV6Dns []string

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

DhcpV6DnsAuto bool

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

DhcpV6Enabled bool

Enable stateful DHCPv6 for static configuration.

DhcpV6Lease int

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

DhcpV6Start string

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

DhcpV6Stop string

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

DhcpdBootEnabled bool

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

DhcpdBootFilename string

Specifies the file to PXE boot from on the dhcpdbootserver.

DhcpdBootServer string

Specifies the IPv4 address of a TFTP server to network boot from.

DomainName string

The domain name of this network.

IgmpSnooping bool

Specifies whether IGMP snooping is enabled or not.

InternetAccessEnabled bool

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

IntraNetworkAccessEnabled bool

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

Ipv6InterfaceType string

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

Ipv6PdInterface string

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

Ipv6PdPrefixid string

Specifies the IPv6 Prefix ID.

Ipv6PdStart string

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

Ipv6PdStop string

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

Ipv6RaEnable bool

Specifies whether to enable router advertisements or not.

Ipv6RaPreferredLifetime int

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

Ipv6RaPriority string

IPv6 router advertisement priority. Must be one of either high, medium, or low

Ipv6RaValidLifetime int

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

Ipv6StaticSubnet string

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

Name string

The name of the network.

NetworkGroup string

The group of the network. Defaults to LAN.

Site string

The name of the site to associate the network with.

Subnet string

The subnet of the network. Must be a valid CIDR address.

VlanId int

The VLAN ID of the network.

WanDhcpV6PdSize int

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

WanDns []string

DNS servers IPs of the WAN.

WanEgressQos int

Specifies the WAN egress quality of service. Defaults to 0.

WanGateway string

The IPv4 gateway of the WAN.

WanGatewayV6 string

The IPv6 gateway of the WAN.

WanIp string

The IPv4 address of the WAN.

WanIpv6 string

The IPv6 address of the WAN.

WanNetmask string

The IPv4 netmask of the WAN.

WanNetworkgroup string

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

WanPrefixlen int

The IPv6 prefix length of the WAN. Must be between 1 and 128.

WanType string

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

WanTypeV6 string

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

WanUsername string

Specifies the IPV4 WAN username.

XWanPassword string

Specifies the IPV4 WAN password.

purpose String

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

dhcpDns List<String>

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

dhcpEnabled Boolean

Specifies whether DHCP is enabled or not on this network.

dhcpLease Integer

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

dhcpRelayEnabled Boolean

Specifies whether DHCP relay is enabled or not on this network.

dhcpStart String

The IPv4 address where the DHCP range of addresses starts.

dhcpStop String

The IPv4 address where the DHCP range of addresses stops.

dhcpV6Dns List<String>

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

dhcpV6DnsAuto Boolean

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

dhcpV6Enabled Boolean

Enable stateful DHCPv6 for static configuration.

dhcpV6Lease Integer

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

dhcpV6Start String

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpV6Stop String

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpdBootEnabled Boolean

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

dhcpdBootFilename String

Specifies the file to PXE boot from on the dhcpdbootserver.

dhcpdBootServer String

Specifies the IPv4 address of a TFTP server to network boot from.

domainName String

The domain name of this network.

igmpSnooping Boolean

Specifies whether IGMP snooping is enabled or not.

internetAccessEnabled Boolean

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

intraNetworkAccessEnabled Boolean

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

ipv6InterfaceType String

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

ipv6PdInterface String

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

ipv6PdPrefixid String

Specifies the IPv6 Prefix ID.

ipv6PdStart String

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6PdStop String

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6RaEnable Boolean

Specifies whether to enable router advertisements or not.

ipv6RaPreferredLifetime Integer

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

ipv6RaPriority String

IPv6 router advertisement priority. Must be one of either high, medium, or low

ipv6RaValidLifetime Integer

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

ipv6StaticSubnet String

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

name String

The name of the network.

networkGroup String

The group of the network. Defaults to LAN.

site String

The name of the site to associate the network with.

subnet String

The subnet of the network. Must be a valid CIDR address.

vlanId Integer

The VLAN ID of the network.

wanDhcpV6PdSize Integer

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

wanDns List<String>

DNS servers IPs of the WAN.

wanEgressQos Integer

Specifies the WAN egress quality of service. Defaults to 0.

wanGateway String

The IPv4 gateway of the WAN.

wanGatewayV6 String

The IPv6 gateway of the WAN.

wanIp String

The IPv4 address of the WAN.

wanIpv6 String

The IPv6 address of the WAN.

wanNetmask String

The IPv4 netmask of the WAN.

wanNetworkgroup String

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

wanPrefixlen Integer

The IPv6 prefix length of the WAN. Must be between 1 and 128.

wanType String

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

wanTypeV6 String

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

wanUsername String

Specifies the IPV4 WAN username.

xWanPassword String

Specifies the IPV4 WAN password.

purpose string

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

dhcpDns string[]

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

dhcpEnabled boolean

Specifies whether DHCP is enabled or not on this network.

dhcpLease number

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

dhcpRelayEnabled boolean

Specifies whether DHCP relay is enabled or not on this network.

dhcpStart string

The IPv4 address where the DHCP range of addresses starts.

dhcpStop string

The IPv4 address where the DHCP range of addresses stops.

dhcpV6Dns string[]

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

dhcpV6DnsAuto boolean

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

dhcpV6Enabled boolean

Enable stateful DHCPv6 for static configuration.

dhcpV6Lease number

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

dhcpV6Start string

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpV6Stop string

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpdBootEnabled boolean

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

dhcpdBootFilename string

Specifies the file to PXE boot from on the dhcpdbootserver.

dhcpdBootServer string

Specifies the IPv4 address of a TFTP server to network boot from.

domainName string

The domain name of this network.

igmpSnooping boolean

Specifies whether IGMP snooping is enabled or not.

internetAccessEnabled boolean

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

intraNetworkAccessEnabled boolean

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

ipv6InterfaceType string

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

ipv6PdInterface string

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

ipv6PdPrefixid string

Specifies the IPv6 Prefix ID.

ipv6PdStart string

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6PdStop string

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6RaEnable boolean

Specifies whether to enable router advertisements or not.

ipv6RaPreferredLifetime number

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

ipv6RaPriority string

IPv6 router advertisement priority. Must be one of either high, medium, or low

ipv6RaValidLifetime number

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

ipv6StaticSubnet string

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

name string

The name of the network.

networkGroup string

The group of the network. Defaults to LAN.

site string

The name of the site to associate the network with.

subnet string

The subnet of the network. Must be a valid CIDR address.

vlanId number

The VLAN ID of the network.

wanDhcpV6PdSize number

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

wanDns string[]

DNS servers IPs of the WAN.

wanEgressQos number

Specifies the WAN egress quality of service. Defaults to 0.

wanGateway string

The IPv4 gateway of the WAN.

wanGatewayV6 string

The IPv6 gateway of the WAN.

wanIp string

The IPv4 address of the WAN.

wanIpv6 string

The IPv6 address of the WAN.

wanNetmask string

The IPv4 netmask of the WAN.

wanNetworkgroup string

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

wanPrefixlen number

The IPv6 prefix length of the WAN. Must be between 1 and 128.

wanType string

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

wanTypeV6 string

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

wanUsername string

Specifies the IPV4 WAN username.

xWanPassword string

Specifies the IPV4 WAN password.

purpose str

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

dhcp_dns Sequence[str]

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

dhcp_enabled bool

Specifies whether DHCP is enabled or not on this network.

dhcp_lease int

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

dhcp_relay_enabled bool

Specifies whether DHCP relay is enabled or not on this network.

dhcp_start str

The IPv4 address where the DHCP range of addresses starts.

dhcp_stop str

The IPv4 address where the DHCP range of addresses stops.

dhcp_v6_dns Sequence[str]

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

dhcp_v6_dns_auto bool

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

dhcp_v6_enabled bool

Enable stateful DHCPv6 for static configuration.

dhcp_v6_lease int

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

dhcp_v6_start str

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcp_v6_stop str

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpd_boot_enabled bool

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

dhcpd_boot_filename str

Specifies the file to PXE boot from on the dhcpdbootserver.

dhcpd_boot_server str

Specifies the IPv4 address of a TFTP server to network boot from.

domain_name str

The domain name of this network.

igmp_snooping bool

Specifies whether IGMP snooping is enabled or not.

internet_access_enabled bool

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

intra_network_access_enabled bool

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

ipv6_interface_type str

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

ipv6_pd_interface str

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

ipv6_pd_prefixid str

Specifies the IPv6 Prefix ID.

ipv6_pd_start str

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6_pd_stop str

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6_ra_enable bool

Specifies whether to enable router advertisements or not.

ipv6_ra_preferred_lifetime int

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

ipv6_ra_priority str

IPv6 router advertisement priority. Must be one of either high, medium, or low

ipv6_ra_valid_lifetime int

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

ipv6_static_subnet str

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

name str

The name of the network.

network_group str

The group of the network. Defaults to LAN.

site str

The name of the site to associate the network with.

subnet str

The subnet of the network. Must be a valid CIDR address.

vlan_id int

The VLAN ID of the network.

wan_dhcp_v6_pd_size int

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

wan_dns Sequence[str]

DNS servers IPs of the WAN.

wan_egress_qos int

Specifies the WAN egress quality of service. Defaults to 0.

wan_gateway str

The IPv4 gateway of the WAN.

wan_gateway_v6 str

The IPv6 gateway of the WAN.

wan_ip str

The IPv4 address of the WAN.

wan_ipv6 str

The IPv6 address of the WAN.

wan_netmask str

The IPv4 netmask of the WAN.

wan_networkgroup str

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

wan_prefixlen int

The IPv6 prefix length of the WAN. Must be between 1 and 128.

wan_type str

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

wan_type_v6 str

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

wan_username str

Specifies the IPV4 WAN username.

x_wan_password str

Specifies the IPV4 WAN password.

purpose String

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

dhcpDns List<String>

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

dhcpEnabled Boolean

Specifies whether DHCP is enabled or not on this network.

dhcpLease Number

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

dhcpRelayEnabled Boolean

Specifies whether DHCP relay is enabled or not on this network.

dhcpStart String

The IPv4 address where the DHCP range of addresses starts.

dhcpStop String

The IPv4 address where the DHCP range of addresses stops.

dhcpV6Dns List<String>

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

dhcpV6DnsAuto Boolean

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

dhcpV6Enabled Boolean

Enable stateful DHCPv6 for static configuration.

dhcpV6Lease Number

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

dhcpV6Start String

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpV6Stop String

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpdBootEnabled Boolean

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

dhcpdBootFilename String

Specifies the file to PXE boot from on the dhcpdbootserver.

dhcpdBootServer String

Specifies the IPv4 address of a TFTP server to network boot from.

domainName String

The domain name of this network.

igmpSnooping Boolean

Specifies whether IGMP snooping is enabled or not.

internetAccessEnabled Boolean

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

intraNetworkAccessEnabled Boolean

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

ipv6InterfaceType String

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

ipv6PdInterface String

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

ipv6PdPrefixid String

Specifies the IPv6 Prefix ID.

ipv6PdStart String

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6PdStop String

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6RaEnable Boolean

Specifies whether to enable router advertisements or not.

ipv6RaPreferredLifetime Number

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

ipv6RaPriority String

IPv6 router advertisement priority. Must be one of either high, medium, or low

ipv6RaValidLifetime Number

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

ipv6StaticSubnet String

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

name String

The name of the network.

networkGroup String

The group of the network. Defaults to LAN.

site String

The name of the site to associate the network with.

subnet String

The subnet of the network. Must be a valid CIDR address.

vlanId Number

The VLAN ID of the network.

wanDhcpV6PdSize Number

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

wanDns List<String>

DNS servers IPs of the WAN.

wanEgressQos Number

Specifies the WAN egress quality of service. Defaults to 0.

wanGateway String

The IPv4 gateway of the WAN.

wanGatewayV6 String

The IPv6 gateway of the WAN.

wanIp String

The IPv4 address of the WAN.

wanIpv6 String

The IPv6 address of the WAN.

wanNetmask String

The IPv4 netmask of the WAN.

wanNetworkgroup String

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

wanPrefixlen Number

The IPv6 prefix length of the WAN. Must be between 1 and 128.

wanType String

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

wanTypeV6 String

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

wanUsername String

Specifies the IPV4 WAN username.

xWanPassword String

Specifies the IPV4 WAN password.

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,
        dhcp_dns: Optional[Sequence[str]] = None,
        dhcp_enabled: Optional[bool] = None,
        dhcp_lease: Optional[int] = None,
        dhcp_relay_enabled: Optional[bool] = None,
        dhcp_start: Optional[str] = None,
        dhcp_stop: Optional[str] = None,
        dhcp_v6_dns: Optional[Sequence[str]] = None,
        dhcp_v6_dns_auto: Optional[bool] = None,
        dhcp_v6_enabled: Optional[bool] = None,
        dhcp_v6_lease: Optional[int] = None,
        dhcp_v6_start: Optional[str] = None,
        dhcp_v6_stop: Optional[str] = None,
        dhcpd_boot_enabled: Optional[bool] = None,
        dhcpd_boot_filename: Optional[str] = None,
        dhcpd_boot_server: Optional[str] = None,
        domain_name: Optional[str] = None,
        igmp_snooping: Optional[bool] = None,
        internet_access_enabled: Optional[bool] = None,
        intra_network_access_enabled: Optional[bool] = None,
        ipv6_interface_type: Optional[str] = None,
        ipv6_pd_interface: Optional[str] = None,
        ipv6_pd_prefixid: Optional[str] = None,
        ipv6_pd_start: Optional[str] = None,
        ipv6_pd_stop: Optional[str] = None,
        ipv6_ra_enable: Optional[bool] = None,
        ipv6_ra_preferred_lifetime: Optional[int] = None,
        ipv6_ra_priority: Optional[str] = None,
        ipv6_ra_valid_lifetime: Optional[int] = None,
        ipv6_static_subnet: Optional[str] = None,
        name: Optional[str] = None,
        network_group: Optional[str] = None,
        purpose: Optional[str] = None,
        site: Optional[str] = None,
        subnet: Optional[str] = None,
        vlan_id: Optional[int] = None,
        wan_dhcp_v6_pd_size: Optional[int] = None,
        wan_dns: Optional[Sequence[str]] = None,
        wan_egress_qos: Optional[int] = None,
        wan_gateway: Optional[str] = None,
        wan_gateway_v6: Optional[str] = None,
        wan_ip: Optional[str] = None,
        wan_ipv6: Optional[str] = None,
        wan_netmask: Optional[str] = None,
        wan_networkgroup: Optional[str] = None,
        wan_prefixlen: Optional[int] = None,
        wan_type: Optional[str] = None,
        wan_type_v6: Optional[str] = None,
        wan_username: Optional[str] = None,
        x_wan_password: Optional[str] = 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:
DhcpDns List<string>

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

DhcpEnabled bool

Specifies whether DHCP is enabled or not on this network.

DhcpLease int

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

DhcpRelayEnabled bool

Specifies whether DHCP relay is enabled or not on this network.

DhcpStart string

The IPv4 address where the DHCP range of addresses starts.

DhcpStop string

The IPv4 address where the DHCP range of addresses stops.

DhcpV6Dns List<string>

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

DhcpV6DnsAuto bool

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

DhcpV6Enabled bool

Enable stateful DHCPv6 for static configuration.

DhcpV6Lease int

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

DhcpV6Start string

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

DhcpV6Stop string

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

DhcpdBootEnabled bool

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

DhcpdBootFilename string

Specifies the file to PXE boot from on the dhcpdbootserver.

DhcpdBootServer string

Specifies the IPv4 address of a TFTP server to network boot from.

DomainName string

The domain name of this network.

IgmpSnooping bool

Specifies whether IGMP snooping is enabled or not.

InternetAccessEnabled bool

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

IntraNetworkAccessEnabled bool

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

Ipv6InterfaceType string

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

Ipv6PdInterface string

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

Ipv6PdPrefixid string

Specifies the IPv6 Prefix ID.

Ipv6PdStart string

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

Ipv6PdStop string

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

Ipv6RaEnable bool

Specifies whether to enable router advertisements or not.

Ipv6RaPreferredLifetime int

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

Ipv6RaPriority string

IPv6 router advertisement priority. Must be one of either high, medium, or low

Ipv6RaValidLifetime int

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

Ipv6StaticSubnet string

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

Name string

The name of the network.

NetworkGroup string

The group of the network. Defaults to LAN.

Purpose string

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

Site string

The name of the site to associate the network with.

Subnet string

The subnet of the network. Must be a valid CIDR address.

VlanId int

The VLAN ID of the network.

WanDhcpV6PdSize int

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

WanDns List<string>

DNS servers IPs of the WAN.

WanEgressQos int

Specifies the WAN egress quality of service. Defaults to 0.

WanGateway string

The IPv4 gateway of the WAN.

WanGatewayV6 string

The IPv6 gateway of the WAN.

WanIp string

The IPv4 address of the WAN.

WanIpv6 string

The IPv6 address of the WAN.

WanNetmask string

The IPv4 netmask of the WAN.

WanNetworkgroup string

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

WanPrefixlen int

The IPv6 prefix length of the WAN. Must be between 1 and 128.

WanType string

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

WanTypeV6 string

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

WanUsername string

Specifies the IPV4 WAN username.

XWanPassword string

Specifies the IPV4 WAN password.

DhcpDns []string

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

DhcpEnabled bool

Specifies whether DHCP is enabled or not on this network.

DhcpLease int

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

DhcpRelayEnabled bool

Specifies whether DHCP relay is enabled or not on this network.

DhcpStart string

The IPv4 address where the DHCP range of addresses starts.

DhcpStop string

The IPv4 address where the DHCP range of addresses stops.

DhcpV6Dns []string

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

DhcpV6DnsAuto bool

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

DhcpV6Enabled bool

Enable stateful DHCPv6 for static configuration.

DhcpV6Lease int

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

DhcpV6Start string

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

DhcpV6Stop string

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

DhcpdBootEnabled bool

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

DhcpdBootFilename string

Specifies the file to PXE boot from on the dhcpdbootserver.

DhcpdBootServer string

Specifies the IPv4 address of a TFTP server to network boot from.

DomainName string

The domain name of this network.

IgmpSnooping bool

Specifies whether IGMP snooping is enabled or not.

InternetAccessEnabled bool

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

IntraNetworkAccessEnabled bool

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

Ipv6InterfaceType string

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

Ipv6PdInterface string

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

Ipv6PdPrefixid string

Specifies the IPv6 Prefix ID.

Ipv6PdStart string

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

Ipv6PdStop string

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

Ipv6RaEnable bool

Specifies whether to enable router advertisements or not.

Ipv6RaPreferredLifetime int

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

Ipv6RaPriority string

IPv6 router advertisement priority. Must be one of either high, medium, or low

Ipv6RaValidLifetime int

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

Ipv6StaticSubnet string

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

Name string

The name of the network.

NetworkGroup string

The group of the network. Defaults to LAN.

Purpose string

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

Site string

The name of the site to associate the network with.

Subnet string

The subnet of the network. Must be a valid CIDR address.

VlanId int

The VLAN ID of the network.

WanDhcpV6PdSize int

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

WanDns []string

DNS servers IPs of the WAN.

WanEgressQos int

Specifies the WAN egress quality of service. Defaults to 0.

WanGateway string

The IPv4 gateway of the WAN.

WanGatewayV6 string

The IPv6 gateway of the WAN.

WanIp string

The IPv4 address of the WAN.

WanIpv6 string

The IPv6 address of the WAN.

WanNetmask string

The IPv4 netmask of the WAN.

WanNetworkgroup string

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

WanPrefixlen int

The IPv6 prefix length of the WAN. Must be between 1 and 128.

WanType string

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

WanTypeV6 string

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

WanUsername string

Specifies the IPV4 WAN username.

XWanPassword string

Specifies the IPV4 WAN password.

dhcpDns List<String>

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

dhcpEnabled Boolean

Specifies whether DHCP is enabled or not on this network.

dhcpLease Integer

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

dhcpRelayEnabled Boolean

Specifies whether DHCP relay is enabled or not on this network.

dhcpStart String

The IPv4 address where the DHCP range of addresses starts.

dhcpStop String

The IPv4 address where the DHCP range of addresses stops.

dhcpV6Dns List<String>

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

dhcpV6DnsAuto Boolean

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

dhcpV6Enabled Boolean

Enable stateful DHCPv6 for static configuration.

dhcpV6Lease Integer

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

dhcpV6Start String

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpV6Stop String

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpdBootEnabled Boolean

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

dhcpdBootFilename String

Specifies the file to PXE boot from on the dhcpdbootserver.

dhcpdBootServer String

Specifies the IPv4 address of a TFTP server to network boot from.

domainName String

The domain name of this network.

igmpSnooping Boolean

Specifies whether IGMP snooping is enabled or not.

internetAccessEnabled Boolean

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

intraNetworkAccessEnabled Boolean

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

ipv6InterfaceType String

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

ipv6PdInterface String

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

ipv6PdPrefixid String

Specifies the IPv6 Prefix ID.

ipv6PdStart String

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6PdStop String

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6RaEnable Boolean

Specifies whether to enable router advertisements or not.

ipv6RaPreferredLifetime Integer

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

ipv6RaPriority String

IPv6 router advertisement priority. Must be one of either high, medium, or low

ipv6RaValidLifetime Integer

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

ipv6StaticSubnet String

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

name String

The name of the network.

networkGroup String

The group of the network. Defaults to LAN.

purpose String

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

site String

The name of the site to associate the network with.

subnet String

The subnet of the network. Must be a valid CIDR address.

vlanId Integer

The VLAN ID of the network.

wanDhcpV6PdSize Integer

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

wanDns List<String>

DNS servers IPs of the WAN.

wanEgressQos Integer

Specifies the WAN egress quality of service. Defaults to 0.

wanGateway String

The IPv4 gateway of the WAN.

wanGatewayV6 String

The IPv6 gateway of the WAN.

wanIp String

The IPv4 address of the WAN.

wanIpv6 String

The IPv6 address of the WAN.

wanNetmask String

The IPv4 netmask of the WAN.

wanNetworkgroup String

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

wanPrefixlen Integer

The IPv6 prefix length of the WAN. Must be between 1 and 128.

wanType String

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

wanTypeV6 String

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

wanUsername String

Specifies the IPV4 WAN username.

xWanPassword String

Specifies the IPV4 WAN password.

dhcpDns string[]

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

dhcpEnabled boolean

Specifies whether DHCP is enabled or not on this network.

dhcpLease number

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

dhcpRelayEnabled boolean

Specifies whether DHCP relay is enabled or not on this network.

dhcpStart string

The IPv4 address where the DHCP range of addresses starts.

dhcpStop string

The IPv4 address where the DHCP range of addresses stops.

dhcpV6Dns string[]

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

dhcpV6DnsAuto boolean

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

dhcpV6Enabled boolean

Enable stateful DHCPv6 for static configuration.

dhcpV6Lease number

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

dhcpV6Start string

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpV6Stop string

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpdBootEnabled boolean

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

dhcpdBootFilename string

Specifies the file to PXE boot from on the dhcpdbootserver.

dhcpdBootServer string

Specifies the IPv4 address of a TFTP server to network boot from.

domainName string

The domain name of this network.

igmpSnooping boolean

Specifies whether IGMP snooping is enabled or not.

internetAccessEnabled boolean

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

intraNetworkAccessEnabled boolean

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

ipv6InterfaceType string

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

ipv6PdInterface string

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

ipv6PdPrefixid string

Specifies the IPv6 Prefix ID.

ipv6PdStart string

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6PdStop string

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6RaEnable boolean

Specifies whether to enable router advertisements or not.

ipv6RaPreferredLifetime number

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

ipv6RaPriority string

IPv6 router advertisement priority. Must be one of either high, medium, or low

ipv6RaValidLifetime number

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

ipv6StaticSubnet string

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

name string

The name of the network.

networkGroup string

The group of the network. Defaults to LAN.

purpose string

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

site string

The name of the site to associate the network with.

subnet string

The subnet of the network. Must be a valid CIDR address.

vlanId number

The VLAN ID of the network.

wanDhcpV6PdSize number

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

wanDns string[]

DNS servers IPs of the WAN.

wanEgressQos number

Specifies the WAN egress quality of service. Defaults to 0.

wanGateway string

The IPv4 gateway of the WAN.

wanGatewayV6 string

The IPv6 gateway of the WAN.

wanIp string

The IPv4 address of the WAN.

wanIpv6 string

The IPv6 address of the WAN.

wanNetmask string

The IPv4 netmask of the WAN.

wanNetworkgroup string

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

wanPrefixlen number

The IPv6 prefix length of the WAN. Must be between 1 and 128.

wanType string

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

wanTypeV6 string

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

wanUsername string

Specifies the IPV4 WAN username.

xWanPassword string

Specifies the IPV4 WAN password.

dhcp_dns Sequence[str]

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

dhcp_enabled bool

Specifies whether DHCP is enabled or not on this network.

dhcp_lease int

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

dhcp_relay_enabled bool

Specifies whether DHCP relay is enabled or not on this network.

dhcp_start str

The IPv4 address where the DHCP range of addresses starts.

dhcp_stop str

The IPv4 address where the DHCP range of addresses stops.

dhcp_v6_dns Sequence[str]

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

dhcp_v6_dns_auto bool

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

dhcp_v6_enabled bool

Enable stateful DHCPv6 for static configuration.

dhcp_v6_lease int

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

dhcp_v6_start str

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcp_v6_stop str

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpd_boot_enabled bool

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

dhcpd_boot_filename str

Specifies the file to PXE boot from on the dhcpdbootserver.

dhcpd_boot_server str

Specifies the IPv4 address of a TFTP server to network boot from.

domain_name str

The domain name of this network.

igmp_snooping bool

Specifies whether IGMP snooping is enabled or not.

internet_access_enabled bool

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

intra_network_access_enabled bool

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

ipv6_interface_type str

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

ipv6_pd_interface str

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

ipv6_pd_prefixid str

Specifies the IPv6 Prefix ID.

ipv6_pd_start str

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6_pd_stop str

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6_ra_enable bool

Specifies whether to enable router advertisements or not.

ipv6_ra_preferred_lifetime int

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

ipv6_ra_priority str

IPv6 router advertisement priority. Must be one of either high, medium, or low

ipv6_ra_valid_lifetime int

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

ipv6_static_subnet str

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

name str

The name of the network.

network_group str

The group of the network. Defaults to LAN.

purpose str

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

site str

The name of the site to associate the network with.

subnet str

The subnet of the network. Must be a valid CIDR address.

vlan_id int

The VLAN ID of the network.

wan_dhcp_v6_pd_size int

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

wan_dns Sequence[str]

DNS servers IPs of the WAN.

wan_egress_qos int

Specifies the WAN egress quality of service. Defaults to 0.

wan_gateway str

The IPv4 gateway of the WAN.

wan_gateway_v6 str

The IPv6 gateway of the WAN.

wan_ip str

The IPv4 address of the WAN.

wan_ipv6 str

The IPv6 address of the WAN.

wan_netmask str

The IPv4 netmask of the WAN.

wan_networkgroup str

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

wan_prefixlen int

The IPv6 prefix length of the WAN. Must be between 1 and 128.

wan_type str

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

wan_type_v6 str

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

wan_username str

Specifies the IPV4 WAN username.

x_wan_password str

Specifies the IPV4 WAN password.

dhcpDns List<String>

Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.

dhcpEnabled Boolean

Specifies whether DHCP is enabled or not on this network.

dhcpLease Number

Specifies the lease time for DHCP addresses in seconds. Defaults to 86400.

dhcpRelayEnabled Boolean

Specifies whether DHCP relay is enabled or not on this network.

dhcpStart String

The IPv4 address where the DHCP range of addresses starts.

dhcpStop String

The IPv4 address where the DHCP range of addresses stops.

dhcpV6Dns List<String>

Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if dhcp_v6_dns_auto is set to false.

dhcpV6DnsAuto Boolean

Specifies DNS source to propagate. If set false the entries in dhcp_v6_dns are used, the upstream entries otherwise Defaults to true.

dhcpV6Enabled Boolean

Enable stateful DHCPv6 for static configuration.

dhcpV6Lease Number

Specifies the lease time for DHCPv6 addresses in seconds. Defaults to 86400.

dhcpV6Start String

Start address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpV6Stop String

End address of the DHCPv6 range. Used in static DHCPv6 configuration.

dhcpdBootEnabled Boolean

Toggles on the DHCP boot options. Should be set to true when you want to have dhcpdbootfilename, and dhcpdbootserver to take effect.

dhcpdBootFilename String

Specifies the file to PXE boot from on the dhcpdbootserver.

dhcpdBootServer String

Specifies the IPv4 address of a TFTP server to network boot from.

domainName String

The domain name of this network.

igmpSnooping Boolean

Specifies whether IGMP snooping is enabled or not.

internetAccessEnabled Boolean

Specifies whether this network should be allowed to access the internet or not. Defaults to true.

intraNetworkAccessEnabled Boolean

Specifies whether this network should be allowed to access other local networks or not. Defaults to true.

ipv6InterfaceType String

Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.

ipv6PdInterface String

Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.

ipv6PdPrefixid String

Specifies the IPv6 Prefix ID.

ipv6PdStart String

Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6PdStop String

End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.

ipv6RaEnable Boolean

Specifies whether to enable router advertisements or not.

ipv6RaPreferredLifetime Number

Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.

ipv6RaPriority String

IPv6 router advertisement priority. Must be one of either high, medium, or low

ipv6RaValidLifetime Number

Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.

ipv6StaticSubnet String

Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.

name String

The name of the network.

networkGroup String

The group of the network. Defaults to LAN.

purpose String

The purpose of the network. Must be one of corporate, guest, wan, or vlan-only.

site String

The name of the site to associate the network with.

subnet String

The subnet of the network. Must be a valid CIDR address.

vlanId Number

The VLAN ID of the network.

wanDhcpV6PdSize Number

Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.

wanDns List<String>

DNS servers IPs of the WAN.

wanEgressQos Number

Specifies the WAN egress quality of service. Defaults to 0.

wanGateway String

The IPv4 gateway of the WAN.

wanGatewayV6 String

The IPv6 gateway of the WAN.

wanIp String

The IPv4 address of the WAN.

wanIpv6 String

The IPv6 address of the WAN.

wanNetmask String

The IPv4 netmask of the WAN.

wanNetworkgroup String

Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.

wanPrefixlen Number

The IPv6 prefix length of the WAN. Must be between 1 and 128.

wanType String

Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.

wanTypeV6 String

Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.

wanUsername String

Specifies the IPV4 WAN username.

xWanPassword String

Specifies the IPV4 WAN password.

Import

import from provider configured site

 $ pulumi import unifi:index/network:Network mynetwork 5dc28e5e9106d105bdc87217

import from another site

 $ pulumi import unifi:index/network:Network mynetwork bfa2l6i7:5dc28e5e9106d105bdc87217

import network by name

 $ pulumi import unifi:index/network:Network mynetwork name=LAN

Package Details

Repository
unifi pulumiverse/pulumi-unifi
License
Apache-2.0
Notes

This Pulumi package is based on the unifi Terraform Provider.