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

fortios.wirelesscontroller.Wtpgroup

Explore with Pulumi AI

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

    Configure WTP groups.

    Create Wtpgroup Resource

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

    Constructor syntax

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

@overload
def Wtpgroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             ble_major_id: Optional[int] = None,
             dynamic_sort_subtable: Optional[str] = None,
             get_all_tables: Optional[str] = None,
             name: Optional[str] = None,
             platform_type: Optional[str] = None,
             vdomparam: Optional[str] = None,
             wtps: Optional[Sequence[WtpgroupWtpArgs]] = None)
    func NewWtpgroup(ctx *Context, name string, args *WtpgroupArgs, opts ...ResourceOption) (*Wtpgroup, error)
    public Wtpgroup(string name, WtpgroupArgs? args = null, CustomResourceOptions? opts = null)
    public Wtpgroup(String name, WtpgroupArgs args)
public Wtpgroup(String name, WtpgroupArgs args, CustomResourceOptions options)

    type: fortios:wirelesscontroller:Wtpgroup
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 WtpgroupArgs
    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 WtpgroupArgs
    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 WtpgroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WtpgroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WtpgroupArgs
    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 wtpgroupResource = new Fortios.Wirelesscontroller.Wtpgroup("wtpgroupResource", new()
{
    BleMajorId = 0,
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Name = "string",
    PlatformType = "string",
    Vdomparam = "string",
    Wtps = new[]
    {
        new Fortios.Wirelesscontroller.Inputs.WtpgroupWtpArgs
        {
            WtpId = "string",
        },
    },
});

    example, err := wirelesscontroller.NewWtpgroup(ctx, "wtpgroupResource", &wirelesscontroller.WtpgroupArgs{
	BleMajorId:          pulumi.Int(0),
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	PlatformType:        pulumi.String("string"),
	Vdomparam:           pulumi.String("string"),
	Wtps: wirelesscontroller.WtpgroupWtpArray{
		&wirelesscontroller.WtpgroupWtpArgs{
			WtpId: pulumi.String("string"),
		},
	},
})

    var wtpgroupResource = new Wtpgroup("wtpgroupResource", WtpgroupArgs.builder()
    .bleMajorId(0)
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .name("string")
    .platformType("string")
    .vdomparam("string")
    .wtps(WtpgroupWtpArgs.builder()
        .wtpId("string")
        .build())
    .build());

    wtpgroup_resource = fortios.wirelesscontroller.Wtpgroup("wtpgroupResource",
    ble_major_id=0,
    dynamic_sort_subtable="string",
    get_all_tables="string",
    name="string",
    platform_type="string",
    vdomparam="string",
    wtps=[{
        "wtp_id": "string",
    }])

    const wtpgroupResource = new fortios.wirelesscontroller.Wtpgroup("wtpgroupResource", {
    bleMajorId: 0,
    dynamicSortSubtable: "string",
    getAllTables: "string",
    name: "string",
    platformType: "string",
    vdomparam: "string",
    wtps: [{
        wtpId: "string",
    }],
});

    type: fortios:wirelesscontroller:Wtpgroup
