networktocode.nautobot.provider module – Create, update or delete providers within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 5.2.1).

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: networktocode.nautobot.provider.

New in networktocode.nautobot 1.0.0

Synopsis

  • Creates, updates or removes providers from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

account

string

added in networktocode.nautobot 3.0.0

The account number of the provider

admin_contact

string

added in networktocode.nautobot 3.0.0

The admin contact of the provider

api_version

string

added in networktocode.nautobot 4.1.0

API Version Nautobot REST API

asn

integer

added in networktocode.nautobot 3.0.0

The provider ASN

comments

string

added in networktocode.nautobot 3.0.0

Comments related to the provider

custom_fields

dictionary

added in networktocode.nautobot 3.0.0

Must exist in Nautobot and in key/value format

name

string / required

added in networktocode.nautobot 3.0.0

The name of the provider

noc_contact

string

added in networktocode.nautobot 3.0.0

The NOC contact of the provider

portal_url

string

added in networktocode.nautobot 3.0.0

The URL of the provider

query_params

list / elements=string

added in networktocode.nautobot 3.0.0

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/utils.py and provides control to users on what may make

an object unique in their environment.

state

string

Use present or absent for adding or removing.

Choices:

tags

list / elements=any

added in networktocode.nautobot 3.0.0

Any tags that this item may need to be associated with

token

string / required

The token created within Nautobot to authorize API access

Can be omitted if the NAUTOBOT_TOKEN environment variable is configured.

url

string / required

The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)

Can be omitted if the NAUTOBOT_URL environment variable is configured.

validate_certs

any

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Can be omitted if the NAUTOBOT_VALIDATE_CERTS environment variable is configured.

Default: :ansible-option-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 Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create provider within Nautobot with only required information
      networktocode.nautobot.provider:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Provider
        state: present

    - name: Update provider with other fields
      networktocode.nautobot.provider:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Provider
        asn: 65001
        account: 200129104
        portal_url: http://provider.net
        noc_contact: noc@provider.net
        admin_contact: admin@provider.net
        comments: "BAD PROVIDER"
        state: present

    - name: Delete provider within nautobot
      networktocode.nautobot.provider:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Provider
        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

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

Authors

  • Mikhail Yohman (@FragmentedPacket)