Fortios v0.0.6, Jul 9 24

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.wirelesscontroller/hotspot20.Hsprofile

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

Create Hsprofile Resource

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

Constructor syntax

new Hsprofile(name: string, args?: HsprofileArgs, opts?: CustomResourceOptions);

@overload
def Hsprofile(resource_name: str,
              args: Optional[HsprofileArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Hsprofile(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              access_network_asra: Optional[str] = None,
              access_network_esr: Optional[str] = None,
              access_network_internet: Optional[str] = None,
              access_network_type: Optional[str] = None,
              access_network_uesa: Optional[str] = None,
              advice_of_charge: Optional[str] = None,
              anqp_domain_id: Optional[int] = None,
              bss_transition: Optional[str] = None,
              conn_cap: Optional[str] = None,
              deauth_request_timeout: Optional[int] = None,
              dgaf: Optional[str] = None,
              domain_name: Optional[str] = None,
              dynamic_sort_subtable: Optional[str] = None,
              gas_comeback_delay: Optional[int] = None,
              gas_fragmentation_limit: Optional[int] = None,
              get_all_tables: Optional[str] = None,
              hessid: Optional[str] = None,
              ip_addr_type: Optional[str] = None,
              l2tif: Optional[str] = None,
              n3gpp_plmn: Optional[str] = None,
              nai_realm: Optional[str] = None,
              name: Optional[str] = None,
              network_auth: Optional[str] = None,
              oper_friendly_name: Optional[str] = None,
              oper_icon: Optional[str] = None,
              osu_provider_nai: Optional[str] = None,
              osu_providers: Optional[Sequence[HsprofileOsuProviderArgs]] = None,
              osu_ssid: Optional[str] = None,
              pame_bi: Optional[str] = None,
              proxy_arp: Optional[str] = None,
              qos_map: Optional[str] = None,
              release: Optional[int] = None,
              roaming_consortium: Optional[str] = None,
              terms_and_conditions: Optional[str] = None,
              vdomparam: Optional[str] = None,
              venue_group: Optional[str] = None,
              venue_name: Optional[str] = None,
              venue_type: Optional[str] = None,
              venue_url: Optional[str] = None,
              wan_metrics: Optional[str] = None,
              wnm_sleep_mode: Optional[str] = None)

func NewHsprofile(ctx *Context, name string, args *HsprofileArgs, opts ...ResourceOption) (*Hsprofile, error)

public Hsprofile(string name, HsprofileArgs? args = null, CustomResourceOptions? opts = null)

public Hsprofile(String name, HsprofileArgs args)
public Hsprofile(String name, HsprofileArgs args, CustomResourceOptions options)

type: fortios:wirelesscontroller/hotspot20/hsprofile:Hsprofile
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 HsprofileArgs: 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 HsprofileArgs: 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 HsprofileArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HsprofileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args HsprofileArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

AccessNetworkAsra string: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
AccessNetworkEsr string: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
AccessNetworkInternet string: Enable/disable connectivity to the Internet. Valid values: enable, disable.
AccessNetworkType string: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
AccessNetworkUesa string: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
AdviceOfCharge string: Advice of charge.
AnqpDomainId int: ANQP Domain ID (0-65535).
BssTransition string: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
ConnCap string: Connection capability name.
DeauthRequestTimeout int: Deauthentication request timeout (in seconds).
Dgaf string: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
DomainName string: Domain name.
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 ].
GasComebackDelay int: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
GasFragmentationLimit int: GAS fragmentation limit (512 - 4096, default = 1024).
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.
Hessid string: Homogeneous extended service set identifier (HESSID).
IpAddrType string: IP address type name.
L2tif string: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
N3gppPlmn string: 3GPP PLMN name.
NaiRealm string: NAI realm list name.
Name string: Hotspot profile name.
NetworkAuth string: Network authentication name.
OperFriendlyName string: Operator friendly name.
OperIcon string: Operator icon.
OsuProviderNai string: OSU Provider NAI.
OsuProviders List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.HsprofileOsuProvider>: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
OsuSsid string: Online sign up (OSU) SSID.
PameBi string: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
ProxyArp string: Enable/disable Proxy ARP. Valid values: enable, disable.
QosMap string: QoS MAP set ID.
Release int: Hotspot 2.0 Release number (1, 2, 3, default = 2).
RoamingConsortium string: Roaming consortium list name.
TermsAndConditions string: Terms and conditions.
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.
VenueGroup string: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
VenueName string: Venue name.
VenueType string: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
VenueUrl string: Venue name.
WanMetrics string: WAN metric name.
WnmSleepMode string: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

AccessNetworkAsra string: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
AccessNetworkEsr string: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
AccessNetworkInternet string: Enable/disable connectivity to the Internet. Valid values: enable, disable.
AccessNetworkType string: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
AccessNetworkUesa string: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
AdviceOfCharge string: Advice of charge.
AnqpDomainId int: ANQP Domain ID (0-65535).
BssTransition string: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
ConnCap string: Connection capability name.
DeauthRequestTimeout int: Deauthentication request timeout (in seconds).
Dgaf string: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
DomainName string: Domain name.
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 ].
GasComebackDelay int: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
GasFragmentationLimit int: GAS fragmentation limit (512 - 4096, default = 1024).
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.
Hessid string: Homogeneous extended service set identifier (HESSID).
IpAddrType string: IP address type name.
L2tif string: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
N3gppPlmn string: 3GPP PLMN name.
NaiRealm string: NAI realm list name.
Name string: Hotspot profile name.
NetworkAuth string: Network authentication name.
OperFriendlyName string: Operator friendly name.
OperIcon string: Operator icon.
OsuProviderNai string: OSU Provider NAI.
OsuProviders []HsprofileOsuProviderArgs: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
OsuSsid string: Online sign up (OSU) SSID.
PameBi string: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
ProxyArp string: Enable/disable Proxy ARP. Valid values: enable, disable.
QosMap string: QoS MAP set ID.
Release int: Hotspot 2.0 Release number (1, 2, 3, default = 2).
RoamingConsortium string: Roaming consortium list name.
TermsAndConditions string: Terms and conditions.
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.
VenueGroup string: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
VenueName string: Venue name.
VenueType string: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
VenueUrl string: Venue name.
WanMetrics string: WAN metric name.
WnmSleepMode string: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

