Class: Ansible::Ruby::Modules::Meraki_ssid

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Meraki_ssid

Defined in:

lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb

Overview

Allows for management of SSIDs in a Meraki wireless environment.

Instance Method Summary

• #ap_tags_vlan_ids ⇒ Object^?

  List of VLAN tags.

• #auth_mode ⇒ :open, ...

  Set authentication mode of network.

• #band_selection ⇒ :"Dual band operation", ...

  Set band selection mode.

• #concentrator_network_id ⇒ Object^?

  The concentrator to use for ‘Layer 3 roaming with a concentrator’ or ‘VPN’.

• #default_vlan_id ⇒ Object^?

  Default VLAN ID.

• #enabled ⇒ Symbol^?

  Enable or disable SSID network.

• #encryption_mode ⇒ :wpa, ...

  Set encryption mode of network.

• #ip_assignment_mode ⇒ :"NAT mode", ...

  Method of which SSID uses to assign IP addresses.

• #min_bitrate ⇒ 1, ...

  Minimum bitrate (Mbps) allowed on SSID.

• #name ⇒ Object^?

  Name of SSID.

• #net_id ⇒ Object^?

  ID of network.

• #net_name ⇒ Object^?

  Name of network.

• #number ⇒ Object^?

  SSID number within network.

• #org_id ⇒ Object^?

  ID of organization.

• #org_name ⇒ Object^?

  Name of organization.

• #per_client_bandwidth_limit_down ⇒ Object^?

  Maximum bandwidth in Mbps devices on SSID can download.

• #per_client_bandwidth_limit_up ⇒ Object^?

  Maximum bandwidth in Mbps devices on SSID can upload.

• #psk ⇒ Object^?

  Password for wireless network.,Requires auth_mode to be set to psk.

• #radius_accounting_enabled ⇒ Symbol^?

  Enable or disable RADIUS accounting.

• #radius_accounting_servers ⇒ Object^?

  List of RADIUS servers for RADIUS accounting.

• #radius_coa_enabled ⇒ Symbol^?

  Enable or disable RADIUS CoA (Change of Authorization) on SSID.

• #radius_failover_policy ⇒ :"Deny access", ...

  Set client access policy in case RADIUS servers aren’t available.

• #radius_load_balancing_policy ⇒ :"Strict priority order", ...

  Set load balancing policy when multiple RADIUS servers are specified.

• #radius_servers ⇒ Object^?

  List of RADIUS servers.

• #splash_page ⇒ :None, ...

  Set to enable splash page and specify type of splash.

• #state ⇒ :absent, ...

  Specifies whether SNMP information should be queried or modified.

• #use_vlan_tagging ⇒ Symbol^?

  Set whether to use VLAN tagging.

• #vlan_id ⇒ Object^?

  ID number of VLAN on SSID.

• #walled_garden_enabled ⇒ Symbol^?

  Enable or disable walled garden functionality.

• #walled_garden_ranges ⇒ Object^?

  List of walled garden ranges.

• #wpa_encryption_mode ⇒ :"WPA1 and WPA2", ...

  Encryption mode within WPA2 specification.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#ap_tags_vlan_ids ⇒ Object^?

Returns List of VLAN tags.

Returns:

• (Object, nil) —

  List of VLAN tags.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 93

attribute :ap_tags_vlan_ids

#auth_mode ⇒ :open, ...

Returns Set authentication mode of network.

Returns:

• (:open, :psk, :"open-with-radius", :"8021x-meraki", :"8021x-radius", nil) —

  Set authentication mode of network.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 38

attribute :auth_mode

#band_selection ⇒ :"Dual band operation", ...

Returns Set band selection mode.

Returns:

• (:"Dual band operation", :"5 GHz band only", :"Dual band operation with Band Steering", nil) —

  Set band selection mode.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 107

attribute :band_selection

#concentrator_network_id ⇒ Object^?

Returns The concentrator to use for ‘Layer 3 roaming with a concentrator’ or ‘VPN’.

Returns:

• (Object, nil) —

  The concentrator to use for ‘Layer 3 roaming with a concentrator’ or ‘VPN’.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 117

attribute :concentrator_network_id

#default_vlan_id ⇒ Object^?

Returns Default VLAN ID.

Returns:

• (Object, nil) —

  Default VLAN ID.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 87

attribute :default_vlan_id

#enabled ⇒ Symbol^?

Returns Enable or disable SSID network.

Returns:

• (Symbol, nil) —

  Enable or disable SSID network.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 34

attribute :enabled

#encryption_mode ⇒ :wpa, ...

Returns Set encryption mode of network.

Returns:

• (:wpa, :eap, :"wpa-eap", nil) —

  Set encryption mode of network.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 42

attribute :encryption_mode

#ip_assignment_mode ⇒ :"NAT mode", ...

Returns Method of which SSID uses to assign IP addresses.

Returns:

• (:"NAT mode", :"Bridge mode", :"Layer 3 roaming", :"Layer 3 roaming with a concentrator", :VPN, nil) —

  Method of which SSID uses to assign IP addresses.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 79

