netbox.netbox.netbox_tenant_group 模块 – 从 NetBox 创建或删除租户组

注意

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

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

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

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

netbox.netbox 0.1.0 中的新增功能

概要 

从 NetBox 创建或删除租户组

要求 

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

pynetbox

参数 

参数	注释
cert 任意	证书路径
data 字典 / 必需	定义租户组配置
custom_fields 字典在 netbox.netbox 3.6.0 中添加	必须存在于 NetBox 中
description 字符串	租户组的描述
name 字符串 / 必需	要创建的租户组的名称
parent_tenant_group 字符串	父租户组的 Slug
slug 字符串	URL 友好的唯一简写
tags 列表 / elements=any 在 netbox.netbox 3.6.0 中添加	要添加/更新的标签
netbox_token 字符串 / 必需	NetBox API 令牌。
netbox_url 字符串 / 必需	NetBox 实例的 URL。 Ansible 控制主机必须可以访问。
query_params 列表 / elements=string	这可以用来覆盖 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中的指定值，并允许用户控制哪些内容在其环境中可以使对象唯一。在 plugins/module_utils/netbox_utils.py 中定义，并为用户提供控制权，以确定在其环境中哪些内容可以使对象唯一。在 plugins/module_utils/netbox_utils.py 中定义，并为用户提供控制权，以确定在其环境中哪些内容可以使对象唯一。
state 字符串	对象的状态。选项 `"present"` ← (默认) `"absent"`
validate_certs 任意	如果为 `no`，则不会验证 SSL 证书。这应该只在个人控制的使用自签名证书的站点上使用。默认值： `true`

注释 

注意

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

示例 

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

    - name: Delete tenant within netbox
      netbox_tenant_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Tenant ABC
        state: absent

返回值 

常见的返回值在此处进行了文档记录，以下是此模块特有的字段

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

作者

Mikhail Yohman (@FragmentedPacket)