netbox.netbox.netbox_virtual_chassis 模块 – 在 NetBox 中创建、更新或删除虚拟机箱

注意

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

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

要安装它，请使用：ansible-galaxy collection install netbox.netbox。您需要其他要求才能使用此模块，请参阅需求以了解详情。

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

netbox.netbox 0.3.0 中的新增功能

概要 

创建、更新或删除 NetBox 中的虚拟机箱

需求 

以下是执行此模块的主机所需的条件。

pynetbox

参数 

参数	注释
cert 任意	证书路径
data 字典 / 必填	定义虚拟机箱配置
comments 字符串 netbox.netbox 3.10.0 中新增	可能包含有关虚拟机箱的其他信息的注释
custom_fields 字典	必须存在于 NetBox 中
description 字符串 netbox.netbox 3.10.0 中新增	虚拟机箱的描述
domain 字符串	虚拟机箱的域名
master 任意	虚拟机箱连接到的主设备
name 字符串	名称
tags 列表 / 元素=任意	虚拟机箱可能需要关联的任何标签
netbox_token 字符串 / 必填	NetBox API 令牌。
netbox_url 字符串 / 必填	NetBox 实例的 URL。 Ansible 控制主机必须能够访问。
query_params 列表 / 元素=字符串	这可以用来覆盖在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的参数，并为用户提供控制在其环境中使对象唯一的方法。在插件/module_utils/netbox_utils.py中定义，并为用户提供控制在其环境中使对象唯一的方法。
state 字符串	对象的狀態。选项 `"present"` ← (默认) `"absent"`
validate_certs 任意	如果为 `no`，则不会验证 SSL 证书。这应该只用于使用自签名证书的个人控制站点。默认值： `true`

注释 

注意

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

示例 

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

  tasks:
    - name: Create virtual chassis within NetBox with only required information
      netbox_virtual_chassis:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Virtual Chassis 1"
          master: Test Device
        state: present

    - name: Update virtual chassis with other fields
      netbox_virtual_chassis:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Virtual Chassis 1"
          domain: Domain Text
        state: present

    - name: Delete virtual chassis within netbox
      netbox_virtual_chassis:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Virtual Chassis 1"
        state: absent

返回值 

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

键	描述
msg 字符串	指示失败或有关已完成工作的消息返回：始终
virtual_chassis 字典	NetBox 中已创建或已存在的序列化对象返回：成功（当 state=present 时）

作者

Tobias Groß (@toerb)