netbox.netbox.netbox_config_context – Creates, updates or deletes configuration contexts 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_config_context
.
New in version 3.3.0: of netbox.netbox
Synopsis¶
Creates, updates or removes configuration contexts 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 config_context module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create config context and apply it to sites euc1-az1, euc1-az2 with the default weight of 1000
netbox_config_context:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: "dns_nameservers-quadnine"
description: "9.9.9.9"
data: "{ \"dns\": { \"nameservers\": [ \"9.9.9.9\" ] } }"
sites: [ euc1-az1, euc1-az2 ]
- name: Detach config context from euc1-az1, euc1-az2 and attach to euc1-az3
netbox_config_context:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: "dns_nameservers-quadnine"
data: "{ \"dns\": { \"nameservers\": [ \"9.9.9.9\" ] } }"
sites: [ euc1-az3 ]
- name: Delete config context
netbox_config_context:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: "dns_nameservers-quadnine"
data: "{ \"dns\": { \"nameservers\": [ \"9.9.9.9\" ] } }"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module: