cisco.meraki.meraki_network_settings 模块 – 管理 Meraki 云中网络的设置

注意

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

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

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

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

已弃用

在以下版本中移除：

3.0.0 版本

原因：

发布了功能增强的更新模块

替代方案：

cisco.meraki.networks_settings

概要

• 允许管理 Meraki 中网络的设置。

参数

参数	注释
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此参数。
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
local_status_page 字典	本地状态页面的配置部分。
authentication 字典	本地状态页面的身份验证设置。
enabled 布尔值	设置是否启用本地状态页面的身份验证。 选项 false true
password 字符串	设置本地状态页面的密码。
local_status_page_enabled 布尔值	启用本地设备状态页面（[my.meraki.com](my.meraki.com)、[ap.meraki.com](ap.meraki.com)、[switch.meraki.com](switch.meraki.com)、[wired.meraki.com](wired.meraki.com)）。- 只能单独指定或与 remote_status_page_enabled 一起指定。 选项 false true
net_id 字符串	网络的 ID 号。
net_name 别名：name, network 字符串	网络名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键应该是蛇形命名法（例如 net_id）还是驼峰命名法（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
remote_status_page_enabled 布尔值	启用对设备状态页面的访问（http://device LAN IP）。 只有当 local_status_page_enabled: 设置为 yes 时才能设置。 只能单独指定或与 local_status_page_enabled 一起指定。 选项 false true
secure_port 字典	应用于网络的 SecureConnect 选项的配置。
enabled 布尔值	设置网络上是否启用 SecureConnect。 选项 false true
state 字符串	创建或修改组织。 选项 "present" "query" ← (默认)
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，则使用 HTTP。否则将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)

备注

注意

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

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

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

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

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

示例

- name: Get network settings
  cisco.meraki.meraki_network_settings:
    auth_key: '{{ auth_key }}'
    state: query
    org_name: '{{test_org_name}}'
    net_name: NetworkSettingsTestNet
  delegate_to: localhost

- name: Update network settings
  cisco.meraki.meraki_network_settings:
    auth_key: '{{ auth_key }}'
    state: present
    org_name: '{{test_org_name}}'
    net_name: NetworkSettingsTestNet
    local_status_page_enabled: false
  delegate_to: localhost

- name: Enable password on local page
  cisco.meraki.meraki_network_settings:
    auth_key: '{{ auth_key }}'
    state: present
    org_name: '{{test_org_name}}'
    net_name: NetworkSettingsTestNet
    local_status_page_enabled: true
    local_status_page:
      authentication:
        enabled: true
        password: abc123
  delegate_to: localhost

返回值

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

键	描述
数据 复杂数据	有关已创建或操作的对象的信息。 返回： info
expire_data_older_than 整数	在纪元时间中，数据过期前的天数、周数或月数 返回： success 示例： 1234
fips 复杂数据	应用于网络的 FIPS 选项的哈希值。 返回： success
enabled 布尔值	启用/禁用网络上的 FIPS。 返回： success 示例： true
local_status_page 复杂数据	应用于网络的本地状态页面身份验证选项的哈希值。 返回： success
authentication 复杂数据	应用于网络的本地状态页面的身份验证选项的哈希值。 返回： success 示例： true
enabled 布尔值	启用/禁用本地状态页面的身份验证。 返回： success
用户名 字符串	用于本地状态页面的用户名。 返回： success 示例： "admin"
local_status_page_enabled 布尔值	指示是否应启用 my.meraki.com 和其他设备门户。 返回： success 示例： true
named_vlans 复杂数据	应用于网络的命名 VLAN 选项的哈希值。 返回： success
enabled 布尔值	启用/禁用网络上的命名 VLAN。 返回： success 示例： true
remote_status_page_enabled 布尔值	启用对设备状态页面的访问。 返回： success 示例： true
secure_port 复杂数据	应用于网络的 SecureConnect 选项的哈希值。 返回： success
enabled 布尔值	启用/禁用网络上的 SecureConnect。 返回： success 示例： true

状态

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

• 更多信息请参见 已弃用。

作者

• Kevin Breit (@kbreit)

资源链接

• 问题追踪器
• 代码库（源码）