Check Logging

The following scenario shows how to display and register user actions performed on the OSDx CLI (Command Line Interface).

Test CLI Events Logging

Description

This scenario demonstrates how to show and store in a file the different actions that users perform on the CLI.

Scenario

Step 1: Set the following configuration in DUT0:

set system description DESC1

Step 2: Run command system journal show | tail -n 20 at DUT0 and expect this output:

Show output
-- Logs begin at Thu 2024-10-10 09:42:35 UTC, end at Thu 2024-10-10 09:42:37 UTC. --
Oct 10 09:42:35.440787 osdx systemd-journald[27260]: Runtime journal (/run/log/journal/c2d6011d26b547ba87daa360869210a1) is 2.0M, max 16.0M, 14.0M free.
Oct 10 09:42:35.468207 osdx OSDxCLI[1106]: User 'admin' executed a new command: 'system journal clear'.
Oct 10 09:42:36.183638 osdx osdx-coredump[15660]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Oct 10 09:42:36.191878 osdx OSDxCLI[1106]: User 'admin' executed a new command: 'system coredump delete all'.
Oct 10 09:42:37.136612 osdx OSDxCLI[1106]: User 'admin' entered the configuration menu.
Oct 10 09:42:37.245967 osdx OSDxCLI[1106]: User 'admin' added a new cfg line: 'set system description DESC1'.
Oct 10 09:42:37.383130 osdx cfgd[1328]: [1106]Completed change to active configuration
Oct 10 09:42:37.387295 osdx OSDxCLI[1106]: User 'admin' committed the configuration.
Oct 10 09:42:37.452943 osdx OSDxCLI[1106]: User 'admin' left the configuration menu.

Step 3: Run command system login show users at DUT0 and expect this output:

Show output
NAME     LINE         TIME             COMMENT
admin    ttyS0        2024-10-10 09:32

Step 4: Run command system journal show | tail -n 20 at DUT0 and expect this output:

Show output
-- Logs begin at Thu 2024-10-10 09:42:35 UTC, end at Thu 2024-10-10 09:42:37 UTC. --
Oct 10 09:42:35.440787 osdx systemd-journald[27260]: Runtime journal (/run/log/journal/c2d6011d26b547ba87daa360869210a1) is 2.0M, max 16.0M, 14.0M free.
Oct 10 09:42:35.468207 osdx OSDxCLI[1106]: User 'admin' executed a new command: 'system journal clear'.
Oct 10 09:42:36.183638 osdx osdx-coredump[15660]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Oct 10 09:42:36.191878 osdx OSDxCLI[1106]: User 'admin' executed a new command: 'system coredump delete all'.
Oct 10 09:42:37.136612 osdx OSDxCLI[1106]: User 'admin' entered the configuration menu.
Oct 10 09:42:37.245967 osdx OSDxCLI[1106]: User 'admin' added a new cfg line: 'set system description DESC1'.
Oct 10 09:42:37.383130 osdx cfgd[1328]: [1106]Completed change to active configuration
Oct 10 09:42:37.387295 osdx OSDxCLI[1106]: User 'admin' committed the configuration.
Oct 10 09:42:37.452943 osdx OSDxCLI[1106]: User 'admin' left the configuration menu.
Oct 10 09:42:37.647112 osdx OSDxCLI[1106]: User 'admin' executed a new command: 'system journal show | tail -n 20'.
Oct 10 09:42:37.738956 osdx OSDxCLI[1106]: User 'admin' executed a new command: 'system login show users'.

Step 5: Set the following configuration in DUT0:

set system syslog file CLI app OSDxCLI
set system syslog file CLI level info

Step 6: Login as admin user on {‘DOC’: ‘SDE’, ‘CAPS’: ‘all -cellular -ceetm’, ‘FWID’: ‘iso’, ‘LICENSE’: ‘VM’, ‘PORT’: ‘4000’, ‘ETH0’: ‘eth0’, ‘ETH1’: ‘eth1’, ‘MAC0’: ‘DE:AD:BE:EF:6C:10’, ‘MAC1’: ‘DE:AD:BE:EF:6C:11’, ‘HDA’: ‘/var/tmp/hd-vm0.img’, ‘CPUS’: ‘4’, ‘MEM’: ‘2049’, ‘MON_PORT’: ‘5000’, ‘MON_ALIAS’: ‘VM0_MON’, ‘ADDR’: ‘localhost’, ‘CMD_TIMEOUT’: ’10s’, ‘REBOOT_TIMEOUT’: ‘300s’, ‘UPDATE_TIMEOUT’: ‘600s’, ‘COMMIT_TIMEOUT’: ’60s’, ‘IMAGE_STORAGE’: ‘True’, ‘ALIAS’: ‘DUT0’, ‘FW_NAME’: ‘os_iso.iso’, ‘ROBOT_IP’: ‘10.215.168.64’, ‘NEEDS_REBOOT’: False, ‘NEEDS_LICENSE’: True}.

Step 7: Set the following configuration in DUT0:

set system description DESC2

Step 8: Run command file show running://log/user/CLI/CLI at DUT0 and expect this output:

Show output
2024-10-10 09:42:38.437473 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-10-10 09:42:38.504181 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.
2024-10-10 09:42:38.618176 auth-notice , OSDxCLI:  User 'admin' has logged out.
2024-10-10 09:42:40.401094 auth-notice , OSDxCLI:  User 'admin' has logged in.
2024-10-10 09:42:40.585121 auth-notice , OSDxCLI:  User 'admin' entered the configuration menu.
2024-10-10 09:42:40.697944 auth-notice , OSDxCLI:  User 'admin' added a new cfg line: 'set system description DESC2'.
2024-10-10 09:42:40.819094 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-10-10 09:42:40.844291 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.