netbox.netbox.netbox_power_panel 模块 – 在 NetBox 中创建、更新或删除电源面板

注意

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

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

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

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

netbox.netbox 0.2.3 中的新增功能

概要 

创建、更新或删除 NetBox 中的电源面板

需求 

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

pynetbox

参数 

参数	注释
cert 任意	证书路径
data 字典 / 必需	定义电源面板配置
comments 字符串 netbox.netbox 3.10.0 中新增	与电源面板相关的注释
custom_fields 字典 netbox.netbox 3.6.0 中新增	必须存在于 NetBox 中
description 字符串 netbox.netbox 3.10.0 中新增	电源面板的描述
location 任意 netbox.netbox 3.1.0 中新增	分配电源面板的位置 (NetBox 2.11+)
name 字符串 / 必需	电源面板的名称
rack_group 任意	分配电源面板的机架组 (NetBox < 2.11) 将在 5.0.0 版本中删除
site 任意 / 必需	电源面板所在的位置
tags 列表 / 元素=任意 netbox.netbox 3.6.0 中新增	要添加/更新的标签
netbox_token 字符串 / 必需	NetBox API 令牌。
netbox_url 字符串 / 必需	NetBox 实例的 URL。 Ansible 控制主机必须能够访问。
query_params 列表 / 元素=字符串	这可以用来覆盖 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的 value，并为用户提供对可能使对象在其环境中唯一化的内容的控制。在 plugins/module_utils/netbox_utils.py 中定义，并为用户提供对可能使对象在其环境中唯一化的内容的控制。在 plugins/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 power panel within NetBox with only required information
      netbox.netbox.netbox_power_panel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Panel
          site: Test Site
        state: present

    - name: Update power panel with other fields - Pre 2.11
      netbox.netbox.netbox_power_panel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Panel
          site: Test Site
          rack_group: Test Rack Group
        state: present

    - name: Create power panel within NetBox with only required information - Post 2.11
      netbox.netbox.netbox_power_panel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Panel
          site: Test Site
          location: Test Location
        state: present

    - name: Delete power panel within netbox
      netbox.netbox.netbox_power_panel:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Panel
          site: Test Site
        state: absent

返回值 

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

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

作者

Tobias Groß (@toerb)