Note
This plugin is part of the netbox.netbox collection (version 3.3.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
.
To use it in a playbook, specify: netbox.netbox.netbox_rear_port_template
.
New in version 0.2.3: of netbox.netbox
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
cert raw | Certificate path | ||
data dictionary / required | Defines the rear port template configuration | ||
device_type raw / required | The device type the rear port template is attached to | ||
name string / required | The name of the rear port template | ||
positions integer | The number of front ports which may be mapped to each rear port | ||
type string |
| The type of the rear port | |
netbox_token string / required | The token created within Netbox to authorize API access | ||
netbox_url string / required | URL of the Netbox instance resolvable by Ansible control host | ||
query_params list / elements=string | This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is 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 |
| Use present or absent for adding or removing. | |
validate_certs raw | Default: "yes" | If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Note
local
and hosts localhost
- name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create rear port template within Netbox with only required information netbox_rear_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port Template device_type: Test Device Type type: bnc state: present - name: Update rear port template with other fields netbox_rear_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port Template device_type: Test Device Type type: bnc positions: 5 state: present - name: Delete rear port template within netbox netbox_rear_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port Template device_type: Test Device Type type: bnc state: absent
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg string | always | Message indicating failure or info about what has been achieved |
rear_port_template dictionary | success (when state=present) | Serialized object as created or already existent within Netbox |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_rear_port_template_module.html