cisco.meraki.networks_switch_alternate_management_interface 模块 – 网络_交换机_备用管理接口的资源模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.meraki.networks_switch_alternate_management_interface。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源网络_交换机_备用管理接口的操作更新。
更新网络的交换机备用管理接口。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
布尔值，用于启用或禁用 AMI 配置。如果启用，则必须设置 VLAN 和协议。 选项
|
|
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 速率限制错误则重试？ 选项
|
|
NetworkId 路径参数。网络 ID。 |
|
可以是以下值之一或多个：'radius'、'snmp' 或 'syslog'。 |
|
交换机序列号和IP分配数组。如果存在此参数，则其内容不能为空。请注意，switches参数不适用于模板网络，换句话说，更新模板网络时，不要在正文中添加‘switches’。此外，空‘switches’数组将删除所有之前的分配。 |
|
交换机的备用管理IP。要删除之前的IP设置，请提供一个空字符串。 |
|
交换机网关必须为IP格式。仅对Polaris交换机必须指定此参数。 |
|
交换机序列号。 |
|
交换机子网掩码必须为IP格式。仅对Polaris交换机必须指定此参数。 |
|
备用管理VLAN，必须在1到4094之间。 |
注释
注意
使用的SDK方法为switch.Switch.update_network_switch_alternate_management_interface,
使用的路径为put /networks/{networkId}/switch/alternateManagementInterface,
不支持
check_mode该插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco DNAC SDK的嵌入式连接管理器。
以dnac_开头的参数由Cisco DNAC Python SDK用于建立连接。
另请参阅
另请参阅
- Cisco Meraki关于updateNetworkSwitchAlternateManagementInterface的文档
updateNetworkSwitchAlternateManagementInterface API的完整参考。
示例
- name: Update all
cisco.meraki.networks_switch_alternate_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
enabled: true
networkId: string
protocols:
- radius
- snmp
- syslog
switches:
- alternateManagementIp: 1.2.3.4
gateway: 1.2.3.5
serial: Q234-ABCD-5678
subnetMask: 255.255.255.0
vlanId: 100
返回值
常见的返回值已在 此处 文档中说明，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含Cisco Meraki Python SDK返回的响应的字典或列表 返回值：始终 示例： |