networktocode.nautobot.console_port module – Create, update or delete console 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.console_port.

New in networktocode.nautobot 1.0.0

Synopsis

  • Creates, updates or removes console 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 console port

device

any / required

added in networktocode.nautobot 3.0.0

The device the console port is attached to

name

string / required

added in networktocode.nautobot 3.0.0

The name of the console 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

added in networktocode.nautobot 3.0.0

The type of the console 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 console port within Nautobot with only required information
      networktocode.nautobot.console_port:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Console Port
        device: Test Device
        state: present

    - name: Update console port with other fields
      networktocode.nautobot.console_port:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Console Port
        device: Test Device
        type: usb-a
        description: console port description
        state: present

    - name: Delete console port within nautobot
      networktocode.nautobot.console_port:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Console Port
        device: Test Device
        state: absent

Return Values

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

Key

Description

console_port

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Tobias Groß (@toerb)