Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Unifi
  3. API Docs
  4. setting
  5. USG
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
pulumiverse/pulumi-unifi

unifi.setting.USG

Explore with Pulumi AI

unifi logo
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
pulumiverse/pulumi-unifi

    unifi.setting.USG manages settings for a Unifi Security Gateway.

    Create USG Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new USG(name: string, args?: USGArgs, opts?: CustomResourceOptions);
    @overload
def USG(resource_name: str,
        args: Optional[USGArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def USG(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        dhcp_relay_servers: Optional[Sequence[str]] = None,
        firewall_guest_default_log: Optional[bool] = None,
        firewall_lan_default_log: Optional[bool] = None,
        firewall_wan_default_log: Optional[bool] = None,
        multicast_dns_enabled: Optional[bool] = None,
        site: Optional[str] = None)
    func NewUSG(ctx *Context, name string, args *USGArgs, opts ...ResourceOption) (*USG, error)
    public USG(string name, USGArgs? args = null, CustomResourceOptions? opts = null)
    public USG(String name, USGArgs args)
public USG(String name, USGArgs args, CustomResourceOptions options)

    type: unifi:setting:USG
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var usgResource = new Unifi.Setting.USG("usgResource", new()
{
    DhcpRelayServers = new[]
    {
        "string",
    },
    FirewallGuestDefaultLog = false,
    FirewallLanDefaultLog = false,
    FirewallWanDefaultLog = false,
    MulticastDnsEnabled = false,
    Site = "string",
});

    example, err := setting.NewUSG(ctx, "usgResource", &setting.USGArgs{
	DhcpRelayServers: pulumi.StringArray{
		pulumi.String("string"),
	},
	FirewallGuestDefaultLog: pulumi.Bool(false),
	FirewallLanDefaultLog:   pulumi.Bool(false),
	FirewallWanDefaultLog:   pulumi.Bool(false),
	MulticastDnsEnabled:     pulumi.Bool(false),
	Site:                    pulumi.String("string"),
})

    var usgResource = new USG("usgResource", USGArgs.builder()
    .dhcpRelayServers("string")
    .firewallGuestDefaultLog(false)
    .firewallLanDefaultLog(false)
    .firewallWanDefaultLog(false)
    .multicastDnsEnabled(false)
    .site("string")
    .build());

    usg_resource = unifi.setting.USG("usgResource",
    dhcp_relay_servers=["string"],
    firewall_guest_default_log=False,
    firewall_lan_default_log=False,
    firewall_wan_default_log=False,
    multicast_dns_enabled=False,
    site="string")

    const usgResource = new unifi.setting.USG("usgResource", {
    dhcpRelayServers: ["string"],
    firewallGuestDefaultLog: false,
    firewallLanDefaultLog: false,
    firewallWanDefaultLog: false,
    multicastDnsEnabled: false,
    site: "string",
});

    type: unifi:setting:USG
properties:
    dhcpRelayServers:
        - string
    firewallGuestDefaultLog: false
    firewallLanDefaultLog: false
    firewallWanDefaultLog: false
    multicastDnsEnabled: false
    site: string

    USG Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The USG resource accepts the following input properties:

    DhcpRelayServers List<string>
    The DHCP relay servers.
    FirewallGuestDefaultLog bool
    Whether the guest firewall log is enabled.
    FirewallLanDefaultLog bool
    Whether the LAN firewall log is enabled.
    FirewallWanDefaultLog bool
    Whether the WAN firewall log is enabled.
    MulticastDnsEnabled bool
    Whether multicast DNS is enabled.
    Site string
    The name of the site to associate the settings with.
    DhcpRelayServers []string
    The DHCP relay servers.
    FirewallGuestDefaultLog bool
    Whether the guest firewall log is enabled.
    FirewallLanDefaultLog bool
    Whether the LAN firewall log is enabled.
    FirewallWanDefaultLog bool
    Whether the WAN firewall log is enabled.
    MulticastDnsEnabled bool
    Whether multicast DNS is enabled.
    Site string
    The name of the site to associate the settings with.
    dhcpRelayServers List<String>
    The DHCP relay servers.
    firewallGuestDefaultLog Boolean
    Whether the guest firewall log is enabled.
    firewallLanDefaultLog Boolean
    Whether the LAN firewall log is enabled.
    firewallWanDefaultLog Boolean
    Whether the WAN firewall log is enabled.
    multicastDnsEnabled Boolean
    Whether multicast DNS is enabled.
    site String
    The name of the site to associate the settings with.
    dhcpRelayServers string[]
    The DHCP relay servers.
    firewallGuestDefaultLog boolean
    Whether the guest firewall log is enabled.
    firewallLanDefaultLog boolean
    Whether the LAN firewall log is enabled.
    firewallWanDefaultLog boolean
    Whether the WAN firewall log is enabled.
    multicastDnsEnabled boolean
    Whether multicast DNS is enabled.
    site string
    The name of the site to associate the settings with.
    dhcp_relay_servers Sequence[str]
    The DHCP relay servers.
    firewall_guest_default_log bool
    Whether the guest firewall log is enabled.
    firewall_lan_default_log bool
    Whether the LAN firewall log is enabled.
    firewall_wan_default_log bool
    Whether the WAN firewall log is enabled.
    multicast_dns_enabled bool
    Whether multicast DNS is enabled.
    site str
    The name of the site to associate the settings with.
    dhcpRelayServers List<String>
    The DHCP relay servers.
    firewallGuestDefaultLog Boolean
    Whether the guest firewall log is enabled.
    firewallLanDefaultLog Boolean
    Whether the LAN firewall log is enabled.
    firewallWanDefaultLog Boolean
    Whether the WAN firewall log is enabled.
    multicastDnsEnabled Boolean
    Whether multicast DNS is enabled.
    site String
    The name of the site to associate the settings with.

    Outputs

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

    Get an existing USG 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?: USGState, opts?: CustomResourceOptions): USG
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dhcp_relay_servers: Optional[Sequence[str]] = None,
        firewall_guest_default_log: Optional[bool] = None,
        firewall_lan_default_log: Optional[bool] = None,
        firewall_wan_default_log: Optional[bool] = None,
        multicast_dns_enabled: Optional[bool] = None,
        site: Optional[str] = None) -> USG
    func GetUSG(ctx *Context, name string, id IDInput, state *USGState, opts ...ResourceOption) (*USG, error)
    public static USG Get(string name, Input<string> id, USGState? state, CustomResourceOptions? opts = null)
    public static USG get(String name, Output<String> id, USGState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:USG    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DhcpRelayServers List<string>
    The DHCP relay servers.
    FirewallGuestDefaultLog bool
    Whether the guest firewall log is enabled.
    FirewallLanDefaultLog bool
    Whether the LAN firewall log is enabled.
    FirewallWanDefaultLog bool
    Whether the WAN firewall log is enabled.
    MulticastDnsEnabled bool
    Whether multicast DNS is enabled.
    Site string
    The name of the site to associate the settings with.
    DhcpRelayServers []string
    The DHCP relay servers.
    FirewallGuestDefaultLog bool
    Whether the guest firewall log is enabled.
    FirewallLanDefaultLog bool
    Whether the LAN firewall log is enabled.
    FirewallWanDefaultLog bool
    Whether the WAN firewall log is enabled.
    MulticastDnsEnabled bool
    Whether multicast DNS is enabled.
    Site string
    The name of the site to associate the settings with.
    dhcpRelayServers List<String>
    The DHCP relay servers.
    firewallGuestDefaultLog Boolean
    Whether the guest firewall log is enabled.
    firewallLanDefaultLog Boolean
    Whether the LAN firewall log is enabled.
    firewallWanDefaultLog Boolean
    Whether the WAN firewall log is enabled.
    multicastDnsEnabled Boolean
    Whether multicast DNS is enabled.
    site String
    The name of the site to associate the settings with.
    dhcpRelayServers string[]
    The DHCP relay servers.
    firewallGuestDefaultLog boolean
    Whether the guest firewall log is enabled.
    firewallLanDefaultLog boolean
    Whether the LAN firewall log is enabled.
    firewallWanDefaultLog boolean
    Whether the WAN firewall log is enabled.
    multicastDnsEnabled boolean
    Whether multicast DNS is enabled.
    site string
    The name of the site to associate the settings with.
    dhcp_relay_servers Sequence[str]
    The DHCP relay servers.
    firewall_guest_default_log bool
    Whether the guest firewall log is enabled.
    firewall_lan_default_log bool
    Whether the LAN firewall log is enabled.
    firewall_wan_default_log bool
    Whether the WAN firewall log is enabled.
    multicast_dns_enabled bool
    Whether multicast DNS is enabled.
    site str
    The name of the site to associate the settings with.
    dhcpRelayServers List<String>
    The DHCP relay servers.
    firewallGuestDefaultLog Boolean
    Whether the guest firewall log is enabled.
    firewallLanDefaultLog Boolean
    Whether the LAN firewall log is enabled.
    firewallWanDefaultLog Boolean
    Whether the WAN firewall log is enabled.
    multicastDnsEnabled Boolean
    Whether multicast DNS is enabled.
    site String
    The name of the site to associate the settings with.

    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
    pulumiverse/pulumi-unifi