cisco.meraki.networks_sm_devices_reboot 模块 – 用于 networks _sm _devices _reboot 的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：cisco.meraki.networks_sm_devices_reboot。

cisco.meraki 2.18.0 中的新功能

概要 

管理资源 networks _sm _devices _reboot 的创建操作。
重启一组端点。

注意

此模块具有相应的 action 插件。

要求 

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

meraki >= 2.4.9
python >= 3.5

参数 

参数	注释
ids list / elements=string	要重启的端点的 ID。
kextPaths list / elements=string	要重启的端点的 KextPaths。适用于 macOS 11+。
meraki_action_batch_retry_wait_time 整数	meraki_action_batch_retry_wait_time (integer), 操作批处理并发错误重试等待时间默认: `60`
meraki_api_key string / 必填	meraki_api_key (string)，在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY
meraki_base_url 字符串	meraki_base_url (string)，在所有端点资源之前的资源默认: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id 字符串	meraki_be_geo_id (string)，用于 API 使用情况跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认: `""`
meraki_caller 字符串	meraki_caller (string)，用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认: `""`
meraki_certificate_path 字符串	meraki_certificate_path (string)，如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径默认: `""`
meraki_inherit_logging_config 布尔值	meraki_inherit_logging_config (boolean)，继承您自己的记录器实例选项 `false` ← (默认) `true`
meraki_log_file_prefix 字符串	meraki_log_file_prefix (string)，附加日期和时间戳的日志文件名默认: `"meraki_api_"`
meraki_log_path 字符串	log_path (string)，输出日志的路径；默认情况下，如果未指定，则为脚本的工作目录默认: `""`
meraki_maximum_retries 整数	meraki_maximum_retries (integer)，当遇到 429 或其他服务器端错误时，最多重试这么多次默认: `2`
meraki_nginx_429_retry_wait_time 整数	meraki_nginx_429_retry_wait_time (integer)，Nginx 429 重试等待时间默认: `60`
meraki_output_log 布尔值	meraki_output_log (boolean)，创建输出日志文件？选项 `false` `true` ← (默认)
meraki_print_console 布尔值	meraki_print_console (boolean)，将日志输出打印到控制台？选项 `false` `true` ← (默认)
meraki_requests_proxy 字符串	meraki_requests_proxy (string)，如果需要，用于 HTTPS 的代理服务器和端口默认: `""`
meraki_retry_4xx_error 布尔值	meraki_retry_4xx_error (boolean)，如果遇到其他 4XX 错误（除了 429）是否重试？选项 `false` ← (默认) `true`
meraki_retry_4xx_error_wait_time 整数	meraki_retry_4xx_error_wait_time (integer)，其他 4XX 错误重试等待时间默认: `60`
meraki_simulate 布尔值	meraki_simulate (boolean)，模拟 POST/PUT/DELETE 调用以防止更改？选项 `false` ← (默认) `true`
meraki_single_request_timeout 整数	meraki_single_request_timeout (integer)，每次 API 调用的最大秒数默认: `60`
meraki_suppress_logging 布尔值	meraki_suppress_logging (boolean)，禁用所有日志记录？那您就自己看着办吧！选项 `false` ← (默认) `true`
meraki_use_iterator_for_get_pages 布尔值	meraki_use_iterator_for_get_pages (boolean)，list* 方法将返回一个迭代器，其中包含每个对象，而不是包含所有项的完整列表选项 `false` ← (默认) `true`
meraki_wait_on_rate_limit 布尔值	meraki_wait_on_rate_limit (boolean)，如果遇到 429 速率限制错误是否重试？选项 `false` `true` ← (默认)
networkId 字符串	NetworkId 路径参数。网络 ID。
notifyUser 布尔值	是否在重启端点之前通知用户。适用于 macOS 11.3+。选项 `false` `true`
rebuildKernelCache 布尔值	重启端点时是否重建内核缓存。适用于 macOS 11+。选项 `false` `true`
requestRequiresNetworkTether 布尔值	请求是否需要网络共享。适用于 macOS 和受监督的 iOS 或 tvOS。选项 `false` `true`
scope list / elements=string	要重启的端点的范围（all、none、withAny、withAll、withoutAny 或 withoutAll 之一）和一组标签。
serials list / elements=string	要重启的端点的序列号。
wifiMacs list / elements=string	要重启的端点的 wifiMacs。

注释 

注意

使用的 SDK 方法是 sm.Sm.reboot_network_sm_devices，
使用的路径是 post /networks/{networkId}/sm/devices/reboot，
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco Meraki 文档，了解 sm rebootNetworkSmDevices: rebootNetworkSmDevices API 的完整参考。

示例 

- name: Create
  cisco.meraki.networks_sm_devices_reboot:
    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}}"
    ids:
    - '1284392014819'
    - '2983092129865'
    kextPaths:
    - test
    networkId: string
    notifyUser: true
    rebuildKernelCache: true
    requestRequiresNetworkTether: true
    scope:
    - withAny
    - tag1
    - tag2
    serials:
    - XY0XX0Y0X0
    - A01B01CD00E
    - X02YZ1ZYZX
    wifiMacs:
    - 00:11:22:33:44:55

返回值 

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

键	描述
meraki_response 字典	由 Cisco Meraki Python SDK 返回的响应字典或列表返回: 始终示例: `{"ids": ["string"]}`

作者

Francisco Munoz (@fmunoz)