cisco.meraki.networks_wireless_billing 模块 – 网络无线计费资源模块

注意

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

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

要安装它,请使用: ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在playbook中使用它,请指定: cisco.meraki.networks_wireless_billing

cisco.meraki 2.16.0 新增功能

概要

  • 管理资源网络无线计费的操作更新。

  • 更新计费设置。

注意

此模块具有相应的 action 插件

要求

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

  • meraki >= 2.4.9

  • python >= 3.5

参数

参数

注释

currency

字符串

此节点组计费计划的货币代码。

meraki_action_batch_retry_wait_time

整数

meraki_action_batch_retry_wait_time(整数),操作批处理并发错误重试等待时间

默认值: 60

meraki_api_key

字符串 / 必填

meraki_api_key(字符串),在仪表盘中生成的API密钥;也可以设置为环境变量MERAKI_DASHBOARD_API_KEY

meraki_base_url

字符串

meraki_base_url(字符串),位于所有端点资源之前

默认值: "https://api.meraki.com/api/v1"

meraki_be_geo_id

字符串

meraki_be_geo_id(字符串),API使用跟踪的可选合作伙伴标识符;也可以设置为环境变量BE_GEO_ID

默认值: ""

meraki_caller

字符串

meraki_caller(字符串),API使用跟踪的可选标识符;也可以设置为环境变量MERAKI_PYTHON_SDK_CALLER

默认值: ""

meraki_certificate_path

字符串

meraki_certificate_path(字符串),位于本地代理后面的TLS/SSL证书验证的路径

默认值: ""

meraki_inherit_logging_config

布尔值

meraki_inherit_logging_config(布尔值),继承您自己的日志记录实例

选项

  • false ← (默认)

  • true

meraki_log_file_prefix

字符串

meraki_log_file_prefix(字符串),日志文件名附加日期和时间戳

默认值: "meraki_api_"

meraki_log_path

字符串

log_path(字符串),输出日志的路径;如果未指定,则默认为脚本的工作目录

默认值: ""

meraki_maximum_retries

整数

meraki_maximum_retries(整数),遇到429或其他服务器端错误时最多重试这么多次

默认值: 2

meraki_nginx_429_retry_wait_time

整数

meraki_nginx_429_retry_wait_time(整数),Nginx 429重试等待时间

默认值: 60

meraki_output_log

布尔值

meraki_output_log(布尔值),创建输出日志文件?

选项

  • false

  • true ← (默认)

meraki_print_console

布尔值

meraki_print_console(布尔值),将日志输出打印到控制台?

选项

  • false

  • true ← (默认)

meraki_requests_proxy

字符串

meraki_requests_proxy(字符串),如果需要,用于HTTPS的代理服务器和端口

默认值: ""

meraki_retry_4xx_error

布尔值

meraki_retry_4xx_error(布尔值),如果遇到其他4XX错误(除了429)则重试?

选项

  • false ← (默认)

  • true

meraki_retry_4xx_error_wait_time

整数

meraki_retry_4xx_error_wait_time(整数),其他4XX错误重试等待时间

默认值: 60

meraki_simulate

布尔值

meraki_simulate(布尔值),模拟POST/PUT/DELETE调用以防止更改?

选项

  • false ← (默认)

  • true

meraki_single_request_timeout

整数

meraki_single_request_timeout(整数),每次API调用的最大秒数

默认值: 60

meraki_suppress_logging

布尔值

meraki_suppress_logging(布尔值),禁用所有日志记录?那么你只能自求多福了!

选项

  • false ← (默认)

  • true

meraki_use_iterator_for_get_pages

布尔值

meraki_use_iterator_for_get_pages(布尔值),list*方法将返回包含每个对象的迭代器,而不是包含所有项目的完整列表

选项

  • false ← (默认)

  • true

meraki_wait_on_rate_limit

布尔值

meraki_wait_on_rate_limit(布尔值),如果遇到429速率限制错误则重试?

选项

  • false

  • true ← (默认)

networkId

字符串

NetworkId 路径参数。网络ID。

plans

列表 / 元素=字典

节点组中的计费计划数组。(最多可配置5个)。

bandwidthLimits

字典

定价计划的上行带宽设置。

limitDown

整数

最大下载限制(整数,以Kbps为单位)。空表示无限制。

limitUp

整数

最大上传限制(整数,以Kbps为单位)。空表示无限制。

id

字符串

要更新的定价计划的ID。

price

浮点数

计费计划的价格。

timeLimit

字符串

计费计划的时间限制,以分钟为单位。可以是“1小时”、“1天”、“1周”或“30天”。

备注

注意

  • 使用的SDK方法是wireless.Wireless.update_network_wireless_billing,

  • 使用的路径是put /networks/{networkId}/wireless/billing,

  • 不支持 check_mode

  • 该插件运行在控制节点上,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参见

另请参见

Cisco Meraki 无线更新网络计费文档 (updateNetworkWirelessBilling)

updateNetworkWirelessBilling API 的完整参考。

示例

- name: Update all
  cisco.meraki.networks_wireless_billing:
    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
    currency: USD
    networkId: string
    plans:
    - bandwidthLimits:
        limitDown: 1000000
        limitUp: 1000000
      id: '1'
      price: 5.0
      timeLimit: 1 hour

返回值

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

描述

meraki_response

字典

由 Cisco Meraki Python SDK 返回的响应字典或列表。

返回值:始终返回

示例: {"currency": "string", "plans": [{"bandwidthLimits": {"limitDown": 0, "limitUp": 0}, "id": "string", "price": 0, "timeLimit": "string"}]}

作者

  • Francisco Munoz (@fmunoz)