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).

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
cert	Certificate path
data	Defines the rear port configuration
description	Description of the rear port
device	The device the rear port is attached to
label :ansible-option-versionadded:`added in netbox.netbox 3.7.0`	Label of the rear port
name	The name of the rear port
positions	The number of front ports which may be mapped to each rear port
tags	Any tags that the rear port may need to be associated with
type	The type of the rear port :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"8p8c"` :ansible-option-choices-entry:`"110-punch"` :ansible-option-choices-entry:`"bnc"` :ansible-option-choices-entry:`"mrj21"` :ansible-option-choices-entry:`"fc"` :ansible-option-choices-entry:`"lc"` :ansible-option-choices-entry:`"lc-apc"` :ansible-option-choices-entry:`"lsh"` :ansible-option-choices-entry:`"lsh-apc"` :ansible-option-choices-entry:`"mpo"` :ansible-option-choices-entry:`"mtrj"` :ansible-option-choices-entry:`"sc"` :ansible-option-choices-entry:`"sc-apc"` :ansible-option-choices-entry:`"st"`
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`Default:` :ansible-option-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 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
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always
rear_port	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)

Authors

• Tobias Groß (@toerb)

Collection links