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 to 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 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.8.1.7-beta3
# Thu 23 Nov 2023 11:50:36 PM UTC
# Warning: Configuration has not been saved
set system advisor ADVISOR1 test true
set system 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 to 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 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 2023-11-23 23:50:41 UTC, end at Thu 2023-11-23 23:50:43 UTC. --
Nov 23 23:50:41.421128 osdx systemd-journald[619]: Runtime journal (/run/log/journal/1b38b2114cf0481baed8058b17ed7ac1) is 2.0M, max 16.0M, 14.0M free.
Nov 23 23:50:41.435185 osdx OSDxCLI[28348]: User 'admin' executed a new command: 'system journal clear'.
Nov 23 23:50:41.880245 osdx OSDxCLI[28348]: User 'admin' entered the configuration menu.
Nov 23 23:50:42.002125 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Nov 23 23:50:42.093617 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Nov 23 23:50:42.193521 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system configuration logging global info'.
Nov 23 23:50:42.335009 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Nov 23 23:50:42.442529 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Nov 23 23:50:42.593294 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Nov 23 23:50:42.716579 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Nov 23 23:50:42.878155 osdx modulelauncher[934]: + Received data: ['28348', 'osdx.utils.xos', 'set_console_log_level', 'info']
Nov 23 23:50:42.891054 osdx OSDxCLI[28348]: Signal 10 received
Nov 23 23:50:42.957857 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Nov 23 23:50:43.013680 osdx cfgd[1092]: [28348]Completed change to active configuration
Nov 23 23:50:43.028704 osdx OSDxCLI[28348]: User 'admin' committed the configuration.
Nov 23 23:50:43.087157 osdx OSDxCLI[28348]: User 'admin' left the configuration menu.
Nov 23 23:50:43.358767 osdx OSDxCLI[28348]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Nov 23 23:50:43.359537 osdx OSDxCLI[28348]: pam_unix(cli:session): session closed for user admin
Nov 23 23:50:43.359829 osdx OSDxCLI[28348]: User 'admin' entered the configuration menu.
Nov 23 23:50:43.465709 osdx OSDxCLI[28348]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Nov 23 23:50:43.466204 osdx OSDxCLI[28348]: pam_unix(cli:session): session closed for user admin
Nov 23 23:50:43.466441 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Nov 23 23:50:43.581143 osdx OSDxCLI[28348]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Nov 23 23:50:43.612353 osdx cfgd[1092]: [28348]Completed change to active configuration
Nov 23 23:50:43.617720 osdx OSDxCLI[28348]: pam_unix(cli:session): session closed for user admin
Nov 23 23:50:43.618096 osdx OSDxCLI[28348]: User 'admin' committed the configuration.
Nov 23 23:50:43.621612 osdx INFO[30331]: SCRIPT SCRIPT_1 operations:
Nov 23 23:50:43.637942 osdx OSDxCLI[30337]: Tecla::GetLine tcgetattr error
Nov 23 23:50:43.638306 osdx OSDxCLI[30337]: User 'admin' has logged in.
Nov 23 23:50:43.654133 osdx OSDxCLI[30337]: User 'admin' executed a new command: 'interfaces ethernet show'.
Nov 23 23:50:43.656452 osdx OSDxCLI[30337]: User 'admin' has logged out.
Nov 23 23:50:43.656554 osdx OSDxCLI[30337]: Tecla::GetLine tcgetattr error
Nov 23 23:50:43.657550 osdx INFO[30331]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Nov 23 23:50:43.660217 osdx modulelauncher[30331]: 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
Nov 23 23:50:43.661879 osdx cfgd[1092]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Nov 23 23:50:43.661901 osdx cfgd[1092]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Nov 23 23:50:43.672991 osdx OSDxCLI[28348]: User 'admin' left the configuration menu.
Nov 23 23:50:43.818860 osdx OSDxCLI[28348]: 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 2023-11-23 23:50:41 UTC, end at Thu 2023-11-23 23:50:44 UTC. --
Nov 23 23:50:41.421128 osdx systemd-journald[619]: Runtime journal (/run/log/journal/1b38b2114cf0481baed8058b17ed7ac1) is 2.0M, max 16.0M, 14.0M free.
Nov 23 23:50:41.435185 osdx OSDxCLI[28348]: User 'admin' executed a new command: 'system journal clear'.
Nov 23 23:50:41.880245 osdx OSDxCLI[28348]: User 'admin' entered the configuration menu.
Nov 23 23:50:42.002125 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Nov 23 23:50:42.093617 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Nov 23 23:50:42.193521 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system configuration logging global info'.
Nov 23 23:50:42.335009 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Nov 23 23:50:42.442529 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Nov 23 23:50:42.593294 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Nov 23 23:50:42.716579 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Nov 23 23:50:42.878155 osdx modulelauncher[934]: + Received data: ['28348', 'osdx.utils.xos', 'set_console_log_level', 'info']
Nov 23 23:50:42.891054 osdx OSDxCLI[28348]: Signal 10 received
Nov 23 23:50:42.957857 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Nov 23 23:50:43.013680 osdx cfgd[1092]: [28348]Completed change to active configuration
Nov 23 23:50:43.028704 osdx OSDxCLI[28348]: User 'admin' committed the configuration.
Nov 23 23:50:43.087157 osdx OSDxCLI[28348]: User 'admin' left the configuration menu.
Nov 23 23:50:43.358767 osdx OSDxCLI[28348]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Nov 23 23:50:43.359537 osdx OSDxCLI[28348]: pam_unix(cli:session): session closed for user admin
Nov 23 23:50:43.359829 osdx OSDxCLI[28348]: User 'admin' entered the configuration menu.
Nov 23 23:50:43.465709 osdx OSDxCLI[28348]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Nov 23 23:50:43.466204 osdx OSDxCLI[28348]: pam_unix(cli:session): session closed for user admin
Nov 23 23:50:43.466441 osdx OSDxCLI[28348]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Nov 23 23:50:43.581143 osdx OSDxCLI[28348]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Nov 23 23:50:43.612353 osdx cfgd[1092]: [28348]Completed change to active configuration
Nov 23 23:50:43.617720 osdx OSDxCLI[28348]: pam_unix(cli:session): session closed for user admin
Nov 23 23:50:43.618096 osdx OSDxCLI[28348]: User 'admin' committed the configuration.
Nov 23 23:50:43.621612 osdx INFO[30331]: SCRIPT SCRIPT_1 operations:
Nov 23 23:50:43.637942 osdx OSDxCLI[30337]: Tecla::GetLine tcgetattr error
Nov 23 23:50:43.638306 osdx OSDxCLI[30337]: User 'admin' has logged in.
Nov 23 23:50:43.654133 osdx OSDxCLI[30337]: User 'admin' executed a new command: 'interfaces ethernet show'.
Nov 23 23:50:43.656452 osdx OSDxCLI[30337]: User 'admin' has logged out.
Nov 23 23:50:43.656554 osdx OSDxCLI[30337]: Tecla::GetLine tcgetattr error
Nov 23 23:50:43.657550 osdx INFO[30331]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Nov 23 23:50:43.660217 osdx modulelauncher[30331]: 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
Nov 23 23:50:43.661879 osdx cfgd[1092]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Nov 23 23:50:43.661901 osdx cfgd[1092]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Nov 23 23:50:43.672991 osdx OSDxCLI[28348]: User 'admin' left the configuration menu.
Nov 23 23:50:43.818860 osdx OSDxCLI[28348]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Nov 23 23:50:43.864744 osdx OSDxCLI[28348]: pam_unix(cli:session): session closed for user admin
Nov 23 23:50:43.865027 osdx OSDxCLI[28348]: User 'admin' executed a new command: 'system journal show | cat'.
Nov 23 23:50:44.011811 osdx OSDxCLI[28348]: 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 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::c8b2:64ff:fe4a:8377/64  up     up
dum1  fe80::b07e:f9ff:fe52:8ccc/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 to 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 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.8.1.7-beta3
# Thu 23 Nov 2023 11:51:00 PM UTC
# Warning: Configuration has not been saved
set system advisor ADVISOR1 test false
set system 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.8.1.7-beta3
# Thu 23 Nov 2023 11:51:01 PM UTC
# Warning: Configuration has not been saved
set system advisor ADVISOR1 test false
set system 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.8.1.7-beta3
# Thu 23 Nov 2023 11:51:02 PM UTC
# Warning: Configuration has not been saved
set system advisor ADVISOR1 test false
set system 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