netbox_config_context_module.rst

orphan:

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

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_config_context_module_requirements>` for details.

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

.. rst-class:: ansible-version-added

New in netbox.netbox 3.3.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates, updates or removes configuration contexts from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the configuration context
.. rst-class:: ansible-option-title cluster_groups .. rst-class:: ansible-option-type-line list / elements=string	List of cluster_groups to which configuration context applies
.. rst-class:: ansible-option-title cluster_types .. rst-class:: ansible-option-type-line list / elements=string	List of cluster_types to which configuration context applies
.. rst-class:: ansible-option-title clusters .. rst-class:: ansible-option-type-line list / elements=string	List of clusters to which configuration context applies
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary	JSON-formatted configuration context data
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	The description of the configuration context
.. rst-class:: ansible-option-title device_types .. rst-class:: ansible-option-type-line list / elements=string	List of device_types to which configuration context applies
.. rst-class:: ansible-option-title is_active .. rst-class:: ansible-option-type-line boolean	Whether configuration context is active .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line string / required	Name of the context
.. rst-class:: ansible-option-title platforms .. rst-class:: ansible-option-type-line list / elements=string	List of platforms to which configuration context applies
.. rst-class:: ansible-option-title regions .. rst-class:: ansible-option-type-line list / elements=string	List of regions where configuration context applies
.. rst-class:: ansible-option-title roles .. rst-class:: ansible-option-type-line list / elements=string	List of roles to which configuration context applies
.. rst-class:: ansible-option-title site_groups .. rst-class:: ansible-option-type-line list / elements=string	List of site groups where configuration context applies
.. rst-class:: ansible-option-title sites .. rst-class:: ansible-option-type-line list / elements=string	List of sites where configuration context applies
.. rst-class:: ansible-option-title tags .. rst-class:: ansible-option-type-line list / elements=string	Any tags that the configuration context associates with
.. rst-class:: ansible-option-title tenant_groups .. rst-class:: ansible-option-type-line list / elements=string	List of tenant_groups to which configuration context applies
.. rst-class:: ansible-option-title tenants .. rst-class:: ansible-option-type-line list / elements=string	List of tenants to which configuration context applies
.. rst-class:: ansible-option-title weight .. rst-class:: ansible-option-type-line integer	The weight of the configuration context
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: ansible-option-type-line list / elements=string	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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line 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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title config_context .. rst-class:: ansible-option-type-line dictionary	Serialized object as created/existent/updated/deleted within NetBox .. rst-class:: ansible-option-line Returned: always
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always

Authors

• Pavel Korovin (@pkorovin)

Collection links

Issue Tracker Repository (Sources)