Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. wirelesscontroller
  5. Addrgrp
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.wirelesscontroller.Addrgrp

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure the MAC address group. Applies to FortiOS Version 6.2.4,6.2.6,6.4.0,6.4.1,6.4.2,6.4.10,6.4.11,6.4.12,6.4.13,6.4.14,6.4.15,7.0.0,7.0.1,7.0.2,7.0.3,7.0.4,7.0.5,7.0.6,7.0.7,7.0.8,7.0.9,7.0.10,7.0.11,7.0.12,7.0.13,7.0.14,7.0.15.

    Create Addrgrp Resource

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

    Constructor syntax

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

@overload
def Addrgrp(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            addresses: Optional[Sequence[AddrgrpAddressArgs]] = None,
            default_policy: Optional[str] = None,
            dynamic_sort_subtable: Optional[str] = None,
            fosid: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            vdomparam: Optional[str] = None)
    func NewAddrgrp(ctx *Context, name string, args *AddrgrpArgs, opts ...ResourceOption) (*Addrgrp, error)
    public Addrgrp(string name, AddrgrpArgs? args = null, CustomResourceOptions? opts = null)
    public Addrgrp(String name, AddrgrpArgs args)
public Addrgrp(String name, AddrgrpArgs args, CustomResourceOptions options)

    type: fortios:wirelesscontroller:Addrgrp
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 AddrgrpArgs
    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 AddrgrpArgs
    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 AddrgrpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddrgrpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddrgrpArgs
    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 fortiosAddrgrpResource = new Fortios.Wirelesscontroller.Addrgrp("fortiosAddrgrpResource", new()
{
    Addresses = new[]
    {
        new Fortios.Wirelesscontroller.Inputs.AddrgrpAddressArgs
        {
            Id = "string",
        },
    },
    DefaultPolicy = "string",
    DynamicSortSubtable = "string",
    Fosid = "string",
    GetAllTables = "string",
    Vdomparam = "string",
});

    example, err := wirelesscontroller.NewAddrgrp(ctx, "fortiosAddrgrpResource", &wirelesscontroller.AddrgrpArgs{
	Addresses: wirelesscontroller.AddrgrpAddressArray{
		&wirelesscontroller.AddrgrpAddressArgs{
			Id: pulumi.String("string"),
		},
	},
	DefaultPolicy:       pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	Fosid:               pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Vdomparam:           pulumi.String("string"),
})

    var fortiosAddrgrpResource = new Addrgrp("fortiosAddrgrpResource", AddrgrpArgs.builder()
    .addresses(AddrgrpAddressArgs.builder()
        .id("string")
        .build())
    .defaultPolicy("string")
    .dynamicSortSubtable("string")
    .fosid("string")
    .getAllTables("string")
    .vdomparam("string")
    .build());

    fortios_addrgrp_resource = fortios.wirelesscontroller.Addrgrp("fortiosAddrgrpResource",
    addresses=[{
        "id": "string",
    }],
    default_policy="string",
    dynamic_sort_subtable="string",
    fosid="string",
    get_all_tables="string",
    vdomparam="string")

    const fortiosAddrgrpResource = new fortios.wirelesscontroller.Addrgrp("fortiosAddrgrpResource", {
    addresses: [{
        id: "string",
    }],
    defaultPolicy: "string",
    dynamicSortSubtable: "string",
    fosid: "string",
    getAllTables: "string",
    vdomparam: "string",
});

    type: fortios:wirelesscontroller:Addrgrp
properties:
    addresses:
        - id: string
    defaultPolicy: string
    dynamicSortSubtable: string
    fosid: string
    getAllTables: string
    vdomparam: string

    Addrgrp 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 Addrgrp resource accepts the following input properties:

    Addresses List<Pulumiverse.Fortios.Wirelesscontroller.Inputs.AddrgrpAddress>
    Manually selected group of addresses. The structure of addresses block is documented below.
    DefaultPolicy string
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Fosid string
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Addresses []AddrgrpAddressArgs
    Manually selected group of addresses. The structure of addresses block is documented below.
    DefaultPolicy string
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Fosid string
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addresses List<AddrgrpAddress>
    Manually selected group of addresses. The structure of addresses block is documented below.
    defaultPolicy String
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid String
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addresses AddrgrpAddress[]
    Manually selected group of addresses. The structure of addresses block is documented below.
    defaultPolicy string
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid string
    ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addresses Sequence[AddrgrpAddressArgs]
    Manually selected group of addresses. The structure of addresses block is documented below.
    default_policy str
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid str
    ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addresses List<Property Map>
    Manually selected group of addresses. The structure of addresses block is documented below.
    defaultPolicy String
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid String
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Get an existing Addrgrp 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?: AddrgrpState, opts?: CustomResourceOptions): Addrgrp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[AddrgrpAddressArgs]] = None,
        default_policy: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fosid: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Addrgrp
    func GetAddrgrp(ctx *Context, name string, id IDInput, state *AddrgrpState, opts ...ResourceOption) (*Addrgrp, error)
    public static Addrgrp Get(string name, Input<string> id, AddrgrpState? state, CustomResourceOptions? opts = null)
    public static Addrgrp get(String name, Output<String> id, AddrgrpState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Addresses List<Pulumiverse.Fortios.Wirelesscontroller.Inputs.AddrgrpAddress>
    Manually selected group of addresses. The structure of addresses block is documented below.
    DefaultPolicy string
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Fosid string
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Addresses []AddrgrpAddressArgs
    Manually selected group of addresses. The structure of addresses block is documented below.
    DefaultPolicy string
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Fosid string
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addresses List<AddrgrpAddress>
    Manually selected group of addresses. The structure of addresses block is documented below.
    defaultPolicy String
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid String
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addresses AddrgrpAddress[]
    Manually selected group of addresses. The structure of addresses block is documented below.
    defaultPolicy string
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid string
    ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addresses Sequence[AddrgrpAddressArgs]
    Manually selected group of addresses. The structure of addresses block is documented below.
    default_policy str
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid str
    ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addresses List<Property Map>
    Manually selected group of addresses. The structure of addresses block is documented below.
    defaultPolicy String
    Allow or block the clients with MAC addresses that are not in the group. Valid values: allow, deny.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fosid String
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Supporting Types

    AddrgrpAddress, AddrgrpAddressArgs

    Id string
    Address ID.
    Id string
    Address ID.
    id String
    Address ID.
    id string
    Address ID.
    id str
    Address ID.
    id String
    Address ID.

    Import

    WirelessController Addrgrp can be imported using any of these accepted formats:

    $ pulumi import fortios:wirelesscontroller/addrgrp:Addrgrp labelname {{fosid}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:wirelesscontroller/addrgrp:Addrgrp labelname {{fosid}}

    $ unset “FORTIOS_IMPORT_TABLE”

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios