Table of Contents

Class SsidUpdateRequest

Namespace
Meraki.Api.Data
Assembly
Meraki.Api.dll

UpdateNetworkSsid

[DataContract]
public class SsidUpdateRequest
Inheritance
SsidUpdateRequest
Derived
Inherited Members

Properties

ActiveDirectory

Accepts a list of tags for this SSID. If availableOnAllAps is false, then the SSID will only be broadcast by APs with tags matching any of the tags in this list.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "activeDirectory")]
public ActiveDirectory? ActiveDirectory { get; set; }

Property Value

ActiveDirectory

AdultContentFilteringEnabled

Boolean indicating whether or not adult content will be blocked

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "adultContentFilteringEnabled")]
public bool? AdultContentFilteringEnabled { get; set; }

Property Value

bool?

ApTagsAndVlanIds

The list of tags and VLAN IDs used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "apTagsAndVlanIds")]
public List<ApTagsAndVlanId>? ApTagsAndVlanIds { get; set; }

Property Value

List<ApTagsAndVlanId>

AuthMode

The association control method for the SSID ('open', 'psk', 'open-with-radius', '8021x-meraki', '8021x-radius', '8021x-google', '8021x-localradius', 'ipsk-with-radius' or 'ipsk-without-radius')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "authMode")]
public AuthMode? AuthMode { get; set; }

Property Value

AuthMode?

AvailabilityTags

Accepts a list of tags for this SSID. If availableOnAllAps is false, then the SSID will only be broadcast by APs with tags matching any of the tags in this list.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "availabilityTags")]
public List<string>? AvailabilityTags { get; set; }

Property Value

List<string>

AvailableOnAllAps

Boolean indicating whether all APs should broadcast the SSID or if it should be restricted to APs matching any availability tags. Can only be false if the SSID has availability tags

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "availableOnAllAps")]
public bool? AvailableOnAllAps { get; set; }

Property Value

bool?

BandSelection

The client-serving radio frequencies of this SSID in the default indoor RF profile. ('Dual band operation', '5 GHz band only' or 'Dual band operation with Band Steering')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "bandSelection")]
public string? BandSelection { get; set; }

Property Value

string

ConcentratorNetworkId

The concentrator to use when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "concentratorNetworkId")]
public string? ConcentratorNetworkId { get; set; }

Property Value

string

DefaultVlanId

The default VLAN ID used for 'all other APs'. This param is only valid when the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "defaultVlanId")]
public int? DefaultVlanId { get; set; }

Property Value

int?

DisassociateClientsOnVpnFailover

Disassociate clients when 'VPN' concentrator failover occurs in order to trigger clients to re-associate and generate new DHCP requests. This param is only valid if ipAssignmentMode is 'VPN'.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "disassociateClientsOnVpnFailover")]
public bool? DisassociateClientsOnVpnFailover { get; set; }

Property Value

bool?

DnsRewrite

DNS servers rewrite settings

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "dnsRewrite")]
public DnsRewrite? DnsRewrite { get; set; }

Property Value

DnsRewrite

Dot11r

The current setting for 802.11r

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "dot11r")]
public Dot11r? Dot11r { get; set; }

Property Value

Dot11r

Dot11w

The current setting for Protected Management Frames (802.11w).

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "dot11w")]
public Dot11w? Dot11w { get; set; }

Property Value

Dot11w

Enabled

Whether or not the SSID is enabled

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "enabled")]
public bool? Enabled { get; set; }

Property Value

bool?

EncryptionMode

The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "encryptionMode")]
public EncryptionMode? EncryptionMode { get; set; }

Property Value

EncryptionMode?

EnterpriseAdminAccess

Whether or not an SSID is accessible by 'enterprise' administrators ('access disabled' or 'access enabled')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "enterpriseAdminAccess")]
public EnterpriseAdminAccess? EnterpriseAdminAccess { get; set; }

Property Value

EnterpriseAdminAccess?

Gre

Ethernet over GRE settings

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "gre")]
public Gre? Gre { get; set; }

Property Value

Gre

IpAssignmentMode

The client IP assignment mode('NAT mode', 'Bridge mode', 'Layer 3 roaming', 'Layer 3 roaming with a concentrator' or 'VPN')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "ipAssignmentMode")]
public string? IpAssignmentMode { get; set; }

Property Value

string

LanIsolationEnabled

Boolean indicating whether Layer 2 LAN isolation should be enabled or disabled. Only configurable when ipAssignmentMode is 'Bridge mode'.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "lanIsolationEnabled")]
public bool? LanIsolationEnabled { get; set; }

Property Value

bool?

Ldap

The current setting for LDAP. Only valid if splashPage is 'Password-protected with LDAP'.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "ldap")]
public Ldap? Ldap { get; set; }

Property Value

Ldap

LocalAuth

localAuth

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "localAuth")]
public bool? LocalAuth { get; set; }

Property Value

bool?

LocalRadius

The current setting for Local Authentication, a built-in RADIUS server on the access point. Only valid if authMode is '8021x-localradius'.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "localRadius")]
public LocalRadius? LocalRadius { get; set; }

Property Value

LocalRadius

MandatoryDhcpEnabled

If true, Mandatory DHCP will enforce that clients connecting to this SSID must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "mandatoryDhcpEnabled")]
public bool? MandatoryDhcpEnabled { get; set; }

Property Value

bool?

MinBitrate

The minimum bitrate in Mbps of this SSID in the default indoor RF profile. ('1', '2', '5.5', '6', '9', '11', '12', '18', '24', '36', '48' or '54')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "minBitrate")]
public double? MinBitrate { get; set; }

Property Value

double?

Name

The name of the SSID

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "name")]
public string? Name { get; set; }

Property Value

string

NamedVlans

Named VLAN settings

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "namedVlans")]
public SsidNamedVlans? NamedVlans { get; set; }

Property Value

SsidNamedVlans

Oauth

The OAuth settings of this SSID. Only valid if splashPage is 'Google OAuth'.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "oauth")]
public Oauth? Oauth { get; set; }

Property Value

Oauth

PerClientBandwidthLimitDown

The download bandwidth limit in Kbps. (0 represents no limit.)

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "perClientBandwidthLimitDown")]
public int? PerClientBandwidthLimitDown { get; set; }

Property Value

int?

PerClientBandwidthLimitUp

The upload bandwidth limit in Kbps. (0 represents no limit.)

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "perClientBandwidthLimitUp")]
public int? PerClientBandwidthLimitUp { get; set; }

Property Value

int?

PerSsidBandwidthLimitDown

The total download bandwidth limit in Kbps. (0 represents no limit.)

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "perSsidBandwidthLimitDown")]
public int? PerSsidBandwidthLimitDown { get; set; }

Property Value

int?

PerSsidBandwidthLimitUp

The total upload bandwidth limit in Kbps. (0 represents no limit.)

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "perSsidBandwidthLimitUp")]
public int? PerSsidBandwidthLimitUp { get; set; }

Property Value

int?

Psk

The passkey for the SSID. This param is only valid if the authMode is 'psk'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "psk")]
public string? Psk { get; set; }

Property Value

string

RadiusAccountingEnabled

Whether or not RADIUS accounting is enabled. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusAccountingEnabled")]
public bool? RadiusAccountingEnabled { get; set; }

Property Value

bool?

RadiusAccountingInterimInterval

The interval (in seconds) in which accounting information is updated and sent to the RADIUS accounting server

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusAccountingInterimInterval")]
public int? RadiusAccountingInterimInterval { get; set; }

Property Value

int?

RadiusAccountingServers

The RADIUS accounting 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius' and radiusAccountingEnabled is 'true'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusAccountingServers")]
public List<RadiusAccountingServer>? RadiusAccountingServers { get; set; }

Property Value

List<RadiusAccountingServer>

RadiusAttributeForGroupPolicies

Specify the RADIUS attribute used to look up group policies ('Filter-Id', 'Reply-Message', 'Airespace-ACL-Name' or 'Aruba-User-Role'). Access points must receive this attribute in the RADIUS Access-Accept message

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusAttributeForGroupPolicies")]
public string? RadiusAttributeForGroupPolicies { get; set; }

Property Value

string

RadiusAuthenticationNasId

The template of the NAS identifier to be used for RADIUS authentication (ex. \(NODE_MAC\):\(VAP_NUM\)).

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusAuthenticationNasId")]
public string? RadiusAuthenticationNasId { get; set; }

Property Value

string

RadiusCalledStationId

The template of the called station identifier to be used for RADIUS (ex. \(NODE_MAC\):\(VAP_NUM\)).

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusCalledStationId")]
public string? RadiusCalledStationId { get; set; }

Property Value

string

RadiusCoaEnabled

If true, Meraki devices will act as a RADIUS Dynamic Authorization Server and will respond to RADIUS Change-of-Authorization and Disconnect messages sent by the RADIUS server.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusCoaEnabled")]
public bool? RadiusCoaEnabled { get; set; }

Property Value

bool?

RadiusEnabled

radiusEnabled

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusEnabled")]
public bool? RadiusEnabled { get; set; }

Property Value

bool?

RadiusFailoverPolicy

This policy determines how authentication requests should be handled in the event that all of the configured RADIUS servers are unreachable ('Deny access' or 'Allow access')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusFailoverPolicy")]
public RadiusFailoverPolicy? RadiusFailoverPolicy { get; set; }

Property Value

RadiusFailoverPolicy?

RadiusFallbackEnabled

Whether or not higher priority RADIUS servers should be retried after 60 seconds.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusFallbackEnabled")]
public bool? RadiusFallbackEnabled { get; set; }

Property Value

bool?

RadiusGuestVlanEnabled

Whether or not RADIUS Guest VLAN is enabled. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusGuestVlanEnabled")]
public bool? RadiusGuestVlanEnabled { get; set; }

Property Value

bool?

RadiusGuestVlanId

VLAN ID of the RADIUS Guest VLAN. This param is only valid if the authMode is 'open-with-radius' and addressing mode is not set to 'isolated' or 'nat' mode

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusGuestVlanId")]
public int? RadiusGuestVlanId { get; set; }

Property Value

int?

RadiusLoadBalancingPolicy

This policy determines which RADIUS server will be contacted first in an authentication attempt and the ordering of any necessary retry attempts ('Strict priority order' or 'Round robin')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusLoadBalancingPolicy")]
public RadiusLoadBalancingPolicy? RadiusLoadBalancingPolicy { get; set; }

Property Value

RadiusLoadBalancingPolicy?

RadiusOverride

If true, the RADIUS response can override VLAN tag. This is not valid when ipAssignmentMode is 'NAT mode'.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusOverride")]
public bool? RadiusOverride { get; set; }

Property Value

bool?

RadiusProxyEnabled

If true, Meraki devices will proxy RADIUS messages through the Meraki cloud to the configured RADIUS auth and accounting servers.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusProxyEnabled")]
public bool? RadiusProxyEnabled { get; set; }

Property Value

bool?

RadiusRadsec

The current settings for RADIUS RADSec

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusRadsec")]
public SsidUpdateRequestRadiusRadsec? RadiusRadsec { get; set; }

Property Value

SsidUpdateRequestRadiusRadsec

RadiusRadsecTlsIdleTimeout

radiusRadsecTlsIdleTimeout - undocumented

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusRadsecTlsIdleTimeout")]
public int? RadiusRadsecTlsIdleTimeout { get; set; }

Property Value

int?

RadiusServerAttemptsLimit

The maximum number of transmit attempts after which a RADIUS server is failed over (must be between 1-5).

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusServerAttemptsLimit")]
public int? RadiusServerAttemptsLimit { get; set; }

Property Value

int?

RadiusServerTimeout

The amount of time for which a RADIUS client waits for a reply from the RADIUS server (must be between 1-10 seconds).

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusServerTimeout")]
public int? RadiusServerTimeout { get; set; }

Property Value

int?

RadiusServers

The RADIUS 802.1X servers to be used for authentication. This param is only valid if the authMode is 'open-with-radius', '8021x-radius' or 'ipsk-with-radius'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusServers")]
public List<SsidRadiusServer>? RadiusServers { get; set; }

Property Value

List<SsidRadiusServer>

RadiusTestingEnabled

If true, Meraki devices will periodically send Access-Request messages to configured RADIUS servers using identity 'meraki_8021x_test' to ensure that the RADIUS servers are reachable.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "radiusTestingEnabled")]
public bool? RadiusTestingEnabled { get; set; }

Property Value

bool?

SecondaryConcentratorNetworkId

The secondary concentrator to use when the ipAssignmentMode is 'VPN'. If configured, the APs will switch to using this concentrator if the primary concentrator is unreachable. This param is optional. ('disabled' represents no secondary concentrator.)

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "secondaryConcentratorNetworkId")]
public string? SecondaryConcentratorNetworkId { get; set; }

Property Value

string

SpeedBurst

speedBurst settings

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "speedBurst")]
public SpeedBurst? SpeedBurst { get; set; }

Property Value

SpeedBurst

SplashGuestSponsorDomains

Array of valid sponsor email domains for sponsored guest splash type.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "splashGuestSponsorDomains")]
public List<string>? SplashGuestSponsorDomains { get; set; }

Property Value

List<string>

SplashPage

The type of splash page for the SSID ('None', 'Click-through splash page', 'Billing', 'Password-protected with Meraki RADIUS', 'Password-protected with custom RADIUS', 'Password-protected with Active Directory', 'Password-protected with LDAP', 'SMS authentication', 'Systems Manager Sentry', 'Facebook Wi-Fi', 'Google OAuth', 'Sponsored guest', 'Cisco ISE' or 'Google Apps domain'). This attribute is not supported for template children.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "splashPage")]
public SplashPage? SplashPage { get; set; }

Property Value

SplashPage?

SplashTimeout

splashTimeout

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "splashTimeout")]
public string? SplashTimeout { get; set; }

Property Value

string

UseVlanTagging

Whether or not traffic should be directed to use specific VLANs. This param is only valid if the ipAssignmentMode is 'Bridge mode' or 'Layer 3 roaming'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "useVlanTagging")]
public bool? UseVlanTagging { get; set; }

Property Value

bool?

Visible

Boolean indicating whether APs should advertise or hide this SSID. APs will only broadcast this SSID if set to true

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "visible")]
public bool? Visible { get; set; }

Property Value

bool?

VlanId

The VLAN ID used for VLAN tagging. This param is only valid when the ipAssignmentMode is 'Layer 3 roaming with a concentrator' or 'VPN'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "vlanId")]
public int? VlanId { get; set; }

Property Value

int?

WalledGardenEnabled

Allow access to a configurable list of IP ranges, which users may access prior to sign-on.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "walledGardenEnabled")]
public bool? WalledGardenEnabled { get; set; }

Property Value

bool?

WalledGardenRanges

Specify your walled garden by entering an array of addresses, ranges using CIDR notation, domain names, and domain wildcards (e.g. '192.168.1.1/24', '192.168.37.10/32', 'www.yahoo.com', '*.google.com']). Meraki's splash page is automatically included in your walled garden.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "walledGardenRanges")]
public List<string>? WalledGardenRanges { get; set; }

Property Value

List<string>

WpaEncryptionMode

The types of WPA encryption. ('WPA1 only', 'WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode' or 'WPA3 only')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "wpaEncryptionMode")]
public WpaEncryptionMode? WpaEncryptionMode { get; set; }

Property Value

WpaEncryptionMode?
Edit this page