networktocode.nautobot.rear_port module – Create, update or delete rear ports within Nautobot

Note

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

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

New in networktocode.nautobot 1.0.0

Synopsis

  • Creates, updates or removes rear ports from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

api_version

string

added in networktocode.nautobot 4.1.0

API Version Nautobot REST API

description

string

added in networktocode.nautobot 3.0.0

Description of the rear port

device

any / required

added in networktocode.nautobot 3.0.0

The device the rear port is attached to

name

string / required

added in networktocode.nautobot 3.0.0

The name of the rear port

positions

integer

added in networktocode.nautobot 3.0.0

The number of front ports which may be mapped to each rear port

query_params

list / elements=string

added in networktocode.nautobot 3.0.0

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.

state

string

Use present or absent for adding or removing.

Choices:

tags

list / elements=any

added in networktocode.nautobot 3.0.0

Any tags that this item may need to be associated with

token

string / required

The token created within Nautobot to authorize API access

type

string / required

added in networktocode.nautobot 3.0.0

The type of the rear port

Choices:

url

string / required

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

validate_certs

any

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

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 rear port within Nautobot with only required information
      networktocode.nautobot.rear_port:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Rear Port
        device: Test Device
        type: bnc
        state: present

    - name: Update rear port with other fields
      networktocode.nautobot.rear_port:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Rear Port
        device: Test Device
        type: bnc
        positions: 5
        description: rear port description
        state: present

    - name: Delete rear port within nautobot
      networktocode.nautobot.rear_port:
        url: http://nautobot.local
        token: thisIsMyToken
        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

string

Message indicating failure or info about what has been achieved

Returned: always

rear_port

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

Authors

  • Tobias Groß (@toerb)