accessNetworkAsra String: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
accessNetworkEsr String: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
accessNetworkInternet String: Enable/disable connectivity to the Internet. Valid values: enable, disable.
accessNetworkType String: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
accessNetworkUesa String: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
adviceOfCharge String: Advice of charge.
anqpDomainId Integer: ANQP Domain ID (0-65535).
bssTransition String: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
connCap String: Connection capability name.
deauthRequestTimeout Integer: Deauthentication request timeout (in seconds).
dgaf String: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
domainName String: Domain name.
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 ].
gasComebackDelay Integer: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
gasFragmentationLimit Integer: GAS fragmentation limit (512 - 4096, default = 1024).
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.
hessid String: Homogeneous extended service set identifier (HESSID).
ipAddrType String: IP address type name.
l2tif String: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
n3gppPlmn String: 3GPP PLMN name.
naiRealm String: NAI realm list name.
name String: Hotspot profile name.
networkAuth String: Network authentication name.
operFriendlyName String: Operator friendly name.
operIcon String: Operator icon.
osuProviderNai String: OSU Provider NAI.
osuProviders List<HsprofileOsuProvider>: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
osuSsid String: Online sign up (OSU) SSID.
pameBi String: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
proxyArp String: Enable/disable Proxy ARP. Valid values: enable, disable.
qosMap String: QoS MAP set ID.
release Integer: Hotspot 2.0 Release number (1, 2, 3, default = 2).
roamingConsortium String: Roaming consortium list name.
termsAndConditions String: Terms and conditions.
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.
venueGroup String: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
venueName String: Venue name.
venueType String: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
venueUrl String: Venue name.
wanMetrics String: WAN metric name.
wnmSleepMode String: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

