W3cubDocs

/Ansible

netbox.netbox.netbox_service_template module – Create, update or delete service templates within NetBox

Note

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

New in netbox.netbox 3.10.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Creates, updates or removes service templates from NetBox

Requirements

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

pynetbox

Parameters

Parameter	Comments
cert any	Certificate path
data dictionary / required	Defines the service template configuration
comments string	Comments
custom_fields dictionary	Must exist in NetBox and in key/value format
description string	Description of the service template
name string / required	The name of the service template
ports list / elements=integer	The ports attached to the service template
protocol string	The protocol Choices: `"tcp"` `"udp"` `"sctp"`
tags list / elements=any	Any tags that the service template may need to be associated with
netbox_token string / required	The NetBox API token.
netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string	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 string	The state of the object. Choices: `"present"` ← (default) `"absent"`
validate_certs any	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. 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 service template within NetBox with only required information
      netbox.netbox.netbox_service_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: SSH
          ports:
            - 22
          protocol: tcp
        state: present

    - name: Update service template with other fields
      netbox.netbox.netbox_service_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: SSH
          ports:
            - 22
          protocol: tcp
          description: SSH service template
        state: present

    - name: Delete service template within netbox
      netbox.netbox.netbox_service_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: SSH
        state: absent

Return Values

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

Key	Description
msg string	Message indicating failure or info about what has been achieved Returned: always
service_template dictionary	Serialized object as created or already existent within NetBox Returned: success (when state=present)

Authors

Martin Rødvand (@rodvand)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_service_template_module.html