netbox.netbox.netbox_config_context module – Creates, updates or deletes configuration contexts within NetBox¶
Note
This module is part of the netbox.netbox collection (version 3.6.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
.
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¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the configuration context |
|
List of cluster_groups to which configuration context applies |
|
List of clusters to which configuration context applies |
|
JSON-formatted configuration context data |
|
The description of the configuration context |
|
List of device_types to which configuration context applies |
|
Whether configuration context is active Choices:
|
|
Name of the context |
|
List of platforms to which configuration context applies |
|
List of regions where configuration context applies |
|
List of roles to which configuration context applies |
|
List of sites where configuration context applies |
|
Any tags that the configuration context associates with |
|
List of tenant_groups to which configuration context applies |
|
List of tenants to which configuration context applies |
|
The weight of the configuration context |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: “yes” |
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:
Key |
Description |
---|---|
Serialized object as created/existent/updated/deleted within NetBox Returned: always |
|
Message indicating failure or info about what has been achieved Returned: always |