netbox.netbox.netbox_vrf 模块 – 在 NetBox 中创建、更新或删除 VRF

注意

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

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

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

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

netbox.netbox 0.1.0 中的新增功能

概要 

从 NetBox 创建、更新或删除 VRF

要求 

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

pynetbox

参数 

参数	注释
cert any	证书路径
data 字典 / 必需	定义 VRF 配置
comments string 在 netbox.netbox 3.10.0 中添加	可能包含有关 VRF 的其他信息的注释
custom_fields dictionary	必须存在于 NetBox 中
description string	VRF 的描述
enforce_unique boolean	防止此 VRF 中出现重复的前缀/IP 地址选项 `false` `true`
export_targets 列表 / elements=string 在 netbox.netbox 2.0.0 中添加	与 VRF 绑定的导出目标
import_targets 列表 / elements=string 在 netbox.netbox 2.0.0 中添加	与 VRF 绑定的导入目标
name 字符串 / 必需	VRF 的名称
rd string	VRF 的 RD。必须用引号引起来才能作为字符串传递。
tags 列表 / elements=any	VRF 可能需要关联的任何标签
tenant any	VRF 将分配到的租户
netbox_token 字符串 / 必需	NetBox API 令牌。
netbox_url 字符串 / 必需	NetBox 实例的 URL。 Ansible 控制主机必须可访问。
query_params 列表 / elements=string	这可以用来覆盖在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的值，并为用户提供控制，以便在其环境中确定对象的唯一性。 plugins/module_utils/netbox_utils.py 在一个对象在其环境中是唯一的。
state string	对象的状态。选项 `"present"` ← (默认) `"absent"`
validate_certs any	如果 `no`，则不会验证 SSL 证书。这应该只在个人控制的站点上使用自签名证书。默认值： `true`

备注 

注意

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

示例 

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: false

  tasks:
    - name: Create vrf within NetBox with only required information
      netbox_vrf:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test VRF
        state: present

    - name: Delete vrf within netbox
      netbox_vrf:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test VRF
        state: absent

    - name: Create vrf with all information
      netbox_vrf:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test VRF
          rd: "65000:1"
          tenant: Test Tenant
          enforce_unique: true
          import_targets:
            - "65000:65001"
          export_targets:
            - "65000:65001"
          description: VRF description
          tags:
            - Schnozzberry
        state: present

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
msg string	指示失败或有关已实现内容的的消息返回：始终
vrf dictionary	在 NetBox 中创建或已存在的序列化对象返回：成功（当 state=present 时）

作者

Mikhail Yohman (@FragmentedPacket)