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 Wed 2024-05-22 10:23:55 UTC, end at Wed 2024-05-22 10:23:57 UTC. --
May 22 10:23:55.392551 osdx systemd-journald[11035]: Runtime journal (/run/log/journal/99893f06e2ec475e9e852fdd13370208) is 2.0M, max 16.0M, 14.0M free.
May 22 10:23:55.425726 osdx OSDxCLI[4198]: User 'admin' executed a new command: 'system journal clear'.
May 22 10:23:56.064434 osdx osdx-coredump[4816]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
May 22 10:23:56.072925 osdx OSDxCLI[4198]: User 'admin' executed a new command: 'system coredump delete all'.
May 22 10:23:57.042789 osdx OSDxCLI[4198]: User 'admin' entered the configuration menu.
May 22 10:23:57.206070 osdx OSDxCLI[4198]: User 'admin' added a new cfg line: 'set system description DESC1'.
May 22 10:23:57.315614 osdx cfgd[1125]: [4198]Completed change to active configuration
May 22 10:23:57.319098 osdx OSDxCLI[4198]: User 'admin' committed the configuration.
May 22 10:23:57.344817 osdx OSDxCLI[4198]: 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-05-22 10:23

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

Show output
-- Logs begin at Wed 2024-05-22 10:23:55 UTC, end at Wed 2024-05-22 10:23:57 UTC. --
May 22 10:23:55.392551 osdx systemd-journald[11035]: Runtime journal (/run/log/journal/99893f06e2ec475e9e852fdd13370208) is 2.0M, max 16.0M, 14.0M free.
May 22 10:23:55.425726 osdx OSDxCLI[4198]: User 'admin' executed a new command: 'system journal clear'.
May 22 10:23:56.064434 osdx osdx-coredump[4816]: Deleting all coredumps in /opt/vyatta/etc/config/coredump...
May 22 10:23:56.072925 osdx OSDxCLI[4198]: User 'admin' executed a new command: 'system coredump delete all'.
May 22 10:23:57.042789 osdx OSDxCLI[4198]: User 'admin' entered the configuration menu.
May 22 10:23:57.206070 osdx OSDxCLI[4198]: User 'admin' added a new cfg line: 'set system description DESC1'.
May 22 10:23:57.315614 osdx cfgd[1125]: [4198]Completed change to active configuration
May 22 10:23:57.319098 osdx OSDxCLI[4198]: User 'admin' committed the configuration.
May 22 10:23:57.344817 osdx OSDxCLI[4198]: User 'admin' left the configuration menu.
May 22 10:23:57.515802 osdx OSDxCLI[4198]: User 'admin' executed a new command: 'system journal show | tail -n 20'.
May 22 10:23:57.610919 osdx OSDxCLI[4198]: 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-05-22 10:23:58.404932 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-05-22 10:23:58.466458 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.
2024-05-22 10:23:58.561463 auth-notice , OSDxCLI:  User 'admin' has logged out.
2024-05-22 10:24:00.500209 auth-notice , OSDxCLI:  User 'admin' has logged in.
2024-05-22 10:24:00.679205 auth-notice , OSDxCLI:  User 'admin' entered the configuration menu.
2024-05-22 10:24:00.772035 auth-notice , OSDxCLI:  User 'admin' added a new cfg line: 'set system description DESC2'.
2024-05-22 10:24:00.888269 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-05-22 10:24:00.913647 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.