netbox.netbox.netbox_front_port_template module – Create, update or delete front port templates within NetBox

Note

This module is part of the netbox.netbox collection (version 3.17.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_front_port_template.

New in netbox.netbox 0.2.3

Synopsis

• Creates, updates or removes front port templates from NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the front port template configuration
description :ansible-option-versionadded:`added in netbox.netbox 3.7.0`	Description of the front port
device_type	The device type the front port template is attached to
label :ansible-option-versionadded:`added in netbox.netbox 3.7.0`	Label of the front port
name	The name of the front port template
rear_port_template	The rear_port_template the front port template is attached to
rear_port_template_position	The position of the rear port template this front port template is connected to
type	The type of the front port template :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"8p8c"` :ansible-option-choices-entry:`"110-punch"` :ansible-option-choices-entry:`"bnc"` :ansible-option-choices-entry:`"mrj21"` :ansible-option-choices-entry:`"fc"` :ansible-option-choices-entry:`"lc"` :ansible-option-choices-entry:`"lc-apc"` :ansible-option-choices-entry:`"lsh"` :ansible-option-choices-entry:`"lsh-apc"` :ansible-option-choices-entry:`"mpo"` :ansible-option-choices-entry:`"mtrj"` :ansible-option-choices-entry:`"sc"` :ansible-option-choices-entry:`"sc-apc"` :ansible-option-choices-entry:`"st"`
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. 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 hosts localhost

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create front port template within NetBox with only required information
      netbox.netbox.netbox_front_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Front Port Template
          device_type: Test Device Type
          type: bnc
          rear_port_template: Test Rear Port Template
        state: present

    - name: Update front port template with other fields
      netbox.netbox.netbox_front_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Front Port Template
          device_type: Test Device Type
          type: bnc
          rear_port_template: Test Rear Port Template
          rear_port_template_position: 5
        state: present

    - name: Delete front port template within netbox
      netbox.netbox.netbox_front_port_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Front Port Template
          device_type: Test Device Type
          type: bnc
          rear_port_template: Test Rear Port Template
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
front_port_template	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Tobias Groß (@toerb)

Collection links