netbox.netbox.netbox_permission 模块 – 从 NetBox 创建或删除权限

注意

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

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

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

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

netbox.netbox 3.20.0 中的新增功能

概要 

从 NetBox 创建或删除权限

要求 

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

pynetbox

参数 

参数	注释
cert any	证书路径
data dictionary / required	定义权限配置
actions list / elements=any	要创建的权限的操作
constraints dictionary	要创建的权限的约束
description string	要创建的权限的描述
enabled boolean	是否应启用要创建的权限选项 `false` `true`
name string / required	要创建的权限的名称
object_types list / elements=any	要创建的权限的对象类型
netbox_token string / required	NetBox API 令牌。
netbox_url string / required	NetBox 实例的 URL。 Ansible 控制主机必须可以访问它。
query_params list / elements=string	这可以用来覆盖在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中的指定值，并允许用户控制什么可能使对象在其环境中是唯一的。在 plugins/module_utils/netbox_utils.py 中定义，并允许用户控制什么可能使对象在其环境中是唯一的。在 plugins/module_utils/netbox_utils.py 中定义，并允许用户控制什么可能使对象在其环境中是唯一的。
state string	对象的状态。选项 `"present"` ← (默认) `"absent"`
validate_certs any	如果为 `no`，则不会验证 SSL 证书。这应该仅在个人控制的站点上使用自签名证书。默认值： `true`

说明 

注意

标签应定义为 YAML 列表
这应该使用连接 local 和主机 localhost 运行

示例 

- name: "Test NetBox module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create permission within NetBox with only required information
      netbox.netbox.netbox_permission:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: My Permission
          actions:
            - view
          object_types: []
        state: present

    - name: Create user which has the permission
      netbox.netbox.netbox_user:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          username: MyUser
          password: MyPassword
          permissions:
            - My Permission
        state: present

    - name: Create a group which has the permission
      netbox.netbox.netbox_user_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: My Group
          permissions:
            - My Permission
        state: absent

    - name: Delete permission within netbox
      netbox.netbox.netbox_permission:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: My Permission
        state: absent

    - name: Create permission with all parameters
      netbox.netbox.netbox_permission:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: My permission
          description: The permission I made
          enabled: false
          actions:
            - view
            - add
            - change
            - delete
            - extreme_administration
          object_types:
            - vpn.tunneltermination
            - wireless.wirelesslan
          constraints:
            id: 1
        state: present

返回值 

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

键	描述
msg string	指示失败的消息或有关已实现目标的信息返回：始终
permissions dictionary	在 NetBox 中创建或已存在的序列化对象返回：在创建时

作者

Daniel Chiquito (@dchiquito)