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.6
# Mon 30 Oct 2023 01:17:28 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 Mon 2023-10-30 13:17:32 UTC, end at Mon 2023-10-30 13:17:34 UTC. --
Oct 30 13:17:32.404797 osdx systemd-journald[629]: Runtime journal (/run/log/journal/3d151f703f7748e3bca150e5e3f65077) is 2.0M, max 16.0M, 14.0M free.
Oct 30 13:17:32.424532 osdx OSDxCLI[20463]: User 'admin' executed a new command: 'system journal clear'.
Oct 30 13:17:32.805275 osdx OSDxCLI[20463]: User 'admin' entered the configuration menu.
Oct 30 13:17:32.929844 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 30 13:17:33.025022 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Oct 30 13:17:33.129080 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system configuration logging global info'.
Oct 30 13:17:33.260494 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 30 13:17:33.441349 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Oct 30 13:17:33.541356 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Oct 30 13:17:33.637314 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Oct 30 13:17:33.744171 osdx modulelauncher[935]: + Received data: ['20463', 'osdx.utils.xos', 'set_console_log_level', 'info']
Oct 30 13:17:33.754018 osdx OSDxCLI[20463]: Signal 10 received
Oct 30 13:17:33.814643 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Oct 30 13:17:33.876601 osdx cfgd[1093]: [20463]Completed change to active configuration
Oct 30 13:17:33.890940 osdx OSDxCLI[20463]: User 'admin' committed the configuration.
Oct 30 13:17:33.934162 osdx OSDxCLI[20463]: User 'admin' left the configuration menu.
Oct 30 13:17:34.161772 osdx OSDxCLI[20463]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 30 13:17:34.162557 osdx OSDxCLI[20463]: pam_unix(cli:session): session closed for user admin
Oct 30 13:17:34.162858 osdx OSDxCLI[20463]: User 'admin' entered the configuration menu.
Oct 30 13:17:34.261442 osdx OSDxCLI[20463]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 30 13:17:34.262036 osdx OSDxCLI[20463]: pam_unix(cli:session): session closed for user admin
Oct 30 13:17:34.262327 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Oct 30 13:17:34.372567 osdx OSDxCLI[20463]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 30 13:17:34.395557 osdx cfgd[1093]: [20463]Completed change to active configuration
Oct 30 13:17:34.401493 osdx OSDxCLI[20463]: pam_unix(cli:session): session closed for user admin
Oct 30 13:17:34.401809 osdx OSDxCLI[20463]: User 'admin' committed the configuration.
Oct 30 13:17:34.407094 osdx INFO[21198]: SCRIPT SCRIPT_1 operations:
Oct 30 13:17:34.418043 osdx OSDxCLI[21203]: Tecla::GetLine tcgetattr error
Oct 30 13:17:34.418340 osdx OSDxCLI[21203]: User 'admin' has logged in.
Oct 30 13:17:34.426746 osdx OSDxCLI[20463]: User 'admin' left the configuration menu.
Oct 30 13:17:34.432722 osdx OSDxCLI[21203]: User 'admin' executed a new command: 'interfaces ethernet show'.
Oct 30 13:17:34.434406 osdx OSDxCLI[21203]: User 'admin' has logged out.
Oct 30 13:17:34.434519 osdx OSDxCLI[21203]: Tecla::GetLine tcgetattr error
Oct 30 13:17:34.435304 osdx INFO[21198]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Oct 30 13:17:34.437275 osdx modulelauncher[21198]: 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 30 13:17:34.438683 osdx cfgd[1093]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Oct 30 13:17:34.438699 osdx cfgd[1093]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Oct 30 13:17:34.576907 osdx OSDxCLI[20463]: 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 Mon 2023-10-30 13:17:32 UTC, end at Mon 2023-10-30 13:17:34 UTC. --
Oct 30 13:17:32.404797 osdx systemd-journald[629]: Runtime journal (/run/log/journal/3d151f703f7748e3bca150e5e3f65077) is 2.0M, max 16.0M, 14.0M free.
Oct 30 13:17:32.424532 osdx OSDxCLI[20463]: User 'admin' executed a new command: 'system journal clear'.
Oct 30 13:17:32.805275 osdx OSDxCLI[20463]: User 'admin' entered the configuration menu.
Oct 30 13:17:32.929844 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 30 13:17:33.025022 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Oct 30 13:17:33.129080 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system configuration logging global info'.
Oct 30 13:17:33.260494 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 30 13:17:33.441349 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Oct 30 13:17:33.541356 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Oct 30 13:17:33.637314 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Oct 30 13:17:33.744171 osdx modulelauncher[935]: + Received data: ['20463', 'osdx.utils.xos', 'set_console_log_level', 'info']
Oct 30 13:17:33.754018 osdx OSDxCLI[20463]: Signal 10 received
Oct 30 13:17:33.814643 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Oct 30 13:17:33.876601 osdx cfgd[1093]: [20463]Completed change to active configuration
Oct 30 13:17:33.890940 osdx OSDxCLI[20463]: User 'admin' committed the configuration.
Oct 30 13:17:33.934162 osdx OSDxCLI[20463]: User 'admin' left the configuration menu.
Oct 30 13:17:34.161772 osdx OSDxCLI[20463]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 30 13:17:34.162557 osdx OSDxCLI[20463]: pam_unix(cli:session): session closed for user admin
Oct 30 13:17:34.162858 osdx OSDxCLI[20463]: User 'admin' entered the configuration menu.
Oct 30 13:17:34.261442 osdx OSDxCLI[20463]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 30 13:17:34.262036 osdx OSDxCLI[20463]: pam_unix(cli:session): session closed for user admin
Oct 30 13:17:34.262327 osdx OSDxCLI[20463]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Oct 30 13:17:34.372567 osdx OSDxCLI[20463]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 30 13:17:34.395557 osdx cfgd[1093]: [20463]Completed change to active configuration
Oct 30 13:17:34.401493 osdx OSDxCLI[20463]: pam_unix(cli:session): session closed for user admin
Oct 30 13:17:34.401809 osdx OSDxCLI[20463]: User 'admin' committed the configuration.
Oct 30 13:17:34.407094 osdx INFO[21198]: SCRIPT SCRIPT_1 operations:
Oct 30 13:17:34.418043 osdx OSDxCLI[21203]: Tecla::GetLine tcgetattr error
Oct 30 13:17:34.418340 osdx OSDxCLI[21203]: User 'admin' has logged in.
Oct 30 13:17:34.426746 osdx OSDxCLI[20463]: User 'admin' left the configuration menu.
Oct 30 13:17:34.432722 osdx OSDxCLI[21203]: User 'admin' executed a new command: 'interfaces ethernet show'.
Oct 30 13:17:34.434406 osdx OSDxCLI[21203]: User 'admin' has logged out.
Oct 30 13:17:34.434519 osdx OSDxCLI[21203]: Tecla::GetLine tcgetattr error
Oct 30 13:17:34.435304 osdx INFO[21198]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Oct 30 13:17:34.437275 osdx modulelauncher[21198]: 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 30 13:17:34.438683 osdx cfgd[1093]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Oct 30 13:17:34.438699 osdx cfgd[1093]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Oct 30 13:17:34.576907 osdx OSDxCLI[20463]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Oct 30 13:17:34.625044 osdx OSDxCLI[20463]: pam_unix(cli:session): session closed for user admin
Oct 30 13:17:34.625352 osdx OSDxCLI[20463]: User 'admin' executed a new command: 'system journal show | cat'.
Oct 30 13:17:34.759261 osdx OSDxCLI[20463]: 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::ccf5:1cff:fee5:21da/64  up     up
dum1  fe80::c8ae:93ff:feb5:9cf0/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.6
# Mon 30 Oct 2023 01:17:46 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.6
# Mon 30 Oct 2023 01:17:48 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.6
# Mon 30 Oct 2023 01:17:49 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