def send_configs_from_file(
task: Task,
file: str,
dry_run: bool = False,
strip_prompt: bool = True,
failed_when_contains: Optional[Union[str, List[str]]] = None,
stop_on_failed: bool = False,
privilege_level: str = "",
) -> Result:
"""
Send configs from a file to device using scrapli
Args:
task: nornir task object
file: string path to file
dry_run: Whether to apply changes or not; if dry run, will ensure that it is possible to
enter config mode, but will NOT send any configs
strip_prompt: True/False strip prompt from returned output
failed_when_contains: string or list of strings indicating failure if found in response
stop_on_failed: True/False stop executing commands if a command fails, returns results as of
current execution
privilege_level: name of configuration privilege level/type to acquire; this is platform
dependent, so check the device driver for specifics. Examples of privilege_name
would be "configuration_exclusive" for IOSXRDriver, or "configuration_private" for
JunosDriver. You can also pass in a name of a configuration session such as
"my-config-session" if you have registered a session using the
"register_config_session" method of the EOSDriver or NXOSDriver.
Returns:
Result: nornir result object with Result.result value set to returned scrapli Response
object
Raises:
NornirScrapliNoConfigModeGenericDriver: If attempting to use this task function against a
host that is using the "generic" platform type
"""
if task.host.platform == "generic":
raise NornirScrapliNoConfigModeGenericDriver(
"No config mode for 'generic' platform type")
scrapli_conn = task.host.get_connection("scrapli", task.nornir.config)
if dry_run:
# if dry run, try to acquire config mode then back out; do not send any configurations!
scrapli_conn.acquire_priv("configuration")
scrapli_conn.acquire_priv(scrapli_conn.default_desired_privilege_level)
return ScrapliResult(host=task.host,
result=None,
scrapli_response=None,
changed=False)
scrapli_response = scrapli_conn.send_configs_from_file(
file=file,
strip_prompt=strip_prompt,
failed_when_contains=failed_when_contains,
stop_on_failed=stop_on_failed,
privilege_level=privilege_level,
)
result = ScrapliResult(
host=task.host,
result=process_config_result(scrapli_response=scrapli_response),
scrapli_response=scrapli_response,
changed=True,
)
return result
def send_config(
task: Task,
config: str,
dry_run: Optional[bool] = None,
strip_prompt: bool = True,
failed_when_contains: Optional[Union[str, List[str]]] = None,
stop_on_failed: bool = False,
privilege_level: str = "",
timeout_ops: Optional[float] = None,
) -> Result:
"""
Send a config to device using scrapli
Args:
task: nornir task object
config: string configuration to send to the device, supports sending multi-line strings
dry_run: Whether to apply changes or not; if dry run, will ensure that it is possible to
enter config mode, but will NOT send any configs
strip_prompt: True/False strip prompt from returned output
failed_when_contains: string or list of strings indicating failure if found in response
stop_on_failed: True/False stop executing commands if a command fails, returns results as of
current execution
privilege_level: name of configuration privilege level/type to acquire; this is platform
dependent, so check the device driver for specifics. Examples of privilege_name
would be "configuration_exclusive" for IOSXRDriver, or "configuration_private" for
JunosDriver. You can also pass in a name of a configuration session such as
"my-config-session" if you have registered a session using the
"register_config_session" method of the EOSDriver or NXOSDriver.
timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
the duration of the operation, value is reset to initial value after operation is
completed. Note that this is the timeout value PER CONFIG sent, not for the total
of the configs being sent!
Returns:
Result: nornir result object with Result.result value set to returned scrapli Response
object
Raises:
NornirScrapliNoConfigModeGenericDriver: If attempting to use this task function against a
host that is using the "generic" platform type
"""
if task.host.platform == "generic":
raise NornirScrapliNoConfigModeGenericDriver(
"No config mode for 'generic' platform type")
scrapli_conn = task.host.get_connection("scrapli", task.nornir.config)
_task_dry_run = dry_run if dry_run is not None else task.global_dry_run
if _task_dry_run:
# if dry run, try to acquire config mode then back out; do not send any configurations!
scrapli_conn.acquire_priv("configuration")
scrapli_conn.acquire_priv(scrapli_conn.default_desired_privilege_level)
return ScrapliResult(host=task.host,
result=None,
scrapli_response=None,
changed=False)
scrapli_response = scrapli_conn.send_config(
config=config,
strip_prompt=strip_prompt,
failed_when_contains=failed_when_contains,
stop_on_failed=stop_on_failed,
privilege_level=privilege_level,
timeout_ops=timeout_ops,
)
result = ScrapliResult(
host=task.host,
result=process_config_result(scrapli_response=scrapli_response),
scrapli_response=scrapli_response,
changed=True,
)
return result
