netbox.netbox.netbox_device_interface_template 模块 – 从 NetBox 创建或删除设备上的接口

注意

此模块是 netbox.netbox 集合 (版本 3.20.0) 的一部分。

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

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

要在 playbook 中使用它，请指定：netbox.netbox.netbox_device_interface_template。

netbox.netbox 0.3.0 中的新增功能

概要 

从 NetBox 创建或删除接口

要求 

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

pynetbox

参数 

参数	注释
cert any	证书路径
data 字典 / 必需	定义接口模板配置
device_type any / 必需	与接口模板关联的设备的名称（区分大小写）
mgmt_only 布尔值	此接口模板仅用于带外管理选项 `false` `true`
name 字符串 / 必需	要创建的接口模板的名称
poe_mode any 在 netbox.netbox 3.8.0 中添加	此接口具有 PoE 能力（NetBox 3.3 及更高版本）
poe_type any 在 netbox.netbox 3.8.0 中添加	此接口的电源类型（NetBox 3.3 及更高版本）
type 字符串 / 必需	接口的外形尺寸：例如，1000Base-T (1GE)、Virtual、10GBASE-T (10GE)。这必须与 UI 中找到的完全一致。
netbox_token 字符串 / 必需	NetBox API 令牌。
netbox_url 字符串 / 必需	NetBox 实例的 URL。 Ansible 控制主机必须可以访问。
query_params 列表 / elements=字符串	这可以用来覆盖 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中的指定值，并提供控制用户在其环境中可能使对象唯一的内容。在 plugins/module_utils/netbox_utils.py 中定义，并允许用户控制在其环境中可能使对象唯一的内容。在插件/模块实用程序/netbox_utils.py 中定义，并提供用户控制在其环境中可能使对象唯一的内容。
state 字符串	对象的状态。选项 `"present"` ← (默认) `"absent"`
validate_certs any	如果为 `no`，则不会验证 SSL 证书。这应该仅在个人控制的使用自签名证书的站点上使用。默认值： `true`

注意 

注意

标签应定义为 YAML 列表
这应该使用连接 local 和主机 localhost 运行

示例 

- name: "Test NetBox interface template module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create interface template within NetBox with only required information
      netbox.netbox.netbox_device_interface_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device_type: Arista Test
          name: 10GBASE-T (10GE)
          type: 10gbase-t
        state: present
    - name: Delete interface template within netbox
      netbox.netbox.netbox_device_interface_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device_type: Arista Test
          name: 10GBASE-T (10GE)
          type: 10gbase-t
        state: absent

返回值 

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

键	描述
interface_template 字典	在 NetBox 中创建或已存在的序列化对象返回值：在创建时
msg 字符串	指示失败或有关已完成操作的信息的消息返回值：总是

作者

Tobias Groß (@toerb)