netbox.netbox.netbox_rear_port – Create, update or delete rear ports within Netbox

Note

This plugin is part of the netbox.netbox collection (version 3.1.0).

To install it use: ansible-galaxy collection install netbox.netbox.

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

New in version 0.2.3: of netbox.netbox

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 Choices/Defaults Comments
data
dictionary / required
Defines the rear port configuration
description
string
Description of the rear port
device
raw / required
The device the rear port is attached to
name
string / required
The name of the rear port
positions
integer
The number of front ports which may be mapped to each rear port
tags
list / elements=string
Any tags that the rear port may need to be associated with
type
string / required
    Choices:
  • 8p8c
  • 110-punch
  • bnc
  • mrj21
  • fc
  • lc
  • lc-apc
  • lsh
  • lsh-apc
  • mpo
  • mtrj
  • sc
  • sc-apc
  • st
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
    Choices:
  • absent
  • present ←
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.

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Netbox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create rear port within Netbox with only required information
      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_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_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 Returned Description
msg
string
always
Message indicating failure or info about what has been achieved

rear_port
dictionary
success (when state=present)
Serialized object as created or already existent within Netbox



Authors

  • Tobias Groß (@toerb)