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 Mon 2024-06-24 11:42:04 UTC, end at Mon 2024-06-24 11:42:06 UTC. --
Jun 24 11:42:04.357512 osdx systemd-journald[596]: Runtime journal (/run/log/journal/9a819f3302304ea795867ea7c248068f) is 2.0M, max 16.0M, 14.0M free.
Jun 24 11:42:04.388240 osdx OSDxCLI[379]: User 'admin' executed a new command: 'system journal clear'.
Jun 24 11:42:04.998137 osdx osdx-coredump[5072]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Jun 24 11:42:05.008812 osdx OSDxCLI[379]: User 'admin' executed a new command: 'system coredump delete all'.
Jun 24 11:42:06.076444 osdx OSDxCLI[379]: User 'admin' entered the configuration menu.
Jun 24 11:42:06.222299 osdx OSDxCLI[379]: User 'admin' added a new cfg line: 'set system description DESC1'.
Jun 24 11:42:06.359341 osdx cfgd[1115]: [379]Completed change to active configuration
Jun 24 11:42:06.363542 osdx OSDxCLI[379]: User 'admin' committed the configuration.
Jun 24 11:42:06.408374 osdx OSDxCLI[379]: 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-06-24 11:39

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

Show output
-- Logs begin at Mon 2024-06-24 11:42:04 UTC, end at Mon 2024-06-24 11:42:06 UTC. --
Jun 24 11:42:04.357512 osdx systemd-journald[596]: Runtime journal (/run/log/journal/9a819f3302304ea795867ea7c248068f) is 2.0M, max 16.0M, 14.0M free.
Jun 24 11:42:04.388240 osdx OSDxCLI[379]: User 'admin' executed a new command: 'system journal clear'.
Jun 24 11:42:04.998137 osdx osdx-coredump[5072]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
Jun 24 11:42:05.008812 osdx OSDxCLI[379]: User 'admin' executed a new command: 'system coredump delete all'.
Jun 24 11:42:06.076444 osdx OSDxCLI[379]: User 'admin' entered the configuration menu.
Jun 24 11:42:06.222299 osdx OSDxCLI[379]: User 'admin' added a new cfg line: 'set system description DESC1'.
Jun 24 11:42:06.359341 osdx cfgd[1115]: [379]Completed change to active configuration
Jun 24 11:42:06.363542 osdx OSDxCLI[379]: User 'admin' committed the configuration.
Jun 24 11:42:06.408374 osdx OSDxCLI[379]: User 'admin' left the configuration menu.
Jun 24 11:42:06.584939 osdx OSDxCLI[379]: User 'admin' executed a new command: 'system journal show | tail -n 20'.
Jun 24 11:42:06.688831 osdx OSDxCLI[379]: 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-06-24 11:42:07.492010 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-06-24 11:42:07.538715 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.
2024-06-24 11:42:07.649246 auth-notice , OSDxCLI:  User 'admin' has logged out.
2024-06-24 11:42:09.618300 auth-notice , OSDxCLI:  User 'admin' has logged in.
2024-06-24 11:42:09.802976 auth-notice , OSDxCLI:  User 'admin' entered the configuration menu.
2024-06-24 11:42:09.903754 auth-notice , OSDxCLI:  User 'admin' added a new cfg line: 'set system description DESC2'.
2024-06-24 11:42:10.107953 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-06-24 11:42:10.162043 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.