netbox.netbox.netbox_front_port – Create, update or delete front ports within Netbox

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

New in version 0.2.3: of netbox.netbox

Synopsis

  • Creates, updates or removes front ports from Netbox

Requirements

The below requirements are needed on the host that executes this module.

  • pynetbox

Parameters

Parameter Choices/Defaults Comments
cert
raw
Certificate path
data
dictionary / required
Defines the front port configuration
description
string
Description of the front port
device
raw / required
The device the front port is attached to
name
string / required
The name of the front port
rear_port
raw / required
The rear_port the front port is attached to
rear_port_position
integer
The position of the rear port this front port is connected to
tags
list / elements=raw
Any tags that the front 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 front 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 front port within Netbox with only required information
      netbox_front_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Front Port
          device: Test Device
          type: bnc
          rear_port: Test Rear Port
        state: present

    - name: Update front port with other fields
      netbox_front_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Front Port
          device: Test Device
          type: bnc
          rear_port: Test Rear Port
          rear_port_position: 5
          description: front port description
        state: present

    - name: Delete front port within netbox
      netbox_front_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Front Port
          device: Test Device
          type: bnc
          rear_port: Test Rear Port
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
front_port
dictionary
success (when state=present)
Serialized object as created or already existent within Netbox
msg
string
always
Message indicating failure or info about what has been achieved


Authors

  • Tobias Groß (@toerb)

© 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_front_port_module.html