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

注意

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

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

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

要在剧本中使用它，请指定： netbox.netbox.netbox_contact_group。

netbox.netbox 3.5.0 中的新增功能

概要 

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

要求 

以下要求是在执行此模块的主机上所需的。

pynetbox

参数 

参数	注释
cert 任意	证书路径
data 字典 / 必需	定义联系人组配置
custom_fields 字典	必须存在于 NetBox 中
description 字符串	联系人组的描述
name 字符串 / 必需	要创建的联系人组的名称
parent_contact_group 字符串	父联系人组的slug
slug 字符串	URL 友好的唯一简写
tags 列表 / 元素=任意	联系人组可能需要关联的任何标签
netbox_token 字符串 / 必需	NetBox API 令牌。
netbox_url 字符串 / 必需	NetBox 实例的 URL。必须可被 Ansible 控制主机访问。
query_params 列表 / 元素=字符串	这可以用来覆盖在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的值，并为用户提供对可能使其在环境中唯一的对象的控制。在 plugins/module_utils/netbox_utils.py 中定义，并为用户提供对可能使其在他们环境中唯一化对象的控制。
state 字符串	对象的狀態。选项 `"present"` ← (默认) `"absent"`
validate_certs 任意	如果为 `no`，则不会验证 SSL 证书。这只能在使用自签名证书的个人控制站点上使用。默认值： `true`

备注 

注意

标签应定义为 YAML 列表
这应该使用连接 local 和主机 localhost 来运行

示例 

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

    - name: Delete contact group within netbox
      netbox.netbox.netbox_contact_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Contact Group ABC
        state: absent

返回值 

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

键	描述
contact_group 字典	NetBox 中已创建或已存在的序列化对象返回：创建时
msg 字符串	指示失败或有关已实现内容的信息的消息返回：始终

作者

Martin Rødvand (@rodvand)