netbox.netbox.netbox_device_bay 模块 – 在 NetBox 中创建、更新或删除设备托架

注意

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

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

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

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

netbox.netbox 0.1.0 中的新增功能

概要 

在 NetBox 中创建、更新或删除设备托架

要求 

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

pynetbox

参数 

参数	注释
cert 任何	证书路径
data 字典 / 必需	定义设备托架配置
description 字符串	设备托架的描述。 NetBox v2.6+ 支持此功能
device 任何	将设备托架关联到的设备。设备类型必须为 “parent”。
installed_device 任何	将安装到托架中的设备。设备类型必须为 “child”。
label 字符串在 netbox.netbox 3.9.0 中添加	设备托架的标签
name 字符串 / 必需	设备托架的名称
tags 列表 / elements=任何	设备托架可能需要关联的任何标签
netbox_token 字符串 / 必需	NetBox API 令牌。
netbox_url 字符串 / 必需	NetBox 实例的 URL。必须可由 Ansible 控制主机访问。
query_params 列表 / elements=字符串	这可用于覆盖 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中的指定值，并为用户提供对其环境中使对象唯一的内容的控制。 in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
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 device bay within NetBox with only required information
      netbox.netbox.netbox_device_bay:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: Test Nexus One
          name: "Device Bay One"
        state: present

    - name: Add device into device bay
      netbox.netbox.netbox_device_bay:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: Test Nexus One
          name: "Device Bay One"
          description: "First child"
          installed_device: Test Nexus Child One
        state: absent

    - name: Delete device bay within netbox
      netbox.netbox.netbox_device_bay:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Device Bay One
        state: absent

返回值 

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

键	描述
device_bay 字典	在 NetBox 中创建或已存在的序列化对象返回: 成功 (当 state=present 时)
msg 字符串	指示失败的消息或有关已实现内容的信息返回: 总是

作者

Mikhail Yohman (@FragmentedPacket)