cisco.meraki.networks_switch_link_aggregations 模块 – 用于网络交换机链路聚合的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 Playbook 中使用它，请指定：cisco.meraki.networks_switch_link_aggregations。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源网络交换机链路聚合的创建、更新和删除操作。
创建链路聚合组。
将链路聚合组拆分为单独的端口。
更新链路聚合组。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
LinkAggregationId 路径参数。链路聚合 ID。 |
|
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。 |
|
用于创建聚合组的交换机或堆叠端口数组。支持最少 2 个和最多 8 个端口。 |
|
交换机端口的端口标识符。对于模块，标识符是“SlotNumber_ModuleType_PortNumber”（例如“1_8X10G_1”），否则它只是端口号（例如“8”）。 |
|
交换机的序列号。 |
|
用于创建聚合组的交换机配置文件端口数组。最少支持 2 个端口，最多支持 8 个端口。 |
|
交换机端口的端口标识符。对于模块，标识符是“SlotNumber_ModuleType_PortNumber”（例如“1_8X10G_1”），否则它只是端口号（例如“8”）。 |
|
配置文件标识符。 |
注释
注意
使用的 SDK 方法包括 switch.Switch.create_network_switch_link_aggregation、switch.Switch.delete_network_switch_link_aggregation、switch.Switch.update_network_switch_link_aggregation。
使用的路径包括 post /networks/{networkId}/switch/linkAggregations、delete /networks/{networkId}/switch/linkAggregations/{linkAggregationId}、put /networks/{networkId}/switch/linkAggregations/{linkAggregationId}。
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco Meraki 关于 switch createNetworkSwitchLinkAggregation 的文档
createNetworkSwitchLinkAggregation API 的完整参考。
- Cisco Meraki 关于 switch deleteNetworkSwitchLinkAggregation 的文档
deleteNetworkSwitchLinkAggregation API 的完整参考。
- Cisco Meraki 关于 switch updateNetworkSwitchLinkAggregation 的文档
updateNetworkSwitchLinkAggregation API 的完整参考。
示例
- name: Create
cisco.meraki.networks_switch_link_aggregations:
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
networkId: string
switchPorts:
- portId: '1'
serial: Q234-ABCD-0001
- portId: '2'
serial: Q234-ABCD-0002
- portId: '3'
serial: Q234-ABCD-0003
- portId: '4'
serial: Q234-ABCD-0004
- portId: '5'
serial: Q234-ABCD-0005
- portId: '6'
serial: Q234-ABCD-0006
- portId: '7'
serial: Q234-ABCD-0007
- portId: '8'
serial: Q234-ABCD-0008
- name: Delete by id
cisco.meraki.networks_switch_link_aggregations:
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: absent
linkAggregationId: string
networkId: string
- name: Update by id
cisco.meraki.networks_switch_link_aggregations:
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
id: NDU2N18yXzM=
linkAggregationId: string
networkId: string
switchPorts:
- portId: '1'
serial: Q234-ABCD-0001
- portId: '2'
serial: Q234-ABCD-0002
- portId: '3'
serial: Q234-ABCD-0003
- portId: '4'
serial: Q234-ABCD-0004
- portId: '5'
serial: Q234-ABCD-0005
- portId: '6'
serial: Q234-ABCD-0006
- portId: '7'
serial: Q234-ABCD-0007
- portId: '8'
serial: Q234-ABCD-0008
返回值
常见的返回值记录在 此处，以下是此模块特有的字段。
键 |
描述 |
|---|---|
由 Cisco Meraki Python SDK 返回的字典或列表响应。 返回值: 总是 示例: |