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 202401241058.f949bb7-v3.9.1.2-snapshot
# Thu 25 Jan 2024 12:47:30 AM UTC
# 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-01-25 00:47:38 UTC, end at Thu 2024-01-25 00:47:42 UTC. --
Jan 25 00:47:38.459233 osdx systemd-journald[1486]: Runtime journal (/run/log/journal/6c43fcb6d98c40f095ee4a4601056b4b) is 4.0M, max 16.0M, 12.0M free.
Jan 25 00:47:38.480485 osdx OSDxCLI[17975]: User 'admin' executed a new command: 'system journal clear'.
Jan 25 00:47:39.253305 osdx osdx-coredump[18799]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Jan 25 00:47:39.261582 osdx OSDxCLI[17975]: User 'admin' executed a new command: 'system coredump delete all'.
Jan 25 00:47:40.429520 osdx OSDxCLI[17975]: User 'admin' entered the configuration menu.
Jan 25 00:47:40.616719 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jan 25 00:47:40.754021 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Jan 25 00:47:40.873334 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Jan 25 00:47:40.977792 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jan 25 00:47:41.098593 osdx zebra[1048]: [RZ3YY-GPH41][EC 100663310] snmp[warning]: Warning: Failed to connect to the agentx master agent ([NIL]):
Jan 25 00:47:41.098708 osdx zebra[1048]: [RZ3YY-GPH41][EC 100663310] snmp[warning]: Warning: Failed to connect to the agentx master agent ([NIL]):
Jan 25 00:47:41.111901 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Jan 25 00:47:41.211248 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Jan 25 00:47:41.326607 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Jan 25 00:47:41.519553 osdx modulelauncher[950]: + Received data: ['17975', 'osdx.utils.xos', 'set_console_log_level', 'info']
Jan 25 00:47:41.529107 osdx OSDxCLI[17975]: Signal 10 received
Jan 25 00:47:41.578401 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Jan 25 00:47:41.622478 osdx cfgd[1112]: [17975]Completed change to active configuration
Jan 25 00:47:41.629306 osdx OSDxCLI[17975]: User 'admin' committed the configuration.
Jan 25 00:47:41.682098 osdx OSDxCLI[17975]: User 'admin' left the configuration menu.
Jan 25 00:47:42.002643 osdx OSDxCLI[17975]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jan 25 00:47:42.003317 osdx OSDxCLI[17975]: pam_unix(cli:session): session closed for user admin
Jan 25 00:47:42.003550 osdx OSDxCLI[17975]: User 'admin' entered the configuration menu.
Jan 25 00:47:42.125380 osdx OSDxCLI[17975]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jan 25 00:47:42.125972 osdx OSDxCLI[17975]: pam_unix(cli:session): session closed for user admin
Jan 25 00:47:42.126257 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Jan 25 00:47:42.276453 osdx OSDxCLI[17975]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jan 25 00:47:42.280872 osdx cfgd[1112]: [17975]must validation for [system login user admin role] was skipped
Jan 25 00:47:42.280998 osdx cfgd[1112]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Jan 25 00:47:42.296983 osdx cfgd[1112]: Execute action [end] for node [system advisor ADVISOR1]
Jan 25 00:47:42.307163 osdx cfgd[1112]: [17975]Completed change to active configuration
Jan 25 00:47:42.315070 osdx OSDxCLI[17975]: pam_unix(cli:session): session closed for user admin
Jan 25 00:47:42.315415 osdx OSDxCLI[17975]: User 'admin' committed the configuration.
Jan 25 00:47:42.318864 osdx INFO[18938]: SCRIPT SCRIPT_1 operations:
Jan 25 00:47:42.335553 osdx OSDxCLI[18943]: Tecla::GetLine tcgetattr error
Jan 25 00:47:42.335995 osdx OSDxCLI[18943]: User 'admin' has logged in.
Jan 25 00:47:42.349357 osdx OSDxCLI[17975]: User 'admin' left the configuration menu.
Jan 25 00:47:42.357162 osdx OSDxCLI[18943]: User 'admin' executed a new command: 'interfaces ethernet show'.
Jan 25 00:47:42.359806 osdx OSDxCLI[18943]: User 'admin' has logged out.
Jan 25 00:47:42.359934 osdx OSDxCLI[18943]: Tecla::GetLine tcgetattr error
Jan 25 00:47:42.361715 osdx INFO[18938]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Jan 25 00:47:42.363086 osdx modulelauncher[18938]: 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
Jan 25 00:47:42.364134 osdx cfgd[1112]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Jan 25 00:47:42.364158 osdx cfgd[1112]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Jan 25 00:47:42.506785 osdx OSDxCLI[17975]: 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-01-25 00:47:38 UTC, end at Thu 2024-01-25 00:47:42 UTC. --
Jan 25 00:47:38.459233 osdx systemd-journald[1486]: Runtime journal (/run/log/journal/6c43fcb6d98c40f095ee4a4601056b4b) is 4.0M, max 16.0M, 12.0M free.
Jan 25 00:47:38.480485 osdx OSDxCLI[17975]: User 'admin' executed a new command: 'system journal clear'.
Jan 25 00:47:39.253305 osdx osdx-coredump[18799]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Jan 25 00:47:39.261582 osdx OSDxCLI[17975]: User 'admin' executed a new command: 'system coredump delete all'.
Jan 25 00:47:40.429520 osdx OSDxCLI[17975]: User 'admin' entered the configuration menu.
Jan 25 00:47:40.616719 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jan 25 00:47:40.754021 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Jan 25 00:47:40.873334 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Jan 25 00:47:40.977792 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Jan 25 00:47:41.098593 osdx zebra[1048]: [RZ3YY-GPH41][EC 100663310] snmp[warning]: Warning: Failed to connect to the agentx master agent ([NIL]):
Jan 25 00:47:41.098708 osdx zebra[1048]: [RZ3YY-GPH41][EC 100663310] snmp[warning]: Warning: Failed to connect to the agentx master agent ([NIL]):
Jan 25 00:47:41.111901 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Jan 25 00:47:41.211248 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Jan 25 00:47:41.326607 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Jan 25 00:47:41.519553 osdx modulelauncher[950]: + Received data: ['17975', 'osdx.utils.xos', 'set_console_log_level', 'info']
Jan 25 00:47:41.529107 osdx OSDxCLI[17975]: Signal 10 received
Jan 25 00:47:41.578401 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Jan 25 00:47:41.622478 osdx cfgd[1112]: [17975]Completed change to active configuration
Jan 25 00:47:41.629306 osdx OSDxCLI[17975]: User 'admin' committed the configuration.
Jan 25 00:47:41.682098 osdx OSDxCLI[17975]: User 'admin' left the configuration menu.
Jan 25 00:47:42.002643 osdx OSDxCLI[17975]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jan 25 00:47:42.003317 osdx OSDxCLI[17975]: pam_unix(cli:session): session closed for user admin
Jan 25 00:47:42.003550 osdx OSDxCLI[17975]: User 'admin' entered the configuration menu.
Jan 25 00:47:42.125380 osdx OSDxCLI[17975]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jan 25 00:47:42.125972 osdx OSDxCLI[17975]: pam_unix(cli:session): session closed for user admin
Jan 25 00:47:42.126257 osdx OSDxCLI[17975]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Jan 25 00:47:42.276453 osdx OSDxCLI[17975]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jan 25 00:47:42.280872 osdx cfgd[1112]: [17975]must validation for [system login user admin role] was skipped
Jan 25 00:47:42.280998 osdx cfgd[1112]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Jan 25 00:47:42.296983 osdx cfgd[1112]: Execute action [end] for node [system advisor ADVISOR1]
Jan 25 00:47:42.307163 osdx cfgd[1112]: [17975]Completed change to active configuration
Jan 25 00:47:42.315070 osdx OSDxCLI[17975]: pam_unix(cli:session): session closed for user admin
Jan 25 00:47:42.315415 osdx OSDxCLI[17975]: User 'admin' committed the configuration.
Jan 25 00:47:42.318864 osdx INFO[18938]: SCRIPT SCRIPT_1 operations:
Jan 25 00:47:42.335553 osdx OSDxCLI[18943]: Tecla::GetLine tcgetattr error
Jan 25 00:47:42.335995 osdx OSDxCLI[18943]: User 'admin' has logged in.
Jan 25 00:47:42.349357 osdx OSDxCLI[17975]: User 'admin' left the configuration menu.
Jan 25 00:47:42.357162 osdx OSDxCLI[18943]: User 'admin' executed a new command: 'interfaces ethernet show'.
Jan 25 00:47:42.359806 osdx OSDxCLI[18943]: User 'admin' has logged out.
Jan 25 00:47:42.359934 osdx OSDxCLI[18943]: Tecla::GetLine tcgetattr error
Jan 25 00:47:42.361715 osdx INFO[18938]: Operation 1 'interfaces ethernet show
                                         ':

                                         -----------------------------------------------
                                         Name  IP Address  Admin  Oper  Vrf  Description
                                         -----------------------------------------------
                                         eth0              down   down
                                         eth1              down   down
Jan 25 00:47:42.363086 osdx modulelauncher[18938]: 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
Jan 25 00:47:42.364134 osdx cfgd[1112]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Jan 25 00:47:42.364158 osdx cfgd[1112]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Jan 25 00:47:42.506785 osdx OSDxCLI[17975]: pam_unix(cli:session): session opened for user admin by admin(uid=1000)
Jan 25 00:47:42.567405 osdx OSDxCLI[17975]: pam_unix(cli:session): session closed for user admin
Jan 25 00:47:42.567762 osdx OSDxCLI[17975]: User 'admin' executed a new command: 'system journal show | cat'.
Jan 25 00:47:42.766759 osdx OSDxCLI[17975]: 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::4c6f:13ff:fe00:49a8/64  up     up
dum1  fe80::5468:e5ff:fe21:f116/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 202401241058.f949bb7-v3.9.1.2-snapshot
# Thu 25 Jan 2024 12:48:04 AM UTC
# 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 202401241058.f949bb7-v3.9.1.2-snapshot
# Thu 25 Jan 2024 12:48:05 AM UTC
# 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 202401241058.f949bb7-v3.9.1.2-snapshot
# Thu 25 Jan 2024 12:48:06 AM UTC
# 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