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 Nautobot REST API |
|
Must exist in Nautobot and in key/value format |
|
Service description. |
|
Specifies on which device the service is running. |
|
Specifies which IPaddresses to associate with service. |
|
Name of the region to be created. |
|
Specifies which ports used by service (Nautobot 2.10 and newer). |
|
Specifies which protocol used by service. |
|
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. |
|
Use Choices: |
|
Any tags that this item may need to be associated with |
|
The token created within Nautobot to authorize API access |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) |
|
If Default: :ansible-option-default:`true` |
|
Specifies on which virtual machine the service is running. |
Notes
Note
This should be ran with connection
local
and hostslocalhost
.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