cisco.meraki.networks_appliance_single_lan 模块 – 网络_设备_单LAN 资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:cisco.meraki.networks_appliance_single_lan

cisco.meraki 2.16.0 中的新增功能

概要

  • 管理资源网络_设备_单LAN的操作更新。

  • 更新单LAN配置。

注意

此模块具有相应的 action 插件

要求

在执行此模块的主机上需要以下要求。

  • meraki >= 2.4.9

  • python >= 3.5

参数

参数

注释

applianceIp

字符串

单LAN的设备IP地址。

ipv6

字典

VLAN上的IPv6配置。

enabled

布尔值

启用VLAN上的IPv6。

选项

  • false

  • true

prefixAssignments

列表 / 元素=字典

VLAN上的前缀分配。

autonomous

布尔值

从源自动分配 /64 前缀到 VLAN。

选项

  • false

  • true

origin

字典

前缀的来源。

interfaces

列表 / 元素=字符串

与前缀关联的接口。

type

字符串

来源类型。

staticApplianceIp6

字符串

IPv6 设备 IP 的手动配置。

staticPrefix

字符串

VLAN 上 /64 前缀的手动配置。

mandatoryDhcp

字典

强制DHCP将强制连接到此LAN的客户端必须使用DHCP服务器分配的IP地址。使用静态IP地址的客户端将无法关联。仅在固件版本17.0及以上版本可用。

enabled

布尔值

启用LAN上的强制DHCP。

选项

  • false

  • true

meraki_action_batch_retry_wait_time

整数

meraki_action_batch_retry_wait_time (整数),操作批量并发错误重试等待时间

默认值: 60

meraki_api_key

字符串 / 必需

meraki_api_key (字符串),在仪表盘中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY

meraki_base_url

字符串

meraki_base_url (字符串),在所有端点资源之前

默认值: "https://api.meraki.com/api/v1"

meraki_be_geo_id

字符串

meraki_be_geo_id (字符串),用于 API 使用跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID

默认值: ""

meraki_caller

字符串

meraki_caller (字符串),用于 API 使用跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER

默认值: ""

meraki_certificate_path

字符串

meraki_certificate_path (字符串),如果位于本地代理后面,则用于 TLS/SSL 证书验证的路径

默认值: ""

meraki_inherit_logging_config

布尔值

meraki_inherit_logging_config (布尔值),继承您自己的日志记录实例

选项

  • false ← (默认)

  • true

meraki_log_file_prefix

字符串

meraki_log_file_prefix (字符串),日志文件名后附加日期和时间戳

默认值: "meraki_api_"

meraki_log_path

字符串

log_path (字符串),输出日志的路径;如果未指定,则默认为脚本的工作目录

默认值: ""

meraki_maximum_retries

整数

meraki_maximum_retries (整数),遇到 429 或其他服务器端错误时最多重试此次数

默认值: 2

meraki_nginx_429_retry_wait_time

整数

meraki_nginx_429_retry_wait_time (整数),Nginx 429 重试等待时间

默认值: 60

meraki_output_log

布尔值

meraki_output_log (布尔值),创建输出日志文件?

选项

  • false

  • true ← (默认)

meraki_print_console

布尔值

meraki_print_console (布尔值),将日志输出打印到控制台?

选项

  • false

  • true ← (默认)

meraki_requests_proxy

字符串

meraki_requests_proxy (字符串),如果需要,用于 HTTPS 的代理服务器和端口

默认值: ""

meraki_retry_4xx_error

布尔值

meraki_retry_4xx_error (布尔值),如果遇到其他 4XX 错误(除了 429)则重试?

选项

  • false ← (默认)

  • true

meraki_retry_4xx_error_wait_time

整数

meraki_retry_4xx_error_wait_time (整数),其他 4XX 错误重试等待时间

默认值: 60

meraki_simulate

布尔值

meraki_simulate (布尔值),模拟 POST/PUT/DELETE 调用以防止更改?

选项

  • false ← (默认)

  • true

meraki_single_request_timeout

整数

meraki_single_request_timeout (整数),每次 API 调用的最大秒数

默认值: 60

meraki_suppress_logging

布尔值

meraki_suppress_logging (布尔值),禁用所有日志记录?那样的话就只能靠你自己了!

选项

  • false ← (默认)

  • true

meraki_use_iterator_for_get_pages

布尔值

meraki_use_iterator_for_get_pages (布尔值),list* 方法将返回包含每个对象的迭代器,而不是包含所有项目的完整列表

选项

  • false ← (默认)

  • true

meraki_wait_on_rate_limit

布尔值

meraki_wait_on_rate_limit (布尔值),如果遇到 429 速率限制错误则重试?

选项

  • false

  • true ← (默认)

networkId

字符串

NetworkId 路径参数。网络ID。

subnet

字符串

单LAN配置的子网。

备注

注意

  • 使用的SDK方法是appliance.Appliance.update_network_appliance_single_lan,

  • 使用的路径是put /networks/{networkId}/appliance/singleLan,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco Meraki 设备 updateNetworkApplianceSingleLan 的文档

updateNetworkApplianceSingleLan API 的完整参考。

示例

- name: Update all
  cisco.meraki.networks_appliance_single_lan:
    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
    applianceIp: string
    ipv6:
      enabled: true
      prefixAssignments:
      - autonomous: true
        origin:
          interfaces:
          - string
          type: string
        staticApplianceIp6: string
        staticPrefix: string
    mandatoryDhcp:
      enabled: true
    networkId: string
    subnet: string

返回值

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

描述

meraki_response

字典

Cisco Meraki Python SDK 返回的响应字典或列表

返回值:始终

示例: {"applianceIp": "string", "ipv6": {"enabled": true, "prefixAssignments": [{"autonomous": true, "origin": {"interfaces": ["string"], "type": "string"}, "staticApplianceIp6": "string", "staticPrefix": "string"}]}, "mandatoryDhcp": {"enabled": true}, "subnet": "string"}

作者

  • Francisco Munoz (@fmunoz)