Script

Test to check advisor scripts

Configuration Script

Description

In this scenario, an advisor is triggered to activate the automatic script. When the advisor is changed to true, the automatic script associated with the advisor is executed, aplying the commands in the active configuration.

Scenario

Step 1: Set the following configuration in DUT0:

set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0'
set system script SCRIPT_1 advisor ADVISOR1
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''

Step 2: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test true

Step 3: Run command show running at DUT0 and check if output contains the following tokens:

set system description 'advisor applied'
Show output
# Teldat OSDx VM version v4.1.1.1
# Wed 17 Jul 2024 15:42:50 UTC +00:00
# Warning: Configuration has not been saved
set system advisor ADVISOR1 test true
set system cli configuration logging global info
set system description 'advisor applied'
set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0'
set system script SCRIPT_1 advisor ADVISOR1
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''

Operational Script

Description

In this scenario, an advisor is triggered to activate the automatic script. When the advisor is changed to true, the automatic script associated with the advisor is executed, proccessing the operational commands in the specified order.

Scenario

Step 1: Set the following configuration in DUT0:

set interfaces ethernet eth0 address 10.215.200.50/24
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0'
set system script SCRIPT_1 advisor ADVISOR1
set system script SCRIPT_1 operational 1 command 'interfaces ethernet show'
set system script SCRIPT_1 operational 2 command 'license show'

Step 2: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test true

Step 3: Run command system journal show | cat at DUT0 and check if output contains the following tokens:

interfaces ethernet show
Show output
Jul 17 15:42:54.271962 osdx systemd-journald[1576]: Runtime Journal (/run/log/journal/7135572a45764d02b8df631348eed5fb) is 2.0M, max 15.3M, 13.3M free.
Jul 17 15:42:54.272499 osdx systemd-journald[1576]: Received client request to rotate journal, rotating.
Jul 17 15:42:54.272540 osdx systemd-journald[1576]: Vacuuming done, freed 0B of archived journals from /run/log/journal/7135572a45764d02b8df631348eed5fb.
Jul 17 15:42:54.281971 osdx OSDxCLI[75363]: User 'admin' executed a new command: 'system journal clear'.
Jul 17 15:42:54.592680 osdx osdx-coredump[80503]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Jul 17 15:42:54.600231 osdx OSDxCLI[75363]: User 'admin' executed a new command: 'system coredump delete all'.
Jul 17 15:42:55.038069 osdx OSDxCLI[75363]: User 'admin' entered the configuration menu.
Jul 17 15:42:55.100421 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jul 17 15:42:55.198308 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Jul 17 15:42:55.250933 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Jul 17 15:42:55.347420 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jul 17 15:42:55.410247 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Jul 17 15:42:55.501747 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Jul 17 15:42:55.577673 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Jul 17 15:42:55.683829 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'show working'.
Jul 17 15:42:55.756594 osdx modulelauncher[1112]: + Received data: ['75363', 'osdx.utils.xos', 'set_console_log_level', 'info']
Jul 17 15:42:55.770047 osdx OSDxCLI[75363]: Signal 10 received
Jul 17 15:42:55.779186 osdx ifmon[1141]: Changed log-level to info
Jul 17 15:42:55.808465 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Jul 17 15:42:55.845856 osdx cfgd[1240]: [75363]Completed change to active configuration
Jul 17 15:42:55.847747 osdx OSDxCLI[75363]: User 'admin' committed the configuration.
Jul 17 15:42:55.866822 osdx OSDxCLI[75363]: User 'admin' left the configuration menu.
Jul 17 15:42:56.063281 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.064084 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.064437 osdx OSDxCLI[75363]: User 'admin' entered the configuration menu.
Jul 17 15:42:56.121185 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.121592 osdx cfgd[1240]: Execute action [syntax] for node [system advisor ADVISOR1]
Jul 17 15:42:56.121950 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.122205 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Jul 17 15:42:56.211483 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.223307 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.223696 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'show changes'.
Jul 17 15:42:56.270932 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.278262 osdx cfgd[1240]: [75363]must validation for [system login user admin role] was skipped
Jul 17 15:42:56.278272 osdx cfgd[1240]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Jul 17 15:42:56.289661 osdx cfgd[1240]: Execute action [end] for node [system advisor ADVISOR1]
Jul 17 15:42:56.295328 osdx cfgd[1240]: [75363]Completed change to active configuration
Jul 17 15:42:56.297281 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.297606 osdx OSDxCLI[75363]: User 'admin' committed the configuration.
Jul 17 15:42:56.300386 osdx INFO[80638]: SCRIPT SCRIPT_1 operations:
Jul 17 15:42:56.306137 osdx OSDxCLI[80646]: Tecla::GetLine tcgetattr error
Jul 17 15:42:56.306142 osdx OSDxCLI[80646]: User 'admin' has logged in.
Jul 17 15:42:56.313562 osdx OSDxCLI[80646]: User 'admin' executed a new command: 'interfaces ethernet show'.
Jul 17 15:42:56.314498 osdx OSDxCLI[80646]: User 'admin' has logged out.
Jul 17 15:42:56.314502 osdx OSDxCLI[80646]: Tecla::GetLine tcgetattr error
Jul 17 15:42:56.315034 osdx INFO[80638]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Jul 17 15:42:56.316799 osdx modulelauncher[80638]: Traceback (most recent call last):
                                                     File "/osdx/sbin/modulelauncher.py", line 36, in run_file
                                                       result = getattr(module, args[0])(args, cfg_ses_id)
                                                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 61, in process
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 108, in _execute_script
                                                     File "usr/lib/python3.11/subprocess.py", line 1182, in communicate
                                                   ValueError: Cannot send input after starting communication
