netbox.netbox.netbox_service module – Creates or removes service from NetBox¶
Note
This module is part of the netbox.netbox collection (version 3.8.1).
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
.
New in netbox.netbox 0.1.5
Synopsis¶
Creates or removes service from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the service configuration |
|
Comments that may include additional information in regards to the service |
|
Must exist in NetBox 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 port used by service |
|
Specifies which ports used by service (NetBox 2.10 and newer) |
|
Specifies which protocol used by service |
|
What tags to add/update |
|
Specifies on which virtual machine the service is running |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. Choices: |
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: :ansible-option-default:`true` |
Notes¶
Note
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Create netbox service"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create service
netbox.netbox.netbox_service:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
device: Test666
name: node-exporter
port: 9100
protocol: TCP
ipaddresses:
- address: 127.0.0.1
tags:
- prometheus
state: present
- name: Delete service
netbox.netbox.netbox_service:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
device: Test666
name: node-exporter
port: 9100
protocol: TCP
state: absent