netbox.netbox.netbox_front_port module – Create, update or delete front 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_front_port.

New in netbox.netbox 0.2.3

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	Comments
cert any	Certificate path
data dictionary / required	Defines the front port configuration
description string	Description of the front port
device any / required	The device the front port is attached to
label string added in netbox.netbox 3.7.0	Label of the front port
name string / required	The name of the front port
rear_port any / 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=any	Any tags that the front port may need to be associated with
type string / required	The type of the front port Choices: "8p8c" "110-punch" "bnc" "mrj21" "fc" "lc" "lc-apc" "lsh" "lsh-apc" "mpo" "mtrj" "sc" "sc-apc" "st"
netbox_token string / required	The NetBox API token.
netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string	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 string	The state of the object. Choices: "present" ← (default) "absent"
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. 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 front port within NetBox with only required information
      netbox.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: present

    - name: Update front port with other fields
      netbox.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
          rear_port_position: 5
          description: front port description
        state: present

    - name: Delete front port within netbox
      netbox.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	Description
front_port dictionary	Serialized object as created or already existent within NetBox Returned: success (when state=present)
msg string	Message indicating failure or info about what has been achieved Returned: always

Authors

• Tobias Groß (@toerb)

Collection links

• Issue Tracker
• Repository (Sources)