accessNetworkAsra string: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
accessNetworkEsr string: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
accessNetworkInternet string: Enable/disable connectivity to the Internet. Valid values: enable, disable.
accessNetworkType string: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
accessNetworkUesa string: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
adviceOfCharge string: Advice of charge.
anqpDomainId number: ANQP Domain ID (0-65535).
bssTransition string: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
connCap string: Connection capability name.
deauthRequestTimeout number: Deauthentication request timeout (in seconds).
dgaf string: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
domainName string: Domain name.
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 ].
gasComebackDelay number: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
gasFragmentationLimit number: GAS fragmentation limit (512 - 4096, default = 1024).
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.
hessid string: Homogeneous extended service set identifier (HESSID).
ipAddrType string: IP address type name.
l2tif string: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
n3gppPlmn string: 3GPP PLMN name.
naiRealm string: NAI realm list name.
name string: Hotspot profile name.
networkAuth string: Network authentication name.
operFriendlyName string: Operator friendly name.
operIcon string: Operator icon.
osuProviderNai string: OSU Provider NAI.
osuProviders HsprofileOsuProvider[]: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
osuSsid string: Online sign up (OSU) SSID.
pameBi string: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
proxyArp string: Enable/disable Proxy ARP. Valid values: enable, disable.
qosMap string: QoS MAP set ID.
release number: Hotspot 2.0 Release number (1, 2, 3, default = 2).
roamingConsortium string: Roaming consortium list name.
termsAndConditions string: Terms and conditions.
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.
venueGroup string: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
venueName string: Venue name.
venueType string: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
venueUrl string: Venue name.
wanMetrics string: WAN metric name.
wnmSleepMode string: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

access_network_asra str: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
access_network_esr str: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
access_network_internet str: Enable/disable connectivity to the Internet. Valid values: enable, disable.
access_network_type str: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
access_network_uesa str: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
advice_of_charge str: Advice of charge.
anqp_domain_id int: ANQP Domain ID (0-65535).
bss_transition str: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
conn_cap str: Connection capability name.
deauth_request_timeout int: Deauthentication request timeout (in seconds).
dgaf str: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
domain_name str: Domain name.
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 ].
gas_comeback_delay int: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
gas_fragmentation_limit int: GAS fragmentation limit (512 - 4096, default = 1024).
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.
hessid str: Homogeneous extended service set identifier (HESSID).
ip_addr_type str: IP address type name.
l2tif str: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
n3gpp_plmn str: 3GPP PLMN name.
nai_realm str: NAI realm list name.
name str: Hotspot profile name.
network_auth str: Network authentication name.
oper_friendly_name str: Operator friendly name.
oper_icon str: Operator icon.
osu_provider_nai str: OSU Provider NAI.
osu_providers Sequence[HsprofileOsuProviderArgs]: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
osu_ssid str: Online sign up (OSU) SSID.
pame_bi str: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
proxy_arp str: Enable/disable Proxy ARP. Valid values: enable, disable.
qos_map str: QoS MAP set ID.
release int: Hotspot 2.0 Release number (1, 2, 3, default = 2).
roaming_consortium str: Roaming consortium list name.
terms_and_conditions str: Terms and conditions.
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.
venue_group str: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
venue_name str: Venue name.
venue_type str: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
venue_url str: Venue name.
wan_metrics str: WAN metric name.
wnm_sleep_mode str: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

