1. Packages
  2. Fortios
  3. API Docs
  4. wirelesscontroller
  5. wirelesscontroller/hotspot20
  6. H2qposuprovidernai
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.wirelesscontroller/hotspot20.H2qposuprovidernai

Explore with Pulumi AI

Configure online sign up (OSU) provider NAI list. Applies to FortiOS Version >= 7.0.2.

Create H2qposuprovidernai Resource

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

Constructor syntax

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

@overload
def H2qposuprovidernai(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       dynamic_sort_subtable: Optional[str] = None,
                       get_all_tables: Optional[str] = None,
                       nai_lists: Optional[Sequence[H2qposuprovidernaiNaiListArgs]] = None,
                       name: Optional[str] = None,
                       vdomparam: Optional[str] = None)
func NewH2qposuprovidernai(ctx *Context, name string, args *H2qposuprovidernaiArgs, opts ...ResourceOption) (*H2qposuprovidernai, error)
public H2qposuprovidernai(string name, H2qposuprovidernaiArgs? args = null, CustomResourceOptions? opts = null)
public H2qposuprovidernai(String name, H2qposuprovidernaiArgs args)
public H2qposuprovidernai(String name, H2qposuprovidernaiArgs args, CustomResourceOptions options)
type: fortios:wirelesscontroller/hotspot20/h2qposuprovidernai:H2qposuprovidernai
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args H2qposuprovidernaiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args H2qposuprovidernaiArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args H2qposuprovidernaiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args H2qposuprovidernaiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. H2qposuprovidernaiArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

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.
NaiLists List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.H2qposuprovidernaiNaiList>
OSU NAI list. The structure of nai_list block is documented below.
Name Changes to this property will trigger replacement. string
OSU provider NAI ID.
Vdomparam Changes to this property will trigger replacement. 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.
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.
NaiLists []H2qposuprovidernaiNaiListArgs
OSU NAI list. The structure of nai_list block is documented below.
Name Changes to this property will trigger replacement. string
OSU provider NAI ID.
Vdomparam Changes to this property will trigger replacement. 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.
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.
naiLists List<H2qposuprovidernaiNaiList>
OSU NAI list. The structure of nai_list block is documented below.
name Changes to this property will trigger replacement. String
OSU provider NAI ID.
vdomparam Changes to this property will trigger replacement. 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.
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.
naiLists H2qposuprovidernaiNaiList[]
OSU NAI list. The structure of nai_list block is documented below.
name Changes to this property will trigger replacement. string
OSU provider NAI ID.
vdomparam Changes to this property will trigger replacement. 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.
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.
nai_lists Sequence[H2qposuprovidernaiNaiListArgs]
OSU NAI list. The structure of nai_list block is documented below.
name Changes to this property will trigger replacement. str
OSU provider NAI ID.
vdomparam Changes to this property will trigger replacement. 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.
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.
naiLists List<Property Map>
OSU NAI list. The structure of nai_list block is documented below.
name Changes to this property will trigger replacement. String
OSU provider NAI ID.
vdomparam Changes to this property will trigger replacement. 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 H2qposuprovidernai 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 H2qposuprovidernai Resource

Get an existing H2qposuprovidernai 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?: H2qposuprovidernaiState, opts?: CustomResourceOptions): H2qposuprovidernai
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        nai_lists: Optional[Sequence[H2qposuprovidernaiNaiListArgs]] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> H2qposuprovidernai
func GetH2qposuprovidernai(ctx *Context, name string, id IDInput, state *H2qposuprovidernaiState, opts ...ResourceOption) (*H2qposuprovidernai, error)
public static H2qposuprovidernai Get(string name, Input<string> id, H2qposuprovidernaiState? state, CustomResourceOptions? opts = null)
public static H2qposuprovidernai get(String name, Output<String> id, H2qposuprovidernaiState state, CustomResourceOptions options)
resources:  _:    type: fortios:wirelesscontroller/hotspot20/h2qposuprovidernai:H2qposuprovidernai    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
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.
NaiLists List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.H2qposuprovidernaiNaiList>
OSU NAI list. The structure of nai_list block is documented below.
Name Changes to this property will trigger replacement. string
OSU provider NAI ID.
Vdomparam Changes to this property will trigger replacement. 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.
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.
NaiLists []H2qposuprovidernaiNaiListArgs
OSU NAI list. The structure of nai_list block is documented below.
Name Changes to this property will trigger replacement. string
OSU provider NAI ID.
Vdomparam Changes to this property will trigger replacement. 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.
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.
naiLists List<H2qposuprovidernaiNaiList>
OSU NAI list. The structure of nai_list block is documented below.
name Changes to this property will trigger replacement. String
OSU provider NAI ID.
vdomparam Changes to this property will trigger replacement. 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.
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.
naiLists H2qposuprovidernaiNaiList[]
OSU NAI list. The structure of nai_list block is documented below.
name Changes to this property will trigger replacement. string
OSU provider NAI ID.
vdomparam Changes to this property will trigger replacement. 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.
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.
nai_lists Sequence[H2qposuprovidernaiNaiListArgs]
OSU NAI list. The structure of nai_list block is documented below.
name Changes to this property will trigger replacement. str
OSU provider NAI ID.
vdomparam Changes to this property will trigger replacement. 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.
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.
naiLists List<Property Map>
OSU NAI list. The structure of nai_list block is documented below.
name Changes to this property will trigger replacement. String
OSU provider NAI ID.
vdomparam Changes to this property will trigger replacement. 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

H2qposuprovidernaiNaiList
, H2qposuprovidernaiNaiListArgs

Name string
OSU NAI ID.
OsuNai string
OSU NAI.
Name string
OSU NAI ID.
OsuNai string
OSU NAI.
name String
OSU NAI ID.
osuNai String
OSU NAI.
name string
OSU NAI ID.
osuNai string
OSU NAI.
name str
OSU NAI ID.
osu_nai str
OSU NAI.
name String
OSU NAI ID.
osuNai String
OSU NAI.

Import

WirelessControllerHotspot20 H2QpOsuProviderNai can be imported using any of these accepted formats:

$ pulumi import fortios:wirelesscontroller/hotspot20/h2qposuprovidernai:H2qposuprovidernai labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:wirelesscontroller/hotspot20/h2qposuprovidernai:H2qposuprovidernai labelname {{name}}
Copy

$ 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.