netbox.netbox.netbox_contact 模块 – 在 NetBox 中创建或删除联系人

注意

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

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

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

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

netbox.netbox 3.5.0 中的新增功能

概要

  • 在 NetBox 中创建或删除联系人

需求

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

  • pynetbox

参数

参数

注释

cert

任意

证书路径

data

字典 / 必需

定义联系人配置

address

字符串

联系人的地址

comments

字符串

联系人的注释

contact_group

任意

联系人的分组分配

custom_fields

字典

必须存在于 NetBox 中

description

字符串

netbox.netbox 3.10.0 中新增

联系人的描述

email

字符串

联系人的电子邮件

字符串

netbox.netbox 3.7.0 中新增

与联系人关联的 URL

name

字符串 / 必需

要创建的联系人的名称

phone

字符串

联系人的电话号码

tags

列表 / 元素=任意

联系人可能需要关联的任何标签

title

字符串

联系人的职位

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

字符串

对象的 state。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

任意

如果为 no，则不会验证 SSL 证书。

这应该只用于使用自签名证书的个人控制站点。

默认值： true

备注

注意

  • 标签应定义为 YAML 列表

  • 这应该使用连接 local 和主机 localhost 运行

示例

- name: "Test NetBox module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create contact within NetBox with only required information
      netbox.netbox.netbox_contact:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Contact One
        state: present

    - name: Delete contact within netbox
      netbox.netbox.netbox_contact:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Contact One
        state: absent

    - name: Create contact with all parameters
      netbox.netbox.netbox_contact:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: contact ABC
          title: Mr Contact
          phone: 123456789
          email: [email protected]
          tags:
            - tagA
            - tagB
            - tagC
        state: present

返回值

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

键

描述

contact

字典

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

返回：创建时

msg

字符串

指示失败的消息或关于已完成工作的的信息

返回：始终

作者

  • Martin Rødvand (@rodvand)