accessNetworkAsra String: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
accessNetworkEsr String: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
accessNetworkInternet String: Enable/disable connectivity to the Internet. Valid values: enable, disable.
accessNetworkType String: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
accessNetworkUesa String: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
adviceOfCharge String: Advice of charge.
anqpDomainId Number: ANQP Domain ID (0-65535).
bssTransition String: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
connCap String: Connection capability name.
deauthRequestTimeout Number: Deauthentication request timeout (in seconds).
dgaf String: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
domainName String: Domain name.
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 ].
gasComebackDelay Number: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
gasFragmentationLimit Number: GAS fragmentation limit (512 - 4096, default = 1024).
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.
hessid String: Homogeneous extended service set identifier (HESSID).
ipAddrType String: IP address type name.
l2tif String: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
n3gppPlmn String: 3GPP PLMN name.
naiRealm String: NAI realm list name.
name String: Hotspot profile name.
networkAuth String: Network authentication name.
operFriendlyName String: Operator friendly name.
operIcon String: Operator icon.
osuProviderNai String: OSU Provider NAI.
osuProviders List<Property Map>: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
osuSsid String: Online sign up (OSU) SSID.
pameBi String: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
proxyArp String: Enable/disable Proxy ARP. Valid values: enable, disable.
qosMap String: QoS MAP set ID.
release Number: Hotspot 2.0 Release number (1, 2, 3, default = 2).
roamingConsortium String: Roaming consortium list name.
termsAndConditions String: Terms and conditions.
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.
venueGroup String: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
venueName String: Venue name.
venueType String: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
venueUrl String: Venue name.
wanMetrics String: WAN metric name.
wnmSleepMode String: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

Outputs

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

Get an existing Hsprofile 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?: HsprofileState, opts?: CustomResourceOptions): Hsprofile

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_network_asra: Optional[str] = None,
        access_network_esr: Optional[str] = None,
        access_network_internet: Optional[str] = None,
        access_network_type: Optional[str] = None,
        access_network_uesa: Optional[str] = None,
        advice_of_charge: Optional[str] = None,
        anqp_domain_id: Optional[int] = None,
        bss_transition: Optional[str] = None,
        conn_cap: Optional[str] = None,
        deauth_request_timeout: Optional[int] = None,
        dgaf: Optional[str] = None,
        domain_name: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        gas_comeback_delay: Optional[int] = None,
        gas_fragmentation_limit: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        hessid: Optional[str] = None,
        ip_addr_type: Optional[str] = None,
        l2tif: Optional[str] = None,
        n3gpp_plmn: Optional[str] = None,
        nai_realm: Optional[str] = None,
        name: Optional[str] = None,
        network_auth: Optional[str] = None,
        oper_friendly_name: Optional[str] = None,
        oper_icon: Optional[str] = None,
        osu_provider_nai: Optional[str] = None,
        osu_providers: Optional[Sequence[HsprofileOsuProviderArgs]] = None,
        osu_ssid: Optional[str] = None,
        pame_bi: Optional[str] = None,
        proxy_arp: Optional[str] = None,
        qos_map: Optional[str] = None,
        release: Optional[int] = None,
        roaming_consortium: Optional[str] = None,
        terms_and_conditions: Optional[str] = None,
        vdomparam: Optional[str] = None,
        venue_group: Optional[str] = None,
        venue_name: Optional[str] = None,
        venue_type: Optional[str] = None,
        venue_url: Optional[str] = None,
        wan_metrics: Optional[str] = None,
        wnm_sleep_mode: Optional[str] = None) -> Hsprofile

func GetHsprofile(ctx *Context, name string, id IDInput, state *HsprofileState, opts ...ResourceOption) (*Hsprofile, error)

public static Hsprofile Get(string name, Input<string> id, HsprofileState? state, CustomResourceOptions? opts = null)

