Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
meraki.networks.getWirelessSsids
Explore with Pulumi AI
Example Usage
Using getWirelessSsids
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getWirelessSsids(args: GetWirelessSsidsArgs, opts?: InvokeOptions): Promise<GetWirelessSsidsResult>
function getWirelessSsidsOutput(args: GetWirelessSsidsOutputArgs, opts?: InvokeOptions): Output<GetWirelessSsidsResult>
def get_wireless_ssids(network_id: Optional[str] = None,
number: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetWirelessSsidsResult
def get_wireless_ssids_output(network_id: Optional[pulumi.Input[str]] = None,
number: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetWirelessSsidsResult]
func LookupWirelessSsids(ctx *Context, args *LookupWirelessSsidsArgs, opts ...InvokeOption) (*LookupWirelessSsidsResult, error)
func LookupWirelessSsidsOutput(ctx *Context, args *LookupWirelessSsidsOutputArgs, opts ...InvokeOption) LookupWirelessSsidsResultOutput
> Note: This function is named LookupWirelessSsids
in the Go SDK.
public static class GetWirelessSsids
{
public static Task<GetWirelessSsidsResult> InvokeAsync(GetWirelessSsidsArgs args, InvokeOptions? opts = null)
public static Output<GetWirelessSsidsResult> Invoke(GetWirelessSsidsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWirelessSsidsResult> getWirelessSsids(GetWirelessSsidsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: meraki:networks/getWirelessSsids:getWirelessSsids
arguments:
# arguments dictionary
The following arguments are supported:
- network_
id str - networkId path parameter. Network ID
- number str
- number path parameter.
getWirelessSsids Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Get
Wireless Ssids Item - Items
List<Get
Wireless Ssids Item> - Array of ResponseWirelessGetNetworkWirelessSsids
- Network
Id string - networkId path parameter. Network ID
- Number string
- number path parameter.
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Get
Wireless Ssids Item - Items
[]Get
Wireless Ssids Item - Array of ResponseWirelessGetNetworkWirelessSsids
- Network
Id string - networkId path parameter. Network ID
- Number string
- number path parameter.
- id String
- The provider-assigned unique ID for this managed resource.
- item
Get
Wireless Ssids Item - items
List<Get
Wireless Ssids Item> - Array of ResponseWirelessGetNetworkWirelessSsids
- network
Id String - networkId path parameter. Network ID
- number String
- number path parameter.
- id string
- The provider-assigned unique ID for this managed resource.
- item
Get
Wireless Ssids Item - items
Get
Wireless Ssids Item[] - Array of ResponseWirelessGetNetworkWirelessSsids
- network
Id string - networkId path parameter. Network ID
- number string
- number path parameter.
- id str
- The provider-assigned unique ID for this managed resource.
- item
Get
Wireless Ssids Item - items
Sequence[Get
Wireless Ssids Item] - Array of ResponseWirelessGetNetworkWirelessSsids
- network_
id str - networkId path parameter. Network ID
- number str
- number path parameter.
- id String
- The provider-assigned unique ID for this managed resource.
- item Property Map
- items List<Property Map>
- Array of ResponseWirelessGetNetworkWirelessSsids
- network
Id String - networkId path parameter. Network ID
- number String
- number path parameter.
Supporting Types
GetWirelessSsidsItem
- Admin
Splash stringUrl - URL for the admin splash page
- Auth
Mode string - The association control method for the SSID
- List<string>
- List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list
- Available
On boolAll Aps - Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
- Band
Selection string - The client-serving radio frequencies of this SSID in the default indoor RF profile
- Enabled bool
- Whether or not the SSID is enabled
- Encryption
Mode string - The psk encryption mode for the SSID
- Ip
Assignment stringMode - The client IP assignment mode
- Local
Auth bool - Extended local auth flag for Enterprise NAC
- Mandatory
Dhcp boolEnabled - Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
- Min
Bitrate int - The minimum bitrate in Mbps of this SSID in the default indoor RF profile
- Name string
- The name of the SSID
- Number int
- Unique identifier of the SSID
- Per
Client intBandwidth Limit Down - The download bandwidth limit in Kbps. (0 represents no limit.)
- Per
Client intBandwidth Limit Up - The upload bandwidth limit in Kbps. (0 represents no limit.)
- Per
Ssid intBandwidth Limit Down - The total download bandwidth limit in Kbps (0 represents no limit)
- Per
Ssid intBandwidth Limit Up - The total upload bandwidth limit in Kbps (0 represents no limit)
- Radius
Accounting boolEnabled - Whether or not RADIUS accounting is enabled
- Radius
Accounting List<GetServers Wireless Ssids Item Radius Accounting Server> - List of RADIUS accounting 802.1X servers to be used for authentication
- Radius
Attribute stringFor Group Policies - RADIUS attribute used to look up group policies
- Radius
Enabled bool - Whether RADIUS authentication is enabled
- Radius
Failover stringPolicy - Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
- Radius
Load stringBalancing Policy - Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
- Radius
Servers List<GetWireless Ssids Item Radius Server> - List of RADIUS 802.1X servers to be used for authentication
- Splash
Page string - The type of splash page for the SSID
- Splash
Timeout string - Splash page timeout
- Ssid
Admin boolAccessible - SSID Administrator access status
- Visible bool
- Whether the SSID is advertised or hidden by the AP
- Walled
Garden boolEnabled - Allow users to access a configurable list of IP ranges prior to sign-on
- Walled
Garden List<string>Ranges - Domain names and IP address ranges available in Walled Garden mode
- Wpa
Encryption stringMode - The types of WPA encryption
- Admin
Splash stringUrl - URL for the admin splash page
- Auth
Mode string - The association control method for the SSID
- []string
- List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list
- Available
On boolAll Aps - Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
- Band
Selection string - The client-serving radio frequencies of this SSID in the default indoor RF profile
- Enabled bool
- Whether or not the SSID is enabled
- Encryption
Mode string - The psk encryption mode for the SSID
- Ip
Assignment stringMode - The client IP assignment mode
- Local
Auth bool - Extended local auth flag for Enterprise NAC
- Mandatory
Dhcp boolEnabled - Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
- Min
Bitrate int - The minimum bitrate in Mbps of this SSID in the default indoor RF profile
- Name string
- The name of the SSID
- Number int
- Unique identifier of the SSID
- Per
Client intBandwidth Limit Down - The download bandwidth limit in Kbps. (0 represents no limit.)
- Per
Client intBandwidth Limit Up - The upload bandwidth limit in Kbps. (0 represents no limit.)
- Per
Ssid intBandwidth Limit Down - The total download bandwidth limit in Kbps (0 represents no limit)
- Per
Ssid intBandwidth Limit Up - The total upload bandwidth limit in Kbps (0 represents no limit)
- Radius
Accounting boolEnabled - Whether or not RADIUS accounting is enabled
- Radius
Accounting []GetServers Wireless Ssids Item Radius Accounting Server - List of RADIUS accounting 802.1X servers to be used for authentication
- Radius
Attribute stringFor Group Policies - RADIUS attribute used to look up group policies
- Radius
Enabled bool - Whether RADIUS authentication is enabled
- Radius
Failover stringPolicy - Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
- Radius
Load stringBalancing Policy - Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
- Radius
Servers []GetWireless Ssids Item Radius Server - List of RADIUS 802.1X servers to be used for authentication
- Splash
Page string - The type of splash page for the SSID
- Splash
Timeout string - Splash page timeout
- Ssid
Admin boolAccessible - SSID Administrator access status
- Visible bool
- Whether the SSID is advertised or hidden by the AP
- Walled
Garden boolEnabled - Allow users to access a configurable list of IP ranges prior to sign-on
- Walled
Garden []stringRanges - Domain names and IP address ranges available in Walled Garden mode
- Wpa
Encryption stringMode - The types of WPA encryption
- admin
Splash StringUrl - URL for the admin splash page
- auth
Mode String - The association control method for the SSID
- List<String>
- List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list
- available
On BooleanAll Aps - Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
- band
Selection String - The client-serving radio frequencies of this SSID in the default indoor RF profile
- enabled Boolean
- Whether or not the SSID is enabled
- encryption
Mode String - The psk encryption mode for the SSID
- ip
Assignment StringMode - The client IP assignment mode
- local
Auth Boolean - Extended local auth flag for Enterprise NAC
- mandatory
Dhcp BooleanEnabled - Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
- min
Bitrate Integer - The minimum bitrate in Mbps of this SSID in the default indoor RF profile
- name String
- The name of the SSID
- number Integer
- Unique identifier of the SSID
- per
Client IntegerBandwidth Limit Down - The download bandwidth limit in Kbps. (0 represents no limit.)
- per
Client IntegerBandwidth Limit Up - The upload bandwidth limit in Kbps. (0 represents no limit.)
- per
Ssid IntegerBandwidth Limit Down - The total download bandwidth limit in Kbps (0 represents no limit)
- per
Ssid IntegerBandwidth Limit Up - The total upload bandwidth limit in Kbps (0 represents no limit)
- radius
Accounting BooleanEnabled - Whether or not RADIUS accounting is enabled
- radius
Accounting List<GetServers Wireless Ssids Item Radius Accounting Server> - List of RADIUS accounting 802.1X servers to be used for authentication
- radius
Attribute StringFor Group Policies - RADIUS attribute used to look up group policies
- radius
Enabled Boolean - Whether RADIUS authentication is enabled
- radius
Failover StringPolicy - Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
- radius
Load StringBalancing Policy - Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
- radius
Servers List<GetWireless Ssids Item Radius Server> - List of RADIUS 802.1X servers to be used for authentication
- splash
Page String - The type of splash page for the SSID
- splash
Timeout String - Splash page timeout
- ssid
Admin BooleanAccessible - SSID Administrator access status
- visible Boolean
- Whether the SSID is advertised or hidden by the AP
- walled
Garden BooleanEnabled - Allow users to access a configurable list of IP ranges prior to sign-on
- walled
Garden List<String>Ranges - Domain names and IP address ranges available in Walled Garden mode
- wpa
Encryption StringMode - The types of WPA encryption
- admin
Splash stringUrl - URL for the admin splash page
- auth
Mode string - The association control method for the SSID
- string[]
- List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list
- available
On booleanAll Aps - Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
- band
Selection string - The client-serving radio frequencies of this SSID in the default indoor RF profile
- enabled boolean
- Whether or not the SSID is enabled
- encryption
Mode string - The psk encryption mode for the SSID
- ip
Assignment stringMode - The client IP assignment mode
- local
Auth boolean - Extended local auth flag for Enterprise NAC
- mandatory
Dhcp booleanEnabled - Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
- min
Bitrate number - The minimum bitrate in Mbps of this SSID in the default indoor RF profile
- name string
- The name of the SSID
- number number
- Unique identifier of the SSID
- per
Client numberBandwidth Limit Down - The download bandwidth limit in Kbps. (0 represents no limit.)
- per
Client numberBandwidth Limit Up - The upload bandwidth limit in Kbps. (0 represents no limit.)
- per
Ssid numberBandwidth Limit Down - The total download bandwidth limit in Kbps (0 represents no limit)
- per
Ssid numberBandwidth Limit Up - The total upload bandwidth limit in Kbps (0 represents no limit)
- radius
Accounting booleanEnabled - Whether or not RADIUS accounting is enabled
- radius
Accounting GetServers Wireless Ssids Item Radius Accounting Server[] - List of RADIUS accounting 802.1X servers to be used for authentication
- radius
Attribute stringFor Group Policies - RADIUS attribute used to look up group policies
- radius
Enabled boolean - Whether RADIUS authentication is enabled
- radius
Failover stringPolicy - Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
- radius
Load stringBalancing Policy - Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
- radius
Servers GetWireless Ssids Item Radius Server[] - List of RADIUS 802.1X servers to be used for authentication
- splash
Page string - The type of splash page for the SSID
- splash
Timeout string - Splash page timeout
- ssid
Admin booleanAccessible - SSID Administrator access status
- visible boolean
- Whether the SSID is advertised or hidden by the AP
- walled
Garden booleanEnabled - Allow users to access a configurable list of IP ranges prior to sign-on
- walled
Garden string[]Ranges - Domain names and IP address ranges available in Walled Garden mode
- wpa
Encryption stringMode - The types of WPA encryption
- admin_
splash_ strurl - URL for the admin splash page
- auth_
mode str - The association control method for the SSID
- Sequence[str]
- List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list
- available_
on_ boolall_ aps - Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
- band_
selection str - The client-serving radio frequencies of this SSID in the default indoor RF profile
- enabled bool
- Whether or not the SSID is enabled
- encryption_
mode str - The psk encryption mode for the SSID
- ip_
assignment_ strmode - The client IP assignment mode
- local_
auth bool - Extended local auth flag for Enterprise NAC
- mandatory_
dhcp_ boolenabled - Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
- min_
bitrate int - The minimum bitrate in Mbps of this SSID in the default indoor RF profile
- name str
- The name of the SSID
- number int
- Unique identifier of the SSID
- per_
client_ intbandwidth_ limit_ down - The download bandwidth limit in Kbps. (0 represents no limit.)
- per_
client_ intbandwidth_ limit_ up - The upload bandwidth limit in Kbps. (0 represents no limit.)
- per_
ssid_ intbandwidth_ limit_ down - The total download bandwidth limit in Kbps (0 represents no limit)
- per_
ssid_ intbandwidth_ limit_ up - The total upload bandwidth limit in Kbps (0 represents no limit)
- radius_
accounting_ boolenabled - Whether or not RADIUS accounting is enabled
- radius_
accounting_ Sequence[Getservers Wireless Ssids Item Radius Accounting Server] - List of RADIUS accounting 802.1X servers to be used for authentication
- radius_
attribute_ strfor_ group_ policies - RADIUS attribute used to look up group policies
- radius_
enabled bool - Whether RADIUS authentication is enabled
- radius_
failover_ strpolicy - Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
- radius_
load_ strbalancing_ policy - Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
- radius_
servers Sequence[GetWireless Ssids Item Radius Server] - List of RADIUS 802.1X servers to be used for authentication
- splash_
page str - The type of splash page for the SSID
- splash_
timeout str - Splash page timeout
- ssid_
admin_ boolaccessible - SSID Administrator access status
- visible bool
- Whether the SSID is advertised or hidden by the AP
- walled_
garden_ boolenabled - Allow users to access a configurable list of IP ranges prior to sign-on
- walled_
garden_ Sequence[str]ranges - Domain names and IP address ranges available in Walled Garden mode
- wpa_
encryption_ strmode - The types of WPA encryption
- admin
Splash StringUrl - URL for the admin splash page
- auth
Mode String - The association control method for the SSID
- List<String>
- List of tags for this SSID. If availableOnAllAps is false, then the SSID is only broadcast by APs with tags matching any of the tags in this list
- available
On BooleanAll Aps - Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
- band
Selection String - The client-serving radio frequencies of this SSID in the default indoor RF profile
- enabled Boolean
- Whether or not the SSID is enabled
- encryption
Mode String - The psk encryption mode for the SSID
- ip
Assignment StringMode - The client IP assignment mode
- local
Auth Boolean - Extended local auth flag for Enterprise NAC
- mandatory
Dhcp BooleanEnabled - Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
- min
Bitrate Number - The minimum bitrate in Mbps of this SSID in the default indoor RF profile
- name String
- The name of the SSID
- number Number
- Unique identifier of the SSID
- per
Client NumberBandwidth Limit Down - The download bandwidth limit in Kbps. (0 represents no limit.)
- per
Client NumberBandwidth Limit Up - The upload bandwidth limit in Kbps. (0 represents no limit.)
- per
Ssid NumberBandwidth Limit Down - The total download bandwidth limit in Kbps (0 represents no limit)
- per
Ssid NumberBandwidth Limit Up - The total upload bandwidth limit in Kbps (0 represents no limit)
- radius
Accounting BooleanEnabled - Whether or not RADIUS accounting is enabled
- radius
Accounting List<Property Map>Servers - List of RADIUS accounting 802.1X servers to be used for authentication
- radius
Attribute StringFor Group Policies - RADIUS attribute used to look up group policies
- radius
Enabled Boolean - Whether RADIUS authentication is enabled
- radius
Failover StringPolicy - Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
- radius
Load StringBalancing Policy - Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
- radius
Servers List<Property Map> - List of RADIUS 802.1X servers to be used for authentication
- splash
Page String - The type of splash page for the SSID
- splash
Timeout String - Splash page timeout
- ssid
Admin BooleanAccessible - SSID Administrator access status
- visible Boolean
- Whether the SSID is advertised or hidden by the AP
- walled
Garden BooleanEnabled - Allow users to access a configurable list of IP ranges prior to sign-on
- walled
Garden List<String>Ranges - Domain names and IP address ranges available in Walled Garden mode
- wpa
Encryption StringMode - The types of WPA encryption
GetWirelessSsidsItemRadiusAccountingServer
- Ca
Certificate string - Certificate used for authorization for the RADSEC Server
- Host string
- IP address (or FQDN) to which the APs will send RADIUS accounting messages
- Open
Roaming intCertificate Id - The ID of the Openroaming Certificate attached to radius server
- Port int
- Port on the RADIUS server that is listening for accounting messages
- Ca
Certificate string - Certificate used for authorization for the RADSEC Server
- Host string
- IP address (or FQDN) to which the APs will send RADIUS accounting messages
- Open
Roaming intCertificate Id - The ID of the Openroaming Certificate attached to radius server
- Port int
- Port on the RADIUS server that is listening for accounting messages
- ca
Certificate String - Certificate used for authorization for the RADSEC Server
- host String
- IP address (or FQDN) to which the APs will send RADIUS accounting messages
- open
Roaming IntegerCertificate Id - The ID of the Openroaming Certificate attached to radius server
- port Integer
- Port on the RADIUS server that is listening for accounting messages
- ca
Certificate string - Certificate used for authorization for the RADSEC Server
- host string
- IP address (or FQDN) to which the APs will send RADIUS accounting messages
- open
Roaming numberCertificate Id - The ID of the Openroaming Certificate attached to radius server
- port number
- Port on the RADIUS server that is listening for accounting messages
- ca_
certificate str - Certificate used for authorization for the RADSEC Server
- host str
- IP address (or FQDN) to which the APs will send RADIUS accounting messages
- open_
roaming_ intcertificate_ id - The ID of the Openroaming Certificate attached to radius server
- port int
- Port on the RADIUS server that is listening for accounting messages
- ca
Certificate String - Certificate used for authorization for the RADSEC Server
- host String
- IP address (or FQDN) to which the APs will send RADIUS accounting messages
- open
Roaming NumberCertificate Id - The ID of the Openroaming Certificate attached to radius server
- port Number
- Port on the RADIUS server that is listening for accounting messages
GetWirelessSsidsItemRadiusServer
- Ca
Certificate string - Certificate used for authorization for the RADSEC Server
- Host string
- IP address (or FQDN) of your RADIUS server
- Open
Roaming intCertificate Id - The ID of the Openroaming Certificate attached to radius server
- Port int
- UDP port the RADIUS server listens on for Access-requests
- Ca
Certificate string - Certificate used for authorization for the RADSEC Server
- Host string
- IP address (or FQDN) of your RADIUS server
- Open
Roaming intCertificate Id - The ID of the Openroaming Certificate attached to radius server
- Port int
- UDP port the RADIUS server listens on for Access-requests
- ca
Certificate String - Certificate used for authorization for the RADSEC Server
- host String
- IP address (or FQDN) of your RADIUS server
- open
Roaming IntegerCertificate Id - The ID of the Openroaming Certificate attached to radius server
- port Integer
- UDP port the RADIUS server listens on for Access-requests
- ca
Certificate string - Certificate used for authorization for the RADSEC Server
- host string
- IP address (or FQDN) of your RADIUS server
- open
Roaming numberCertificate Id - The ID of the Openroaming Certificate attached to radius server
- port number
- UDP port the RADIUS server listens on for Access-requests
- ca_
certificate str - Certificate used for authorization for the RADSEC Server
- host str
- IP address (or FQDN) of your RADIUS server
- open_
roaming_ intcertificate_ id - The ID of the Openroaming Certificate attached to radius server
- port int
- UDP port the RADIUS server listens on for Access-requests
- ca
Certificate String - Certificate used for authorization for the RADSEC Server
- host String
- IP address (or FQDN) of your RADIUS server
- open
Roaming NumberCertificate Id - The ID of the Openroaming Certificate attached to radius server
- port Number
- UDP port the RADIUS server listens on for Access-requests
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
meraki
Terraform Provider.