1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. getWirelessSsids
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.networks.getWirelessSsids

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

    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:

    NetworkId string
    networkId path parameter. Network ID
    Number string
    number path parameter.
    NetworkId string
    networkId path parameter. Network ID
    Number string
    number path parameter.
    networkId String
    networkId path parameter. Network ID
    number String
    number path parameter.
    networkId string
    networkId path parameter. Network ID
    number string
    number path parameter.
    network_id str
    networkId path parameter. Network ID
    number str
    number path parameter.
    networkId String
    networkId path parameter. Network ID
    number String
    number path parameter.

    getWirelessSsids Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetWirelessSsidsItem
    Items List<GetWirelessSsidsItem>
    Array of ResponseWirelessGetNetworkWirelessSsids
    NetworkId string
    networkId path parameter. Network ID
    Number string
    number path parameter.
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetWirelessSsidsItem
    Items []GetWirelessSsidsItem
    Array of ResponseWirelessGetNetworkWirelessSsids
    NetworkId string
    networkId path parameter. Network ID
    Number string
    number path parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    item GetWirelessSsidsItem
    items List<GetWirelessSsidsItem>
    Array of ResponseWirelessGetNetworkWirelessSsids
    networkId String
    networkId path parameter. Network ID
    number String
    number path parameter.
    id string
    The provider-assigned unique ID for this managed resource.
    item GetWirelessSsidsItem
    items GetWirelessSsidsItem[]
    Array of ResponseWirelessGetNetworkWirelessSsids
    networkId string
    networkId path parameter. Network ID
    number string
    number path parameter.
    id str
    The provider-assigned unique ID for this managed resource.
    item GetWirelessSsidsItem
    items Sequence[GetWirelessSsidsItem]
    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
    networkId String
    networkId path parameter. Network ID
    number String
    number path parameter.

    Supporting Types

    GetWirelessSsidsItem

    AdminSplashUrl string
    URL for the admin splash page
    AuthMode string
    The association control method for the SSID
    AvailabilityTags 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
    AvailableOnAllAps bool
    Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
    BandSelection string
    The client-serving radio frequencies of this SSID in the default indoor RF profile
    Enabled bool
    Whether or not the SSID is enabled
    EncryptionMode string
    The psk encryption mode for the SSID
    IpAssignmentMode string
    The client IP assignment mode
    LocalAuth bool
    Extended local auth flag for Enterprise NAC
    MandatoryDhcpEnabled bool
    Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
    MinBitrate 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
    PerClientBandwidthLimitDown int
    The download bandwidth limit in Kbps. (0 represents no limit.)
    PerClientBandwidthLimitUp int
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    PerSsidBandwidthLimitDown int
    The total download bandwidth limit in Kbps (0 represents no limit)
    PerSsidBandwidthLimitUp int
    The total upload bandwidth limit in Kbps (0 represents no limit)
    RadiusAccountingEnabled bool
    Whether or not RADIUS accounting is enabled
    RadiusAccountingServers List<GetWirelessSsidsItemRadiusAccountingServer>
    List of RADIUS accounting 802.1X servers to be used for authentication
    RadiusAttributeForGroupPolicies string
    RADIUS attribute used to look up group policies
    RadiusEnabled bool
    Whether RADIUS authentication is enabled
    RadiusFailoverPolicy string
    Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
    RadiusLoadBalancingPolicy string
    Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
    RadiusServers List<GetWirelessSsidsItemRadiusServer>
    List of RADIUS 802.1X servers to be used for authentication
    SplashPage string
    The type of splash page for the SSID
    SplashTimeout string
    Splash page timeout
    SsidAdminAccessible bool
    SSID Administrator access status
    Visible bool
    Whether the SSID is advertised or hidden by the AP
    WalledGardenEnabled bool
    Allow users to access a configurable list of IP ranges prior to sign-on
    WalledGardenRanges List<string>
    Domain names and IP address ranges available in Walled Garden mode
    WpaEncryptionMode string
    The types of WPA encryption
    AdminSplashUrl string
    URL for the admin splash page
    AuthMode string
    The association control method for the SSID
    AvailabilityTags []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
    AvailableOnAllAps bool
    Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
    BandSelection string
    The client-serving radio frequencies of this SSID in the default indoor RF profile
    Enabled bool
    Whether or not the SSID is enabled
    EncryptionMode string
    The psk encryption mode for the SSID
    IpAssignmentMode string
    The client IP assignment mode
    LocalAuth bool
    Extended local auth flag for Enterprise NAC
    MandatoryDhcpEnabled bool
    Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
    MinBitrate 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
    PerClientBandwidthLimitDown int
    The download bandwidth limit in Kbps. (0 represents no limit.)
    PerClientBandwidthLimitUp int
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    PerSsidBandwidthLimitDown int
    The total download bandwidth limit in Kbps (0 represents no limit)
    PerSsidBandwidthLimitUp int
    The total upload bandwidth limit in Kbps (0 represents no limit)
    RadiusAccountingEnabled bool
    Whether or not RADIUS accounting is enabled
    RadiusAccountingServers []GetWirelessSsidsItemRadiusAccountingServer
    List of RADIUS accounting 802.1X servers to be used for authentication
    RadiusAttributeForGroupPolicies string
    RADIUS attribute used to look up group policies
    RadiusEnabled bool
    Whether RADIUS authentication is enabled
    RadiusFailoverPolicy string
    Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
    RadiusLoadBalancingPolicy string
    Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
    RadiusServers []GetWirelessSsidsItemRadiusServer
    List of RADIUS 802.1X servers to be used for authentication
    SplashPage string
    The type of splash page for the SSID
    SplashTimeout string
    Splash page timeout
    SsidAdminAccessible bool
    SSID Administrator access status
    Visible bool
    Whether the SSID is advertised or hidden by the AP
    WalledGardenEnabled bool
    Allow users to access a configurable list of IP ranges prior to sign-on
    WalledGardenRanges []string
    Domain names and IP address ranges available in Walled Garden mode
    WpaEncryptionMode string
    The types of WPA encryption
    adminSplashUrl String
    URL for the admin splash page
    authMode String
    The association control method for the SSID
    availabilityTags 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
    availableOnAllAps Boolean
    Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
    bandSelection String
    The client-serving radio frequencies of this SSID in the default indoor RF profile
    enabled Boolean
    Whether or not the SSID is enabled
    encryptionMode String
    The psk encryption mode for the SSID
    ipAssignmentMode String
    The client IP assignment mode
    localAuth Boolean
    Extended local auth flag for Enterprise NAC
    mandatoryDhcpEnabled Boolean
    Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
    minBitrate 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
    perClientBandwidthLimitDown Integer
    The download bandwidth limit in Kbps. (0 represents no limit.)
    perClientBandwidthLimitUp Integer
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    perSsidBandwidthLimitDown Integer
    The total download bandwidth limit in Kbps (0 represents no limit)
    perSsidBandwidthLimitUp Integer
    The total upload bandwidth limit in Kbps (0 represents no limit)
    radiusAccountingEnabled Boolean
    Whether or not RADIUS accounting is enabled
    radiusAccountingServers List<GetWirelessSsidsItemRadiusAccountingServer>
    List of RADIUS accounting 802.1X servers to be used for authentication
    radiusAttributeForGroupPolicies String
    RADIUS attribute used to look up group policies
    radiusEnabled Boolean
    Whether RADIUS authentication is enabled
    radiusFailoverPolicy String
    Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
    radiusLoadBalancingPolicy String
    Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
    radiusServers List<GetWirelessSsidsItemRadiusServer>
    List of RADIUS 802.1X servers to be used for authentication
    splashPage String
    The type of splash page for the SSID
    splashTimeout String
    Splash page timeout
    ssidAdminAccessible Boolean
    SSID Administrator access status
    visible Boolean
    Whether the SSID is advertised or hidden by the AP
    walledGardenEnabled Boolean
    Allow users to access a configurable list of IP ranges prior to sign-on
    walledGardenRanges List<String>
    Domain names and IP address ranges available in Walled Garden mode
    wpaEncryptionMode String
    The types of WPA encryption
    adminSplashUrl string
    URL for the admin splash page
    authMode string
    The association control method for the SSID
    availabilityTags 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
    availableOnAllAps boolean
    Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
    bandSelection string
    The client-serving radio frequencies of this SSID in the default indoor RF profile
    enabled boolean
    Whether or not the SSID is enabled
    encryptionMode string
    The psk encryption mode for the SSID
    ipAssignmentMode string
    The client IP assignment mode
    localAuth boolean
    Extended local auth flag for Enterprise NAC
    mandatoryDhcpEnabled boolean
    Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
    minBitrate 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
    perClientBandwidthLimitDown number
    The download bandwidth limit in Kbps. (0 represents no limit.)
    perClientBandwidthLimitUp number
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    perSsidBandwidthLimitDown number
    The total download bandwidth limit in Kbps (0 represents no limit)
    perSsidBandwidthLimitUp number
    The total upload bandwidth limit in Kbps (0 represents no limit)
    radiusAccountingEnabled boolean
    Whether or not RADIUS accounting is enabled
    radiusAccountingServers GetWirelessSsidsItemRadiusAccountingServer[]
    List of RADIUS accounting 802.1X servers to be used for authentication
    radiusAttributeForGroupPolicies string
    RADIUS attribute used to look up group policies
    radiusEnabled boolean
    Whether RADIUS authentication is enabled
    radiusFailoverPolicy string
    Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
    radiusLoadBalancingPolicy string
    Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
    radiusServers GetWirelessSsidsItemRadiusServer[]
    List of RADIUS 802.1X servers to be used for authentication
    splashPage string
    The type of splash page for the SSID
    splashTimeout string
    Splash page timeout
    ssidAdminAccessible boolean
    SSID Administrator access status
    visible boolean
    Whether the SSID is advertised or hidden by the AP
    walledGardenEnabled boolean
    Allow users to access a configurable list of IP ranges prior to sign-on
    walledGardenRanges string[]
    Domain names and IP address ranges available in Walled Garden mode
    wpaEncryptionMode string
    The types of WPA encryption
    admin_splash_url str
    URL for the admin splash page
    auth_mode str
    The association control method for the SSID
    availability_tags 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_all_aps bool
    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_mode str
    The client IP assignment mode
    local_auth bool
    Extended local auth flag for Enterprise NAC
    mandatory_dhcp_enabled bool
    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_bandwidth_limit_down int
    The download bandwidth limit in Kbps. (0 represents no limit.)
    per_client_bandwidth_limit_up int
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    per_ssid_bandwidth_limit_down int
    The total download bandwidth limit in Kbps (0 represents no limit)
    per_ssid_bandwidth_limit_up int
    The total upload bandwidth limit in Kbps (0 represents no limit)
    radius_accounting_enabled bool
    Whether or not RADIUS accounting is enabled
    radius_accounting_servers Sequence[GetWirelessSsidsItemRadiusAccountingServer]
    List of RADIUS accounting 802.1X servers to be used for authentication
    radius_attribute_for_group_policies str
    RADIUS attribute used to look up group policies
    radius_enabled bool
    Whether RADIUS authentication is enabled
    radius_failover_policy str
    Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
    radius_load_balancing_policy str
    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[GetWirelessSsidsItemRadiusServer]
    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_accessible bool
    SSID Administrator access status
    visible bool
    Whether the SSID is advertised or hidden by the AP
    walled_garden_enabled bool
    Allow users to access a configurable list of IP ranges prior to sign-on
    walled_garden_ranges Sequence[str]
    Domain names and IP address ranges available in Walled Garden mode
    wpa_encryption_mode str
    The types of WPA encryption
    adminSplashUrl String
    URL for the admin splash page
    authMode String
    The association control method for the SSID
    availabilityTags 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
    availableOnAllAps Boolean
    Whether all APs broadcast the SSID or if it's restricted to APs matching any availability tags
    bandSelection String
    The client-serving radio frequencies of this SSID in the default indoor RF profile
    enabled Boolean
    Whether or not the SSID is enabled
    encryptionMode String
    The psk encryption mode for the SSID
    ipAssignmentMode String
    The client IP assignment mode
    localAuth Boolean
    Extended local auth flag for Enterprise NAC
    mandatoryDhcpEnabled Boolean
    Whether clients connecting to this SSID must use the IP address assigned by the DHCP server
    minBitrate 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
    perClientBandwidthLimitDown Number
    The download bandwidth limit in Kbps. (0 represents no limit.)
    perClientBandwidthLimitUp Number
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    perSsidBandwidthLimitDown Number
    The total download bandwidth limit in Kbps (0 represents no limit)
    perSsidBandwidthLimitUp Number
    The total upload bandwidth limit in Kbps (0 represents no limit)
    radiusAccountingEnabled Boolean
    Whether or not RADIUS accounting is enabled
    radiusAccountingServers List<Property Map>
    List of RADIUS accounting 802.1X servers to be used for authentication
    radiusAttributeForGroupPolicies String
    RADIUS attribute used to look up group policies
    radiusEnabled Boolean
    Whether RADIUS authentication is enabled
    radiusFailoverPolicy String
    Policy which determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable
    radiusLoadBalancingPolicy String
    Policy which determines which RADIUS server will be contacted first in an authentication attempt, and the ordering of any necessary retry attempts
    radiusServers List<Property Map>
    List of RADIUS 802.1X servers to be used for authentication
    splashPage String
    The type of splash page for the SSID
    splashTimeout String
    Splash page timeout
    ssidAdminAccessible Boolean
    SSID Administrator access status
    visible Boolean
    Whether the SSID is advertised or hidden by the AP
    walledGardenEnabled Boolean
    Allow users to access a configurable list of IP ranges prior to sign-on
    walledGardenRanges List<String>
    Domain names and IP address ranges available in Walled Garden mode
    wpaEncryptionMode String
    The types of WPA encryption

    GetWirelessSsidsItemRadiusAccountingServer

    CaCertificate string
    Certificate used for authorization for the RADSEC Server
    Host string
    IP address (or FQDN) to which the APs will send RADIUS accounting messages
    OpenRoamingCertificateId int
    The ID of the Openroaming Certificate attached to radius server
    Port int
    Port on the RADIUS server that is listening for accounting messages
    CaCertificate string
    Certificate used for authorization for the RADSEC Server
    Host string
    IP address (or FQDN) to which the APs will send RADIUS accounting messages
    OpenRoamingCertificateId int
    The ID of the Openroaming Certificate attached to radius server
    Port int
    Port on the RADIUS server that is listening for accounting messages
    caCertificate String
    Certificate used for authorization for the RADSEC Server
    host String
    IP address (or FQDN) to which the APs will send RADIUS accounting messages
    openRoamingCertificateId Integer
    The ID of the Openroaming Certificate attached to radius server
    port Integer
    Port on the RADIUS server that is listening for accounting messages
    caCertificate string
    Certificate used for authorization for the RADSEC Server
    host string
    IP address (or FQDN) to which the APs will send RADIUS accounting messages
    openRoamingCertificateId number
    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_certificate_id int
    The ID of the Openroaming Certificate attached to radius server
    port int
    Port on the RADIUS server that is listening for accounting messages
    caCertificate String
    Certificate used for authorization for the RADSEC Server
    host String
    IP address (or FQDN) to which the APs will send RADIUS accounting messages
    openRoamingCertificateId Number
    The ID of the Openroaming Certificate attached to radius server
    port Number
    Port on the RADIUS server that is listening for accounting messages

    GetWirelessSsidsItemRadiusServer

    CaCertificate string
    Certificate used for authorization for the RADSEC Server
    Host string
    IP address (or FQDN) of your RADIUS server
    OpenRoamingCertificateId int
    The ID of the Openroaming Certificate attached to radius server
    Port int
    UDP port the RADIUS server listens on for Access-requests
    CaCertificate string
    Certificate used for authorization for the RADSEC Server
    Host string
    IP address (or FQDN) of your RADIUS server
    OpenRoamingCertificateId int
    The ID of the Openroaming Certificate attached to radius server
    Port int
    UDP port the RADIUS server listens on for Access-requests
    caCertificate String
    Certificate used for authorization for the RADSEC Server
    host String
    IP address (or FQDN) of your RADIUS server
    openRoamingCertificateId Integer
    The ID of the Openroaming Certificate attached to radius server
    port Integer
    UDP port the RADIUS server listens on for Access-requests
    caCertificate string
    Certificate used for authorization for the RADSEC Server
    host string
    IP address (or FQDN) of your RADIUS server
    openRoamingCertificateId number
    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_certificate_id int
    The ID of the Openroaming Certificate attached to radius server
    port int
    UDP port the RADIUS server listens on for Access-requests
    caCertificate String
    Certificate used for authorization for the RADSEC Server
    host String
    IP address (or FQDN) of your RADIUS server
    openRoamingCertificateId Number
    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.
    meraki logo
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi