cisco.meraki.meraki_config_template 模块 – 管理 Meraki 云中的配置模板

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.meraki。

要在剧本中使用它，请指定： cisco.meraki.meraki_config_template。

cisco.meraki 1.0.0 中的新增功能

已弃用

在以下版本中移除：

3.0.0 版

原因：

发布了功能增强的更新模块

替代方案：

cisco.meraki.organizations_config_templates

概要

  • 允许查询、删除、绑定和取消绑定配置模板。

参数

参数

注释

auth_key

字符串 / 必需

仪表盘提供的身份验证密钥。如果环境变量 MERAKI_KEY 未设置，则需要此密钥。

auto_bind

布尔值

可选布尔值，指示网络交换机是否应自动绑定到相同型号的配置文件。

此选项仅影响交换机网络和交换机模板。

除非交换机模板至少具有一个配置文件并且每个交换机型号最多只有一个配置文件，否则自动绑定无效。

选项

  • false

  • true

config_template

别名：name

字符串

要操作的组织内配置模板的名称。

host

字符串

Meraki 仪表板的主机名。

可用于访问区域性 Meraki 环境，例如中国。

默认值： "api.meraki.com"

internal_error_retry_time

整数

如果服务器返回内部服务器错误，则重试的秒数。

默认值： 60

net_id

字符串

要绑定或取消绑定配置模板的网络 ID。

net_name

字符串

要绑定或取消绑定配置模板的网络名称。

org_id

字符串

与配置模板关联的组织 ID。

org_name

别名：organization

字符串

包含配置模板的组织名称。

output_format

字符串

指示模块响应键应该是蛇形命名法 (例如 net_id) 还是驼峰命名法 (例如 netId)。

选项

  • "snakecase" ← (默认)

  • "camelcase"

output_level

字符串

设置模块执行期间的调试输出量。

选项

  • "debug"

  • "normal" ← (默认)

rate_limit_retry_time

整数

如果触发速率限制器，则重试的秒数。

默认值： 165

state

字符串

指定是否应查询、修改或删除配置模板信息。

选项

  • "absent"

  • "query" ← (默认)

  • "present"

timeout

整数

HTTP 请求的超时时间。

默认值： 30

use_https

布尔值

如果为 no，则将使用 HTTP。否则将使用 HTTPS。

仅对 Meraki 内部开发人员有用。

选项

  • false

  • true ← (默认)

use_proxy

布尔值

如果为 no，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。

选项

  • false ← (默认)

  • true

validate_certs

布尔值

是否验证 HTTP 证书。

选项

  • false

  • true ← (默认)

备注

注意

  • 由于 Meraki API 对其提供的配置模板信息有限制，因此该模块不是幂等的。

  • Meraki 的 API 不支持创建新的配置模板。

  • 要使用配置模板，只需通过 Meraki 模块中的 net_id 参数传递其 ID。

  • 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

  • 某些选项可能仅供 Meraki 内部开发人员使用。

  • 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法 (snake case)。要使用驼峰命名法 (camel case)，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

  • Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法 (camel case) 输出。请更新您的 playbook。

  • 检查模式会从仪表板下载当前配置，然后将更改与该下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- name: Query configuration templates
  meraki_config_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Bind a template from a network
  meraki_config_template:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    config_template: DevConfigTemplate
  delegate_to: localhost

- name: Unbind a template from a network
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    config_template: DevConfigTemplate
  delegate_to: localhost

- name: Delete a configuration template
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    config_template: DevConfigTemplate
  delegate_to: localhost

返回值

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

键

描述

数据

复杂数据

有关查询对象的详细信息。

返回：成功

ID

整数

组织的唯一识别号。

返回：成功

示例："L_2930418"

名称

字符串

配置模板的名称。

返回：成功

示例："YourTemplate"

产品类型

列表 / 元素=字符串

网络中可以存在的产品列表。

返回：成功

示例：["appliance", "switch"]

时区

字符串

应用于每个关联网络的时区。

返回：成功

示例："America/Chicago"

状态

  • 此模块将在 3.0.0 版本中移除。[已弃用]

  • 更多信息请参见 已弃用。

作者

  • Kevin Breit (@kbreit)