netbox.netbox.netbox_cable 模块 – 在 NetBox 中创建、更新或删除电缆

注意

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

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

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

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

netbox.netbox 0.3.0 中的新增功能

概要 

创建、更新或删除 NetBox 中的电缆

要求 

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

pynetbox

参数 

参数	注释
cert 任意	证书路径
data 字典 / 必需	定义电缆配置
color 字符串	电缆的颜色
comments 字符串 netbox.netbox 3.10.0 中添加	与提供商相关的注释
custom_fields 字典 netbox.netbox 3.6.0 中添加	必须存在于 NetBox 中
description 字符串 netbox.netbox 3.10.0 中添加	提供商的描述
label 字符串	电缆的标签
length 浮点数	电缆的长度
length_unit 字符串	测量电缆长度的单位选项 `"m"` `"cm"` `"ft"` `"in"`
status 字符串	电缆的状态选项 `"已连接"` `"已规划"` `"正在退役"`
tags 列表 / 元素=任意	电缆可能需要关联的任何标签
tenant 任意 netbox.netbox 3.14.0 中添加	将分配电缆的租户
termination_a 任意 / 必需	端接 A
termination_a_type 字符串 / 必需	端接 A 的类型选项 `"circuits.circuittermination"` `"dcim.consoleport"` `"dcim.consoleserverport"` `"dcim.frontport"` `"dcim.interface"` `"dcim.powerfeed"` `"dcim.poweroutlet"` `"dcim.powerport"` `"dcim.rearport"`
termination_b 任意 / 必需	端接 B
termination_b_type 字符串 / 必需	端接 B 的类型选项 `"circuits.circuittermination"` `"dcim.consoleport"` `"dcim.consoleserverport"` `"dcim.frontport"` `"dcim.interface"` `"dcim.powerfeed"` `"dcim.poweroutlet"` `"dcim.powerport"` `"dcim.rearport"`
type 字符串	电缆的类型选项 `"cat3"` `"cat5"` `"cat5e"` `"cat6"` `"cat6a"` `"cat7"` `"dac-active"` `"dac-passive"` `"mrj21-trunk"` `"同轴"` `"多模光纤"` `"多模光纤-OM1"` `"多模光纤-OM2"` `"多模光纤-OM3"` `"多模光纤-OM4"` `"单模光纤"` `"单模光纤-OS1"` `"单模光纤-OS2"` `"AOC"` `"电源"`
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 中定义，并为用户提供对在其环境中使对象唯一的内容的控制。对象在其环境中唯一。
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 cable within NetBox with only required information
      netbox.netbox.netbox_cable:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          termination_a_type: dcim.interface
          termination_a:
            device: Test Nexus Child One
            name: Ethernet2/2
          termination_b_type: dcim.interface
          termination_b:
            device: Test Nexus Child One
            name: Ethernet2/1
        state: present

    - name: Update cable with other fields
      netbox.netbox.netbox_cable:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          termination_a_type: dcim.interface
          termination_a:
            device: Test Nexus Child One
            name: Ethernet2/2
          termination_b_type: dcim.interface
          termination_b:
            device: Test Nexus Child One
            name: Ethernet2/1
          type: mmf-om4
          status: planned
          label: label123
          color: abcdef
          length: 30
          length_unit: m
          tags:
            - foo
        state: present

    - name: Delete cable within netbox
      netbox.netbox.netbox_cable:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          termination_a_type: dcim.interface
          termination_a:
            device: Test Nexus Child One
            name: Ethernet2/2
          termination_b_type: dcim.interface
          termination_b:
            device: Test Nexus Child One
            name: Ethernet2/1
        state: absent

返回值 

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

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

作者

Tobias Groß (@toerb)