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 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\''

Step 2: Modify the following configuration lines 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'

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 interfaces ethernet eth0 address 10.215.200.50/24
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 operational 1 command 'interfaces ethernet show'
set system script SCRIPT_1 operational 2 command 'license show'

Step 2: Modify the following configuration lines 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

Oct 07 10:32:36.278296 osdx systemd-journald[115269]: Runtime Journal (/run/log/journal/ea320b11e8924984abe0660bdd8d3fcc) is 2.1M, max 15.3M, 13.2M free.
Oct 07 10:32:36.279699 osdx systemd-journald[115269]: Received client request to rotate journal, rotating.
Oct 07 10:32:36.279741 osdx systemd-journald[115269]: Vacuuming done, freed 0B of archived journals from /run/log/journal/ea320b11e8924984abe0660bdd8d3fcc.
Oct 07 10:32:36.288046 osdx OSDxCLI[115108]: User 'admin' executed a new command: 'system journal clear'.
Oct 07 10:32:36.623933 osdx osdx-coredump[120951]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Oct 07 10:32:36.631854 osdx OSDxCLI[115108]: User 'admin' executed a new command: 'system coredump delete all'.
Oct 07 10:32:37.058706 osdx OSDxCLI[115108]: User 'admin' entered the configuration menu.
Oct 07 10:32:37.139229 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 07 10:32:37.253076 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Oct 07 10:32:37.316221 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Oct 07 10:32:37.427296 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 07 10:32:37.499152 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Oct 07 10:32:37.590224 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Oct 07 10:32:37.652053 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Oct 07 10:32:37.796312 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'show working'.
Oct 07 10:32:37.873443 osdx modulelauncher[1279]: + Received data: ['115108', 'osdx.utils.xos', 'set_console_log_level', 'info']
Oct 07 10:32:37.891590 osdx OSDxCLI[115108]: Signal 10 received
Oct 07 10:32:37.902678 osdx ifmon[1281]: Changed log-level to info
Oct 07 10:32:37.935701 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Oct 07 10:32:37.972453 osdx cfgd[1439]: [115108]Completed change to active configuration
Oct 07 10:32:37.974515 osdx OSDxCLI[115108]: User 'admin' committed the configuration.
Oct 07 10:32:38.017131 osdx OSDxCLI[115108]: User 'admin' left the configuration menu.
Oct 07 10:32:38.209832 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.210264 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.210458 osdx OSDxCLI[115108]: User 'admin' entered the configuration menu.
Oct 07 10:32:38.275651 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.275828 osdx cfgd[1439]: Execute action [syntax] for node [system advisor ADVISOR1]
Oct 07 10:32:38.276111 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.276315 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Oct 07 10:32:38.361600 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.369479 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.369711 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'show changes'.
Oct 07 10:32:38.427293 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.439203 osdx cfgd[1439]: [115108]must validation for [system login user admin role] was skipped
Oct 07 10:32:38.439222 osdx cfgd[1439]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Oct 07 10:32:38.446582 osdx cfgd[1439]: Execute action [end] for node [system advisor ADVISOR1]
Oct 07 10:32:38.455544 osdx cfgd[1439]: [115108]Completed change to active configuration
Oct 07 10:32:38.457469 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.457794 osdx OSDxCLI[115108]: User 'admin' committed the configuration.
Oct 07 10:32:38.460773 osdx INFO[121092]: SCRIPT SCRIPT_1 operations:
Oct 07 10:32:38.466893 osdx OSDxCLI[121100]: Tecla::GetLine tcgetattr error
Oct 07 10:32:38.466901 osdx OSDxCLI[121100]: User 'admin' has logged in.
Oct 07 10:32:38.474598 osdx OSDxCLI[121100]: User 'admin' executed a new command: 'interfaces ethernet show'.
Oct 07 10:32:38.475508 osdx OSDxCLI[121100]: User 'admin' has logged out.
Oct 07 10:32:38.475513 osdx OSDxCLI[121100]: Tecla::GetLine tcgetattr error
Oct 07 10:32:38.476017 osdx INFO[121092]: Operation 1 'interfaces ethernet show
                                          ':

                                          -----------------------------------------------
                                          Name  IP Address  Admin  Oper  Vrf  Description
                                          -----------------------------------------------
                                          eth0              down   down
                                          eth1              down   down
