netbox_console_server_port_module.rst

orphan

netbox.netbox.netbox_console_server_port module -- Create, update or delete console server ports within NetBox

Note

This module is part of the netbox.netbox collection (version 3.9.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see Requirements <ansible_collections.netbox.netbox.netbox_console_server_port_module_requirements> for details.

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

netbox.netbox 0.2.3

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

ansible-option-table

Parameter	Comments
ansible-option-title cert ansible-option-type-line any	Certificate path
ansible-option-title data ansible-option-type-line dictionary / required	Defines the console server port configuration
ansible-option-title cable ansible-option-type-line dictionary added in netbox.netbox 3.9.0	cable to attach port to. Must exist.
ansible-option-title custom_fields ansible-option-type-line dictionary added in netbox.netbox 3.9.0	must exist in netbox
ansible-option-title description ansible-option-type-line string	Description of the console server port
ansible-option-title device ansible-option-type-line any / required	The device the console server port is attached to
ansible-option-title label ansible-option-type-line string added in netbox.netbox 3.9.0	label of the conserver server port
ansible-option-title mark_connected ansible-option-type-line boolean added in netbox.netbox 3.9.0	Treats as if a cable is connected to the port ansible-option-line Choices: false true
ansible-option-title name ansible-option-type-line string / required	The name of the console server port
ansible-option-title speed ansible-option-type-line integer added in netbox.netbox 3.9.0	sets the port speed
ansible-option-title tags ansible-option-type-line list / elements=any	Any tags that the console server port may need to be associated with
ansible-option-title type ansible-option-type-line string	The type of the console server port ansible-option-line Choices: de-9 db-25 rj-11 rj-12 rj-45 mini-din-8 usb-a usb-b usb-c usb-mini-a usb-mini-b usb-micro-a usb-micro-b usb-micro-ab other
ansible-option-title netbox_token ansible-option-type-line string / required	The NetBox API token.
ansible-option-title netbox_url ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
ansible-option-title query_params ansible-option-type-line list / elements=string	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
ansible-option-title state ansible-option-type-line string	The state of the object. ansible-option-line Choices: present ← (default) absent
ansible-option-title validate_certs ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. ansible-option-line 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 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
          speed: 11500
          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 <common_return_values>, the following are the fields unique to this module:

ansible-option-table

Key	Description
ansible-option-title console_server_port ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox ansible-option-line Returned: success (when state=present)
ansible-option-title msg ansible-option-type-line string	Message indicating failure or info about what has been achieved ansible-option-line Returned: always

Authors

• Tobias Groß (@toerb)

Collection links

Issue Tracker Repository (Sources)