cisco.meraki.meraki_ms_access_policies 模块 – 在 Meraki 云中管理交换机访问策略

注意

此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在剧本中使用它，请指定：cisco.meraki.meraki_ms_access_policies。

已弃用

在以下版本中移除:

版本 3.0.0

原因:

发布了具有增强功能的新模块

替代方案:

cisco.meraki.networks_switch_access_policies

概要

• 用于在 Meraki 云中管理交换机访问策略的模块

参数

参数	注释
access_policy_type 字符串	设置访问策略的类型 选择 "802.1x" "MAC 身份验证 绕过" "混合 身份验证"
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需项。
auth_method 字符串	设置策略中的身份验证方法。 选择 "Meraki 身份验证" "我的 RADIUS 服务器"
data_vlan_id 整数	为关键身份验证 VLAN 设置数据 VLAN ID
guest_vlan 整数	访客 VLAN
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
host_mode 字符串	为访问策略选择主机模式。 选择 "单主机" "多域" "多主机" "多身份验证"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
name 字符串	访问策略的名称。
net_id 字符串	网络的 ID。
net_name 别名: network 字符串	网络的名称。
number 别名: access_policy_number 整数	访问策略的编号。
org_id 字符串	与网络关联的组织的 ID。
org_name 别名: organization 字符串	组织的名称。
output_format 字符串	指示模块响应键应使用蛇形命名法 (例如 net_id) 还是驼峰命名法 (例如 netId)。 选择 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选择 "debug" "normal" ← (默认)
radius_accounting_enabled 布尔值	启用或禁用 RADIUS 记帐。 选择 false true
radius_accounting_servers 列表 / 元素=字典	用于 RADIUS 记帐的 RADIUS 服务器列表。
host 字符串 / 必需	RADIUS 服务器的 IP 地址或主机名。
端口 整数	RADIUS 服务器正在侦听的端口号。
secret 字符串	RADIUS 密码。
radius_attribute_group_policy_name 字符串	为 RADIUS 启用该属性 选择 "Filter-Id" "" ← (默认)
radius_coa_enabled 布尔值	启用或禁用 RADIUS CoA（授权变更）。 选择 false true
radius_servers 列表 / 元素=字典	RADIUS 服务器列表。
host 字符串 / 必需	RADIUS 服务器的 IP 地址或主机名。
端口 整数	RADIUS 服务器正在侦听的端口号。
secret 字符串	RADIUS 密码。 设置密码不是幂等的。
radius_testing 布尔值	设置 RADIUS 测试的状态。 选择 false true ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串	指定是否应查询或修改 SNMP 信息。 选择 "absent" "query" "present" ← (默认)
suspend_port_bounce 布尔值	启用或禁用当 RADIUS 服务器不可达时挂起端口反弹。 选择 false ← (默认) true
systems_management_enrollment 布尔值	设置是否启用或禁用系统管理注册 选择 false ← (默认) true
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，它将使用 HTTP。否则它将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选择 false true ← (默认)
use_proxy 布尔值	如果为 no，即使在目标主机上的环境变量中定义了代理，它也不会使用代理。 选择 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选择 false true ← (默认)
voice_vlan_clients 布尔值	如果启用，则表示语音 VLAN 客户端需要身份验证 选择 false true ← (默认)
voice_vlan_id 整数	为关键身份验证 VLAN 设置语音 VLAN ID

备注

注意

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内部开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块输出的键为蛇形命名法（snake case）。要使用驼峰命名法（camel case），请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的 playbook。

• 检查模式（Check Mode）会从仪表板下载当前配置，然后将更改与此下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- 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

返回值

常见返回值记录在此处，以下是此模块特有的字段

键	描述
data complex	访问策略列表 已返回： 成功
access_policy_type 字符串	访问策略的类型 已返回： 成功 示例： "802.1x"
guest_vlan_id 整数	访客 VLAN 的 ID 已返回： 成功 示例： 10
host_mode 字符串	为访问策略选择的主机模式 已返回： 成功 示例： "Single-Host"
name 字符串	访问策略的名称 已返回： 成功 示例： "Policy with 802.1x"
number 整数	访问策略的编号 已返回： 成功 示例： 1
radius complex	radius 特定列表的列表 已返回： 成功
critial_auth complex	关键身份验证列表 已返回： 成功
data_vlan_id 整数	数据 VLAN ID 已返回： 成功 示例： 10
suspend_port_bounce 布尔值	启用或禁用挂起端口反弹 已返回： 成功 示例： false
voice_vlan_id 整数	语音 VLAN ID 已返回： 成功 示例： 10
failed_auth_vlan_id 整数	身份验证失败时的 VLAN ID 已返回： 成功 示例： 11
re_authentication_interval 整数	重新身份验证的间隔 已返回： 成功
radius_accounting_enabled 布尔值	启用或禁用 RADIUS 记帐。 已返回： 成功
radius_accounting_servers 列表 / 元素=字典	用于 RADIUS 记帐的 RADIUS 服务器列表。 已返回： 成功
radius_attribute_group_policy_name 字符串	启用 radius 组属性 已返回： 成功 只能返回 "11" "" 示例： "11"
radius_coa_enabled 布尔值	启用或禁用 RADIUS CoA（授权变更）。 已返回： 成功
radius_servers 列表 / 元素=字典	RADIUS 服务器列表。 已返回： 成功
radius_testing_enabled 布尔值	启用或禁用 Radius 测试 已返回： 成功 示例： true
voice_vlan_clients 布尔值	启用或禁用语音 VLAN 客户端 已返回： 成功 示例： false

状态

• 此模块将在 3.0.0 版本中移除。[已弃用]

• 有关更多信息，请参阅 已弃用。

作者

• Marcin Woźniak (@y0rune)

集合链接

• 问题跟踪器
• 存储库（源代码）