cisco.meraki.networks_webhooks_http_servers 模块 – 网络_webhooks_httpservers 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.meraki.networks_webhooks_http_servers。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源网络 _webhooks _httpservers 的创建、更新和删除操作。
向网络添加 HTTP 服务器。
从网络中删除 HTTP 服务器。
更新 HTTP 服务器。要更改 URL，请创建新的 HTTP 服务器。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
HttpServerId 路径参数。HTTP 服务器 ID。 |
|
meraki_action_batch_retry_wait_time (integer)，操作批量并发错误重试等待时间 默认值： |
|
meraki_api_key (string)，仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string)，位于所有端点资源之前 默认值： |
|
meraki_be_geo_id (string)，用于 API 使用情况跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： |
|
meraki_caller (string)，用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： |
|
meraki_certificate_path (string)，如果位于本地代理之后，则用于 TLS/SSL 证书验证的路径 默认值： |
|
meraki_inherit_logging_config (boolean)，继承您自己的记录器实例 选项
|
|
meraki_log_file_prefix (string)，附加了日期和时间戳的日志文件名 默认值： |
|
log_path (string)，输出日志的路径；默认情况下，如果未指定，则为脚本的工作目录 默认值： |
|
meraki_maximum_retries (integer)，在遇到 429 或其他服务器端错误时，最多重试此次数 默认值： |
|
meraki_nginx_429_retry_wait_time (integer)，Nginx 429 重试等待时间 默认值： |
|
meraki_output_log (boolean)，创建输出日志文件？ 选项
|
|
meraki_print_console (boolean)，将日志输出打印到控制台？ 选项
|
|
meraki_requests_proxy (string)，如果需要，用于 HTTPS 的代理服务器和端口 默认值： |
|
meraki_retry_4xx_error (boolean)，如果遇到其他 4XX 错误（除了 429），是否重试？ 选项
|
|
meraki_retry_4xx_error_wait_time (integer)，其他 4XX 错误重试等待时间 默认值： |
|
meraki_simulate (boolean)，模拟 POST/PUT/DELETE 调用以防止更改？ 选项
|
|
meraki_single_request_timeout (integer)，每次 API 调用的最大秒数 默认值： |
|
meraki_suppress_logging (boolean)，禁用所有日志记录？那就只能靠你自己了！ 选项
|
|
meraki_use_iterator_for_get_pages (boolean)，list* 方法将返回一个迭代器，其中包含每个对象，而不是包含所有项的完整列表 选项
|
|
meraki_wait_on_rate_limit (boolean)，如果遇到 429 速率限制错误，是否重试？ 选项
|
|
易于引用 HTTP 服务器的名称。 |
|
NetworkId 路径参数。网络 ID。 |
|
将数据发布到 HTTP 服务器时使用的有效负载模板。 |
|
有效负载模板的名称。 |
|
有效负载模板的 ID。默认为 Meraki 模板的“wpt_00001”。对于 Webex（包含）模板的 Meraki 内置模板，请使用“wpt_00002”；对于 Slack（包含）模板，请使用“wpt_00003”；对于 Microsoft Teams（包含）模板，请使用“wpt_00004”；对于 ServiceNow（包含）模板，请使用“wpt_00006”。 |
|
将包含在发送到 HTTP 服务器的 POST 中的共享密钥。此密钥可用于验证请求是否由 Meraki 发送。 |
|
HTTP 服务器的 URL。设置后，无法更新。 |
说明
注意
使用的 SDK 方法是 networks.Networks.create_network_webhooks_http_server、networks.Networks.delete_network_webhooks_http_server、networks.Networks.update_network_webhooks_http_server，
使用的路径是 post /networks/{networkId}/webhooks/httpServers、delete /networks/{networkId}/webhooks/httpServers/{httpServerId}、put /networks/{networkId}/webhooks/httpServers/{httpServerId}，
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，了解有关 networks createNetworkWebhooksHttpServer 的信息
createNetworkWebhooksHttpServer API 的完整参考。
- Cisco Meraki 文档，了解有关 networks deleteNetworkWebhooksHttpServer 的信息
deleteNetworkWebhooksHttpServer API 的完整参考。
- Cisco Meraki 文档，了解有关 networks updateNetworkWebhooksHttpServer 的信息
updateNetworkWebhooksHttpServer API 的完整参考。
示例
- name: Create
cisco.meraki.networks_webhooks_http_servers:
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
name: Example Webhook Server
networkId: string
payloadTemplate:
name: Meraki (included)
payloadTemplateId: wpt_00001
sharedSecret: shhh
url: https://example.com
- name: Delete by id
cisco.meraki.networks_webhooks_http_servers:
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
httpServerId: string
networkId: string
- name: Update by id
cisco.meraki.networks_webhooks_http_servers:
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
httpServerId: string
name: Example Webhook Server
networkId: string
payloadTemplate:
payloadTemplateId: wpt_00001
sharedSecret: shhh
返回值
通用的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco Meraki Python SDK 返回的响应 返回: 总是 示例: |