Oct 07 10:32:38.477349 osdx modulelauncher[121092]: Traceback (most recent call last):
                                                      File "/osdx/sbin/modulelauncher.py", line 36, in run_file
                                                        result = getattr(module, args[0])(args, cfg_ses_id)
                                                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                                                      File "osdx/sbin/cfg/auto_scripts.py", line 61, in process
                                                      File "osdx/sbin/cfg/auto_scripts.py", line 108, in _execute_script
                                                      File "usr/lib/python3.11/subprocess.py", line 1182, in communicate
                                                    ValueError: Cannot send input after starting communication
Oct 07 10:32:38.478032 osdx cfgd[1439]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Oct 07 10:32:38.478044 osdx cfgd[1439]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Oct 07 10:32:38.485591 osdx OSDxCLI[115108]: User 'admin' left the configuration menu.
Oct 07 10:32:38.619900 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) 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

Oct 07 10:32:36.278296 osdx systemd-journald[115269]: Runtime Journal (/run/log/journal/ea320b11e8924984abe0660bdd8d3fcc) is 2.1M, max 15.3M, 13.2M free.
Oct 07 10:32:36.279699 osdx systemd-journald[115269]: Received client request to rotate journal, rotating.
Oct 07 10:32:36.279741 osdx systemd-journald[115269]: Vacuuming done, freed 0B of archived journals from /run/log/journal/ea320b11e8924984abe0660bdd8d3fcc.
Oct 07 10:32:36.288046 osdx OSDxCLI[115108]: User 'admin' executed a new command: 'system journal clear'.
Oct 07 10:32:36.623933 osdx osdx-coredump[120951]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Oct 07 10:32:36.631854 osdx OSDxCLI[115108]: User 'admin' executed a new command: 'system coredump delete all'.
Oct 07 10:32:37.058706 osdx OSDxCLI[115108]: User 'admin' entered the configuration menu.
Oct 07 10:32:37.139229 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 07 10:32:37.253076 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test false'.
Oct 07 10:32:37.316221 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system cli configuration logging global info'.
Oct 07 10:32:37.427296 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 advisor ADVISOR1'.
Oct 07 10:32:37.499152 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set interfaces ethernet eth0 address 10.215.200.50/24'.
Oct 07 10:32:37.590224 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 1 command 'interfaces ethernet show''.
Oct 07 10:32:37.652053 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system script SCRIPT_1 operational 2 command 'license show''.
Oct 07 10:32:37.796312 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'show working'.
Oct 07 10:32:37.873443 osdx modulelauncher[1279]: + Received data: ['115108', 'osdx.utils.xos', 'set_console_log_level', 'info']
Oct 07 10:32:37.891590 osdx OSDxCLI[115108]: Signal 10 received
Oct 07 10:32:37.902678 osdx ifmon[1281]: Changed log-level to info
Oct 07 10:32:37.935701 osdx kernel: 8021q: adding VLAN 0 to HW filter on device eth0
Oct 07 10:32:37.972453 osdx cfgd[1439]: [115108]Completed change to active configuration
Oct 07 10:32:37.974515 osdx OSDxCLI[115108]: User 'admin' committed the configuration.
Oct 07 10:32:38.017131 osdx OSDxCLI[115108]: User 'admin' left the configuration menu.
Oct 07 10:32:38.209832 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.210264 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.210458 osdx OSDxCLI[115108]: User 'admin' entered the configuration menu.
Oct 07 10:32:38.275651 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.275828 osdx cfgd[1439]: Execute action [syntax] for node [system advisor ADVISOR1]
Oct 07 10:32:38.276111 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.276315 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'set system advisor ADVISOR1 test true'.
Oct 07 10:32:38.361600 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.369479 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.369711 osdx OSDxCLI[115108]: User 'admin' added a new cfg line: 'show changes'.
Oct 07 10:32:38.427293 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.439203 osdx cfgd[1439]: [115108]must validation for [system login user admin role] was skipped
Oct 07 10:32:38.439222 osdx cfgd[1439]: Execute action [commit-subtree] for node [system advisor ADVISOR1]
Oct 07 10:32:38.446582 osdx cfgd[1439]: Execute action [end] for node [system advisor ADVISOR1]
Oct 07 10:32:38.455544 osdx cfgd[1439]: [115108]Completed change to active configuration
Oct 07 10:32:38.457469 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.457794 osdx OSDxCLI[115108]: User 'admin' committed the configuration.
Oct 07 10:32:38.460773 osdx INFO[121092]: SCRIPT SCRIPT_1 operations:
Oct 07 10:32:38.466893 osdx OSDxCLI[121100]: Tecla::GetLine tcgetattr error
Oct 07 10:32:38.466901 osdx OSDxCLI[121100]: User 'admin' has logged in.
Oct 07 10:32:38.474598 osdx OSDxCLI[121100]: User 'admin' executed a new command: 'interfaces ethernet show'.
Oct 07 10:32:38.475508 osdx OSDxCLI[121100]: User 'admin' has logged out.
Oct 07 10:32:38.475513 osdx OSDxCLI[121100]: Tecla::GetLine tcgetattr error
Oct 07 10:32:38.476017 osdx INFO[121092]: Operation 1 'interfaces ethernet show
                                          ':

                                          -----------------------------------------------
                                          Name  IP Address  Admin  Oper  Vrf  Description
                                          -----------------------------------------------
                                          eth0              down   down
                                          eth1              down   down
