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-04-03 20:27:43 UTC, end at Wed 2024-04-03 20:27:44 UTC. --
Apr 03 20:27:43.422250 osdx systemd-journald[625]: Runtime journal (/run/log/journal/c88512c9e850498898bc11ea5f3658d6) is 2.0M, max 16.0M, 14.0M free.
Apr 03 20:27:43.441219 osdx OSDxCLI[3283]: User 'admin' executed a new command: 'system journal clear'.
Apr 03 20:27:43.903728 osdx OSDxCLI[3283]: User 'admin' entered the configuration menu.
Apr 03 20:27:44.034083 osdx OSDxCLI[3283]: User 'admin' added a new cfg line: 'set system description DESC1'.
Apr 03 20:27:44.185489 osdx cfgd[1091]: [3283]Completed change to active configuration
Apr 03 20:27:44.190371 osdx OSDxCLI[3283]: User 'admin' committed the configuration.
Apr 03 20:27:44.234017 osdx OSDxCLI[3283]: 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-03 20:27

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

Show output

-- Logs begin at Wed 2024-04-03 20:27:43 UTC, end at Wed 2024-04-03 20:27:44 UTC. --
Apr 03 20:27:43.422250 osdx systemd-journald[625]: Runtime journal (/run/log/journal/c88512c9e850498898bc11ea5f3658d6) is 2.0M, max 16.0M, 14.0M free.
Apr 03 20:27:43.441219 osdx OSDxCLI[3283]: User 'admin' executed a new command: 'system journal clear'.
Apr 03 20:27:43.903728 osdx OSDxCLI[3283]: User 'admin' entered the configuration menu.
Apr 03 20:27:44.034083 osdx OSDxCLI[3283]: User 'admin' added a new cfg line: 'set system description DESC1'.
Apr 03 20:27:44.185489 osdx cfgd[1091]: [3283]Completed change to active configuration
Apr 03 20:27:44.190371 osdx OSDxCLI[3283]: User 'admin' committed the configuration.
Apr 03 20:27:44.234017 osdx OSDxCLI[3283]: User 'admin' left the configuration menu.
Apr 03 20:27:44.426346 osdx OSDxCLI[3283]: User 'admin' executed a new command: 'system journal show | tail -n 20'.
Apr 03 20:27:44.547437 osdx OSDxCLI[3283]: 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-03 20:27:45.401804 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-04-03 20:27:45.435241 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.
2024-04-03 20:27:45.543093 auth-notice , OSDxCLI:  User 'admin' has logged out.
2024-04-03 20:27:47.258891 auth-notice , OSDxCLI:  User 'admin' has logged in.
2024-04-03 20:27:47.484761 auth-notice , OSDxCLI:  User 'admin' entered the configuration menu.
2024-04-03 20:27:47.622705 auth-notice , OSDxCLI:  User 'admin' added a new cfg line: 'set system description DESC2'.
2024-04-03 20:27:47.796157 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2024-04-03 20:27:47.828013 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.

---