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

Note

This module is part of the networktocode.nautobot collection (version 5.0.1).

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

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

New in networktocode.nautobot 1.0.0

Synopsis

• Creates or removes service from Nautobot.

Requirements

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

• pynautobot

Parameters

Parameter	Comments
api_version string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
custom_fields dictionary added in networktocode.nautobot 3.0.0	Must exist in Nautobot and in key/value format
description string added in networktocode.nautobot 3.0.0	Service description.
device any added in networktocode.nautobot 3.0.0	Specifies on which device the service is running.
ip_addresses any added in networktocode.nautobot 3.0.0	Specifies which IPaddresses to associate with service.
name string / required added in networktocode.nautobot 3.0.0	Name of the region to be created.
ports list / elements=integer added in networktocode.nautobot 3.0.0	Specifies which ports used by service (Nautobot 2.10 and newer).
protocol any / required added in networktocode.nautobot 3.0.0	Specifies which protocol used by service.
query_params list / elements=string added in networktocode.nautobot 3.0.0	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: :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` ← (default)
tags list / elements=any added in networktocode.nautobot 3.0.0	Any tags that this item may need to be associated with
token string / required	The token created within Nautobot to authorize API access
url string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Default: :ansible-option-default:`true`
virtual_machine any added in networktocode.nautobot 3.0.0	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
        ip_addresses:
          - 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)

Collection links

Issue Tracker Repository (Sources)