cisco.meraki.devices_management_interface 模块 – 设备管理接口资源模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。
要在 playbook 中使用它，请指定：cisco.meraki.devices_management_interface。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 devices_managementinterface 的创建和更新操作。
重新启动设备。
更新设备的管理接口设置。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
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 (布尔值)，继承您自己的日志记录实例 选项
|
|
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 速率限制错误则重试？ 选项
|
|
串口路径参数。 |
|
WAN 1 设置。 |
|
最多两个 DNS IP。 |
|
WAN 上网关的 IP。 |
|
设备应在 WAN 上使用的 IP。 |
|
WAN 的子网掩码。 |
|
将接口配置为具有静态 IP 设置或使用 DHCP。 选项
|
|
管理流量应使用其标记的 VLAN。无论 usingStaticIp 为 true 或 false 都适用。 |
|
启用或禁用接口（仅适用于 MX 设备）。有效值为“enabled”、“disabled”和“not configured”。 |
|
WAN 2 设置（仅适用于 MX 设备）。 |
|
最多两个 DNS IP。 |
|
WAN 上网关的 IP。 |
|
设备应在 WAN 上使用的 IP。 |
|
WAN 的子网掩码。 |
|
将接口配置为具有静态 IP 设置或使用 DHCP。 选项
|
|
管理流量应使用其标记的 VLAN。无论 usingStaticIp 为 true 或 false 都适用。 |
|
启用或禁用接口（仅适用于 MX 设备）。有效值为“enabled”、“disabled”和“not configured”。 |
注释
注意
使用的 SDK 方法为 devices.Devices.reboot_device、devices.Devices.update_device_management_interface，
使用的路径为 post /devices/{serial}/reboot、put /devices/{serial}/managementInterface，
不支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 设备 rebootDevice 文档
rebootDevice API 的完整参考。
- 思科Meraki设备更新DeviceManagementInterface文档
updateDeviceManagementInterface API的完整参考。
示例
- name: Update all
cisco.meraki.devices_management_interface:
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
serial: string
wan1:
staticDns:
- 1.2.3.2
- 1.2.3.3
staticGatewayIp: 1.2.3.1
staticIp: 1.2.3.4
staticSubnetMask: 255.255.255.0
usingStaticIp: true
vlan: 7
wanEnabled: not configured
wan2:
staticDns:
- 1.2.3.2
- 1.2.3.3
staticGatewayIp: 1.2.3.1
staticIp: 1.2.3.4
staticSubnetMask: 255.255.255.0
usingStaticIp: false
vlan: 2
wanEnabled: enabled
- name: Create
cisco.meraki.devices_management_interface:
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
serial: string
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含思科Meraki Python SDK返回的响应的字典或列表 返回值：始终返回 示例： |