Skip to content
Network as Code

SSID

Location in GUI: Design » Network Settings » Wireless » SSIDs

Diagram

Diagram

Classes

wireless (catalyst_center)

NameTypeConstraintMandatoryDefault Value
ssidsList[ssids]No

ssids (catalyst_center.wireless)

NameTypeConstraintMandatoryDefault Value
nameStringYes
auth_typeChoiceWPA2_ENTERPRISE, WPA2_PERSONAL, OPEN, WPA3_ENTERPRISE, WPA3_PERSONAL, WPA2_WPA3_PERSONAL, WPA2_WPA3_ENTERPRISE, OPEN_SECUREDYes
wlan_typeChoiceEnterprise, GuestYes
aaa_overrideBooleantrue, falseNo
acct_serversListIPNo
acl_nameStringNo
ap_beacon_protectionBooleantrue, falseNo
auth_key8021xBooleantrue, falseNo
auth_key8021x_plus_ftBooleantrue, falseNo
auth_key8021x_sha256Booleantrue, falseNo
auth_key_easy_pskBooleantrue, falseNo
auth_key_easy_psk_sha256Booleantrue, falseNo
auth_key_oweBooleantrue, falseNo
auth_key_pskBooleantrue, falseNo
auth_key_psk_plus_ftBooleantrue, falseNo
auth_key_saeBooleantrue, falseNo
auth_key_sae_extBooleantrue, falseNo
auth_key_sae_ext_plus_ftBooleantrue, falseNo
auth_key_sae_plus_ftBooleantrue, falseNo
auth_key_suite_b1921xBooleantrue, falseNo
auth_key_suite_b1xBooleantrue, falseNo
auth_serverChoiceauth_ise, auth_external, auth_internalNo
auth_serversListIPNo
basic_service_set_client_idle_timeoutIntegermin: 15, max: 100000No
basic_service_set_max_idleBooleantrue, falseNo
broadcast_ssidBooleantrue, falseNo
cckmBooleantrue, falseNo
cckm_tsf_toleranceIntegermin: 1000, max: 5000No
client_exclusionBooleantrue, falseNo
client_exclusion_timeoutIntegermin: 0, max: 2147483647No
client_rate_limitIntegermin: 8000, max: 100000000000No
coverage_hole_detectionBooleantrue, falseNo
directed_multicast_serviceBooleantrue, falseNo
egress_qosChoicePLATINUM, SILVER, GOLD, BRONZENo
enabledBooleantrue, falseNo
external_auth_ip_addressStringNo
fast_laneBooleantrue, falseNo
fast_transitionChoiceADAPTIVE, DISABLE, ENABLENo
fast_transition_over_the_distributed_systemBooleantrue, falseNo
ghz24_policyChoicedot11-g-only, dot11-bg-onlyNo
ghz6_policy_client_steeringBooleantrue, falseNo
hexBooleantrue, falseNo
ingress_qosChoicePLATINUM-UP, SILVER-UP, GOLD-UP, BRONZE-UPNo
l3_auth_typeChoiceopen, web_authNo
mac_filteringBooleantrue, falseNo
mft_client_protectionChoiceOPTIONAL, DISABLED, REQUIREDNo
multi_psk_settingsClass[multi_psk_settings]No
nas_optionsListStringNo
neighbor_listBooleantrue, falseNo
open_ssidBooleantrue, falseNo
passphraseStringNo
posturingBooleantrue, falseNo
profile_nameStringNo
protected_management_frameChoiceREQUIRED, DISABLED, OPTIONALNo
random_mac_filterBooleantrue, falseNo
rsn_cipher_suite_ccmp128Booleantrue, falseNo
rsn_cipher_suite_gcmp128Booleantrue, falseNo
rsn_cipher_suite_ccmp256Booleantrue, falseNo
rsn_cipher_suite_gcmp256Booleantrue, falseNo
session_timeoutIntegermin: 1, max: 86400No
session_timeout_enableBooleantrue, falseNo
sleeping_clientBooleantrue, falseNo
sleeping_client_timeoutIntegermin: 10, max: 43200No
ssid_radio_typeChoiceTriple Band, 5GHz, 2.4GHz, 6GHz, 2.4GHz and 5GHz, 2.4GHz and 6GHz, 5GHz and 6GHzNo

multi_psk_settings (catalyst_center.wireless.ssids)

NameTypeConstraintMandatoryDefault Value
priorityStringYes
passphraseStringNo
passphrase_typeChoiceASCII, HEXNo

Examples

catalyst_center:
  wireless:
    ssids:
      - name: SSID_1
        auth_type: WPA3_PERSONAL
        passphrase: Cisco123
        fast_lane: false
        mac_filtering: false
        ssid_radio_type: Triple Band
        broadcast_ssid: true
        fast_transition: ADAPTIVE
        session_timeout_enable: true
        session_timeout: 1800
        client_exclusion: true
        client_exclusion_timeout: 1800
        basic_service_set_max_idle: true
        basic_service_set_client_idle_timeout: 300
        directed_multicast_service: true
        neighbor_list: true
        mft_client_protection: OPTIONAL
        aaa_override: false
        protected_management_frame: REQUIRED
        rsn_cipher_suite_ccmp128: true
        wlan_type: Enterprise
        auth_key_sae_ext: true
        ghz24_policy: dot11-g-only
        hex: false
        random_mac_filter: false