service¶

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

Added in version 1.0.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

Creates or removes service from Nautobot.

Requirements¶

The following Python packages are needed on the host that executes this module:

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
description str		Service description. Version Added: 3.0.0
device raw		Specifies on which device the service is running. Version Added: 3.0.0
ip_addresses raw		Specifies which IPaddresses to associate with service. Version Added: 3.0.0
name str required		Name of the region to be created. Version Added: 3.0.0
ports list / elements=int		Specifies which ports used by service (Nautobot 2.10 and newer). Version Added: 3.0.0
protocol raw required		Specifies which protocol used by service. Version Added: 3.0.0
query_params list / elements=str		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. Version Added: 3.0.0
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url str required		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs raw	Default: True	If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.
virtual_machine raw		Specifies on which virtual machine the service is running. Version Added: 3.0.0

Notes¶

Note

This should be ran with connection C(local) and hosts C(localhost).
The module supports C(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)