1. Packages
  2. Unifi
  3. API Docs
  4. getNetwork
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

unifi.getNetwork

Get Started
unifi logo
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

    unifi.Network data source can be used to retrieve settings for a network by name or ID.

    Example Usage

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

//retrieve network data by unifi network name
const lanNetwork = unifi.getNetwork({
    name: "Default",
});
//retrieve network data from user record
const myDevice = unifi.iam.getUser({
    mac: "01:23:45:67:89:ab",
});
const myNetwork = myDevice.then(myDevice => unifi.getNetwork({
    id: myDevice.networkId,
}));

    import pulumi
import pulumi_unifi as unifi

#retrieve network data by unifi network name
lan_network = unifi.get_network(name="Default")
#retrieve network data from user record
my_device = unifi.iam.get_user(mac="01:23:45:67:89:ab")
my_network = unifi.get_network(id=my_device.network_id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// retrieve network data by unifi network name
		_, err := unifi.LookupNetwork(ctx, &unifi.LookupNetworkArgs{
			Name: pulumi.StringRef("Default"),
		}, nil)
		if err != nil {
			return err
		}
		// retrieve network data from user record
		myDevice, err := iam.LookupUser(ctx, &iam.LookupUserArgs{
			Mac: "01:23:45:67:89:ab",
		}, nil)
		if err != nil {
			return err
		}
		_, err = unifi.LookupNetwork(ctx, &unifi.LookupNetworkArgs{
			Id: pulumi.StringRef(myDevice.NetworkId),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    //retrieve network data by unifi network name
    var lanNetwork = Unifi.GetNetwork.Invoke(new()
    {
        Name = "Default",
    });

    //retrieve network data from user record
    var myDevice = Unifi.IAM.GetUser.Invoke(new()
    {
        Mac = "01:23:45:67:89:ab",
    });

    var myNetwork = Unifi.GetNetwork.Invoke(new()
    {
        Id = myDevice.Apply(getUserResult => getUserResult.NetworkId),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.unifi.UnifiFunctions;
import com.pulumi.unifi.inputs.GetNetworkArgs;
import com.pulumi.unifi.iam.IamFunctions;
import com.pulumi.unifi.iam.inputs.GetUserArgs;
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) {
        //retrieve network data by unifi network name
        final var lanNetwork = UnifiFunctions.getNetwork(GetNetworkArgs.builder()
            .name("Default")
            .build());

        //retrieve network data from user record
        final var myDevice = IamFunctions.getUser(GetUserArgs.builder()
            .mac("01:23:45:67:89:ab")
            .build());

        final var myNetwork = UnifiFunctions.getNetwork(GetNetworkArgs.builder()
            .id(myDevice.applyValue(getUserResult -> getUserResult.networkId()))
            .build());

    }
}

    variables:
  #retrieve network data by unifi network name
  lanNetwork:
    fn::invoke:
      Function: unifi:getNetwork
      Arguments:
        name: Default
  #retrieve network data from user record
  myDevice:
    fn::invoke:
      Function: unifi:iam:getUser
      Arguments:
        mac: 01:23:45:67:89:ab
  myNetwork:
    fn::invoke:
      Function: unifi:getNetwork
      Arguments:
        id: ${myDevice.networkId}

    Using getNetwork

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>
function getNetworkOutput(args: GetNetworkOutputArgs, opts?: InvokeOptions): Output<GetNetworkResult>
    def get_network(id: Optional[str] = None,
                name: Optional[str] = None,
                site: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetNetworkResult
def get_network_output(id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                site: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetNetworkResult]
    func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput

    > Note: This function is named LookupNetwork in the Go SDK.

    public static class GetNetwork 
{
    public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkResult> Invoke(GetNetworkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
public static Output<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)

    fn::invoke:
  function: unifi:index/getNetwork:getNetwork
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the network.
    Name string
    The name of the network.
    Site string
    The name of the site to associate the network with.
    Id string
    The ID of the network.
    Name string
    The name of the network.
    Site string
    The name of the site to associate the network with.
    id String
    The ID of the network.
    name String
    The name of the network.
    site String
    The name of the site to associate the network with.
    id string
    The ID of the network.
    name string
    The name of the network.
    site string
    The name of the site to associate the network with.
    id str
    The ID of the network.
    name str
    The name of the network.
    site str
    The name of the site to associate the network with.
    id String
    The ID of the network.
    name String
    The name of the network.
    site String
    The name of the site to associate the network with.

    getNetwork Result

    The following output properties are available:

    DhcpDns List<string>
    IPv4 addresses for the DNS server to be returned from the DHCP server.
    DhcpEnabled bool
    whether DHCP is enabled or not on this network.
    DhcpLease int
    lease time for DHCP addresses.
    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
    DhcpV6Enabled bool
    Enable stateful DHCPv6 for static configuration.
    DhcpV6Lease int
    Specifies the lease time for DHCPv6 addresses.
    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. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
    DhcpdBootFilename string
    the file to PXE boot from on the dhcpdbootserver.
    DhcpdBootServer string
    IPv4 address of a TFTP server to network boot from.
    DomainName string
    The domain name of this network.
    Id string
    The ID of the network.
    IgmpSnooping bool
    Specifies whether IGMP snooping is enabled or not.
    Ipv6InterfaceType string
    Specifies which type of IPv6 connection to use. Must be one of either static, pd, or 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
    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.
    Ipv6StaticSubnet string
    Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
    MulticastDns bool
    Specifies whether Multicast DNS (mDNS) is enabled or not on the network (Controller >=v7).
    Name string
    The name of the network.
    NetworkGroup string
    The group of the network.
    Purpose string
    The purpose of the network. 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 (CIDR address).
    VlanId int
    The VLAN ID of the network.
    WanDhcpV6PdSize int
    Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
    WanDns List<string>
    DNS servers IPs of the WAN.
    WanEgressQos int
    Specifies the WAN egress quality of service.
    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. 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. 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
    IPv4 addresses for the DNS server to be returned from the DHCP server.
    DhcpEnabled bool
    whether DHCP is enabled or not on this network.
    DhcpLease int
    lease time for DHCP addresses.
    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
    DhcpV6Enabled bool
    Enable stateful DHCPv6 for static configuration.
    DhcpV6Lease int
    Specifies the lease time for DHCPv6 addresses.
    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. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
    DhcpdBootFilename string
    the file to PXE boot from on the dhcpdbootserver.
    DhcpdBootServer string
    IPv4 address of a TFTP server to network boot from.
    DomainName string
    The domain name of this network.
    Id string
    The ID of the network.
    IgmpSnooping bool
    Specifies whether IGMP snooping is enabled or not.
    Ipv6InterfaceType string
    Specifies which type of IPv6 connection to use. Must be one of either static, pd, or 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
    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.
    Ipv6StaticSubnet string
    Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
    MulticastDns bool
    Specifies whether Multicast DNS (mDNS) is enabled or not on the network (Controller >=v7).
    Name string
    The name of the network.
    NetworkGroup string
    The group of the network.
    Purpose string
    The purpose of the network. 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 (CIDR address).
    VlanId int
    The VLAN ID of the network.
    WanDhcpV6PdSize int
    Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
    WanDns []string
    DNS servers IPs of the WAN.
    WanEgressQos int
    Specifies the WAN egress quality of service.
    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. 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. 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>
    IPv4 addresses for the DNS server to be returned from the DHCP server.
    dhcpEnabled Boolean
    whether DHCP is enabled or not on this network.
    dhcpLease Integer
    lease time for DHCP addresses.
    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
    dhcpV6Enabled Boolean
    Enable stateful DHCPv6 for static configuration.
    dhcpV6Lease Integer
    Specifies the lease time for DHCPv6 addresses.
    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. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
    dhcpdBootFilename String
    the file to PXE boot from on the dhcpdbootserver.
    dhcpdBootServer String
    IPv4 address of a TFTP server to network boot from.
    domainName String
    The domain name of this network.
    id String
    The ID of the network.
    igmpSnooping Boolean
    Specifies whether IGMP snooping is enabled or not.
    ipv6InterfaceType String
    Specifies which type of IPv6 connection to use. Must be one of either static, pd, or 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
    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.
    ipv6StaticSubnet String
    Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
    multicastDns Boolean
    Specifies whether Multicast DNS (mDNS) is enabled or not on the network (Controller >=v7).
    name String
    The name of the network.
    networkGroup String
    The group of the network.
    purpose String
    The purpose of the network. 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 (CIDR address).
    vlanId Integer
    The VLAN ID of the network.
    wanDhcpV6PdSize Integer
    Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
    wanDns List<String>
    DNS servers IPs of the WAN.
    wanEgressQos Integer
    Specifies the WAN egress quality of service.
    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. 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. 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[]
    IPv4 addresses for the DNS server to be returned from the DHCP server.
    dhcpEnabled boolean
    whether DHCP is enabled or not on this network.
    dhcpLease number
    lease time for DHCP addresses.
    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
    dhcpV6Enabled boolean
    Enable stateful DHCPv6 for static configuration.
    dhcpV6Lease number
    Specifies the lease time for DHCPv6 addresses.
    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. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
    dhcpdBootFilename string
    the file to PXE boot from on the dhcpdbootserver.
    dhcpdBootServer string
    IPv4 address of a TFTP server to network boot from.
    domainName string
    The domain name of this network.
    id string
    The ID of the network.
    igmpSnooping boolean
    Specifies whether IGMP snooping is enabled or not.
    ipv6InterfaceType string
    Specifies which type of IPv6 connection to use. Must be one of either static, pd, or 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
    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.
    ipv6StaticSubnet string
    Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
    multicastDns boolean
    Specifies whether Multicast DNS (mDNS) is enabled or not on the network (Controller >=v7).
    name string
    The name of the network.
    networkGroup string
    The group of the network.
    purpose string
    The purpose of the network. 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 (CIDR address).
    vlanId number
    The VLAN ID of the network.
    wanDhcpV6PdSize number
    Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
    wanDns string[]
    DNS servers IPs of the WAN.
    wanEgressQos number
    Specifies the WAN egress quality of service.
    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. 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. 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]
    IPv4 addresses for the DNS server to be returned from the DHCP server.
    dhcp_enabled bool
    whether DHCP is enabled or not on this network.
    dhcp_lease int
    lease time for DHCP addresses.
    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
    dhcp_v6_enabled bool
    Enable stateful DHCPv6 for static configuration.
    dhcp_v6_lease int
    Specifies the lease time for DHCPv6 addresses.
    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. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
    dhcpd_boot_filename str
    the file to PXE boot from on the dhcpdbootserver.
    dhcpd_boot_server str
    IPv4 address of a TFTP server to network boot from.
    domain_name str
    The domain name of this network.
    id str
    The ID of the network.
    igmp_snooping bool
    Specifies whether IGMP snooping is enabled or not.
    ipv6_interface_type str
    Specifies which type of IPv6 connection to use. Must be one of either static, pd, or 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
    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.
    ipv6_static_subnet str
    Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
    multicast_dns bool
    Specifies whether Multicast DNS (mDNS) is enabled or not on the network (Controller >=v7).
    name str
    The name of the network.
    network_group str
    The group of the network.
    purpose str
    The purpose of the network. 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 (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 a number 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.
    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. 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. 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>
    IPv4 addresses for the DNS server to be returned from the DHCP server.
    dhcpEnabled Boolean
    whether DHCP is enabled or not on this network.
    dhcpLease Number
    lease time for DHCP addresses.
    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
    dhcpV6Enabled Boolean
    Enable stateful DHCPv6 for static configuration.
    dhcpV6Lease Number
    Specifies the lease time for DHCPv6 addresses.
    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. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
    dhcpdBootFilename String
    the file to PXE boot from on the dhcpdbootserver.
    dhcpdBootServer String
    IPv4 address of a TFTP server to network boot from.
    domainName String
    The domain name of this network.
    id String
    The ID of the network.
    igmpSnooping Boolean
    Specifies whether IGMP snooping is enabled or not.
    ipv6InterfaceType String
    Specifies which type of IPv6 connection to use. Must be one of either static, pd, or 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
    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.
    ipv6StaticSubnet String
    Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
    multicastDns Boolean
    Specifies whether Multicast DNS (mDNS) is enabled or not on the network (Controller >=v7).
    name String
    The name of the network.
    networkGroup String
    The group of the network.
    purpose String
    The purpose of the network. 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 (CIDR address).
    vlanId Number
    The VLAN ID of the network.
    wanDhcpV6PdSize Number
    Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
    wanDns List<String>
    DNS servers IPs of the WAN.
    wanEgressQos Number
    Specifies the WAN egress quality of service.
    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. 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. 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.

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-unifi
      Meet Neo: Your AI Platform Teammate