netbox.netbox.netbox_rear_port module – Create, update or delete rear ports within 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_rear_port
.
New in netbox.netbox 0.2.3
Synopsis
Creates, updates or removes rear ports from NetBox
Requirements
The below requirements are needed on the host that executes this module.
pynetbox
Parameters
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the rear port configuration |
|
Description of the rear port |
|
The device the rear port is attached to |
|
Label of the rear port |
|
The name of the rear port |
|
The number of front ports which may be mapped to each rear port |
|
Any tags that the rear port may need to be associated with |
|
The type of the rear port Choices:
|
|
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. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: false
tasks:
- name: Create rear port within NetBox with only required information
netbox.netbox.netbox_rear_port:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Rear Port
device: Test Device
type: bnc
state: present
- name: Update rear port with other fields
netbox.netbox.netbox_rear_port:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Rear Port
device: Test Device
type: bnc
positions: 5
description: rear port description
state: present
- name: Delete rear port within netbox
netbox.netbox.netbox_rear_port:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Rear Port
device: Test Device
type: bnc
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Message indicating failure or info about what has been achieved Returned: always |
|
Serialized object as created or already existent within NetBox Returned: success (when state=present) |