netbox.netbox.netbox_wireless_lan 模块 – 从 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。

netbox.netbox 3.5.0 中的新增功能

概要

  • 从 NetBox 创建或删除无线 LAN

要求

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

  • pynetbox

参数

参数

注释

cert

任何

证书路径

data

字典 / 必需

定义联系人配置

auth_cipher

字符串

无线 LAN 的身份验证密码

选择

  • "auto"

  • "tkip"

  • "aes"

auth_psk

字符串

无线 LAN 的 PSK

auth_type

字符串

无线 LAN 的身份验证类型

选择

  • "open"

  • "wep"

  • "wpa-personal"

  • "wpa-enterprise"

comments

字符串

在 netbox.netbox 3.10.0 中添加

无线 LAN 的注释

custom_fields

字典

必须在 NetBox 中存在

description

字符串

无线 LAN 的描述

ssid

字符串 / 必需

要创建的 SSID 的名称

status

任何

无线 LAN 的状态

tags

列表 / elements=any

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

vlan

任何

无线 LAN 的 VLAN

wireless_lan_group

任何

无线 LAN 组

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 中定义，并为用户提供控制权，以决定什么可以使其环境中的对象唯一。

一个对象在其环境中是唯一的。

state

字符串

对象的状态。

选择

  • "present" ← (默认)

  • "absent"

validate_certs

任何

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

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

默认值： true

说明

注意

  • 应该使用连接 local 和主机 localhost 运行此操作

示例

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

    - name: Delete Wireless LAN within netbox
      netbox_wireless_lan:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          ssid: Wireless Network One
        state: absent

    - name: Create Wireless LAN with all parameters
      netbox_wireless_lan:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          ssid: Wireless Network One
          description: Cool Wireless Network
          auth_type: wpa-enterprise
          auth_cipher: aes
          auth_psk: psk123456
          tags:
            - tagA
            - tagB
            - tagC
        state: present

返回值

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

键

描述

msg

字符串

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

返回： 总是

wireless_lan

字典

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

返回： 在创建时

作者

  • Martin Rødvand (@rodvand)