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 Tue 2024-04-23 17:20:12 UTC, end at Tue 2024-04-23 17:20:12 UTC. --
Apr 23 17:20:12.265799 osdx systemd-journald[567]: Runtime journal (/run/log/journal/6df91b3cebc34c1981199ddec73128ac) is 2.0M, max 16.0M, 14.0M free.
Apr 23 17:20:12.274116 osdx OSDxCLI[8118]: User 'admin' executed a new command: 'system journal clear'.
Apr 23 17:20:12.476548 osdx OSDxCLI[8118]: User 'admin' entered the configuration menu.
Apr 23 17:20:12.573878 osdx OSDxCLI[8118]: User 'admin' added a new cfg line: 'set system description DESC1'.
Apr 23 17:20:12.639171 osdx cfgd[1182]: [8118]Completed change to active configuration
Apr 23 17:20:12.641530 osdx OSDxCLI[8118]: User 'admin' committed the configuration.
Apr 23 17:20:12.681748 osdx OSDxCLI[8118]: 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-04-23 17:20

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

Show output

-- Logs begin at Tue 2024-04-23 17:20:12 UTC, end at Tue 2024-04-23 17:20:12 UTC. --
Apr 23 17:20:12.265799 osdx systemd-journald[567]: Runtime journal (/run/log/journal/6df91b3cebc34c1981199ddec73128ac) is 2.0M, max 16.0M, 14.0M free.
Apr 23 17:20:12.274116 osdx OSDxCLI[8118]: User 'admin' executed a new command: 'system journal clear'.
Apr 23 17:20:12.476548 osdx OSDxCLI[8118]: User 'admin' entered the configuration menu.
Apr 23 17:20:12.573878 osdx OSDxCLI[8118]: User 'admin' added a new cfg line: 'set system description DESC1'.
Apr 23 17:20:12.639171 osdx cfgd[1182]: [8118]Completed change to active configuration
Apr 23 17:20:12.641530 osdx OSDxCLI[8118]: User 'admin' committed the configuration.
Apr 23 17:20:12.681748 osdx OSDxCLI[8118]: User 'admin' left the configuration menu.
Apr 23 17:20:12.802439 osdx OSDxCLI[8118]: User 'admin' executed a new command: 'system journal show | tail -n 20'.
Apr 23 17:20:12.857077 osdx OSDxCLI[8118]: 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’, ‘MEM’: ‘2049’, ‘MON_PORT’: ‘5000’, ‘MON_ALIAS’: ‘VM0_MON’, ‘ADDR’: ‘localhost’, ‘CMD_TIMEOUT’: ’10s’, ‘REBOOT_TIMEOUT’: ‘300s’, ‘UPDATE_TIMEOUT’: ‘600s’, ‘COMMIT_TIMEOUT’: ’60s’, ‘DELETE_IMAGES’: ‘True’, ‘ALIAS’: ‘DUT0’, ‘FW_NAME’: ‘os_iso.iso’, ‘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-04-23 17:20:13.297581 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-04-23 17:20:13.332416 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.
2024-04-23 17:20:13.415636 auth-notice , OSDxCLI:  User 'admin' has logged out.
2024-04-23 17:20:15.059372 auth-notice , OSDxCLI:  User 'admin' has logged in.
2024-04-23 17:20:15.204672 auth-notice , OSDxCLI:  User 'admin' entered the configuration menu.
2024-04-23 17:20:15.271339 auth-notice , OSDxCLI:  User 'admin' added a new cfg line: 'set system description DESC2'.
2024-04-23 17:20:15.414048 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-04-23 17:20:15.429504 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.

---