Note
This plugin is part of the netbox.netbox collection (version 3.3.0).
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
.
To use it in a playbook, specify: netbox.netbox.netbox_console_server_port
.
New in version 0.2.3: of netbox.netbox
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
cert raw | Certificate path | ||
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=raw | Any tags that the console server port may need to be associated with | ||
type string |
| 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 |
| 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. |
Note
local
and hosts localhost
- 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
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_console_server_port_module.html