Accops Hyworks

Accops Hyworks

Automation Guide for Bloo

1. Objective

This document is used to configure syslog server in HyWorks management console to enable log forwarding to syslog server.

2. Prerequisites

• HyWorks management console access
• Syslog server IP
• Port must be open from HyWorks controller

3. Steps to Configure Syslog Server

Follow the steps below to configure the syslog server for log forwarding:

1. Login into HyWorks Controller Management Console.
2. Go to the following location: Settings > System > Syslog Config.

Provide the following details:

• Identity: Specify Server name, e.g., HWSCTRL1
• Remote Address: Specify Syslog server IP
• Remote Port: Specify port on which the syslog server is configured to receive logs
• Enable Syslog: Select to send logs to the configured syslog server.
• Click Update button to save the settings.

4. Advance Configurations

The following advance configurations can be done to get some extra logs:

Location of Controls: System -> Advance Config

• Controller Session Monitoring: This flag is used to enable Controller Session logging. After enabling this flag, it will add extra logs for user login and connect desktop and application. Default is false and should be marked as true to get additional session details.
• Controller Session Monitoring Interval: This value is used to define Controller Session Monitoring interval (in minutes). Default is 15 minutes.

5. Log Format Used for Syslog Server

Below is the log format used for HyWorks logs:

DateTime\_UserName\_OrganizationName\_LogLevel(Info/Error/Warn)\_LogMessage\_Exception(StackTrace)\_Logger(Entity)\_CorelationIdL1\_CorelationIdL2\_CorelationIdL3

HyWorks logs can be downloaded for verification from the following location on the HyWorks Controller Management console:

HyWorks management console -\> Logs -\> download logs

6. HyWorks Logs Parsing Examples

Field	Details	Example Log
@timestamp	Log timing	2021-11-23 17:30:48,138
Course\_Self\_Study\_Reservation\_Name	Name of CSS reservation from logs	\<14\>HWC-PROD: 2021-11-23 17:30:48,138 \_a0215550 \_default \_INFO \_User 'a0215550' log-in into course self-study reservation 'Res-EITWGH' and course '\[\]' – '2021888T013001'. \_ \_EDCLog
Self\_Study\_Course\_Code	CSS course name; if users create CSS, filter course name through this tag	User 'a0193741' log-in into course self-study reservation 'Res-GPIOG6' and course '' – '20211106202000'
Course\_Self\_Study\_Username	Username of user from CSS	User 'a0193741' log-in into course self-study reservation 'Res-GPIOG6' and course '' – '20211106202000'
HyWorks\_Identifier	HyWorks server name added as Identifier in Syslog settings in HyWorks	\<14\>HWC-PROD: 2021-11-23 17:30:48,138 \_a0215550 \_default \_INFO \_User 'a0215550' log-in into course self-study reservation 'Res-EITWGH' and course '\[\]' – '2021888T013001'. \_ \_EDCLog
LogType	Type of logs in HyWorks, i.e. INFO/ERROR/WARNING	2021-11-23 17:30:52,311 \_ \_default \_INFO \_'VDI-OC3XP6-0044' 'Shutdown' \_ \_EDCLog / 2021-11-23 17:30:48,028 \_a0215550 \_default \_WARN \_RDP login name changed from a0215550@kuecs.kyoto-u.ac.jp to a0215550 for desktop VDI-V1NAV4-0085 \_ \_EDCLog
Login\_Time	Login time of user logged into HyWorks	—
Profile	Organization details (Default in case of Kyoto HyLabs)	default
Self\_Study\_Reservation\_Name	Name of SS reservation	\<14\>HWC-PROD: 2021-11-23 11:09:20,062 \_a0181820 \_default \_INFO \_User 'a0181820' log-in into self-study reservation 'Res-X55BV0'. \_ \_EDCLog
Self\_Study\_Username	Username of user from SS	\<14\>HWC-PROD: 2021-11-23 11:09:20,062 \_a0181820 \_default \_INFO \_User 'a0181820' log-in into self-study reservation 'Res-X55BV0'. \_ \_EDCLog
Session\_Time	Specific to Application active time published in HyWorks (not applicable for HyLabs)	—
Username	User connected with VDI on Connect Desktop Agent / Connect Desktop Call	2021-11-23 11:09:20,062 \_a0181820 \_default \_INFO \_\['Connect Desktop'\] UserName: a0181820@kuecs.kyoto-u.ac.jp, Connect Desktop at:11:09:20.0625748 Total time taken – 00:00:01.424 \[Format: HH:MM:SS:sss\] \_ \_EDCLog
\_index	Select the index as per requirement. Available: HyWorks / HySecure / Metricbeat / Goldmaster	—
concurrent\_vms	Concurrent number of powered-on VMs at a particular time interval	2021-11-23 17:31:57,704 \_ \_default \_INFO \_\[Syslog\] System Usage log : Total license : 1000, Used license : 14, Total logged in users : 14, Logged in active users : 12, Logged in idle users : 1, Logged in disconnected users : 1, Total application sessions : 0, Total dedicated desktop sessions : 9, Total Power On Ready Desktop : 560 \_ \_EDCLog
host	HyWorks server address	—
idle\_users\_hw	Logged in idle users; users in idle state in HyWorks	See System Usage log example above.
license\_used\_hw	License used as per total logged in users	See System Usage log example above.
logged\_in\_active\_users\_hw	Users session in active state	See System Usage log example above.
logged\_in\_disconnected\_hw	Users sessions in disconnected state in HyWorks	See System Usage log example above.
loglvl	Controller log level: 14 = Info, 12 = Warning	—
message	Log message from HyWorks	—
timestamp	Log timing	—
total\_dedicated\_desktop\_sessions\_hw	Connected dedicated desktops in HyWorks	See System Usage log example above.
total\_licenses\_hw	Total available licenses in HyWorks	See System Usage log example above.
total\_logged\_in\_users\_hw	Total logged-in concurrent users at a particular time interval	See System Usage log example above.

7. Log Format Used in HyWorks

1. Login in HyWorks management console.
2. Go to Logs.
3. Download log file, compare all logs.