cisco.meraki.networks_meraki_auth_users 模块 – 网络 _merakiauthusers 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，有关详细信息，请参见要求。
要在 playbook 中使用它，请指定：cisco.meraki.networks_meraki_auth_users。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 networks _merakiauthusers 的创建、更新和删除操作。
授权一个使用 Meraki 身份验证配置的网络用户，目前支持 802.1X、访客欢迎页面和客户端 VPN 用户，并且目前组织的用户上限为 50,000 个。
删除 802.1X RADIUS 用户，或取消授权并可选择删除访客欢迎页面或客户端 VPN 用户。
更新一个使用 Meraki 身份验证配置的用户，目前可以更新 802.1X RADIUS、访客欢迎页面和客户端 VPN 用户。
注意
此模块具有相应的操作插件。
要求
执行此模块的主机上需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
用户的授权类型。对于无线网络，可以是“Guest”或“802.1X”，对于 MX 网络，可以是“Client VPN”。默认为“802.1X”。 |
|
用户的授权区域和到期日期。 |
|
授权到期的日期。设置为“Never”表示授权永不过期，这是默认设置。 |
|
无线网络必需。用户被授权的 SSID，该 SSID 必须为用户的给定 accountType 配置。 |
|
删除查询参数。如果提供的 ID 是针对访客欢迎页面或客户端 VPN 用户，并且该用户未在组织中的任何其他网络中获得授权，则还应删除该用户。无论此可选属性如何，都会始终删除 802.1X RADIUS 用户。 选择
|
|
用户的电子邮件地址。 |
|
Meraki 是否应将密码通过电子邮件发送给用户。默认为 false。 选择
|
|
用户是否为仪表板管理员。 选择
|
|
meraki_action_batch_retry_wait_time (整数)，操作批处理并发错误重试等待时间 默认值： |
|
meraki_api_key（字符串），仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url（字符串），所有端点资源的前缀 默认值： |
|
meraki_be_geo_id（字符串），用于 API 使用情况跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： |
|
meraki_caller（字符串），用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： |
|
meraki_certificate_path（字符串），如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径 默认值： |
|
meraki_inherit_logging_config（布尔值），继承您自己的 logger 实例 选择
|
|
meraki_log_file_prefix（字符串），附加日期和时间戳的日志文件名 默认值： |
|
log_path（字符串），输出日志的路径；默认情况下，如果未指定，则为脚本的工作目录 默认值： |
|
meraki_maximum_retries（整数），在遇到 429 或其他服务器端错误时最多重试此次数 默认值： |
|
meraki_nginx_429_retry_wait_time（整数），Nginx 429 重试等待时间 默认值： |
|
meraki_output_log（布尔值），创建输出日志文件？ 选择
|
|
meraki_print_console（布尔值），将日志输出打印到控制台？ 选择
|
|
meraki_requests_proxy（字符串），如果需要，用于 HTTPS 的代理服务器和端口 默认值： |
|
meraki_retry_4xx_error (布尔值), 如果遇到其他 4XX 错误（除了 429）是否重试？ 选择
|
|
meraki_retry_4xx_error_wait_time (整数), 其他 4XX 错误重试等待时间 默认值： |
|
meraki_simulate (布尔值), 模拟 POST/PUT/DELETE 调用以防止更改？ 选择
|
|
meraki_single_request_timeout (整数), 每个 API 调用的最大秒数 默认值： |
|
meraki_suppress_logging (布尔值), 禁用所有日志记录？ 那就只能靠你自己了！ 选择
|
|
meraki_use_iterator_for_get_pages (布尔值), list* 方法将返回一个迭代器，其中包含每个对象，而不是包含所有项的完整列表 选择
|
|
meraki_wait_on_rate_limit (布尔值), 如果遇到 429 速率限制错误是否重试？ 选择
|
|
MerakiAuthUserId 路径参数。Meraki 认证用户 ID。 |
|
用户名称。仅当用户不是 Dashboard 管理员时才需要。 |
|
NetworkId 路径参数。网络 ID。 |
|
此用户帐户的密码。仅当用户不是 Dashboard 管理员时才需要。 |
注意
注意
使用的 SDK 方法是 networks.Networks.create_network_meraki_auth_user, networks.Networks.delete_network_meraki_auth_user, networks.Networks.update_network_meraki_auth_user,
使用的路径是 post /networks/{networkId}/merakiAuthUsers, delete /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}, put /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId},
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，关于 networks createNetworkMerakiAuthUser
createNetworkMerakiAuthUser API 的完整参考。
- Cisco Meraki 文档，关于 networks deleteNetworkMerakiAuthUser
deleteNetworkMerakiAuthUser API 的完整参考。
- Cisco Meraki 文档，关于 networks updateNetworkMerakiAuthUser
updateNetworkMerakiAuthUser API 的完整参考。
示例
- name: Create
cisco.meraki.networks_meraki_auth_users:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
accountType: 802.1X
authorizations:
- expiresAt: '2018-03-13T00:00:00.090210Z'
ssidNumber: 1
email: miles@meraki.com
emailPasswordToUser: false
isAdmin: false
name: Miles Meraki
networkId: string
password: secret
- name: Delete by id
cisco.meraki.networks_meraki_auth_users:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: absent
delete: true
merakiAuthUserId: string
networkId: string
- name: Update by id
cisco.meraki.networks_meraki_auth_users:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
authorizations:
- expiresAt: '2018-03-13T00:00:00.090210Z'
ssidNumber: 1
emailPasswordToUser: false
merakiAuthUserId: string
name: Miles Meraki
networkId: string
password: secret
返回值
常见的返回值在此处记录 这里, 以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco Meraki Python SDK 返回的响应 返回： 总是 示例： |