netbox.netbox.netbox_token 模块 – 在 NetBox 中创建或删除令牌

注意

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

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

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

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

netbox.netbox 3.20.0 中的新增功能

概要

  • 在 NetBox 中创建或删除令牌

要求

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

  • pynetbox

参数

参数

注释

cert

任意

证书路径

data

字典 / 必需

定义令牌配置

description

字符串

要创建的令牌的描述

expires

字符串

要创建的令牌的过期时间

key

字符串 / 必需

要创建的令牌的密钥。必须正好是 40 个字符

user

字符串

要创建的令牌所属的用户

write_enabled

布尔值

要创建的令牌是否允许写入操作

选项

  • false

  • true

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 module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create user to own the token
      netbox.netbox.netbox_user:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          username: MyUser
          password: MyPassword
        state: present

    - name: Create token within NetBox with only required information
      netbox.netbox.netbox_token:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          user: TestUser
          key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        state: present

    - name: Delete token within netbox
      netbox.netbox.netbox_token:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        state: absent

    - name: Create token with all parameters
      netbox.netbox.netbox_token:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          user: TestUser
          key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
          description: The test token
          write_enabled: false
          expires: 2024-08-26T14:49:01.345000+00:00
        state: present

返回值

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

键

描述

msg

字符串

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

返回：始终

token

字典

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

返回：创建时

作者

  • Daniel Chiquito (@dchiquito)