pyez_config

1. Begin by importing your method:

   from nornir_pyez.plugins.tasks import pyez_config
   

2. Now you will need to decide which serialization that you want to send the data in with. ‘text’ is the default. Payload must be passed as a string A text payload example:

payload = """interfaces {
    lo0 {
        unit 0 {
            family inet {
                address 3.3.3.3/32;
            }
        }
    }
}
"""

Take notice of the XML payload’s ability to use attributes like operation=”replace” This will remove and replace this subtree of the candidate config. An XML payload example:

xml_payload = """
<configuration>
        <interfaces>
                <interface>
                    <name>lo0</name>
                    <unit>
                        <name>0</name>
                        <family operation="replace">
                            <inet>
                                <address>
                                    <name>3.3.3.3/32</name>
                                </address>
                            </inet>
                        </family>
                    </unit>
                </interface>
            </interfaces>
</configuration>
"""

Note JSON is also a valid payload with data_format=’json’ set

3. If you want to load several configuration files, you will need to use the first_loading flag. This flag solve the problem of the lock on the Junos OS database when loading configuration. In your code you will need to set this flag as False at your second and more calls of the pyez_config task.

first_loading = True for conf_file in conf_files:

config_response = task.run(

task=pyez_config, template_path=conf_file, template_vars={}, first_loading=first_loading,

) first_loading = False

4. Next you need to decide if you want to commit the changes now, or create a new task to view the diff

Example of NO commit now:

send_result = task.run(
    task=pyez_config, payload=xml_payload, data_format='xml')

Example of commit now:

send_result = task.run(
    task=pyez_config, payload=xml_payload, data_format='xml', commit_now=True)

Full example:

from nornir_pyez.plugins.tasks import pyez_config
import os
from nornir import InitNornir
from rich import print

script_dir = os.path.dirname(os.path.realpath(__file__))

nr = InitNornir(config_file=f"{script_dir}/config.yml")

payload = """interfaces {
    lo0 {
        unit 0 {
            family inet {
                address 3.3.3.3/32;
            }
        }
    }
}
"""

response = nr.run(
    task=pyez_config, payload=payload
)

# response is an AggregatedResult, which behaves like a list
# there is a response object for each device in inventory
devices = []
for dev in response:
    print(response[dev].result)

Now supporting Templates The PyEZ Library uses a template like so. First let’s explore the Jinja2 template:

set system name-server {{ dns_server }}
set system ntp server {{ ntp_server }}

We can retrieve this as arbitrary data from hosts or groups.yml:

---
junos_group:
    username: 'knox'
    password: 'juniper1'
    platform: junos
    data:
        dns_server: '10.10.10.189'
        ntp_server: 'time.google.com'

The official PyEZ method is typically written like so:

cu.load(template_path=CONFIG_FILE, template_vars=CONFIG_DATA, format=’set’, merge=True)

However the load method is replaced by pyez_config. Here is a sample script:

from nornir_pyez.plugins.tasks import pyez_config, pyez_diff, pyez_commit
import os
from nornir import InitNornir
from nornir.core.task import Task, Result
from nornir_utils.plugins.functions import print_result
from nornir_utils.plugins.tasks.data import load_yaml
from rich import print

script_dir = os.path.dirname(os.path.realpath(__file__))

nr = InitNornir(config_file=f"{script_dir}/config.yml")

def template_config(task):
    # retrieve data from groups.yml
    data = {}
    data['dns_server'] = task.host['dns_server']
    data['ntp_server'] = task.host['ntp_server']
    print(data)
    response = task.run(
        task=pyez_config, template_path='junos.j2', template_vars=data, data_format='set')
    if response:
        diff = task.run(pyez_diff)
    if diff:
        task.run(task=pyez_commit)


response = nr.run(
    task=template_config)
print_result(response)