netbox.netbox.netbox_tenant 模块 – 在 NetBox 中创建或删除租户

注意

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

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

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

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

netbox.netbox 0.1.0 中的新增功能

概要 

在 NetBox 中创建或删除租户

需求 

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

pynetbox

参数 

参数	注释
cert 任意	证书路径
data 字典 / 必需	定义租户配置
comments 字符串	租户的注释。可以使用 Markdown 语法
custom_fields 字典	必须存在于 NetBox 中
description 字符串	租户的描述
name 字符串 / 必需	要创建的租户的名称
slug 字符串	友好的 URL 唯一简写
tags 列表 / 元素=任意	租户可能需要关联的任何标签
tenant_group 任意	此租户所属的租户组
netbox_token 字符串 / 必需	NetBox API 令牌。
netbox_url 字符串 / 必需	NetBox 实例的 URL。必须可被 Ansible 控制主机访问。
query_params 列表 / 元素=字符串	这可用于覆盖在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的参数值，并为用户提供对在其环境中使对象唯一的方法的控制。在插件/module_utils/netbox_utils.py 中定义，并为用户提供对在其环境中使对象唯一的方法的控制。使对象在其环境中唯一。
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 tenant within NetBox with only required information
      netbox_tenant:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Tenant ABC
        state: present

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

    - name: Create tenant with all parameters
      netbox_tenant:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Tenant ABC
          tenant_group: Very Special Tenants
          description: ABC Incorporated
          comments: '### This tenant is super cool'
          slug: tenant_abc
          tags:
            - tagA
            - tagB
            - tagC
        state: present

返回值 

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

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

作者

Amy Liebowitz (@amylieb)