netbox_service_module.rst

orphan:

netbox.netbox.netbox_service module -- Creates or removes service from NetBox

Note

This module is part of the netbox.netbox collection (version 3.17.0).

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 netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_service_module_requirements>` for details.

To use it in a playbook, specify: netbox.netbox.netbox_service.

.. rst-class:: ansible-version-added

New in netbox.netbox 0.1.5

• Synopsis
• Requirements
• Parameters
• Notes
• Examples

Synopsis

• Creates or removes service from NetBox

Requirements

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

• pynetbox

Parameters

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Parameter	Comments
.. rst-class:: ansible-option-title cert .. ansible-option-type-line:: :ansible-option-type:`any`	Certificate path
.. rst-class:: ansible-option-title data .. ansible-option-type-line:: :ansible-option-type:`dictionary` / :ansible-option-required:`required`	Defines the service configuration
.. rst-class:: ansible-option-title comments .. ansible-option-type-line:: :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Comments that may include additional information in regards to the service
.. rst-class:: ansible-option-title custom_fields .. ansible-option-type-line:: :ansible-option-type:`dictionary`	Must exist in NetBox and in key/value format
.. rst-class:: ansible-option-title description .. ansible-option-type-line:: :ansible-option-type:`string`	Service description
.. rst-class:: ansible-option-title device .. ansible-option-type-line:: :ansible-option-type:`any`	Specifies on which device the service is running
.. rst-class:: ansible-option-title ipaddresses .. ansible-option-type-line:: :ansible-option-type:`any`	Specifies which IPaddresses to associate with service.
.. rst-class:: ansible-option-title name .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required`	Name of the region to be created
.. rst-class:: ansible-option-title port .. ansible-option-type-line:: :ansible-option-type:`integer`	Specifies which port used by service
.. rst-class:: ansible-option-title ports .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=integer`	Specifies which ports used by service (NetBox 2.10 and newer)
.. rst-class:: ansible-option-title protocol .. ansible-option-type-line:: :ansible-option-type:`any` / :ansible-option-required:`required`	Specifies which protocol used by service
.. rst-class:: ansible-option-title tags .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=any`	What tags to add/update
.. rst-class:: ansible-option-title virtual_machine .. ansible-option-type-line:: :ansible-option-type:`any`	Specifies on which virtual machine the service is running
.. rst-class:: ansible-option-title netbox_token .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required`	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required`	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`	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.
.. rst-class:: ansible-option-title state .. ansible-option-type-line:: :ansible-option-type:`string`	The state of the object. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. ansible-option-type-line:: :ansible-option-type:`any`	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Notes

Note

• This should be ran with connection local and hosts localhost

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

Authors

• Kulakov Ilya (@TawR1024)

Collection links

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/netbox-community/ansible_modules/issues"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/netbox-community/ansible_modules"
    external: true