netbox.netbox.netbox_power_port_template 模块 – 在 NetBox 中创建、更新或删除电源端口模板

注意

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

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

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

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

netbox.netbox 0.2.3 中的新增功能

概要

  • 创建、更新或删除 NetBox 中的电源端口模板

要求

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

  • pynetbox

参数

参数

注释

cert

任意

证书路径

data

字典 / 必需

定义电源端口配置

allocated_draw

整数

电源端口的分配功率（瓦特）

device_type

任意

电源端口连接到的设备类型

需要 `device_type` 或 `module_type` 之一

maximum_draw

整数

电源端口允许的最大功率（瓦特）

module_type

任意

netbox.netbox 3.16.0 中新增

电源端口连接到的模块类型

需要 `device_type` 或 `module_type` 之一

name

字符串 / 必需

电源端口的名称

type

字符串

电源端口的类型

选项

  • "iec-60320-c6"

  • "iec-60320-c8"

  • "iec-60320-c14"

  • "iec-60320-c16"

  • "iec-60320-c20"

  • "iec-60320-c22"

  • "iec-60309-p-n-e-4h"

  • "iec-60309-p-n-e-6h"

  • "iec-60309-p-n-e-9h"

  • "iec-60309-2p-e-4h"

  • "iec-60309-2p-e-6h"

  • "iec-60309-2p-e-9h"

  • "iec-60309-3p-e-4h"

  • "iec-60309-3p-e-6h"

  • "iec-60309-3p-e-9h"

  • "iec-60309-3p-n-e-4h"

  • "iec-60309-3p-n-e-6h"

  • "iec-60309-3p-n-e-9h"

  • "iec-60906-1"

  • "nbr-14136-10a"

  • "nbr-14136-20a"

  • "nema-1-15p"

  • "nema-5-15p"

  • "nema-5-20p"

  • "nema-5-30p"

  • "nema-5-50p"

  • "nema-6-15p"

  • "nema-6-20p"

  • "nema-6-30p"

  • "nema-6-50p"

  • "nema-10-30p"

  • "nema-10-50p"

  • "nema-14-20p"

  • "nema-14-30p"

  • "nema-14-50p"

  • "nema-14-60p"

  • "nema-15-15p"

  • "nema-15-20p"

  • "nema-15-30p"

  • "nema-15-50p"

  • "nema-15-60p"

  • "nema-l1-15p"

  • "nema-l5-15p"

  • "nema-l5-20p"

  • "nema-l5-30p"

  • "nema-l5-50p"

  • "nema-l6-15p"

  • "nema-l6-20p"

  • "nema-l6-30p"

  • "nema-l6-50p"

  • "nema-l10-30p"

  • "nema-l14-20p"

  • "nema-l14-30p"

  • "nema-l14-50p"

  • "nema-l14-60p"

  • "nema-l15-20p"

  • "nema-l15-30p"

  • "nema-l15-50p"

  • "nema-l15-60p"

  • "nema-l21-20p"

  • "nema-l21-30p"

  • "nema-l22-30p"

  • "cs6361c"

  • "cs6365c"

  • "cs8165c"

  • "cs8265c"

  • "cs8365c"

  • "cs8465c"

  • "ita-c"

  • "ita-e"

  • "ita-f"

  • "ita-ef"

  • "ita-g"

  • "ita-h"

  • "ita-i"

  • "ita-j"

  • "ita-k"

  • "ita-l"

  • "ita-m"

  • "ita-n"

  • "ita-o"

  • "usb-a"

  • "usb-b"

  • "usb-c"

  • "usb-mini-a"

  • "usb-mini-b"

  • "usb-micro-a"

  • "usb-micro-b"

  • "usb-micro-ab"

  • "usb-3-b"

  • "usb-3-micro-b"

  • "dc-terminal"

  • "saf-d-grid"

  • "neutrik-powercon-20"

  • "neutrik-powercon-32"

  • "neutrik-powercon-true1"

  • "neutrik-powercon-true1-top"

  • "ubiquiti-smartpower"

  • "hardwired"

  • "other"

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 power port within NetBox with only required information
      netbox.netbox.netbox_power_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Port Template
          device_type: Test Device Type
        state: present

    - name: Create power port for a module type within NetBox
      netbox.netbox.netbox_power_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Port Template
          module_type: Test Module Type
          type: iec-60320-c6
          maximum_draw: 750
        state: present

    - name: Update power port with other fields
      netbox.netbox.netbox_power_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Port Template
          device_type: Test Device Type
          type: iec-60320-c6
          allocated_draw: 16
          maximum_draw: 80
        state: present

    - name: Delete power port within netbox
      netbox.netbox.netbox_power_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Power Port Template
          device_type: Test Device Type
        state: absent

返回值

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

键

描述

msg

字符串

指示失败或有关已实现内容的信息的消息

返回值：始终

power_port_template

字典

在 NetBox 中创建或已存在的序列化对象

返回值：成功（当 state=present 时）

作者

  • Tobias Groß (@toerb)