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.19.1).
You might already have this collection installed if you are using the ansible
package.
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 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
.
New in 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
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the console server port configuration |
|
cable to attach port to. Must exist. |
|
must exist in netbox |
|
Description of the console server port |
|
The device the console server port is attached to |
|
label of the conserver server port |
|
Treats as if a cable is connected to the port Choices:
|
|
The name of the console server port |
|
sets the port speed |
|
Any tags that the console server port may need to be associated with |
|
The type of the console server port Choices:
|
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
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.netbox.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.netbox.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.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 |
Description |
---|---|
Serialized object as created or already existent within NetBox Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved Returned: always |