Docs4dev
Docs
ansible / 2.11 / collections / netbox / netbox / netbox_console_server_port_module.html

netbox.netbox.netbox_console_server_port – Create, update or delete console server ports within Netbox

Note

This plugin is part of the netbox.netbox collection (version 2.0.0).

To install it use: ansible-galaxy collection install netbox.netbox.

To use it in a playbook, specify: netbox.netbox.netbox_console_server_port.

New in version 0.2.3: of netbox.netbox

Synopsis

  • Creates, updates or removes console server ports from Netbox

Requirements

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

  • pynetbox

Parameters

Parameter Choices/Defaults Comments
data
dictionary / required
Defines the console server port configuration
description
string
Description of the console server port
device
raw / required
The device the console server port is attached to
name
string / required
The name of the console server port
tags
list / elements=string
Any tags that the console server port may need to be associated with
type
string
    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
The type of the console server port
netbox_token
string / required
The token created within Netbox to authorize API access
netbox_url
string / required
URL of the Netbox instance resolvable by Ansible control host
query_params
list / elements=string
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
in plugins/module_utils/netbox_utils.py and provides control to users on what may make
an object unique in their environment.
state
string
    Choices:
  • absent
  • present ←
Use present or absent for adding or removing.
validate_certs
raw
Default:
"yes"
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Notes

Note

  • Tags should be defined as a YAML list
  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Netbox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create console server port within Netbox with only required information
      netbox_console_server_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Console Server Port
          device: Test Device
        state: present

    - name: Update console server port with other fields
      netbox_console_server_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Console Server Port
          device: Test Device
          type: usb-a
          description: console server port description
        state: present

    - name: Delete console server port within netbox
      netbox_console_server_port:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Console Server Port
          device: Test Device
        state: absent

Return Values

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

Key Returned Description
console_server_port
dictionary
success (when state=present)
Serialized object as created or already existent within Netbox

msg
string
always
Message indicating failure or info about what has been achieved



Authors

  • Tobias Groß (@toerb)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netbox/netbox/netbox_console_server_port_module.html