public static Hsprofile get(String name, Output<String> id, HsprofileState 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:

AccessNetworkAsra string: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
AccessNetworkEsr string: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
AccessNetworkInternet string: Enable/disable connectivity to the Internet. Valid values: enable, disable.
AccessNetworkType string: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
AccessNetworkUesa string: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
AdviceOfCharge string: Advice of charge.
AnqpDomainId int: ANQP Domain ID (0-65535).
BssTransition string: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
ConnCap string: Connection capability name.
DeauthRequestTimeout int: Deauthentication request timeout (in seconds).
Dgaf string: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
DomainName string: Domain name.
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 ].
GasComebackDelay int: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
GasFragmentationLimit int: GAS fragmentation limit (512 - 4096, default = 1024).
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.
Hessid string: Homogeneous extended service set identifier (HESSID).
IpAddrType string: IP address type name.
L2tif string: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
N3gppPlmn string: 3GPP PLMN name.
NaiRealm string: NAI realm list name.
Name string: Hotspot profile name.
NetworkAuth string: Network authentication name.
OperFriendlyName string: Operator friendly name.
OperIcon string: Operator icon.
OsuProviderNai string: OSU Provider NAI.
OsuProviders List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.HsprofileOsuProvider>: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
OsuSsid string: Online sign up (OSU) SSID.
PameBi string: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
ProxyArp string: Enable/disable Proxy ARP. Valid values: enable, disable.
QosMap string: QoS MAP set ID.
Release int: Hotspot 2.0 Release number (1, 2, 3, default = 2).
RoamingConsortium string: Roaming consortium list name.
TermsAndConditions string: Terms and conditions.
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.
VenueGroup string: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
VenueName string: Venue name.
VenueType string: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
VenueUrl string: Venue name.
WanMetrics string: WAN metric name.
WnmSleepMode string: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

AccessNetworkAsra string: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
AccessNetworkEsr string: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
AccessNetworkInternet string: Enable/disable connectivity to the Internet. Valid values: enable, disable.
AccessNetworkType string: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
AccessNetworkUesa string: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
AdviceOfCharge string: Advice of charge.
AnqpDomainId int: ANQP Domain ID (0-65535).
BssTransition string: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
ConnCap string: Connection capability name.
DeauthRequestTimeout int: Deauthentication request timeout (in seconds).
Dgaf string: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
DomainName string: Domain name.
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 ].
GasComebackDelay int: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
GasFragmentationLimit int: GAS fragmentation limit (512 - 4096, default = 1024).
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.
Hessid string: Homogeneous extended service set identifier (HESSID).
IpAddrType string: IP address type name.
L2tif string: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
N3gppPlmn string: 3GPP PLMN name.
NaiRealm string: NAI realm list name.
Name string: Hotspot profile name.
NetworkAuth string: Network authentication name.
OperFriendlyName string: Operator friendly name.
OperIcon string: Operator icon.
OsuProviderNai string: OSU Provider NAI.
OsuProviders []HsprofileOsuProviderArgs: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
OsuSsid string: Online sign up (OSU) SSID.
PameBi string: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
ProxyArp string: Enable/disable Proxy ARP. Valid values: enable, disable.
QosMap string: QoS MAP set ID.
Release int: Hotspot 2.0 Release number (1, 2, 3, default = 2).
RoamingConsortium string: Roaming consortium list name.
TermsAndConditions string: Terms and conditions.
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.
VenueGroup string: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
VenueName string: Venue name.
VenueType string: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
VenueUrl string: Venue name.
WanMetrics string: WAN metric name.
WnmSleepMode string: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

