netbox.netbox.netbox_provider_network – Create, update or delete provider networks within NetBox¶
Note
This plugin is part of the netbox.netbox collection (version 3.5.1).
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
.
To use it in a playbook, specify: netbox.netbox.netbox_provider_network
.
New in version 3.4.0: of netbox.netbox
Synopsis¶
Creates, updates or removes provider networks from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create provider network within NetBox with only required information
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_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_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: