.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.meraki_ms_access_policies module -- Manage Switch Access Policies in the Meraki cloud ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.meraki collection `_ (version 2.20.9). To install it, use: :code:`ansible-galaxy collection install cisco.meraki`. To use it in a playbook, specify: :code:`cisco.meraki.meraki_ms_access_policies`. .. version_added .. contents:: :local: :depth: 1 .. Deprecated DEPRECATED ---------- :Removed in: version 3.0.0 :Why: Updated modules released with increased functionality :Alternative: cisco.meraki.networks\_switch\_access\_policies Synopsis -------- .. Description - Module for managing a Switch Access Policies in the Meraki cloud .. Aliases .. Requirements .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-access_policy_type: .. rst-class:: ansible-option-title **access_policy_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Set type of the access policy .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"802.1x"` - :ansible-option-choices-entry:`"MAC authentication bypass"` - :ansible-option-choices-entry:`"Hybrid authentication"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-auth_key: .. rst-class:: ansible-option-title **auth_key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Authentication key provided by the dashboard. Required if environmental variable \ :literal:`MERAKI\_KEY`\ is not set. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-auth_method: .. rst-class:: ansible-option-title **auth_method** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Set authentication method in the policy. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Meraki authentication"` - :ansible-option-choices-entry:`"my RADIUS server"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-data_vlan_id: .. rst-class:: ansible-option-title **data_vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Set a Data VLAN ID for Critical Auth VLAN .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-guest_vlan: .. rst-class:: ansible-option-title **guest_vlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Guest Vlan .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"api.meraki.com"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-host_mode: .. rst-class:: ansible-option-title **host_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Choose the Host Mode for the access policy. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Single-Host"` - :ansible-option-choices-entry:`"Multi-Domain"` - :ansible-option-choices-entry:`"Multi-Host"` - :ansible-option-choices-entry:`"Multi-Auth"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-internal_error_retry_time: .. rst-class:: ansible-option-title **internal_error_retry_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of seconds to retry if server returns an internal server error. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of Access Policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-net_id: .. rst-class:: ansible-option-title **net_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-net_name: .. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-network: .. rst-class:: ansible-option-title **net_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: network` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of a network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-access_policy_number: .. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-number: .. rst-class:: ansible-option-title **number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: access_policy_number` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of the access\_policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-org_id: .. rst-class:: ansible-option-title **org_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of organization associated to a network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-org_name: .. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-organization: .. rst-class:: ansible-option-title **org_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: organization` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of organization. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-output_format: .. rst-class:: ansible-option-title **output_format** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Instructs module whether response keys should be snake case (ex. \ :literal:`net\_id`\ ) or camel case (ex. \ :literal:`netId`\ ). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"snakecase"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"camelcase"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-output_level: .. rst-class:: ansible-option-title **output_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Set amount of debug output during module execution. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"debug"` - :ansible-option-choices-entry-default:`"normal"` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_accounting_enabled: .. rst-class:: ansible-option-title **radius_accounting_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable RADIUS accounting. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_accounting_servers: .. rst-class:: ansible-option-title **radius_accounting_servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of RADIUS servers for RADIUS accounting. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_accounting_servers/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
IP address or hostname of RADIUS server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_accounting_servers/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port number RADIUS server is listening to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_accounting_servers/secret: .. rst-class:: ansible-option-title **secret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_attribute_group_policy_name: .. rst-class:: ansible-option-title **radius_attribute_group_policy_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Enable that attribute for a RADIUS .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Filter-Id"` - :ansible-option-choices-entry-default:`""` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_coa_enabled: .. rst-class:: ansible-option-title **radius_coa_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable RADIUS CoA (Change of Authorization). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_servers: .. rst-class:: ansible-option-title **radius_servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of RADIUS servers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_servers/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
IP address or hostname of RADIUS server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_servers/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port number RADIUS server is listening to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_servers/secret: .. rst-class:: ansible-option-title **secret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS password. Setting password is not idempotent. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-radius_testing: .. rst-class:: ansible-option-title **radius_testing** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Set status of testing a radius. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-rate_limit_retry_time: .. rst-class:: ansible-option-title **rate_limit_retry_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of seconds to retry if rate limiter is triggered. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`165` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies whether SNMP information should be queried or modified. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"absent"` - :ansible-option-choices-entry:`"query"` - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-suspend_port_bounce: .. rst-class:: ansible-option-title **suspend_port_bounce** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable the Suspend Port Bounce when RADIUS servers are unreachable. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-systems_management_enrollment: .. rst-class:: ansible-option-title **systems_management_enrollment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Set if the Systems Management Enrollemnt is enabled or disabled .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-timeout: .. rst-class:: ansible-option-title **timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Time to timeout for HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`30` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-use_https: .. rst-class:: ansible-option-title **use_https** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If \ :literal:`no`\ , it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-use_proxy: .. rst-class:: ansible-option-title **use_proxy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether to validate HTTP certificates. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-voice_vlan_clients: .. rst-class:: ansible-option-title **voice_vlan_clients** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If is enabled that means Voice VLAN client require authentication .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__parameter-voice_vlan_id: .. rst-class:: ansible-option-title **voice_vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Set a Voice VLAN ID for Critical Auth VLAN .. raw:: html
.. Attributes .. Notes 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 \ :literal:`ANSIBLE\_MERAKI\_FORMAT`\ environment variable to \ :literal:`camelcase`\ . - 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. .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data: .. rst-class:: ansible-option-title **data** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`complex` .. raw:: html
- .. raw:: html
List of Access Policies .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/access_policy_type: .. rst-class:: ansible-option-title **access_policy_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of the access policy .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"802.1x"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/guest_vlan_id: .. rst-class:: ansible-option-title **guest_vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
ID of the Guest Vlan .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`10` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/host_mode: .. rst-class:: ansible-option-title **host_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Choosen teh Host Mode for the access policy .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"Single-Host"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the Access Policy .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"Policy with 802.1x"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/number: .. rst-class:: ansible-option-title **number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of the Access Policy .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`1` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius: .. rst-class:: ansible-option-title **radius** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`complex` .. raw:: html
- .. raw:: html
List of radius specific list .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius/critial_auth: .. rst-class:: ansible-option-title **critial_auth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`complex` .. raw:: html
- .. raw:: html
Critial Auth List .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius/critial_auth/data_vlan_id: .. rst-class:: ansible-option-title **data_vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
VLAN ID for data .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`10` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius/critial_auth/suspend_port_bounce: .. rst-class:: ansible-option-title **suspend_port_bounce** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable suspend port bounce .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`false` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius/critial_auth/voice_vlan_id: .. rst-class:: ansible-option-title **voice_vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
VLAN ID for voice .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`10` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius/failed_auth_vlan_id: .. rst-class:: ansible-option-title **failed_auth_vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
VLAN ID when failed auth .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`11` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius/re_authentication_interval: .. rst-class:: ansible-option-title **re_authentication_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Interval of re-authentication .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius_accounting_enabled: .. rst-class:: ansible-option-title **radius_accounting_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable RADIUS accounting. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius_accounting_servers: .. rst-class:: ansible-option-title **radius_accounting_servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of RADIUS servers for RADIUS accounting. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius_attribute_group_policy_name: .. rst-class:: ansible-option-title **radius_attribute_group_policy_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Enable the radius group attribute .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line :ansible-option-choices:`Can only return:` - :ansible-option-choices-entry:`"11"` - :ansible-option-choices-entry:`""` .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"11"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius_coa_enabled: .. rst-class:: ansible-option-title **radius_coa_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable RADIUS CoA (Change of Authorization). .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius_servers: .. rst-class:: ansible-option-title **radius_servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of RADIUS servers. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/radius_testing_enabled: .. rst-class:: ansible-option-title **radius_testing_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable Radius Testing .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_ms_access_policies_module__return-data/voice_vlan_clients: .. rst-class:: ansible-option-title **voice_vlan_clients** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable or disable Voice Vlan Clients .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`false` .. raw:: html
.. Status (Presently only deprecated) Status ------ .. Deprecated note - This module will be removed in version 3.0.0. *[deprecated]* - For more information see `DEPRECATED`_. .. Authors Authors ~~~~~~~ - Marcin Woźniak (@y0rune) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors