Skip to content

neops.core.provider.device_configure_from_jinja

DeviceJinjaConfigureProvider

Provider to configure a device based on a jinja template

Device Configure Parameters

Template

A Jinja Template which is processed before apply the result of this template.

The following parameters are passed to the template processing:

  • input: all inputs from the task run arguments
  • device: the current device object serialized as dictionary
  • neops: the neops object brings methods to access to other elements over the neops.io search
    • neops.search_devices(query): returns a list of devices found by the search query
    • neops.search_interfaces(query): returns a list of interfaces found by the search query
    • neops.search_device_groups(query): returns a list of groups found by the search query
    • neops.search_client(query): returns a list of clients found by the search query
    • neops.get_common_facts(key): returns the common/global fact of the given key

For more information on how to build a Jinja2 template, have a look at Appendix under Jinja2

Example of device and neops usage (only to show usage, config change doesn't make sense): 

hostname {{ device.hostname }}

{% for interface in device.interfaces %}
interface {{ interface.name }}
  description NEW-DESCRIPTION
{% endfor %}

{% for interface in neops.interface_search("devices.id:" ~ device.id ~ " AND interfaces.description: *CLIENT*") %}
    {### process every interface with CLIENT in description #}
interface {{ interface.name }}
  description NEW-DESCRIPTION
{% endfor %}

Global Base Configure Parameters

Apply Method

The apply method descripbes how the configuration is written to the device.

  • cli: the configuration is applied directly in the configration mode
  • scp: the configuration is copied (with scp) as a file to the device and applied with an merge operation
  • scp-startup: the configuration is copied (with scp) as a file to the device and written to the start up configuration

Slow Devices

With the slow_device parameter you can specify a delay factor to wait a longer time on responses from slow devices

JSON Schema

Device Configuration

Properties

  • apply (string): Method how to apply the configuration, over cli or copy with scp and merge. Must be one of: ['scp', 'cli', 'scp-startup'].

  • slow_device (integer): Add a factor for longer wait times for heavy loaded devices. Default: 0.

  • template (string)

Methods

run_on_device(self,task: nornir.core.task.Task,device_id: int,**kwargs) -> nornir.core.task.Result
run_on_device is called by the run cycle. \ It generates the configuration with the given input parameters