networktocode.nautobot.provider module – Create, update or delete providers within Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 3.4.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 networktocode.nautobot
.
To use it in a playbook, specify: networktocode.nautobot.provider
.
New in version 1.0.0: of networktocode.nautobot
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 |
---|---|
The account number of the provider |
|
The admin contact of the provider |
|
The provider ASN |
|
Comments related to the provider |
|
must exist in Nautobot |
|
The name of the provider |
|
The NOC contact of the provider |
|
The URL of the provider |
|
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. |
|
Use Choices:
|
|
Any tags that the device may need to be associated with |
|
The token created within Nautobot to authorize API access |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
If Default: “yes” |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
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 |
---|---|
Message indicating failure or info about what has been achieved Returned: always |
|
Serialized object as created or already existent within Nautobot Returned: success (when state=present) |