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.20.0).
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_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 |
---|---|
Certificate path |
|
Defines the console server port template configuration |
|
The device type the console server port template is attached to |
|
The name of the console server port template |
|
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. |
|
If This should only be used on personally controlled sites using a self-signed certificates. :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 hostslocalhost
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 |
---|---|
Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present) |
|
Message indicating failure or info about what has been achieved |