netbox.netbox.netbox_data_source module – Creates or removes data sources from NetBox

Note

This module is part of the netbox.netbox collection (version 3.22.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 Requirements for details.

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

New in netbox.netbox 3.22.0

Synopsis

• Creates or removes data sources from NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the data source configuration
comments	Comments about the data source
description	Description of the data source
enabled	Whether or not this data source can be synced :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
ignore_rules	Patterns (one per line) matching files to ignore when syncing
name	Name of the data source
source_url	URL of the data source to be created
sync_interval	The interval in seconds between syncs :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`1` :ansible-option-choices-entry:`60` :ansible-option-choices-entry:`720` :ansible-option-choices-entry:`1440` :ansible-option-choices-entry:`10080` :ansible-option-choices-entry:`43200`
type	The origin of the data source :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"local"` :ansible-option-choices-entry:`"git"` :ansible-option-choices-entry:`"amazon-s3"`
headers	Dictionary of headers to be passed to the NetBox API.
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: false

  tasks:
    - name: "Create a new data source with only required information"
      netbox.netbox.netbox_data_source:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Data Source 1"
          type: "local"
          source_url: "/tmp/data-source.txt"
          enabled: true
        state: present
    - name: "Update that data source with other fields"
      netbox.netbox.netbox_data_source:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Data Source 1"
          type: "amazon-s3"
          source_url: "path/to/bucket"
          enabled: false
          description: "My first data source"
          ignore_rules: ".*\nfoo.txt\n*.yml"
          sync_interval: 1440
          comments: "Some commentary on this data source"
        state: present
    - name: "Delete the data source"
      netbox.netbox.netbox_data_source:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Data Source 1"
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
data_source	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Daniel Chiquito (@dchiquito)

Collection links