attribute :ip_assignment_mode

#min_bitrate ⇒ 1, ...

Returns Minimum bitrate (Mbps) allowed on SSID.

Returns:

• (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54, nil) —

  Minimum bitrate (Mbps) allowed on SSID.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 103

attribute :min_bitrate

#name ⇒ Object^?

Returns Name of SSID.

Returns:

• (Object, nil) —

  Name of SSID.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 19

attribute :name

#net_id ⇒ Object^?

Returns ID of network.

Returns:

• (Object, nil) —

  ID of network.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 31

attribute :net_id

#net_name ⇒ Object^?

Returns Name of network.

Returns:

• (Object, nil) —

  Name of network.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 28

attribute :net_name

#number ⇒ Object^?

Returns SSID number within network.

Returns:

• (Object, nil) —

  SSID number within network.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 16

attribute :number

#org_id ⇒ Object^?

Returns ID of organization.

Returns:

• (Object, nil) —

  ID of organization.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 25

attribute :org_id

#org_name ⇒ Object^?

Returns Name of organization.

Returns:

• (Object, nil) —

  Name of organization.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 22

attribute :org_name

#per_client_bandwidth_limit_down ⇒ Object^?

Returns Maximum bandwidth in Mbps devices on SSID can download.

Returns:

• (Object, nil) —

  Maximum bandwidth in Mbps devices on SSID can download.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 114

attribute :per_client_bandwidth_limit_down

#per_client_bandwidth_limit_up ⇒ Object^?

Returns Maximum bandwidth in Mbps devices on SSID can upload.

Returns:

• (Object, nil) —

  Maximum bandwidth in Mbps devices on SSID can upload.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 111

attribute :per_client_bandwidth_limit_up

#psk ⇒ Object^?

Returns Password for wireless network.,Requires auth_mode to be set to psk.

Returns:

• (Object, nil) —

  Password for wireless network.,Requires auth_mode to be set to psk.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 46

attribute :psk

#radius_accounting_enabled ⇒ Symbol^?

Returns Enable or disable RADIUS accounting.

Returns:

• (Symbol, nil) —

  Enable or disable RADIUS accounting.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 72

attribute :radius_accounting_enabled

#radius_accounting_servers ⇒ Object^?

Returns List of RADIUS servers for RADIUS accounting.

Returns:

• (Object, nil) —

  List of RADIUS servers for RADIUS accounting.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 76

attribute :radius_accounting_servers

#radius_coa_enabled ⇒ Symbol^?

Returns Enable or disable RADIUS CoA (Change of Authorization) on SSID.

Returns:

• (Symbol, nil) —

  Enable or disable RADIUS CoA (Change of Authorization) on SSID.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 60

attribute :radius_coa_enabled

#radius_failover_policy ⇒ :"Deny access", ...

Returns Set client access policy in case RADIUS servers aren’t available.

Returns:

• (:"Deny access", :"Allow access", nil) —

  Set client access policy in case RADIUS servers aren’t available.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 64

attribute :radius_failover_policy

#radius_load_balancing_policy ⇒ :"Strict priority order", ...

Returns Set load balancing policy when multiple RADIUS servers are specified.

Returns:

• (:"Strict priority order", :"Round robin", nil) —

  Set load balancing policy when multiple RADIUS servers are specified.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 68

attribute :radius_load_balancing_policy

#radius_servers ⇒ Object^?

Returns List of RADIUS servers.

Returns:

• (Object, nil) —

  List of RADIUS servers.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 57

attribute :radius_servers

#splash_page ⇒ :None, ...

Returns Set to enable splash page and specify type of splash.

Returns:

• (: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", nil) —

  Set to enable splash page and specify type of splash.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 53

attribute :splash_page

#state ⇒ :absent, ...

Returns Specifies whether SNMP information should be queried or modified.

Returns:

• (:absent, :query, :present, nil) —

  Specifies whether SNMP information should be queried or modified.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 12

attribute :state

#use_vlan_tagging ⇒ Symbol^?

Returns Set whether to use VLAN tagging.

Returns:

• (Symbol, nil) —

  Set whether to use VLAN tagging.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 83

attribute :use_vlan_tagging

#vlan_id ⇒ Object^?

Returns ID number of VLAN on SSID.

Returns:

• (Object, nil) —

  ID number of VLAN on SSID.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 90

attribute :vlan_id

#walled_garden_enabled ⇒ Symbol^?

Returns Enable or disable walled garden functionality.

Returns:

• (Symbol, nil) —

  Enable or disable walled garden functionality.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 96

attribute :walled_garden_enabled

#walled_garden_ranges ⇒ Object^?

Returns List of walled garden ranges.

Returns:

• (Object, nil) —

  List of walled garden ranges.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 100

attribute :walled_garden_ranges

#wpa_encryption_mode ⇒ :"WPA1 and WPA2", ...

Returns Encryption mode within WPA2 specification.

Returns:

• (:"WPA1 and WPA2", :"WPA2 only", nil) —

  Encryption mode within WPA2 specification.

# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_ssid.rb', line 49

attribute :wpa_encryption_mode