networktocode.nautobot.service module – Creates or removes service from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 3.4.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 networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.service.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates or removes service from Nautobot.

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

custom_fields

dictionary

added in 3.0.0 of networktocode.nautobot

Must exist in Nautobot and in key/value format.

description

string

added in 3.0.0 of networktocode.nautobot

Service description.

device

raw

added in 3.0.0 of networktocode.nautobot

Specifies on which device the service is running.

ipaddresses

raw

added in 3.0.0 of networktocode.nautobot

Specifies which IPaddresses to associate with service.

name

string / required

added in 3.0.0 of networktocode.nautobot

Name of the region to be created.

ports

list / elements=integer

added in 3.0.0 of networktocode.nautobot

Specifies which ports used by service (Nautobot 2.10 and newer).

protocol

raw / required

added in 3.0.0 of networktocode.nautobot

Specifies which protocol used by service.

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/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.

Choices:

  • absent

  • present ← (default)

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

What tags to add/update.

token

string / required

The token created within Nautobot to authorize API access.

url

string / required

URL of the Nautobot instance resolvable by Ansible control host.

validate_certs

raw

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

virtual_machine

raw

added in 3.0.0 of networktocode.nautobot

Specifies on which virtual machine the service is running.

Notes

Note

  • This should be ran with connection local and hosts localhost.

  • The module supports check_mode.

Examples

- name: "Create nautobot service"
  connection: local
  hosts: all
  gather_facts: False

  tasks:
    - name: Create service
      networktocode.nautobot.service:
        url: url
        token: token
        device: Test666
        name: node-exporter
        ports:
          - 9100
        protocol: TCP
        ipaddresses:
          - address: 127.0.0.1
        tags:
          - prometheus
        state: present

- name: "Delete nautobot service"
  connection: local
  hosts: all
  gather_facts: False

  tasks:
    - name: Delete service
      networktocode.nautobot.service:
        url: url
        token: token
        device: Test666
        name: node-exporter
        ports:
          - 9100
        protocol: TCP
        state: absent

Authors

  • Kulakov Ilya (@TawR1024)