netbox.netbox.netbox_console_server_port_template module – Create, update or delete console server port templates within NetBox

Note

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

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

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

New in netbox.netbox 0.2.3

Synopsis

• Creates, updates or removes console server port templates from NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert any	Certificate path
data dictionary / required	Defines the console server port template configuration
device_type any / required	The device type the console server port template is attached to
name string / required	The name of the console server port template
type string	The type of the console server port template Choices: :ansible-option-choices-entry:`"de-9"` :ansible-option-choices-entry:`"db-25"` :ansible-option-choices-entry:`"rj-11"` :ansible-option-choices-entry:`"rj-12"` :ansible-option-choices-entry:`"rj-45"` :ansible-option-choices-entry:`"usb-a"` :ansible-option-choices-entry:`"usb-b"` :ansible-option-choices-entry:`"usb-c"` :ansible-option-choices-entry:`"usb-mini-a"` :ansible-option-choices-entry:`"usb-mini-b"` :ansible-option-choices-entry:`"usb-micro-a"` :ansible-option-choices-entry:`"usb-micro-b"` :ansible-option-choices-entry:`"other"`
netbox_token string / required	The NetBox API token.
netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params 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.
state string	The state of the object. Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a 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 NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create console server port template within NetBox with only required information
      netbox.netbox.netbox_console_server_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Console Server Port Template
          device_type: Test Device Type
        state: present

    - name: Update console server port template with other fields
      netbox.netbox.netbox_console_server_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Console Server Port Template
          device_type: Test Device Type
          type: iec-60320-c6
        state: present

    - name: Delete console server port template within netbox
      netbox.netbox.netbox_console_server_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Console Server 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_server_port_template dictionary	Serialized object as created or already existent within NetBox 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)