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 script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system script SCRIPT_1 configuration 'set system description \'advisor applied\''

Step 2: Set the following configuration 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 v3.10.1.7
# Thu 10 Oct 2024 09:00:44 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 system script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system script SCRIPT_1 advisor ADVISOR1
set interfaces ethernet eth0 address 10.215.200.50/24
set system script SCRIPT_1 operational 1 command 'interfaces ethernet show'
set system script SCRIPT_1 operational 2 command 'license show'

Step 2: Set the following configuration 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
-- Logs begin at Thu 2024-10-10 09:00:48 UTC, end at Thu 2024-10-10 09:00:50 UTC. --
Oct 10 09:00:48.288309 osdx systemd-journald[14746]: Runtime journal (/run/log/journal/0478719b9ca24dfc881db6c3460ca916) is 2.0M, max 16.0M, 14.0M free.
Oct 10 09:00:48.312436 osdx OSDxCLI[16525]: User 'admin' executed a new command: 'system journal clear'.
Oct 10 09:00:48.700651 osdx osdx-coredump[31323]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Oct 10 09:00:48.706764 osdx OSDxCLI[16525]: User 'admin' executed a new command: 'system coredump delete all'.
Oct 10 09:00:49.291677 osdx OSDxCLI[16525]: User 'admin' entered the configuration menu.
Oct 10 09:00:49.396323 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 10 09:00:49.476067 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Oct 10 09:00:49.581962 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Oct 10 09:00:49.649529 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 10 09:00:49.749304 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Oct 10 09:00:49.805803 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Oct 10 09:00:49.898161 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Oct 10 09:00:49.954638 osdx modulelauncher[1139]: + Received data: ['16525', 'osdx.utils.xos', 'set_console_log_level', 'info']
Oct 10 09:00:49.961546 osdx OSDxCLI[16525]: Signal 10 received
Oct 10 09:00:49.966244 osdx ifmon[1186]: Changed log-level to info
Oct 10 09:00:49.992156 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Oct 10 09:00:50.010253 osdx cfgd[1323]: [16525]Completed change to active configuration
Oct 10 09:00:50.012229 osdx OSDxCLI[16525]: User 'admin' committed the configuration.
Oct 10 09:00:50.033951 osdx OSDxCLI[16525]: User 'admin' left the configuration menu.
Oct 10 09:00:50.231422 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 10 09:00:50.231837 osdx OSDxCLI[16525]: pam_unix(cli:session): session closed for user admin
Oct 10 09:00:50.232006 osdx OSDxCLI[16525]: User 'admin' entered the configuration menu.
Oct 10 09:00:50.298370 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 10 09:00:50.298767 osdx cfgd[1323]: Execute action [syntax] for node [(null)]
Oct 10 09:00:50.298857 osdx cfgd[1323]: Execute action [syntax] for node [(null)]
Oct 10 09:00:50.299154 osdx OSDxCLI[16525]: pam_unix(cli:session): session closed for user admin
Oct 10 09:00:50.299377 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Oct 10 09:00:50.392646 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 10 09:00:50.402674 osdx cfgd[1323]: [16525]must validation for [system login user admin role] was skipped
Oct 10 09:00:50.402690 osdx cfgd[1323]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Oct 10 09:00:50.408965 osdx cfgd[1323]: Execute action [end] for node [system advisor ADVISOR1]
Oct 10 09:00:50.414026 osdx cfgd[1323]: [16525]Completed change to active configuration
Oct 10 09:00:50.416515 osdx OSDxCLI[16525]: pam_unix(cli:session): session closed for user admin
Oct 10 09:00:50.416807 osdx OSDxCLI[16525]: User 'admin' committed the configuration.
Oct 10 09:00:50.419605 osdx INFO[31445]: SCRIPT SCRIPT_1 operations:
Oct 10 09:00:50.428316 osdx OSDxCLI[31453]: Tecla::GetLine tcgetattr error
Oct 10 09:00:50.428324 osdx OSDxCLI[31453]: User 'admin' has logged in.
Oct 10 09:00:50.432493 osdx OSDxCLI[16525]: User 'admin' left the configuration menu.
Oct 10 09:00:50.438883 osdx OSDxCLI[31453]: User 'admin' executed a new command: 'interfaces ethernet show'.
Oct 10 09:00:50.439934 osdx OSDxCLI[31453]: User 'admin' has logged out.
Oct 10 09:00:50.439941 osdx OSDxCLI[31453]: Tecla::GetLine tcgetattr error
Oct 10 09:00:50.440615 osdx INFO[31445]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Oct 10 09:00:50.441811 osdx modulelauncher[31445]: Traceback (most recent call last):
                                                     File "/osdx/sbin/modulelauncher.py", line 37, in run_file
                                                       result = getattr(module, args[0])(args, cfg_ses_id)
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 62, in process
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 107, in _execute_script
                                                     File "usr/lib/python2.7/subprocess.py", line 483, in communicate
                                                     File "usr/lib/python2.7/subprocess.py", line 1119, in _communicate
                                                   ValueError: I/O operation on closed file
