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.23.0).

You might already have this collection installed if you are using the ansible package. 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

any

Certificate path

data

dictionary / required

Defines the data source configuration

comments

string

Comments about the data source

description

string

Description of the data source

enabled

boolean

Whether or not this data source can be synced

Choices:

  • false

  • true

ignore_rules

string

Patterns (one per line) matching files to ignore when syncing

name

string / required

Name of the data source

source_url

string

URL of the data source to be created

sync_interval

integer

The interval in seconds between syncs

Choices:

  • 1

  • 60

  • 720

  • 1440

  • 10080

  • 43200

type

string

The origin of the data source

Choices:

  • "local"

  • "git"

  • "amazon-s3"

headers

dictionary

Dictionary of headers to be passed to the NetBox API.

netbox_token

string / required

The NetBox API token.

netbox_url

string / required

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

list / 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.

state

string

The state of the object.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

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

dictionary

Serialized object as created or already existent within NetBox

Returned: on creation

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Daniel Chiquito (@dchiquito)