Jul 17 15:42:56.317099 osdx cfgd[1240]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Jul 17 15:42:56.317114 osdx cfgd[1240]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Jul 17 15:42:56.353617 osdx OSDxCLI[75363]: User 'admin' left the configuration menu.
Jul 17 15:42:56.426598 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)

Step 4: Run command system journal show | cat at DUT0 and check if output contains the following tokens:

license show
Show output
Jul 17 15:42:54.271962 osdx systemd-journald[1576]: Runtime Journal (/run/log/journal/7135572a45764d02b8df631348eed5fb) is 2.0M, max 15.3M, 13.3M free.
Jul 17 15:42:54.272499 osdx systemd-journald[1576]: Received client request to rotate journal, rotating.
Jul 17 15:42:54.272540 osdx systemd-journald[1576]: Vacuuming done, freed 0B of archived journals from /run/log/journal/7135572a45764d02b8df631348eed5fb.
Jul 17 15:42:54.281971 osdx OSDxCLI[75363]: User 'admin' executed a new command: 'system journal clear'.
Jul 17 15:42:54.592680 osdx osdx-coredump[80503]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Jul 17 15:42:54.600231 osdx OSDxCLI[75363]: User 'admin' executed a new command: 'system coredump delete all'.
Jul 17 15:42:55.038069 osdx OSDxCLI[75363]: User 'admin' entered the configuration menu.
Jul 17 15:42:55.100421 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jul 17 15:42:55.198308 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Jul 17 15:42:55.250933 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Jul 17 15:42:55.347420 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jul 17 15:42:55.410247 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Jul 17 15:42:55.501747 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Jul 17 15:42:55.577673 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Jul 17 15:42:55.683829 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'show working'.
Jul 17 15:42:55.756594 osdx modulelauncher[1112]: + Received data: ['75363', 'osdx.utils.xos', 'set_console_log_level', 'info']
Jul 17 15:42:55.770047 osdx OSDxCLI[75363]: Signal 10 received
Jul 17 15:42:55.779186 osdx ifmon[1141]: Changed log-level to info
Jul 17 15:42:55.808465 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Jul 17 15:42:55.845856 osdx cfgd[1240]: [75363]Completed change to active configuration
Jul 17 15:42:55.847747 osdx OSDxCLI[75363]: User 'admin' committed the configuration.
Jul 17 15:42:55.866822 osdx OSDxCLI[75363]: User 'admin' left the configuration menu.
Jul 17 15:42:56.063281 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.064084 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.064437 osdx OSDxCLI[75363]: User 'admin' entered the configuration menu.
Jul 17 15:42:56.121185 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.121592 osdx cfgd[1240]: Execute action [syntax] for node [system advisor ADVISOR1]
Jul 17 15:42:56.121950 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.122205 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Jul 17 15:42:56.211483 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.223307 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.223696 osdx OSDxCLI[75363]: User 'admin' added a new cfg line: 'show changes'.
Jul 17 15:42:56.270932 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.278262 osdx cfgd[1240]: [75363]must validation for [system login user admin role] was skipped
Jul 17 15:42:56.278272 osdx cfgd[1240]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Jul 17 15:42:56.289661 osdx cfgd[1240]: Execute action [end] for node [system advisor ADVISOR1]
Jul 17 15:42:56.295328 osdx cfgd[1240]: [75363]Completed change to active configuration
Jul 17 15:42:56.297281 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.297606 osdx OSDxCLI[75363]: User 'admin' committed the configuration.
Jul 17 15:42:56.300386 osdx INFO[80638]: SCRIPT SCRIPT_1 operations:
Jul 17 15:42:56.306137 osdx OSDxCLI[80646]: Tecla::GetLine tcgetattr error
Jul 17 15:42:56.306142 osdx OSDxCLI[80646]: User 'admin' has logged in.
Jul 17 15:42:56.313562 osdx OSDxCLI[80646]: User 'admin' executed a new command: 'interfaces ethernet show'.
Jul 17 15:42:56.314498 osdx OSDxCLI[80646]: User 'admin' has logged out.
Jul 17 15:42:56.314502 osdx OSDxCLI[80646]: Tecla::GetLine tcgetattr error
Jul 17 15:42:56.315034 osdx INFO[80638]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Jul 17 15:42:56.316799 osdx modulelauncher[80638]: Traceback (most recent call last):
                                                     File "/osdx/sbin/modulelauncher.py", line 36, in run_file
                                                       result = getattr(module, args[0])(args, cfg_ses_id)
                                                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 61, in process
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 108, in _execute_script
                                                     File "usr/lib/python3.11/subprocess.py", line 1182, in communicate
                                                   ValueError: Cannot send input after starting communication
