unifi.getNetwork
unifi.Network
data source can be used to retrieve settings for a network by name or ID.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Unifi = Pulumi.Unifi;
return await Deployment.RunAsync(() =>
{
var lanNetwork = Unifi.GetNetwork.Invoke(new()
{
Name = "Default",
});
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 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 {
_, err = unifi.LookupNetwork(ctx, &unifi.LookupNetworkArgs{
Name: pulumi.StringRef("Default"),
}, nil)
if err != nil {
return err
}
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
})
}
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) {
final var lanNetwork = UnifiFunctions.getNetwork(GetNetworkArgs.builder()
.name("Default")
.build());
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());
}
}
import pulumi
import pulumi_unifi as unifi
lan_network = unifi.get_network(name="Default")
my_device = unifi.iam.get_user(mac="01:23:45:67:89:ab")
my_network = unifi.get_network(id=my_device.network_id)
import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumi/unifi";
const lanNetwork = unifi.getNetwork({
name: "Default",
});
const myDevice = unifi.iam.getUser({
mac: "01:23:45:67:89:ab",
});
const myNetwork = myDevice.then(myDevice => unifi.getNetwork({
id: myDevice.networkId,
}));
variables:
lanNetwork:
fn::invoke:
Function: unifi:getNetwork
Arguments:
name: Default
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: unifi:index/getNetwork:getNetwork
arguments:
# arguments dictionary
The following arguments are supported:
getNetwork Result
The following output properties are available:
- Dhcp
Dns List<string> 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 string The IPv4 address where the DHCP range of addresses starts.
- Dhcp
Stop string The IPv4 address where the DHCP range of addresses stops.
- Dhcp
V6Dns 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 tofalse
.- Dhcp
V6Dns boolAuto Specifies DNS source to propagate. If set
false
the entries indhcp_v6_dns
are used, the upstream entries otherwise- Dhcp
V6Enabled bool Enable stateful DHCPv6 for static configuration.
- Dhcp
V6Lease int Specifies the lease time for DHCPv6 addresses.
- Dhcp
V6Start string Start address of the DHCPv6 range. Used in static DHCPv6 configuration.
- Dhcp
V6Stop string End address of the DHCPv6 range. Used in static DHCPv6 configuration.
- Dhcpd
Boot boolEnabled Toggles on the DHCP boot options. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
- Dhcpd
Boot stringFilename the file to PXE boot from on the dhcpdbootserver.
- Dhcpd
Boot stringServer IPv4 address of a TFTP server to network boot from.
- Domain
Name string The domain name of this network.
- Id string
The ID of the network.
- Igmp
Snooping bool Specifies whether IGMP snooping is enabled or not.
- Ipv6Interface
Type string Specifies which type of IPv6 connection to use. Must be one of either
static
,pd
, ornone
.- Ipv6Pd
Interface string Specifies which WAN interface to use for IPv6 PD. Must be one of either
wan
orwan2
.- Ipv6Pd
Prefixid string Specifies the IPv6 Prefix ID.
- Ipv6Pd
Start string Start address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- Ipv6Pd
Stop string End address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- Ipv6Ra
Enable bool Specifies whether to enable router advertisements or not.
- Ipv6Ra
Preferred intLifetime Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to
ipv6_ra_valid_lifetime
- Ipv6Ra
Priority string IPv6 router advertisement priority. Must be one of either
high
,medium
, orlow
- Ipv6Ra
Valid intLifetime Total lifetime in which the address can be used. Must be equal to or greater than
ipv6_ra_preferred_lifetime
.- Ipv6Static
Subnet string Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
- Name string
The name of the network.
- Network
Group string The group of the network.
- Purpose string
The purpose of the network. One of
corporate
,guest
,wan
, orvlan-only
.- Site string
The name of the site to associate the network with.
- Subnet string
The subnet of the network (CIDR address).
- Vlan
Id int The VLAN ID of the network.
- Wan
Dhcp intV6Pd Size Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
- Wan
Dns List<string> DNS servers IPs of the WAN.
- Wan
Egress intQos Specifies the WAN egress quality of service.
- Wan
Gateway string The IPv4 gateway of the WAN.
- Wan
Gateway stringV6 The IPv6 gateway of the WAN.
- Wan
Ip string The IPv4 address of the WAN.
- Wan
Ipv6 string The IPv6 address of the WAN.
- Wan
Netmask string The IPv4 netmask of the WAN.
- Wan
Networkgroup string Specifies the WAN network group. One of either
WAN
,WAN2
orWAN_LTE_FAILOVER
.- Wan
Prefixlen int The IPv6 prefix length of the WAN. Must be between 1 and 128.
- Wan
Type string Specifies the IPV4 WAN connection type. One of either
disabled
,static
,dhcp
, orpppoe
.- Wan
Type stringV6 Specifies the IPV6 WAN connection type. Must be one of either
disabled
,static
, ordhcpv6
.- Wan
Username string Specifies the IPV4 WAN username.
- XWan
Password string Specifies the IPV4 WAN password.
- Dhcp
Dns []string 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 string The IPv4 address where the DHCP range of addresses starts.
- Dhcp
Stop string The IPv4 address where the DHCP range of addresses stops.
- Dhcp
V6Dns []string Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if
dhcp_v6_dns_auto
is set tofalse
.- Dhcp
V6Dns boolAuto Specifies DNS source to propagate. If set
false
the entries indhcp_v6_dns
are used, the upstream entries otherwise- Dhcp
V6Enabled bool Enable stateful DHCPv6 for static configuration.
- Dhcp
V6Lease int Specifies the lease time for DHCPv6 addresses.
- Dhcp
V6Start string Start address of the DHCPv6 range. Used in static DHCPv6 configuration.
- Dhcp
V6Stop string End address of the DHCPv6 range. Used in static DHCPv6 configuration.
- Dhcpd
Boot boolEnabled Toggles on the DHCP boot options. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
- Dhcpd
Boot stringFilename the file to PXE boot from on the dhcpdbootserver.
- Dhcpd
Boot stringServer IPv4 address of a TFTP server to network boot from.
- Domain
Name string The domain name of this network.
- Id string
The ID of the network.
- Igmp
Snooping bool Specifies whether IGMP snooping is enabled or not.
- Ipv6Interface
Type string Specifies which type of IPv6 connection to use. Must be one of either
static
,pd
, ornone
.- Ipv6Pd
Interface string Specifies which WAN interface to use for IPv6 PD. Must be one of either
wan
orwan2
.- Ipv6Pd
Prefixid string Specifies the IPv6 Prefix ID.
- Ipv6Pd
Start string Start address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- Ipv6Pd
Stop string End address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- Ipv6Ra
Enable bool Specifies whether to enable router advertisements or not.
- Ipv6Ra
Preferred intLifetime Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to
ipv6_ra_valid_lifetime
- Ipv6Ra
Priority string IPv6 router advertisement priority. Must be one of either
high
,medium
, orlow
- Ipv6Ra
Valid intLifetime Total lifetime in which the address can be used. Must be equal to or greater than
ipv6_ra_preferred_lifetime
.- Ipv6Static
Subnet string Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
- Name string
The name of the network.
- Network
Group string The group of the network.
- Purpose string
The purpose of the network. One of
corporate
,guest
,wan
, orvlan-only
.- Site string
The name of the site to associate the network with.
- Subnet string
The subnet of the network (CIDR address).
- Vlan
Id int The VLAN ID of the network.
- Wan
Dhcp intV6Pd Size Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
- Wan
Dns []string DNS servers IPs of the WAN.
- Wan
Egress intQos Specifies the WAN egress quality of service.
- Wan
Gateway string The IPv4 gateway of the WAN.
- Wan
Gateway stringV6 The IPv6 gateway of the WAN.
- Wan
Ip string The IPv4 address of the WAN.
- Wan
Ipv6 string The IPv6 address of the WAN.
- Wan
Netmask string The IPv4 netmask of the WAN.
- Wan
Networkgroup string Specifies the WAN network group. One of either
WAN
,WAN2
orWAN_LTE_FAILOVER
.- Wan
Prefixlen int The IPv6 prefix length of the WAN. Must be between 1 and 128.
- Wan
Type string Specifies the IPV4 WAN connection type. One of either
disabled
,static
,dhcp
, orpppoe
.- Wan
Type stringV6 Specifies the IPV6 WAN connection type. Must be one of either
disabled
,static
, ordhcpv6
.- Wan
Username string Specifies the IPV4 WAN username.
- XWan
Password string Specifies the IPV4 WAN password.
- dhcp
Dns List<String> IPv4 addresses for the DNS server to be returned from the DHCP server.
- dhcp
Enabled Boolean whether DHCP is enabled or not on this network.
- dhcp
Lease Integer lease time for DHCP addresses.
- dhcp
Start String The IPv4 address where the DHCP range of addresses starts.
- dhcp
Stop String The IPv4 address where the DHCP range of addresses stops.
- dhcp
V6Dns 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 tofalse
.- dhcp
V6Dns BooleanAuto Specifies DNS source to propagate. If set
false
the entries indhcp_v6_dns
are used, the upstream entries otherwise- dhcp
V6Enabled Boolean Enable stateful DHCPv6 for static configuration.
- dhcp
V6Lease Integer Specifies the lease time for DHCPv6 addresses.
- dhcp
V6Start String Start address of the DHCPv6 range. Used in static DHCPv6 configuration.
- dhcp
V6Stop String End address of the DHCPv6 range. Used in static DHCPv6 configuration.
- dhcpd
Boot BooleanEnabled Toggles on the DHCP boot options. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
- dhcpd
Boot StringFilename the file to PXE boot from on the dhcpdbootserver.
- dhcpd
Boot StringServer IPv4 address of a TFTP server to network boot from.
- domain
Name String The domain name of this network.
- id String
The ID of the network.
- igmp
Snooping Boolean Specifies whether IGMP snooping is enabled or not.
- ipv6Interface
Type String Specifies which type of IPv6 connection to use. Must be one of either
static
,pd
, ornone
.- ipv6Pd
Interface String Specifies which WAN interface to use for IPv6 PD. Must be one of either
wan
orwan2
.- ipv6Pd
Prefixid String Specifies the IPv6 Prefix ID.
- ipv6Pd
Start String Start address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- ipv6Pd
Stop String End address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- ipv6Ra
Enable Boolean Specifies whether to enable router advertisements or not.
- ipv6Ra
Preferred IntegerLifetime Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to
ipv6_ra_valid_lifetime
- ipv6Ra
Priority String IPv6 router advertisement priority. Must be one of either
high
,medium
, orlow
- ipv6Ra
Valid IntegerLifetime Total lifetime in which the address can be used. Must be equal to or greater than
ipv6_ra_preferred_lifetime
.- ipv6Static
Subnet String Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
- name String
The name of the network.
- network
Group String The group of the network.
- purpose String
The purpose of the network. One of
corporate
,guest
,wan
, orvlan-only
.- site String
The name of the site to associate the network with.
- subnet String
The subnet of the network (CIDR address).
- vlan
Id Integer The VLAN ID of the network.
- wan
Dhcp IntegerV6Pd Size Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
- wan
Dns List<String> DNS servers IPs of the WAN.
- wan
Egress IntegerQos Specifies the WAN egress quality of service.
- wan
Gateway String The IPv4 gateway of the WAN.
- wan
Gateway StringV6 The IPv6 gateway of the WAN.
- wan
Ip String The IPv4 address of the WAN.
- wan
Ipv6 String The IPv6 address of the WAN.
- wan
Netmask String The IPv4 netmask of the WAN.
- wan
Networkgroup String Specifies the WAN network group. One of either
WAN
,WAN2
orWAN_LTE_FAILOVER
.- wan
Prefixlen Integer The IPv6 prefix length of the WAN. Must be between 1 and 128.
- wan
Type String Specifies the IPV4 WAN connection type. One of either
disabled
,static
,dhcp
, orpppoe
.- wan
Type StringV6 Specifies the IPV6 WAN connection type. Must be one of either
disabled
,static
, ordhcpv6
.- wan
Username String Specifies the IPV4 WAN username.
- x
Wan StringPassword Specifies the IPV4 WAN password.
- dhcp
Dns string[] IPv4 addresses for the DNS server to be returned from the DHCP server.
- dhcp
Enabled boolean whether DHCP is enabled or not on this network.
- dhcp
Lease number lease time for DHCP addresses.
- dhcp
Start string The IPv4 address where the DHCP range of addresses starts.
- dhcp
Stop string The IPv4 address where the DHCP range of addresses stops.
- dhcp
V6Dns string[] Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if
dhcp_v6_dns_auto
is set tofalse
.- dhcp
V6Dns booleanAuto Specifies DNS source to propagate. If set
false
the entries indhcp_v6_dns
are used, the upstream entries otherwise- dhcp
V6Enabled boolean Enable stateful DHCPv6 for static configuration.
- dhcp
V6Lease number Specifies the lease time for DHCPv6 addresses.
- dhcp
V6Start string Start address of the DHCPv6 range. Used in static DHCPv6 configuration.
- dhcp
V6Stop string End address of the DHCPv6 range. Used in static DHCPv6 configuration.
- dhcpd
Boot booleanEnabled Toggles on the DHCP boot options. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
- dhcpd
Boot stringFilename the file to PXE boot from on the dhcpdbootserver.
- dhcpd
Boot stringServer IPv4 address of a TFTP server to network boot from.
- domain
Name string The domain name of this network.
- id string
The ID of the network.
- igmp
Snooping boolean Specifies whether IGMP snooping is enabled or not.
- ipv6Interface
Type string Specifies which type of IPv6 connection to use. Must be one of either
static
,pd
, ornone
.- ipv6Pd
Interface string Specifies which WAN interface to use for IPv6 PD. Must be one of either
wan
orwan2
.- ipv6Pd
Prefixid string Specifies the IPv6 Prefix ID.
- ipv6Pd
Start string Start address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- ipv6Pd
Stop string End address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- ipv6Ra
Enable boolean Specifies whether to enable router advertisements or not.
- ipv6Ra
Preferred numberLifetime Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to
ipv6_ra_valid_lifetime
- ipv6Ra
Priority string IPv6 router advertisement priority. Must be one of either
high
,medium
, orlow
- ipv6Ra
Valid numberLifetime Total lifetime in which the address can be used. Must be equal to or greater than
ipv6_ra_preferred_lifetime
.- ipv6Static
Subnet string Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
- name string
The name of the network.
- network
Group string The group of the network.
- purpose string
The purpose of the network. One of
corporate
,guest
,wan
, orvlan-only
.- site string
The name of the site to associate the network with.
- subnet string
The subnet of the network (CIDR address).
- vlan
Id number The VLAN ID of the network.
- wan
Dhcp numberV6Pd Size Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
- wan
Dns string[] DNS servers IPs of the WAN.
- wan
Egress numberQos Specifies the WAN egress quality of service.
- wan
Gateway string The IPv4 gateway of the WAN.
- wan
Gateway stringV6 The IPv6 gateway of the WAN.
- wan
Ip string The IPv4 address of the WAN.
- wan
Ipv6 string The IPv6 address of the WAN.
- wan
Netmask string The IPv4 netmask of the WAN.
- wan
Networkgroup string Specifies the WAN network group. One of either
WAN
,WAN2
orWAN_LTE_FAILOVER
.- wan
Prefixlen number The IPv6 prefix length of the WAN. Must be between 1 and 128.
- wan
Type string Specifies the IPV4 WAN connection type. One of either
disabled
,static
,dhcp
, orpppoe
.- wan
Type stringV6 Specifies the IPV6 WAN connection type. Must be one of either
disabled
,static
, ordhcpv6
.- wan
Username string Specifies the IPV4 WAN username.
- x
Wan stringPassword 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_ Sequence[str]dns Specifies the IPv6 addresses for the DNS server to be returned from the DHCP server. Used if
dhcp_v6_dns_auto
is set tofalse
.- dhcp_
v6_ booldns_ auto Specifies DNS source to propagate. If set
false
the entries indhcp_v6_dns
are used, the upstream entries otherwise- dhcp_
v6_ boolenabled Enable stateful DHCPv6 for static configuration.
- dhcp_
v6_ intlease Specifies the lease time for DHCPv6 addresses.
- dhcp_
v6_ strstart Start address of the DHCPv6 range. Used in static DHCPv6 configuration.
- dhcp_
v6_ strstop End address of the DHCPv6 range. Used in static DHCPv6 configuration.
- dhcpd_
boot_ boolenabled Toggles on the DHCP boot options. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
- dhcpd_
boot_ strfilename the file to PXE boot from on the dhcpdbootserver.
- dhcpd_
boot_ strserver 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_ strtype Specifies which type of IPv6 connection to use. Must be one of either
static
,pd
, ornone
.- ipv6_
pd_ strinterface Specifies which WAN interface to use for IPv6 PD. Must be one of either
wan
orwan2
.- ipv6_
pd_ strprefixid Specifies the IPv6 Prefix ID.
- ipv6_
pd_ strstart Start address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- ipv6_
pd_ strstop End address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- ipv6_
ra_ boolenable Specifies whether to enable router advertisements or not.
- ipv6_
ra_ intpreferred_ lifetime 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_ strpriority IPv6 router advertisement priority. Must be one of either
high
,medium
, orlow
- ipv6_
ra_ intvalid_ lifetime Total lifetime in which the address can be used. Must be equal to or greater than
ipv6_ra_preferred_lifetime
.- ipv6_
static_ strsubnet Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
- 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
, orvlan-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_ intv6_ pd_ size 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_ intqos Specifies the WAN egress quality of service.
- wan_
gateway str The IPv4 gateway of the WAN.
- wan_
gateway_ strv6 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
orWAN_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
, orpppoe
.- wan_
type_ strv6 Specifies the IPV6 WAN connection type. Must be one of either
disabled
,static
, ordhcpv6
.- wan_
username str Specifies the IPV4 WAN username.
- x_
wan_ strpassword Specifies the IPV4 WAN password.
- dhcp
Dns List<String> IPv4 addresses for the DNS server to be returned from the DHCP server.
- dhcp
Enabled Boolean whether DHCP is enabled or not on this network.
- dhcp
Lease Number lease time for DHCP addresses.
- dhcp
Start String The IPv4 address where the DHCP range of addresses starts.
- dhcp
Stop String The IPv4 address where the DHCP range of addresses stops.
- dhcp
V6Dns 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 tofalse
.- dhcp
V6Dns BooleanAuto Specifies DNS source to propagate. If set
false
the entries indhcp_v6_dns
are used, the upstream entries otherwise- dhcp
V6Enabled Boolean Enable stateful DHCPv6 for static configuration.
- dhcp
V6Lease Number Specifies the lease time for DHCPv6 addresses.
- dhcp
V6Start String Start address of the DHCPv6 range. Used in static DHCPv6 configuration.
- dhcp
V6Stop String End address of the DHCPv6 range. Used in static DHCPv6 configuration.
- dhcpd
Boot BooleanEnabled Toggles on the DHCP boot options. will be set to true if you have dhcpdbootfilename, and dhcpdbootserver set.
- dhcpd
Boot StringFilename the file to PXE boot from on the dhcpdbootserver.
- dhcpd
Boot StringServer IPv4 address of a TFTP server to network boot from.
- domain
Name String The domain name of this network.
- id String
The ID of the network.
- igmp
Snooping Boolean Specifies whether IGMP snooping is enabled or not.
- ipv6Interface
Type String Specifies which type of IPv6 connection to use. Must be one of either
static
,pd
, ornone
.- ipv6Pd
Interface String Specifies which WAN interface to use for IPv6 PD. Must be one of either
wan
orwan2
.- ipv6Pd
Prefixid String Specifies the IPv6 Prefix ID.
- ipv6Pd
Start String Start address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- ipv6Pd
Stop String End address of the DHCPv6 range. Used if
ipv6_interface_type
is set topd
.- ipv6Ra
Enable Boolean Specifies whether to enable router advertisements or not.
- ipv6Ra
Preferred NumberLifetime Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to
ipv6_ra_valid_lifetime
- ipv6Ra
Priority String IPv6 router advertisement priority. Must be one of either
high
,medium
, orlow
- ipv6Ra
Valid NumberLifetime Total lifetime in which the address can be used. Must be equal to or greater than
ipv6_ra_preferred_lifetime
.- ipv6Static
Subnet String Specifies the static IPv6 subnet (when ipv6interfacetype is 'static').
- name String
The name of the network.
- network
Group String The group of the network.
- purpose String
The purpose of the network. One of
corporate
,guest
,wan
, orvlan-only
.- site String
The name of the site to associate the network with.
- subnet String
The subnet of the network (CIDR address).
- vlan
Id Number The VLAN ID of the network.
- wan
Dhcp NumberV6Pd Size Specifies the IPv6 prefix size to request from ISP. Must be a number between 48 and 64.
- wan
Dns List<String> DNS servers IPs of the WAN.
- wan
Egress NumberQos Specifies the WAN egress quality of service.
- wan
Gateway String The IPv4 gateway of the WAN.
- wan
Gateway StringV6 The IPv6 gateway of the WAN.
- wan
Ip String The IPv4 address of the WAN.
- wan
Ipv6 String The IPv6 address of the WAN.
- wan
Netmask String The IPv4 netmask of the WAN.
- wan
Networkgroup String Specifies the WAN network group. One of either
WAN
,WAN2
orWAN_LTE_FAILOVER
.- wan
Prefixlen Number The IPv6 prefix length of the WAN. Must be between 1 and 128.
- wan
Type String Specifies the IPV4 WAN connection type. One of either
disabled
,static
,dhcp
, orpppoe
.- wan
Type StringV6 Specifies the IPV6 WAN connection type. Must be one of either
disabled
,static
, ordhcpv6
.- wan
Username String Specifies the IPV4 WAN username.
- x
Wan StringPassword 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.