cisco.meraki.meraki_ms_access_policies module – Manage Switch Access Policies in the Meraki cloud
Note
This module is part of the cisco.meraki collection (version 2.13.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_ms_access_policies
.
Synopsis
Module for managing a Switch Access Policies in the Meraki cloud
Parameters
Parameter |
Comments |
---|---|
Set type of the access policy Choices:
|
|
Authentication key provided by the dashboard. Required if environmental variable |
|
Set authentication method in the policy. Choices:
|
|
Set a Data VLAN ID for Critical Auth VLAN |
|
Guest Vlan |
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
Choose the Host Mode for the access policy. Choices:
|
|
Number of seconds to retry if server returns an internal server error. Default: |
|
Name of Access Policy. |
|
ID of network. |
|
Name of a network. |
|
Number of the access_policy. |
|
ID of organization associated to a network. |
|
Name of organization. |
|
Instructs module whether response keys should be snake case (ex. Choices:
|
|
Set amount of debug output during module execution. Choices:
|
|
Enable or disable RADIUS accounting. Choices:
|
|
List of RADIUS servers for RADIUS accounting. |
|
IP address or hostname of RADIUS server. |
|
Port number RADIUS server is listening to. |
|
RADIUS password. |
|
Enable that attribute for a RADIUS Choices:
|
|
Enable or disable RADIUS CoA (Change of Authorization). Choices:
|
|
List of RADIUS servers. |
|
IP address or hostname of RADIUS server. |
|
Port number RADIUS server is listening to. |
|
RADIUS password. Setting password is not idempotent. |
|
Set status of testing a radius. Choices:
|
|
Number of seconds to retry if rate limiter is triggered. Default: |
|
Specifies whether SNMP information should be queried or modified. Choices:
|
|
Enable or disable the Suspend Port Bounce when RADIUS servers are unreachable. Choices:
|
|
Set if the Systems Management Enrollemnt is enabled or disabled Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Whether to validate HTTP certificates. Choices:
|
|
If is enabled that means Voice VLAN client require authentication Choices:
|
|
Set a Voice VLAN ID for Critical Auth VLAN |
Notes
Note
More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
Some of the options are likely only used for developers within Meraki.
As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the
ANSIBLE_MERAKI_FORMAT
environment variable tocamelcase
.Ansible’s Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.
Examples
- name: Create access policy with auth_method is "Meraki authentication"
cisco.meraki.meraki_ms_access_policies:
auth_key: abc123
state: present
name: "Meraki authentication policy"
auth_method: "Meraki authentication"
net_name: YourNet
org_name: YourOrg
delegate_to: localhost
- name: Create access policy with auth_method is "my Radius Server"
cisco.meraki.meraki_ms_access_policies:
auth_key: abc123
access_policy_type: "802.1x"
host_mode: "Single-Host"
state: present
name: "Meraki authentication policy"
auth_method: "my RADIUS server"
radius_servers:
- host: 192.0.1.18
port: 7890
secret: secret123
net_name: YourNet
org_name: YourOrg
radius_coa_enabled: False
radius_accounting_enabled: False
guest_vlan: 10
voice_vlan_clients: False
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of Access Policies Returned: success |
|
Type of the access policy Returned: success Sample: |
|
ID of the Guest Vlan Returned: success Sample: |
|
Choosen teh Host Mode for the access policy Returned: success Sample: |
|
Name of the Access Policy Returned: success Sample: |
|
Number of the Access Policy Returned: success Sample: |
|
List of radius specific list Returned: success |
|
Critial Auth List Returned: success |
|
VLAN ID for data Returned: success Sample: |
|
Enable or disable suspend port bounce Returned: success Sample: |
|
VLAN ID for voice Returned: success Sample: |
|
VLAN ID when failed auth Returned: success Sample: |
|
Interval of re-authentication Returned: success |
|
Enable or disable RADIUS accounting. Returned: success |
|
List of RADIUS servers for RADIUS accounting. Returned: success |
|
Enable the radius group attribute Returned: success Can only return:
Sample: |
|
Enable or disable RADIUS CoA (Change of Authorization). Returned: success |
|
List of RADIUS servers. Returned: success |
|
Enable or disable Radius Testing Returned: success Sample: |
|
Enable or disable Voice Vlan Clients Returned: success Sample: |