properties:
    bleMajorId: 0
    dynamicSortSubtable: string
    getAllTables: string
    name: string
    platformType: string
    vdomparam: string
    wtps:
        - wtpId: string

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

    BleMajorId int
    Override BLE Major ID.
    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 ].
    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.
    Name string
    WTP group name.
    PlatformType string
    FortiAP models to define the WTP group platform type.
    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.
    Wtps List<Pulumiverse.Fortios.Wirelesscontroller.Inputs.WtpgroupWtp>
    WTP list. The structure of wtps block is documented below.
    BleMajorId int
    Override BLE Major ID.
    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 ].
    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.
    Name string
    WTP group name.
    PlatformType string
    FortiAP models to define the WTP group platform type.
    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.
    Wtps []WtpgroupWtpArgs
    WTP list. The structure of wtps block is documented below.
    bleMajorId Integer
    Override BLE Major ID.
    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 ].
    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.
    name String
    WTP group name.
    platformType String
    FortiAP models to define the WTP group platform type.
    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.
    wtps List<WtpgroupWtp>
    WTP list. The structure of wtps block is documented below.
    bleMajorId number
    Override BLE Major ID.
    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 ].
    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.
    name string
    WTP group name.
    platformType string
    FortiAP models to define the WTP group platform type.
    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.
    wtps WtpgroupWtp[]
    WTP list. The structure of wtps block is documented below.
    ble_major_id int
    Override BLE Major ID.
    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 ].
    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.
    name str
    WTP group name.
    platform_type str
    FortiAP models to define the WTP group platform type.
    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.
    wtps Sequence[WtpgroupWtpArgs]
    WTP list. The structure of wtps block is documented below.
    bleMajorId Number
    Override BLE Major ID.
    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 ].
    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.
    name String
    WTP group name.
    platformType String
    FortiAP models to define the WTP group platform type.
    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.
    wtps List<Property Map>
    WTP list. The structure of wtps block is documented below.

    Outputs

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

    Get an existing Wtpgroup 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?: WtpgroupState, opts?: CustomResourceOptions): Wtpgroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ble_major_id: Optional[int] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        platform_type: Optional[str] = None,
        vdomparam: Optional[str] = None,
        wtps: Optional[Sequence[WtpgroupWtpArgs]] = None) -> Wtpgroup
    func GetWtpgroup(ctx *Context, name string, id IDInput, state *WtpgroupState, opts ...ResourceOption) (*Wtpgroup, error)
    public static Wtpgroup Get(string name, Input<string> id, WtpgroupState? state, CustomResourceOptions? opts = null)
    public static Wtpgroup get(String name, Output<String> id, WtpgroupState 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:
    BleMajorId int
    Override BLE Major ID.
    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 ].
    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.
    Name string
    WTP group name.
    PlatformType string
    FortiAP models to define the WTP group platform type.
    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.
    Wtps List<Pulumiverse.Fortios.Wirelesscontroller.Inputs.WtpgroupWtp>
    WTP list. The structure of wtps block is documented below.
    BleMajorId int
    Override BLE Major ID.
    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 ].
    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.
    Name string
    WTP group name.
    PlatformType string
    FortiAP models to define the WTP group platform type.
    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.
    Wtps []WtpgroupWtpArgs
    WTP list. The structure of wtps block is documented below.
    bleMajorId Integer
    Override BLE Major ID.
    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 ].
    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.
    name String
    WTP group name.
    platformType String
    FortiAP models to define the WTP group platform type.
    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.
    wtps List<WtpgroupWtp>
    WTP list. The structure of wtps block is documented below.
    bleMajorId number
    Override BLE Major ID.
    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 ].
    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.
    name string
    WTP group name.
    platformType string
    FortiAP models to define the WTP group platform type.
    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.
    wtps WtpgroupWtp[]
    WTP list. The structure of wtps block is documented below.
    ble_major_id int
    Override BLE Major ID.
    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 ].
    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.
    name str
    WTP group name.
    platform_type str
    FortiAP models to define the WTP group platform type.
    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.
    wtps Sequence[WtpgroupWtpArgs]
    WTP list. The structure of wtps block is documented below.
    bleMajorId Number
    Override BLE Major ID.
    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 ].
    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.
    name String
    WTP group name.
    platformType String
    FortiAP models to define the WTP group platform type.
    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.
    wtps List<Property Map>
    WTP list. The structure of wtps block is documented below.

    Supporting Types

    WtpgroupWtp, WtpgroupWtpArgs

    WtpId string
    WTP ID.
    WtpId string
    WTP ID.
    wtpId String
    WTP ID.
    wtpId string
    WTP ID.
    wtp_id str
    WTP ID.
    wtpId String
    WTP ID.

    Import

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

    $ pulumi import fortios:wirelesscontroller/wtpgroup:Wtpgroup labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:wirelesscontroller/wtpgroup:Wtpgroup labelname {{name}}

    $ 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