Jul 17 15:42:56.317099 osdx cfgd[1240]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Jul 17 15:42:56.317114 osdx cfgd[1240]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Jul 17 15:42:56.353617 osdx OSDxCLI[75363]: User 'admin' left the configuration menu.
Jul 17 15:42:56.426598 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Jul 17 15:42:56.462937 osdx OSDxCLI[75363]: pam_unix(cli:session): session closed for user admin
Jul 17 15:42:56.463188 osdx OSDxCLI[75363]: User 'admin' executed a new command: 'system journal show | cat'.
Jul 17 15:42:56.538874 osdx OSDxCLI[75363]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)

Simple Script Execution

Description

In this scenario, an automatic script is activated directly without any advisor triggering. The script is activated using the system script <txt> activate command.

Scenario

Step 1: Set the following configuration in DUT0:

set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0'
set system script SCRIPT_1 advisor ADVISOR1
set system script SCRIPT_1 configuration 'set interfaces dummy dum0'
set system script SCRIPT_1 configuration 'set interfaces dummy dum1'

Step 2: Run command system script SCRIPT_1 activate at DUT0.

Step 3: Run command interfaces dummy show at DUT0 and check if output matches the following regular expressions:

dum0.*\ndum1
Show output
-----------------------------------------------------------------
Name           IP Address           Admin  Oper  Vrf  Description
-----------------------------------------------------------------
dum0  fe80::b0ec:a9ff:fe19:3389/64  up     up
dum1  fe80::d6:ccff:fe72:a24f/64    up     up

Multiple Triggers Script

Description

In this scenario, an advisor is triggered multiple times to activate the automatic script. When the advisor is changed to true, the automatic script associated with the advisor is executed, proccessing the operational commands in the specified order.

Scenario

Step 1: Set the following configuration in DUT0:

set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0'
set system script SCRIPT_1 advisor ADVISOR1
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''
set system script SCRIPT_1 number-of-triggers 3

Note

Wait for the advisor to turn on. After that, wait for the advisor to turn off. This produces only one trigger.

Step 2: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test true

Step 3: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test false

Step 4: Expect a failure in the following command: Run command show running at DUT0 and check if output contains the following tokens:

set system description 'advisor applied'
Show output
# Teldat OSDx VM version v4.1.1.1
# Wed 17 Jul 2024 15:43:07 UTC +00:00
# Warning: Configuration has not been saved
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0'
set system script SCRIPT_1 advisor ADVISOR1
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''
set system script SCRIPT_1 number-of-triggers 3

Note

Wait for the advisor to turn on. After that, wait for the advisor to turn off. This produces only one trigger.

Step 5: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test true

Step 6: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test false

Step 7: Expect a failure in the following command: Run command show running at DUT0 and check if output contains the following tokens:

set system description 'advisor applied'
Show output
# Teldat OSDx VM version v4.1.1.1
# Wed 17 Jul 2024 15:43:08 UTC +00:00
# Warning: Configuration has not been saved
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0'
set system script SCRIPT_1 advisor ADVISOR1
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''
set system script SCRIPT_1 number-of-triggers 3

Note

Wait for the advisor to turn on. After that, wait for the advisor to turn off. This produces only one trigger.

Step 8: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test true

Step 9: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test false

Step 10: Run command show running at DUT0 and check if output contains the following tokens:

set system description 'advisor applied'
Show output
# Teldat OSDx VM version v4.1.1.1
# Wed 17 Jul 2024 15:43:09 UTC +00:00
# Warning: Configuration has not been saved
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system description 'advisor applied'
set system login user admin authentication encrypted-password '$6$GSjsCj8gHLv$/VcqU6FLi6CT2Oxn0MJQ2C2tqnRDrYKNF8HIYWJp68nvXvPdFccDsT04.WtigUONbKYrgKg8d6rEs8PjljMkH0'
set system script SCRIPT_1 advisor ADVISOR1
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''
set system script SCRIPT_1 number-of-triggers 3