networktocode.nautobot.console_port module – Create, update or delete console ports within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 4.1.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 version 1.0.0: of networktocode.nautobot

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 4.1.0 of networktocode.nautobot	API Version Nautobot REST API
description string added in 3.0.0 of networktocode.nautobot	Description of the console port
device any / required added in 3.0.0 of networktocode.nautobot	The device the console port is attached to
name string / required added in 3.0.0 of networktocode.nautobot	The name of the console port
query_params list / elements=string added in 3.0.0 of networktocode.nautobot	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: absent present ← (default)
tags list / elements=any added in 3.0.0 of networktocode.nautobot	Any tags that the console port may need to be associated with
token string / required	The token created within Nautobot to authorize API access
type string added in 3.0.0 of networktocode.nautobot	The type of the console port Choices: de-9 db-25 rj-11 rj-12 rj-45 usb-a usb-b usb-c usb-mini-a usb-mini-b usb-micro-a usb-micro-b other
url string / required	URL of the Nautobot instance resolvable by Ansible control host
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: “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)

Collection links

Issue Tracker Repository (Sources)