accessNetworkAsra String: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
accessNetworkEsr String: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
accessNetworkInternet String: Enable/disable connectivity to the Internet. Valid values: enable, disable.
accessNetworkType String: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
accessNetworkUesa String: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
adviceOfCharge String: Advice of charge.
anqpDomainId Integer: ANQP Domain ID (0-65535).
bssTransition String: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
connCap String: Connection capability name.
deauthRequestTimeout Integer: Deauthentication request timeout (in seconds).
dgaf String: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
domainName String: Domain name.
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 ].
gasComebackDelay Integer: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
gasFragmentationLimit Integer: GAS fragmentation limit (512 - 4096, default = 1024).
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.
hessid String: Homogeneous extended service set identifier (HESSID).
ipAddrType String: IP address type name.
l2tif String: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
n3gppPlmn String: 3GPP PLMN name.
naiRealm String: NAI realm list name.
name String: Hotspot profile name.
networkAuth String: Network authentication name.
operFriendlyName String: Operator friendly name.
operIcon String: Operator icon.
osuProviderNai String: OSU Provider NAI.
osuProviders List<HsprofileOsuProvider>: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
osuSsid String: Online sign up (OSU) SSID.
pameBi String: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
proxyArp String: Enable/disable Proxy ARP. Valid values: enable, disable.
qosMap String: QoS MAP set ID.
release Integer: Hotspot 2.0 Release number (1, 2, 3, default = 2).
roamingConsortium String: Roaming consortium list name.
termsAndConditions String: Terms and conditions.
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.
venueGroup String: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
venueName String: Venue name.
venueType String: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
venueUrl String: Venue name.
wanMetrics String: WAN metric name.
wnmSleepMode String: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

accessNetworkAsra string: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
accessNetworkEsr string: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
accessNetworkInternet string: Enable/disable connectivity to the Internet. Valid values: enable, disable.
accessNetworkType string: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
accessNetworkUesa string: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
adviceOfCharge string: Advice of charge.
anqpDomainId number: ANQP Domain ID (0-65535).
bssTransition string: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
connCap string: Connection capability name.
deauthRequestTimeout number: Deauthentication request timeout (in seconds).
dgaf string: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
domainName string: Domain name.
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 ].
gasComebackDelay number: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
gasFragmentationLimit number: GAS fragmentation limit (512 - 4096, default = 1024).
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.
hessid string: Homogeneous extended service set identifier (HESSID).
ipAddrType string: IP address type name.
l2tif string: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
n3gppPlmn string: 3GPP PLMN name.
naiRealm string: NAI realm list name.
name string: Hotspot profile name.
networkAuth string: Network authentication name.
operFriendlyName string: Operator friendly name.
operIcon string: Operator icon.
osuProviderNai string: OSU Provider NAI.
osuProviders HsprofileOsuProvider[]: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
osuSsid string: Online sign up (OSU) SSID.
pameBi string: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
proxyArp string: Enable/disable Proxy ARP. Valid values: enable, disable.
qosMap string: QoS MAP set ID.
release number: Hotspot 2.0 Release number (1, 2, 3, default = 2).
roamingConsortium string: Roaming consortium list name.
termsAndConditions string: Terms and conditions.
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.
venueGroup string: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
venueName string: Venue name.
venueType string: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
venueUrl string: Venue name.
wanMetrics string: WAN metric name.
wnmSleepMode string: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

access_network_asra str: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
access_network_esr str: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
access_network_internet str: Enable/disable connectivity to the Internet. Valid values: enable, disable.
access_network_type str: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
access_network_uesa str: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
advice_of_charge str: Advice of charge.
anqp_domain_id int: ANQP Domain ID (0-65535).
bss_transition str: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
conn_cap str: Connection capability name.
deauth_request_timeout int: Deauthentication request timeout (in seconds).
dgaf str: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
domain_name str: Domain name.
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 ].
gas_comeback_delay int: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
gas_fragmentation_limit int: GAS fragmentation limit (512 - 4096, default = 1024).
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.
hessid str: Homogeneous extended service set identifier (HESSID).
ip_addr_type str: IP address type name.
l2tif str: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
n3gpp_plmn str: 3GPP PLMN name.
nai_realm str: NAI realm list name.
name str: Hotspot profile name.
network_auth str: Network authentication name.
oper_friendly_name str: Operator friendly name.
oper_icon str: Operator icon.
osu_provider_nai str: OSU Provider NAI.
osu_providers Sequence[HsprofileOsuProviderArgs]: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
osu_ssid str: Online sign up (OSU) SSID.
pame_bi str: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
proxy_arp str: Enable/disable Proxy ARP. Valid values: enable, disable.
qos_map str: QoS MAP set ID.
release int: Hotspot 2.0 Release number (1, 2, 3, default = 2).
roaming_consortium str: Roaming consortium list name.
terms_and_conditions str: Terms and conditions.
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.
venue_group str: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
venue_name str: Venue name.
venue_type str: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
venue_url str: Venue name.
wan_metrics str: WAN metric name.
wnm_sleep_mode str: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

