netbox.netbox.netbox_rear_port 模块 – 在 NetBox 中创建、更新或删除后端口

注意

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

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

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

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

netbox.netbox 0.2.3 中的新功能

概要

  • 在 NetBox 中创建、更新或删除后端口

要求

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

  • pynetbox

参数

参数

注释

cert

任意

证书路径

data

字典 / 必需

定义后端口配置

description

字符串

后端口的描述

device

任意 / 必需

后端口所连接的设备

label

字符串

在 netbox.netbox 3.7.0 中添加

后端口的标签

name

字符串 / 必需

后端口的名称

positions

整数

可以映射到每个后端口的前端口数量

tags

列表 / elements=任意

后端口可能需要关联的任何标签

type

字符串 / 必需

后端口的类型

选择

  • "8p8c"

  • "110-punch"

  • "bnc"

  • "mrj21"

  • "fc"

  • "lc"

  • "lc-apc"

  • "lsh"

  • "lsh-apc"

  • "mpo"

  • "mtrj"

  • "sc"

  • "sc-apc"

  • "st"

netbox_token

字符串 / 必需

NetBox API 令牌。

netbox_url

字符串 / 必需

NetBox 实例的 URL。

必须可以被 Ansible 控制主机访问。

query_params

列表 / elements=字符串

这可以用于覆盖在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的值，并允许用户控制在其环境中是什么使对象唯一。

在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的值，并允许用户控制在其环境中是什么使对象唯一。

在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的值，并允许用户控制在其环境中是什么使对象唯一。

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 rear port within NetBox with only required information
      netbox.netbox.netbox_rear_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Rear Port
          device: Test Device
          type: bnc
        state: present

    - name: Update rear port with other fields
      netbox.netbox.netbox_rear_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Rear Port
          device: Test Device
          type: bnc
          positions: 5
          description: rear port description
        state: present

    - name: Delete rear port within netbox
      netbox.netbox.netbox_rear_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Rear Port
          device: Test Device
          type: bnc
        state: absent

返回值

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

键

描述

msg

字符串

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

返回： 始终

rear_port

字典

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

返回： 成功 (当 state=present 时)

作者

  • Tobias Groß (@toerb)