This task plugin uses nornir-scrapli scrapli_send_config task to send configuration commands to devices over SSH or Telnet.

scrapli_send_config exists as part of nornir_salt repository to facilitate per-host configuration rendering performed by SALT prior to running the task.


scrapli_send_config sample usage

Code to invoke scrapli_send_config task:

from nornir import InitNornir
from nornir_salt.plugins.tasks import scrapli_send_config

nr = InitNornir(config_file="config.yaml")

output =
    commands=["interface loopback 0", "description 'configured by script'"]

scrapli_send_config returns

Returns Nornir results object with individual tasks names set equal to commands sent to device.

scrapli_send_config reference

nornir_salt.plugins.tasks.scrapli_send_config.scrapli_send_config(task: nornir.core.task.Task, config=None, **kwargs)

Nornir Task function to send configuration to devices using nornir_scrapli.tasks.send_config plugin

  • kwargs – arguments for file.apply_template_on_contents salt function for configuration rendering as well as for method

  • config – (str or list) configuration string or list of commands to send to device

  • commit – not implemented

Return result

Nornir result object with task execution results