Image Management

pyATS Clean has a feature that can manage passing images between stages to help reduce the size and complexity of the Clean YAML. Images can be defined in the Clean YAML or can be passed via command line arguments (See Passing images through CLI).

To illustrate the difference, please see the Clean YAML below without using Image Management. The highlighted lines are the lines that Image Management would automatically populate if used.

Note

Some stage arguments may be missing in order to be brief. This is not a working example.

 1
 2
 3
 4
 5
 6
 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
34
35
36
37
38
39
40
41
cleaners:
    PyatsDeviceClean:
        module: genie.libs.clean
        devices: [PE1]

devices:
    PE1:
        connect:

        copy_to_linux:
            origin:
                files: /path/to/image.bin
            destination:
                directory: /tftp-server
                hostname: 127.0.0.1
            unique_number: 12345

        copy_to_device:
            origin:
                files: /tftp-server/image_12345.bin
                hostname: 127.0.0.1
            destination:
                directory: 'bootflash:'

        change_boot_variable:
            images:
            - bootflash:/image_12345.bin

        reload:

        verify_running_image:
            images:
            - bootflash:/image_12345.bin

        order:
        - connect
        - copy_to_linux
        - copy_to_device
        - change_boot_variable
        - reload
        - verify_running_image

Now with Image Management used, see how the image only needs to be provided once, rather than in each stage that requires it. pyATS Clean will pass the correct image value automatically between stages.

 1
 2
 3
 4
 5
 6
 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
34
35
36
37
38
cleaners:
    PyatsDeviceClean:
        module: genie.libs.clean
        devices: [PE1]

devices:
    PE1:

        images:
        - /path/to/image.bin

        connect:

        copy_to_linux:
            destination:
                directory: /tftp-server
                hostname: 127.0.0.1
            unique_number: 12345

        copy_to_device:
            origin:
                hostname: 127.0.0.1
            destination:
                directory: 'bootflash:'

        change_boot_variable:

        reload:

        verify_running_image:

        order:
        - connect
        - copy_to_linux
        - copy_to_device
        - change_boot_variable
        - reload
        - verify_running_image

Images key structure for Image Management

Different platforms require different structures for the images key. See the below table to find the correct structure. Some platforms may support multiple structure types.

os

platform

schema

iosxe

 
Structure #1
------------
images:
- /path/to/image.bin
- /path/to/optional_package1
- /path/to/optional_package2

Structure #2
------------
images:
  image:
  - /path/to/image.bin
  packages:   <<< optional
  - /path/to/optional_package1
  - /path/to/optional_package2

Structure #3
------------
images:
  image:
    file:
    - /path/to/image.bin
  packages:  <<< optional
    file:
    - /path/to/optional_package1
    - /path/to/optional_package2

iosxr

 
Structure #1
------------
images:
- /path/to/image.bin
- /path/to/optional_package1
- /path/to/optional_package2

Structure #2
------------
images:
  image:
  - /path/to/image.bin
  packages:   <<< optional
  - /path/to/optional_package1
  - /path/to/optional_package2

Structure #3
------------
images:
  image:
    file:
    - /path/to/image.bin
  packages:  <<< optional
    file:
    - /path/to/optional_package1
    - /path/to/optional_package2

nxos

aci

 
Structure #1
------------
images:
- /path/to/switch_image.bin

Structure #2
------------
images:
  switch:
  - /path/to/switch_image.bin

Structure #3
------------
images:
  switch:
    file:
    - /path/to/switch_image.bin

apic

 
Structure #1
------------
images:
- /path/to/controller_image.bin
- /path/to/switch_image.bin

Structure #2
------------
images:
  controller:
  - /path/to/controller_image.bin
  switch:
  - /path/to/switch_image.bin

Structure #3
------------
images:
  controller:
    file:
    - /path/to/controller_image.bin
  switch:
    file:
    - /path/to/switch_image.bin

nxos

n3k

 
Structure #1
------------
images:
- /path/to/image.bin

Structure #2
------------
images:
  system:
  - /path/to/image.bin

Structure #3
------------
images:
  system:
    file:
    - /path/to/image.bin

nxos

n9k

 
Structure #1
------------
images:
- /path/to/image.bin

Structure #2
------------
images:
  system:
  - /path/to/image.bin

Structure #3
------------
images:
  system:
    file:
    - /path/to/image.bin

nxos

n7k

 
Structure #1
------------
images:
- /path/to/kickstart.bin
- /path/to/system.bin

Structure #2
------------
images:
  kickstart:
  - /path/to/kickstart.bin
  system:
  - /path/to/system.bin

Structure #3
------------
images:
  kickstart:
    file:
    - /path/to/kickstart.bin
  system:
    file:
    - /path/to/system.bin