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.20.0).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netbox.netbox.netbox_config_context.

New in netbox.netbox 3.3.0

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
cert	Certificate path
data	Defines the configuration context
cluster_groups	List of cluster_groups to which configuration context applies
cluster_types	List of cluster_types to which configuration context applies
clusters	List of clusters to which configuration context applies
data	JSON-formatted configuration context data
description	The description of the configuration context
device_types	List of device_types to which configuration context applies
is_active	Whether configuration context is active :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
name	Name of the context
platforms	List of platforms to which configuration context applies
regions	List of regions where configuration context applies
roles	List of roles to which configuration context applies
site_groups	List of site groups where configuration context applies
sites	List of sites where configuration context applies
tags	Any tags that the configuration context associates with
tenant_groups	List of tenant_groups to which configuration context applies
tenants	List of tenants to which configuration context applies
weight	The weight of the configuration context
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`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 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.netbox.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.netbox.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.netbox.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
config_context	Serialized object as created/existent/updated/deleted within NetBox :ansible-option-returned-bold:`Returned:` always
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Pavel Korovin (@pkorovin)

Collection links