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.8-beta1
# Wed 03 Apr 2024 08:16:25 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 Wed 2024-04-03 20:16:31 UTC, end at Wed 2024-04-03 20:16:33 UTC. --
Apr 03 20:16:31.383888 osdx systemd-journald[625]: Runtime journal (/run/log/journal/c88512c9e850498898bc11ea5f3658d6) is 2.0M, max 16.0M, 14.0M free.
Apr 03 20:16:31.399985 osdx OSDxCLI[18738]: User 'admin' executed a new command: 'system journal clear'.
Apr 03 20:16:31.819332 osdx OSDxCLI[18738]: User 'admin' entered the configuration menu.
Apr 03 20:16:31.945292 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Apr 03 20:16:32.088849 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Apr 03 20:16:32.239653 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system configuration logging global info'.
Apr 03 20:16:32.359608 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Apr 03 20:16:32.490831 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Apr 03 20:16:32.609152 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Apr 03 20:16:32.705859 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Apr 03 20:16:32.822513 osdx modulelauncher[933]: + Received data: ['18738', 'osdx.utils.xos', 'set_console_log_level', 'info']
Apr 03 20:16:32.835575 osdx OSDxCLI[18738]: Signal 10 received
Apr 03 20:16:32.900322 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Apr 03 20:16:32.952696 osdx cfgd[1091]: [18738]Completed change to active configuration
Apr 03 20:16:32.959599 osdx OSDxCLI[18738]: User 'admin' committed the configuration.
Apr 03 20:16:32.992039 osdx OSDxCLI[18738]: User 'admin' left the configuration menu.
Apr 03 20:16:33.201601 osdx OSDxCLI[18738]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 03 20:16:33.202363 osdx OSDxCLI[18738]: pam_unix(cli:session): session closed for user admin
Apr 03 20:16:33.202686 osdx OSDxCLI[18738]: User 'admin' entered the configuration menu.
Apr 03 20:16:33.299153 osdx OSDxCLI[18738]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 03 20:16:33.299746 osdx OSDxCLI[18738]: pam_unix(cli:session): session closed for user admin
Apr 03 20:16:33.300043 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Apr 03 20:16:33.415278 osdx OSDxCLI[18738]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 03 20:16:33.444481 osdx cfgd[1091]: [18738]Completed change to active configuration
Apr 03 20:16:33.449466 osdx OSDxCLI[18738]: pam_unix(cli:session): session closed for user admin
Apr 03 20:16:33.449780 osdx OSDxCLI[18738]: User 'admin' committed the configuration.
Apr 03 20:16:33.452924 osdx INFO[24352]: SCRIPT SCRIPT_1 operations:
Apr 03 20:16:33.468666 osdx OSDxCLI[24358]: Tecla::GetLine tcgetattr error
Apr 03 20:16:33.469071 osdx OSDxCLI[24358]: User 'admin' has logged in.
Apr 03 20:16:33.482935 osdx OSDxCLI[24358]: User 'admin' executed a new command: 'interfaces ethernet show'.
Apr 03 20:16:33.484767 osdx OSDxCLI[24358]: User 'admin' has logged out.
Apr 03 20:16:33.484853 osdx OSDxCLI[24358]: Tecla::GetLine tcgetattr error
Apr 03 20:16:33.485858 osdx INFO[24352]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Apr 03 20:16:33.488556 osdx modulelauncher[24352]: 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
Apr 03 20:16:33.489900 osdx cfgd[1091]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Apr 03 20:16:33.489917 osdx cfgd[1091]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Apr 03 20:16:33.503180 osdx OSDxCLI[18738]: User 'admin' left the configuration menu.
Apr 03 20:16:33.649531 osdx OSDxCLI[18738]: 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 Wed 2024-04-03 20:16:31 UTC, end at Wed 2024-04-03 20:16:33 UTC. --
Apr 03 20:16:31.383888 osdx systemd-journald[625]: Runtime journal (/run/log/journal/c88512c9e850498898bc11ea5f3658d6) is 2.0M, max 16.0M, 14.0M free.
Apr 03 20:16:31.399985 osdx OSDxCLI[18738]: User 'admin' executed a new command: 'system journal clear'.
Apr 03 20:16:31.819332 osdx OSDxCLI[18738]: User 'admin' entered the configuration menu.
Apr 03 20:16:31.945292 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Apr 03 20:16:32.088849 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Apr 03 20:16:32.239653 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system configuration logging global info'.
Apr 03 20:16:32.359608 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Apr 03 20:16:32.490831 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Apr 03 20:16:32.609152 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Apr 03 20:16:32.705859 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Apr 03 20:16:32.822513 osdx modulelauncher[933]: + Received data: ['18738', 'osdx.utils.xos', 'set_console_log_level', 'info']
Apr 03 20:16:32.835575 osdx OSDxCLI[18738]: Signal 10 received
Apr 03 20:16:32.900322 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Apr 03 20:16:32.952696 osdx cfgd[1091]: [18738]Completed change to active configuration
Apr 03 20:16:32.959599 osdx OSDxCLI[18738]: User 'admin' committed the configuration.
Apr 03 20:16:32.992039 osdx OSDxCLI[18738]: User 'admin' left the configuration menu.
Apr 03 20:16:33.201601 osdx OSDxCLI[18738]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 03 20:16:33.202363 osdx OSDxCLI[18738]: pam_unix(cli:session): session closed for user admin
Apr 03 20:16:33.202686 osdx OSDxCLI[18738]: User 'admin' entered the configuration menu.
Apr 03 20:16:33.299153 osdx OSDxCLI[18738]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 03 20:16:33.299746 osdx OSDxCLI[18738]: pam_unix(cli:session): session closed for user admin
Apr 03 20:16:33.300043 osdx OSDxCLI[18738]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Apr 03 20:16:33.415278 osdx OSDxCLI[18738]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 03 20:16:33.444481 osdx cfgd[1091]: [18738]Completed change to active configuration
Apr 03 20:16:33.449466 osdx OSDxCLI[18738]: pam_unix(cli:session): session closed for user admin
Apr 03 20:16:33.449780 osdx OSDxCLI[18738]: User 'admin' committed the configuration.
Apr 03 20:16:33.452924 osdx INFO[24352]: SCRIPT SCRIPT_1 operations:
Apr 03 20:16:33.468666 osdx OSDxCLI[24358]: Tecla::GetLine tcgetattr error
Apr 03 20:16:33.469071 osdx OSDxCLI[24358]: User 'admin' has logged in.
Apr 03 20:16:33.482935 osdx OSDxCLI[24358]: User 'admin' executed a new command: 'interfaces ethernet show'.
Apr 03 20:16:33.484767 osdx OSDxCLI[24358]: User 'admin' has logged out.
Apr 03 20:16:33.484853 osdx OSDxCLI[24358]: Tecla::GetLine tcgetattr error
Apr 03 20:16:33.485858 osdx INFO[24352]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Apr 03 20:16:33.488556 osdx modulelauncher[24352]: 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
Apr 03 20:16:33.489900 osdx cfgd[1091]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Apr 03 20:16:33.489917 osdx cfgd[1091]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Apr 03 20:16:33.503180 osdx OSDxCLI[18738]: User 'admin' left the configuration menu.
Apr 03 20:16:33.649531 osdx OSDxCLI[18738]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Apr 03 20:16:33.689346 osdx OSDxCLI[18738]: pam_unix(cli:session): session closed for user admin
Apr 03 20:16:33.689623 osdx OSDxCLI[18738]: User 'admin' executed a new command: 'system journal show | cat'.
Apr 03 20:16:33.862156 osdx OSDxCLI[18738]: 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::425:f3ff:fe06:a2ff/64   up     up
dum1  fe80::588f:9aff:fe7c:6797/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.8-beta1
# Wed 03 Apr 2024 08:16:50 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.8-beta1
# Wed 03 Apr 2024 08:16:51 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.8-beta1
# Wed 03 Apr 2024 08:16:53 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