networktocode.nautobot.front_port module – Create, update or delete front ports within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 5.3.1).

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 networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: networktocode.nautobot.front_port.

New in networktocode.nautobot 1.0.0

Synopsis

  • Creates, updates or removes front ports from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

API Version Nautobot REST API

Description of the front port

The device the front port is attached to

The name of the front port

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/utils.py and provides control to users on what may make

an object unique in their environment.

The rear_port the front port is attached to

The position of the rear port this front port is connected to

state

Any tags that this item may need to be associated with

token

The token created within Nautobot to authorize API access

Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured.

The type of the front port

url

The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)

Can be omitted if the :ansenvvarref:`NAUTOBOT\_URL` environment variable is configured.

validate_certs

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Can be omitted if the :ansenvvar:`NAUTOBOT\_VALIDATE\_CERTS` environment variable is configured.

: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 Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create front port within Nautobot with only required information
      networktocode.nautobot.front_port:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Front Port
        device: Test Device
        type: bnc
        rear_port: Test Rear Port
        state: present

    - name: Update front port with other fields
      networktocode.nautobot.front_port:
        url: http://nautobot.local
        token: thisIsMyToken
        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 nautobot
      networktocode.nautobot.front_port:
        url: http://nautobot.local
        token: thisIsMyToken
        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

Serialized object as created or already existent within Nautobot

:ansible-option-returned-bold:`Returned:` success (when state=present)

msg

Message indicating failure or info about what has been achieved

:ansible-option-returned-bold:`Returned:` always

Authors

  • Tobias Groß (@toerb)