cisco.meraki.networks_switch_alternate_management_interface 模块 – 用于 networks _switch _alternatemanagementinterface 的资源模块

注意

此模块是 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 中的新增功能

概要

• 管理资源 networks _switch _alternatemanagementinterface 的操作更新。

• 更新网络的交换机备用管理接口。

注意

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

要求

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

• meraki >= 2.4.9

• python >= 3.5

参数

参数	注释
enabled boolean	用于启用或禁用 AMI 配置的布尔值。如果启用，则必须设置 VLAN 和协议。 选择 false true
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer)，操作批处理并发错误重试等待时间 默认值: 60
meraki_api_key string / 必需	meraki_api_key (string)，在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string)，所有端点资源的前缀 默认值: "https://api.meraki.com/api/v1"
meraki_be_geo_id string	meraki_be_geo_id (string)，用于 API 使用跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值: ""
meraki_caller string	meraki_caller (string)，用于 API 使用跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值: ""
meraki_certificate_path string	meraki_certificate_path (string)，如果位于本地代理之后，则用于 TLS/SSL 证书验证的路径 默认值: ""
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean)，继承您自己的记录器实例 选择 false ← (默认值) true
meraki_log_file_prefix string	meraki_log_file_prefix (string)，附加日期和时间戳的日志文件名 默认值: "meraki_api_"
meraki_log_path string	log_path (string)，输出日志的路径；默认情况下，如果未指定，则为脚本的工作目录 默认值: ""
meraki_maximum_retries integer	meraki_maximum_retries (integer)，遇到 429 或其他服务器端错误时，最多重试此次数 默认值: 2
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer)，Nginx 429 重试等待时间 默认值: 60
meraki_output_log boolean	meraki_output_log (boolean)，创建输出日志文件？ 选择 false true ← (默认值)
meraki_print_console boolean	meraki_print_console (boolean)，将日志输出打印到控制台？ 选择 false true ← (默认值)
meraki_requests_proxy string	meraki_requests_proxy (string)，如果需要，则为 HTTPS 的代理服务器和端口 默认值: ""
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean)，如果遇到其他 4XX 错误（除了 429），是否重试？ 选择 false ← (默认值) true
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer)，其他 4XX 错误重试等待时间 默认值: 60
meraki_simulate boolean	meraki_simulate (boolean)，模拟 POST/PUT/DELETE 调用以防止更改？ 选择 false ← (默认值) true
meraki_single_request_timeout integer	meraki_single_request_timeout (integer)，每个 API 调用的最大秒数 默认值: 60
meraki_suppress_logging boolean	meraki_suppress_logging (boolean)，禁用所有日志记录？那你自己看着办吧！ 选择 false ← (默认值) true
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean)，list* 方法将返回一个迭代器，其中包含每个对象，而不是包含所有项的完整列表 选择 false ← (默认值) true
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean)，如果遇到 429 速率限制错误，是否重试？ 选择 false true ← (默认值)
networkId string	NetworkId 路径参数。网络 ID。
protocols list / elements=string	可以是以下一个或多个值 ‘radius’、‘snmp’ 或 ‘syslog’。
switches list / elements=dictionary	交换机序列号和 IP 地址分配的数组。如果存在此参数，则其主体不能为空。请注意，`switches` 参数不适用于模板网络，换句话说，更新模板网络时，请不要在主体中包含 `switches`。此外，空的 `switches` 数组将删除所有之前的分配。
alternateManagementIp string	交换机备用管理 IP。要删除先前的 IP 设置，请提供空字符串。
gateway string	交换机网关必须为 IP 格式。仅限 Polaris 交换机且必须指定此项。
serial string	交换机序列号。
subnetMask string	交换机子网掩码必须为 IP 格式。仅限 Polaris 交换机且必须指定此项。
vlanId integer	备用管理 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 文档，了解 switch 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

返回值

通用返回值已在此处记录：此处，以下是此模块独有的字段

键	描述
meraki_response 字典	包含 Cisco Meraki Python SDK 返回的响应的字典或列表 已返回：始终 示例： {}

作者

• Francisco Munoz (@fmunoz)

集合链接

• 问题跟踪器
• 存储库（源）