cisco.meraki.networks_settings 模块 – 网络设置的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：cisco.meraki.networks_settings。

cisco.meraki 2.16.0 中的新增功能

概要

• 管理资源网络设置的更新操作。

• 更新网络的设置。

注意

此模块具有相应的 操作插件。

要求

执行此模块的主机需要满足以下要求。

• meraki >= 2.4.9

• python >= 3.5

参数

参数	注释
localStatusPage 字典	应用于网络的本地状态页面身份验证选项的哈希。
authentication 字典	应用于网络的本地状态页面身份验证选项的哈希。
enabled 布尔值	启用/禁用本地状态页面的身份验证。 选项 false true
password 字符串	本地状态页面使用的密码。将其设置为 null 以清除密码。
localStatusPageEnabled 布尔值	启用/禁用本地设备状态页面（<a target=’_blank’ href=’http //my.meraki.com/’>my.meraki.com, </a><a target=’_blank’ href=’http //ap.meraki.com/’>ap.meraki.com, </a><a target=’_blank’ href=’http //switch.meraki.com/’>switch.meraki.com, </a><a target=’_blank’ href=’http //wired.meraki.com/’>wired.meraki.com</a>）。可选（默认为 false）。 选项 false true
meraki_action_batch_retry_wait_time 整数	meraki_action_batch_retry_wait_time (integer)，操作批次并发错误重试等待时间 默认值: 60
meraki_api_key 字符串 / 必需	meraki_api_key (string)，在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY
meraki_base_url 字符串	meraki_base_url (string)，所有端点资源的前缀 默认值: "https://api.meraki.com/api/v1"
meraki_be_geo_id 字符串	meraki_be_geo_id (string)，用于 API 使用跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值: ""
meraki_caller 字符串	meraki_caller (string)，用于 API 使用跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值: ""
meraki_certificate_path 字符串	meraki_certificate_path (string)，如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径 默认值: ""
meraki_inherit_logging_config 布尔值	meraki_inherit_logging_config (boolean)，继承您自己的记录器实例 选项 false ← (默认) true
meraki_log_file_prefix 字符串	meraki_log_file_prefix (string)，附加日期和时间戳的日志文件名 默认值: "meraki_api_"
meraki_log_path 字符串	log_path (string)，输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值: ""
meraki_maximum_retries 整数	meraki_maximum_retries (integer)，遇到 429 或其他服务器端错误时，最多重试此次数 默认值: 2
meraki_nginx_429_retry_wait_time 整数	meraki_nginx_429_retry_wait_time (integer)，Nginx 429 重试等待时间 默认值: 60
meraki_output_log 布尔值	meraki_output_log (boolean)，创建输出日志文件？ 选项 false true ← (默认)
meraki_print_console 布尔值	meraki_print_console (boolean)，将日志输出打印到控制台？ 选项 false true ← (默认)
meraki_requests_proxy 字符串	meraki_requests_proxy (string)，如果需要，用于 HTTPS 的代理服务器和端口 默认值: ""
meraki_retry_4xx_error 布尔值	meraki_retry_4xx_error (boolean)，如果遇到其他 4XX 错误（除了 429）是否重试？ 选项 false ← (默认) true
meraki_retry_4xx_error_wait_time 整数	meraki_retry_4xx_error_wait_time (integer)，其他 4XX 错误重试等待时间 默认值: 60
meraki_simulate 布尔值	meraki_simulate (boolean)，模拟 POST/PUT/DELETE 调用以防止更改？ 选项 false ← (默认) true
meraki_single_request_timeout 整数	meraki_single_request_timeout (integer)，每次 API 调用的最大秒数 默认值: 60
meraki_suppress_logging 布尔值	meraki_suppress_logging (boolean)，禁用所有日志记录？那你就自求多福吧！ 选项 false ← (默认) true
meraki_use_iterator_for_get_pages 布尔值	meraki_use_iterator_for_get_pages (boolean)，list* 方法将返回一个包含每个对象的迭代器，而不是包含所有项的完整列表 选项 false ← (默认) true
meraki_wait_on_rate_limit 布尔值	meraki_wait_on_rate_limit (boolean)，如果遇到 429 速率限制错误是否重试？ 选项 false true ← (默认)
namedVlans 字典	应用于网络的命名 VLAN 选项的哈希。
enabled 布尔值	启用/禁用网络上的命名 VLAN。 选项 false true
networkId 字符串	NetworkId 路径参数。网络 ID。
remoteStatusPageEnabled 布尔值	启用/禁用对设备状态页面的访问（<a target=’_blank’>http //设备的 LAN IP)</a>。可选。仅当 localStatusPageEnabled 设置为 true 时才能设置。 选项 false true
securePort 字典	应用于网络的 SecureConnect 选项的哈希值。
enabled 布尔值	启用/禁用网络上的 SecureConnect。可选。 选项 false true

注释

注意

• 使用的 SDK 方法是 networks.Networks.update_network_settings。

• 使用的路径是 put /networks/{networkId}/settings。

• 不支持 check_mode

• 该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器。

• 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅

另请参阅

Cisco Meraki 文档，关于 networks updateNetworkSettings

updateNetworkSettings API 的完整参考。

示例

- name: Update all
  cisco.meraki.networks_settings:
    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
    localStatusPage:
      authentication:
        enabled: false
        password: miles123
    localStatusPageEnabled: true
    namedVlans:
      enabled: true
    networkId: string
    remoteStatusPageEnabled: true
    securePort:
      enabled: false

返回值

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

键	描述
meraki_response 字典	由 Cisco Meraki Python SDK 返回的字典或列表形式的响应。 返回值: 总是 示例: {"fips": {"enabled": true}, "localStatusPage": {"authentication": {"enabled": true, "username": "string"}}, "localStatusPageEnabled": true, "namedVlans": {"enabled": true}, "remoteStatusPageEnabled": true, "securePort": {"enabled": true}}

作者

• Francisco Munoz (@fmunoz)

集合链接

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