Oct 07 10:32:38.477349 osdx modulelauncher[121092]: Traceback (most recent call last):
                                                      File "/osdx/sbin/modulelauncher.py", line 36, in run_file
                                                        result = getattr(module, args[0])(args, cfg_ses_id)
                                                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                                                      File "osdx/sbin/cfg/auto_scripts.py", line 61, in process
                                                      File "osdx/sbin/cfg/auto_scripts.py", line 108, in _execute_script
                                                      File "usr/lib/python3.11/subprocess.py", line 1182, in communicate
                                                    ValueError: Cannot send input after starting communication
Oct 07 10:32:38.478032 osdx cfgd[1439]: External python command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true] finished with status 1
Oct 07 10:32:38.478044 osdx cfgd[1439]: Run trap command [cfg.auto_scripts process ADVISOR1 SCRIPT_1 true]: 1
Oct 07 10:32:38.485591 osdx OSDxCLI[115108]: User 'admin' left the configuration menu.
Oct 07 10:32:38.619900 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) by admin(uid=1000)
Oct 07 10:32:38.661374 osdx OSDxCLI[115108]: pam_unix(cli:session): session closed for user admin
Oct 07 10:32:38.661608 osdx OSDxCLI[115108]: User 'admin' executed a new command: 'system journal show | cat'.
Oct 07 10:32:38.736603 osdx OSDxCLI[115108]: pam_unix(cli:session): session opened for user admin(uid=1000) 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 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 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

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 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 2: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test true

Step 3: Modify the following configuration lines 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'

Note

Wait for the advisor to turn on. After that, wait for the advisor to turn off. This produces only one trigger.

Step 5: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test true

Step 6: Modify the following configuration lines 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'

Note

Wait for the advisor to turn on. After that, wait for the advisor to turn off. This produces only one trigger.

Step 8: Modify the following configuration lines in DUT0:

set system advisor ADVISOR1 test true

Step 9: Modify the following configuration lines 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'