PARALLAX

netbox_console_server_port

Create, update or delete console server ports within NetBox

Collection: netbox.netbox

Full Name: netbox.netbox.netbox_console_server_port

Synopsis

Create, update or delete console server ports within NetBox

Parameters

NameTypeRequiredDefaultDescription
certrawCertificate path
datadictyesDefines the console server port configuration
headersdictDictionary of headers to be passed to the NetBox API.
netbox_tokenstringyesThe NetBox API token.
netbox_urlstringyesThe URL of the NetBox instance.
Must be accessible by the Ansible control host.
query_paramslistThis 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.
statestringpresentThe state of the object.
validate_certsrawtrueIf C(no), SSL certificates will not be validated.
This should only be used on personally controlled sites using a self-signed certificates.

Example

yaml
- 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
Search
    ↑ ↓ move↵ openesc close