netbox.netbox.netbox_rack_role 模块 – 在 NetBox 中创建、更新或删除机架角色

注意

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

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

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

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

netbox.netbox 0.1.0 中的新增功能

概要 

创建、更新或删除 NetBox 中的机架角色

要求 

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

pynetbox

参数 

参数	注释
cert 任意	证书路径
data 字典 / 必需	定义机架角色配置
color 字符串	十六进制颜色代码，例如 FFFFFF
custom_fields 字典 netbox.netbox 3.6.0 中新增	必须存在于 NetBox 中
description 字符串 netbox.netbox 3.17.0 中新增	机架角色的描述
name 字符串 / 必需	机架角色的名称
slug 字符串	名称的slug化版本或自定义slug。如果未提供，则会根据 NetBox 规则自动生成。
tags 列表 / 元素=任意 netbox.netbox 3.6.0 中新增	要添加/更新的标签
netbox_token 字符串 / 必需	NetBox API 令牌。
netbox_url 字符串 / 必需	NetBox 实例的 URL。 Ansible 控制主机必须可以访问。
query_params 列表 / 元素=字符串	这可以用来覆盖在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的 value，并为用户提供对在其环境中使对象唯一的内容的控制。在插件/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的 value，并为用户提供对在其环境中使对象唯一的内容的控制。在插件/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中指定的 value，并为用户提供对在其环境中使对象唯一的内容的控制。
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 rack role within NetBox with only required information
      netbox.netbox.netbox_rack_role:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test rack role
          color: FFFFFF
        state: present

    - name: Create rack role within NetBox with a description
      netbox.netbox.netbox_rack_role:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test rack role
          color: FFFFFF
          description: This is a test rack role
        state: present

    - name: Delete rack role within netbox
      netbox.netbox.netbox_rack_role:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Rack role
        state: absent

返回值 

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

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

作者

Mikhail Yohman (@FragmentedPacket)