orphan: |
---|
Note
This module is part of the netbox.netbox collection (version 3.17.0).
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 :ref:`Requirements <ansible_collections.netbox.netbox.netbox_prefix_module_requirements>` for details.
To use it in a playbook, specify: netbox.netbox.netbox_prefix
.
.. rst-class:: ansible-version-added
New in netbox.netbox 0.1.0
- Creates or removes prefixes from NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
.. tabularcolumns:: \X{1}{3}\X{2}{3}
Parameter | Comments |
---|---|
Certificate path |
|
Defines the prefix configuration |
|
.. rst-class:: ansible-option-title comments .. ansible-option-type-line:: :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` |
Comments that may include additional information in regards to the prefix |
Must exist in NetBox and in key/value format |
|
The description of the prefix |
|
Specifies which address family the prefix prefix belongs to |
|
All IP Addresses within this prefix are considered usable .. rst-class:: ansible-option-line |
|
Treat as 100% utilized .. rst-class:: ansible-option-line |
|
Required if state is |
|
Required if state is |
|
|
|
The role of the prefix |
|
Site that prefix is associated with |
|
The status of the prefix |
|
Any tags that the prefix may need to be associated with |
|
The tenant that the prefix will be assigned to |
|
The VLAN the prefix will be assigned to |
|
VRF that prefix is associated with |
|
If .. rst-class:: ansible-option-line |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. .. rst-class:: ansible-option-line |
|
If This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
- name: "Test NetBox prefix module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create prefix within NetBox with only required information
netbox.netbox.netbox_prefix:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
prefix: 10.156.0.0/19
state: present
- name: Delete prefix within netbox
netbox.netbox.netbox_prefix:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
prefix: 10.156.0.0/19
state: absent
- name: Create prefix with several specified options
netbox.netbox.netbox_prefix:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
family: 4
prefix: 10.156.32.0/19
site: Test Site
vrf: Test VRF
tenant: Test Tenant
vlan:
name: Test VLAN
site: Test Site
tenant: Test Tenant
vlan_group: Test Vlan Group
status: Reserved
prefix_role: Network of care
description: Test description
is_pool: true
tags:
- Schnozzberry
state: present
- name: Get a new /24 inside 10.156.0.0/19 within NetBox - Parent doesn't exist
netbox.netbox.netbox_prefix:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
parent: 10.156.0.0/19
prefix_length: 24
state: present
first_available: yes
- name: Create prefix within NetBox with only required information
netbox.netbox.netbox_prefix:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
prefix: 10.156.0.0/19
state: present
- name: Get a new /24 inside 10.156.0.0/19 within NetBox
netbox.netbox.netbox_prefix:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
parent: 10.156.0.0/19
prefix_length: 24
state: present
first_available: yes
- name: Get a new /24 inside 10.157.0.0/19 within NetBox with additional values
netbox.netbox.netbox_prefix:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
parent: 10.157.0.0/19
prefix_length: 24
vrf: Test VRF
site: Test Site
state: present
first_available: yes
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. tabularcolumns:: \X{1}{3}\X{2}{3}
Key | Description |
---|---|
Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line |
|
Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` on creation |
- Mikhail Yohman (@FragmentedPacket)
- Anthony Ruhier (@Anthony25)
.. ansible-links:: - title: "Issue Tracker" url: "https://github.com/netbox-community/ansible_modules/issues" external: true - title: "Repository (Sources)" url: "https://github.com/netbox-community/ansible_modules" external: true