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 2023-10-30 13:27:38 UTC, end at Mon 2023-10-30 13:27:39 UTC. --
Oct 30 13:27:38.393345 osdx systemd-journald[629]: Runtime journal (/run/log/journal/3d151f703f7748e3bca150e5e3f65077) is 2.0M, max 16.0M, 14.0M free.
Oct 30 13:27:38.408033 osdx OSDxCLI[28187]: User 'admin' executed a new command: 'system journal clear'.
Oct 30 13:27:38.775871 osdx OSDxCLI[28187]: User 'admin' entered the configuration menu.
Oct 30 13:27:38.897452 osdx OSDxCLI[28187]: User 'admin' added a new cfg line: 'set system description DESC1'.
Oct 30 13:27:39.016272 osdx cfgd[1093]: [28187]Completed change to active configuration
Oct 30 13:27:39.020463 osdx OSDxCLI[28187]: User 'admin' committed the configuration.
Oct 30 13:27:39.044491 osdx OSDxCLI[28187]: 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        2023-10-30 13:21

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

Show output

-- Logs begin at Mon 2023-10-30 13:27:38 UTC, end at Mon 2023-10-30 13:27:39 UTC. --
Oct 30 13:27:38.393345 osdx systemd-journald[629]: Runtime journal (/run/log/journal/3d151f703f7748e3bca150e5e3f65077) is 2.0M, max 16.0M, 14.0M free.
Oct 30 13:27:38.408033 osdx OSDxCLI[28187]: User 'admin' executed a new command: 'system journal clear'.
Oct 30 13:27:38.775871 osdx OSDxCLI[28187]: User 'admin' entered the configuration menu.
Oct 30 13:27:38.897452 osdx OSDxCLI[28187]: User 'admin' added a new cfg line: 'set system description DESC1'.
Oct 30 13:27:39.016272 osdx cfgd[1093]: [28187]Completed change to active configuration
Oct 30 13:27:39.020463 osdx OSDxCLI[28187]: User 'admin' committed the configuration.
Oct 30 13:27:39.044491 osdx OSDxCLI[28187]: User 'admin' left the configuration menu.
Oct 30 13:27:39.207207 osdx OSDxCLI[28187]: User 'admin' executed a new command: 'system journal show | tail -n 20'.
Oct 30 13:27:39.294371 osdx OSDxCLI[28187]: 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

2023-10-30 13:27:39.952004 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2023-10-30 13:27:39.976143 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.
2023-10-30 13:27:40.092854 auth-notice , OSDxCLI:  User 'admin' has logged out.
2023-10-30 13:27:41.936236 auth-notice , OSDxCLI:  User 'admin' has logged in.
2023-10-30 13:27:42.104990 auth-notice , OSDxCLI:  User 'admin' entered the configuration menu.
2023-10-30 13:27:42.198830 auth-notice , OSDxCLI:  User 'admin' added a new cfg line: 'set system description DESC2'.
2023-10-30 13:27:42.316419 auth-notice , OSDxCLI:  User 'admin' committed the configuration.
2023-10-30 13:27:42.359681 auth-notice , OSDxCLI:  User 'admin' left the configuration menu.

---