netbox.netbox.netbox_provider_network module – Create, update or delete provider networks within NetBox

Note

This module is part of the netbox.netbox collection (version 3.20.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_provider_network.

New in netbox.netbox 3.4.0

Synopsis

• Creates, updates or removes provider networks 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 provider network configuration
comments string	Comments related to the provider network
custom_fields dictionary	must exist in NetBox
description string	Description related to the provider network
name string / required	The name of the provider network
provider any / required	The name of the provider
service_id string added in netbox.netbox 3.7.0	Arbitrary service ID
tags list / elements=any	Any tags that the provdier_network may need to be associated with
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

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

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

  tasks:
    - name: Create provider network within NetBox with only required information
      netbox.netbox.netbox_provider_network:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          provider: Test Provider
          name: Test Provider Network
        state: present

    - name: Update provider with other fields
      netbox.netbox.netbox_provider_network:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          provider: Test Provider
          name: Test Provider Network
          description: Describe a Provider Network
          comments: "A Provider Network"
        state: present

    - name: Delete provider within netbox
      netbox.netbox.netbox_provider_network:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          provider: test Provider
          name: Test Provider Network
        state: absent

Return Values

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

Key	Description
msg string	Message indicating failure or info about what has been achieved Returned: always
provider_network dictionary	Serialized object as created or already existent within NetBox Returned: success (when state=present)

Authors

• Martin Rødvand (@rodvand)

Collection links

• Issue Tracker
• Repository (Sources)