netbox.netbox.netbox_wireless_lan_group 模块 – 从 NetBox 创建或删除无线 LAN 组

注意

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

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

要安装它,请使用:ansible-galaxy collection install netbox.netbox。您需要进一步的要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:netbox.netbox.netbox_wireless_lan_group

netbox.netbox 3.5.0 中的新功能

概要

  • 从 NetBox 创建或删除无线 LAN 组

要求

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

  • pynetbox

参数

参数

注释

cert

any

证书路径

data

字典 / 必填

定义联系人配置

custom_fields

字典

必须在 NetBox 中存在

description

字符串

无线 LAN 组的描述

name

字符串 / 必填

要创建的无线 LAN 组的名称

parent_wireless_lan_group

any

父无线 LAN 组

slug

字符串

无线 LAN 组的别名

tags

列表 / 元素=any

可能需要与无线 LAN 组关联的任何标签

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 中定义,并为用户提供对其环境中可能使对象唯一的内容的控制。

在 plugins/module_utils/netbox_utils.py 中定义,并为用户提供对其环境中可能使对象唯一的内容的控制。

state

字符串

对象的状态。

选择

  • "present" ← (默认)

  • "absent"

validate_certs

any

如果 no,则不会验证 SSL 证书。

这仅应在个人控制的站点上使用自签名证书。

默认值: true

注释

注意

  • 这应与连接 local 和主机 localhost 一起运行

示例

- name: "Test NetBox module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create Wireless LAN Group within NetBox with only required information
      netbox_wireless_lan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Wireless LAN Group One
        state: present

    - name: Delete Wireless LAN within netbox
      netbox_wireless_lan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Wireless LAN Group One
        state: absent

    - name: Create Wireless LAN Group with all parameters
      netbox_wireless_lan_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Wireless LAN Group One
          description: Wireless LAN Group description
          tags:
            - tagA
            - tagB
            - tagC
        state: present

返回值

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

描述

msg

字符串

指示失败的消息或有关已实现目标的详细信息

返回: 始终

wireless_lan_group

字典

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

返回: 创建时

作者

  • Martin Rødvand (@rodvand)