netbox.netbox.netbox_permission module – Creates or removes permissions from NetBox

Note

This module is part of the netbox.netbox collection (version 3.20.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netbox.netbox.netbox_permission.

New in netbox.netbox 3.20.0

Synopsis

• Creates or removes permissions from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

Parameter	Comments
cert any	Certificate path
data dictionary / required	Defines the permission configuration
actions list / elements=any	The actions of the permission to be created
constraints dictionary	The constraints of the permission to be created
description string	Description of the permission to be created
enabled boolean	Whether or not the permission to be created should be enabled Choices: false true
name string / required	Name of the permission to be created
object_types list / elements=any	The object types of the permission to be created
netbox_token string / required	The NetBox API token.
netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
state string	The state of the object. Choices: "present" ← (default) "absent"
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. Default: true

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
msg string	Message indicating failure or info about what has been achieved Returned: always
permissions dictionary	Serialized object as created or already existent within NetBox Returned: on creation

Authors

• Daniel Chiquito (@dchiquito)

Collection links

• Issue Tracker
• Repository (Sources)