accessNetworkAsra String: Enable/disable additional step required for access (ASRA). Valid values: enable, disable.
accessNetworkEsr String: Enable/disable emergency services reachable (ESR). Valid values: enable, disable.
accessNetworkInternet String: Enable/disable connectivity to the Internet. Valid values: enable, disable.
accessNetworkType String: Access network type. Valid values: private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard.
accessNetworkUesa String: Enable/disable unauthenticated emergency service accessible (UESA). Valid values: enable, disable.
adviceOfCharge String: Advice of charge.
anqpDomainId Number: ANQP Domain ID (0-65535).
bssTransition String: Enable/disable basic service set (BSS) transition Support. Valid values: enable, disable.
connCap String: Connection capability name.
deauthRequestTimeout Number: Deauthentication request timeout (in seconds).
dgaf String: Enable/disable downstream group-addressed forwarding (DGAF). Valid values: enable, disable.
domainName String: Domain name.
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 ].
gasComebackDelay Number: GAS comeback delay (default = 500). On FortiOS versions 6.2.0-7.0.0: 0 or 100 - 4000 milliseconds. On FortiOS versions >= 7.0.1: 0 or 100 - 10000 milliseconds.
gasFragmentationLimit Number: GAS fragmentation limit (512 - 4096, default = 1024).
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.
hessid String: Homogeneous extended service set identifier (HESSID).
ipAddrType String: IP address type name.
l2tif String: Enable/disable Layer 2 traffic inspection and filtering. Valid values: enable, disable.
n3gppPlmn String: 3GPP PLMN name.
naiRealm String: NAI realm list name.
name String: Hotspot profile name.
networkAuth String: Network authentication name.
operFriendlyName String: Operator friendly name.
operIcon String: Operator icon.
osuProviderNai String: OSU Provider NAI.
osuProviders List<Property Map>: Manually selected list of OSU provider(s). The structure of osu_provider block is documented below.
osuSsid String: Online sign up (OSU) SSID.
pameBi String: Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI). Valid values: disable, enable.
proxyArp String: Enable/disable Proxy ARP. Valid values: enable, disable.
qosMap String: QoS MAP set ID.
release Number: Hotspot 2.0 Release number (1, 2, 3, default = 2).
roamingConsortium String: Roaming consortium list name.
termsAndConditions String: Terms and conditions.
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.
venueGroup String: Venue group. Valid values: unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor.
venueName String: Venue name.
venueType String: Venue type. Valid values: unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk.
venueUrl String: Venue name.
wanMetrics String: WAN metric name.
wnmSleepMode String: Enable/disable wireless network management (WNM) sleep mode. Valid values: enable, disable.

Supporting Types

HsprofileOsuProvider, HsprofileOsuProviderArgs

Name string: OSU provider name.

Name string: OSU provider name.

name String: OSU provider name.

name string: OSU provider name.

name str: OSU provider name.

name String: OSU provider name.

Import

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

$ pulumi import fortios:wirelesscontroller/hotspot20/hsprofile:Hsprofile labelname {{name}}

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:wirelesscontroller/hotspot20/hsprofile:Hsprofile 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 v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

pulumiverse/pulumi-fortios

fortios.wirelesscontroller/hotspot20.Hsprofile

On this page

On this page

Create Hsprofile Resource

Constructor syntax

Parameters

Hsprofile Resource Properties

Inputs

Outputs

Look up Existing Hsprofile Resource

Supporting Types

HsprofileOsuProvider, HsprofileOsuProviderArgs

Import

Package Details

On this page

On this page