Oct 10 09:00:50.442224 osdx cfgd[1323]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Oct 10 09:00:50.442241 osdx cfgd[1323]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Oct 10 09:00:50.550359 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin 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
-- Logs begin at Thu 2024-10-10 09:00:48 UTC, end at Thu 2024-10-10 09:00:50 UTC. --
Oct 10 09:00:48.288309 osdx systemd-journald[14746]: Runtime journal (/run/log/journal/0478719b9ca24dfc881db6c3460ca916) is 2.0M, max 16.0M, 14.0M free.
Oct 10 09:00:48.312436 osdx OSDxCLI[16525]: User 'admin' executed a new command: 'system journal clear'.
Oct 10 09:00:48.700651 osdx osdx-coredump[31323]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Oct 10 09:00:48.706764 osdx OSDxCLI[16525]: User 'admin' executed a new command: 'system coredump delete all'.
Oct 10 09:00:49.291677 osdx OSDxCLI[16525]: User 'admin' entered the configuration menu.
Oct 10 09:00:49.396323 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 10 09:00:49.476067 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Oct 10 09:00:49.581962 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Oct 10 09:00:49.649529 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 10 09:00:49.749304 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Oct 10 09:00:49.805803 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Oct 10 09:00:49.898161 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Oct 10 09:00:49.954638 osdx modulelauncher[1139]: + Received data: ['16525', 'osdx.utils.xos', 'set_console_log_level', 'info']
Oct 10 09:00:49.961546 osdx OSDxCLI[16525]: Signal 10 received
Oct 10 09:00:49.966244 osdx ifmon[1186]: Changed log-level to info
Oct 10 09:00:49.992156 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Oct 10 09:00:50.010253 osdx cfgd[1323]: [16525]Completed change to active configuration
Oct 10 09:00:50.012229 osdx OSDxCLI[16525]: User 'admin' committed the configuration.
Oct 10 09:00:50.033951 osdx OSDxCLI[16525]: User 'admin' left the configuration menu.
Oct 10 09:00:50.231422 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 10 09:00:50.231837 osdx OSDxCLI[16525]: pam_unix(cli:session): session closed for user admin
Oct 10 09:00:50.232006 osdx OSDxCLI[16525]: User 'admin' entered the configuration menu.
Oct 10 09:00:50.298370 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 10 09:00:50.298767 osdx cfgd[1323]: Execute action [syntax] for node [(null)]
Oct 10 09:00:50.298857 osdx cfgd[1323]: Execute action [syntax] for node [(null)]
Oct 10 09:00:50.299154 osdx OSDxCLI[16525]: pam_unix(cli:session): session closed for user admin
Oct 10 09:00:50.299377 osdx OSDxCLI[16525]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Oct 10 09:00:50.392646 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 10 09:00:50.402674 osdx cfgd[1323]: [16525]must validation for [system login user admin role] was skipped
Oct 10 09:00:50.402690 osdx cfgd[1323]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Oct 10 09:00:50.408965 osdx cfgd[1323]: Execute action [end] for node [system advisor ADVISOR1]
Oct 10 09:00:50.414026 osdx cfgd[1323]: [16525]Completed change to active configuration
Oct 10 09:00:50.416515 osdx OSDxCLI[16525]: pam_unix(cli:session): session closed for user admin
Oct 10 09:00:50.416807 osdx OSDxCLI[16525]: User 'admin' committed the configuration.
Oct 10 09:00:50.419605 osdx INFO[31445]: SCRIPT SCRIPT_1 operations:
Oct 10 09:00:50.428316 osdx OSDxCLI[31453]: Tecla::GetLine tcgetattr error
Oct 10 09:00:50.428324 osdx OSDxCLI[31453]: User 'admin' has logged in.
Oct 10 09:00:50.432493 osdx OSDxCLI[16525]: User 'admin' left the configuration menu.
Oct 10 09:00:50.438883 osdx OSDxCLI[31453]: User 'admin' executed a new command: 'interfaces ethernet show'.
Oct 10 09:00:50.439934 osdx OSDxCLI[31453]: User 'admin' has logged out.
Oct 10 09:00:50.439941 osdx OSDxCLI[31453]: Tecla::GetLine tcgetattr error
Oct 10 09:00:50.440615 osdx INFO[31445]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Oct 10 09:00:50.441811 osdx modulelauncher[31445]: Traceback (most recent call last):
                                                     File "/osdx/sbin/modulelauncher.py", line 37, in run_file
                                                       result = getattr(module, args[0])(args, cfg_ses_id)
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 62, in process
                                                     File "osdx/sbin/cfg/auto_scripts.py", line 107, in _execute_script
                                                     File "usr/lib/python2.7/subprocess.py", line 483, in communicate
                                                     File "usr/lib/python2.7/subprocess.py", line 1119, in _communicate
                                                   ValueError: I/O operation on closed file
Oct 10 09:00:50.442224 osdx cfgd[1323]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Oct 10 09:00:50.442241 osdx cfgd[1323]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Oct 10 09:00:50.550359 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 10 09:00:50.581024 osdx OSDxCLI[16525]: pam_unix(cli:session): session closed for user admin
Oct 10 09:00:50.581272 osdx OSDxCLI[16525]: User 'admin' executed a new command: 'system journal show | cat'.
Oct 10 09:00:50.650532 osdx OSDxCLI[16525]: pam_unix(cli:session): session opened for user admin 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 script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system cli configuration logging global info
set system script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
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::fca4:40ff:fea7:d97e/64  up     up
dum1  fe80::5c52:52ff:fe62:3e98/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 script SCRIPT_1 advisor ADVISOR1
set system advisor ADVISOR1 test false
set system cli configuration logging global info
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: Set the following configuration in DUT0:

set system advisor ADVISOR1 test true

Step 3: Set the following configuration 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 v3.10.1.7
# Thu 10 Oct 2024 09:01:01 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: Set the following configuration in DUT0:

set system advisor ADVISOR1 test true

Step 6: Set the following configuration 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 v3.10.1.7
# Thu 10 Oct 2024 09:01:02 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: Set the following configuration in DUT0:

set system advisor ADVISOR1 test true

Step 9: Set the following configuration 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 v3.10.1.7
# Thu 10 Oct 2024 09:01:03 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