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

New in networktocode.nautobot 1.0.0

Synopsis

• Creates, updates or removes console port templates from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Comments
api_version :ansible-option-versionadded:`added in networktocode.nautobot 4.1.0`	API Version Nautobot REST API
device_type :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The device type the console port template is attached to
name :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The name of the console port template
query_params :ansible-option-versionadded:`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	Use present or absent for adding or removing. :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
token	The token created within Nautobot to authorize API access Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured.
type :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	The type of the console port template
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 console port template within Nautobot with only required information
      networktocode.nautobot.console_port_template:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Console Port Template
        device_type: Test Device Type
        state: present

    - name: Update console port template with other fields
      networktocode.nautobot.console_port_template:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Console Port Template
        device_type: Test Device Type
        type: iec-60320-c6
        state: present

    - name: Delete console port template within nautobot
      networktocode.nautobot.console_port_template:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Console Port Template
        device_type: Test Device Type
        state: absent

Return Values

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

Key	Description
console_port_template	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)

Collection links