Skip to content

abort_config

nornir_scrapli.tasks.cfg_abort_config

cfg_abort_config(task: Task) -> Result

Abort a device candidate config with scrapli-cfg

Parameters:

Name Type Description Default
task Task

nornir task object

required

Returns:

Name Type Description
Result Result

nornir result object with Result.result value set the string result of the load_config operation

Source code in tasks/cfg/abort_config.py
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def cfg_abort_config(task: Task) -> Result:
    """
    Abort a device candidate config with scrapli-cfg

    Args:
        task: nornir task object

    Returns:
        Result: nornir result object with Result.result value set the string result of the
            load_config operation

    Raises:
        N/A

    """
    scrapli_cfg_conn = ScrapliConfig.get_connection(task=task)

    scrapli_response = scrapli_cfg_conn.abort_config()

    result = ScrapliResult(
        host=task.host,
        result=scrapli_response.result,
        scrapli_response=scrapli_response,
        changed=False,
    )

    return result