MLWMI Plugin

From Cinemar Wiki
Jump to: navigation, search

About

Introduction

What is MLWMI Plugin?

MLWMI is a powerful MLServer Plugin application designed for the MainLobby suite of products. It allows the user to view status and control various functions of any number of client machines. The MLWMI plugin consists of two parts:

1 – the MLServer 3 plugin - MLWMIServer

2 – the MLWMI Client program

System Requirements

Minimum:

	800MHz Pentium or Athlon processor 
	128MB RAM
	English version of Microsoft Windows 2000 or higher
	10MB of free hard drive space
	100% Windows compatible mouse
	MLServer 3.244 or later
	MainLobby Client 3.26 or later




MLWMI Architecture Diagram


Installation and Setup


This section will guide you through the basic installation and setup of MLWMI Server Plug-in.

To install MLWMI:

1. Go to the Cinemar MLInstaller and download MLWMI Server and MLWMI Client.

2. Using MLInstaller, on the MainLobby client PC, choose to install the MLWMI Client.

3. Using MLInstaller on the MLServer PC, choose to install the MLWMI Plugin.

4. Select the options appropriate for the server. Depending on your architechture, this may also include the Client User Interface and Client Program setup options.

5. On all other PCs that you wish to monitor/control, install the MLWMI_App_Setup.exe program. This will install the MLWMI Client program on the target computer. Select the options appropriate for the Client.

6. Repeat step 5 for all computers you wish to monitor/control.

7. Follow the below instructions to setup the plug-in:


Interface Introduction (Client Program)

1 Indicates the IP Address for the MLServer with MLWMI Plugin. Please note, this can be entered as an IP Address or Name ie, 192.1681.2. or Server1

2 Communication Port – Default Port ID is 1007. If this value is changed, it must also be changed in each MLWMI client.

3 Connect/Close button. Allows the user to open or close the connection to the server.

4 Indicates whether or not the client will connect to the server at startup. If not checked, the user will have to manually connect to the server

5 Indicates the interval at which the variables on the WMI MESSAGES page will be updated.

6 Indicates the interval at which the variables on the WARNING MESSAGES page will be updated.

7 Shows the user selected WMI Messages. The reported messages are based on the Microsoft WMI response variables

8 The VIEW button allows the user to view the contents of the message prior to selection.

9 This is the WMI Message that will be sent of the option is checked. The variables sent to MLServer can be found in the following sections of this document

10 Checks all of the WMI Message options

11 Clears all of the WMI Message options

12 Applies the user selections. This button MUST be pushed to save the setting and allow the messages to be processed correctly.

13 Indicates processes for which status information will be transmitted. Only the checked processes will have status information sent to the server. If the process is running at the time WMI Client is started, the pertinent process information will be collected. Only processes for which the path information is shown can be started and stopped using the MLWMI plug-in.

14 Indicates the % of drive space below which an WARNING Message will be sent. It is recommend that you put some value in this field otherwise your log will contain error messages. A value of 5 or 10 is recommended.

15 List of drives that can be monitored. Only the checked drives will be monitored.

16 Indicates whether the status of the client anti-virus software will be transmitted to the server.

17 Indicates whether the Wake-On-Lan (WOL) feature is enabled for the client. If enabled, the MAC address will be shown below the checkbox.

18 Allows the user to start a process from the client. Only process that have path information shown in 13 can be started using this feature.

19 This allows the user to reload the process list and path information. Only processes that are running when the button is pushed will be recorded. The process information is stored in the registry and does not need to redone at each startup.

20 Applies the user selections. This button MUST be pushed to save the setting and allow the messages to be processed correctly.

21 It is recommended that a Windows shortcut to WMIClient.exe is put in the Windows Startup directory so that the WMIClient launches each time windows boots.


Interface Introduction (Server Plugin)

22 Indicates the client systems that are being monitored.

23 Changes the WMI Message Update interval of the selected client.

24 Changes the Warn Message Update interval of the selected client.

25 Close the WMI CLIENT program on the selected client. The client must be restarted on the client machine.

26 Shutdowns the client.

27 Disconnect the WMI connection of the selected client. The client must be reconnected on the client machine.

28 Reboots the client.

29 Turns the client screen saver on and off.

30 Indicated the server port used for communication with the client. The default port is 1007.

31 Indicates if the variables are being redirected to another MLServer

32 Indicates the name of the MLServer receiving the redirects

33 Indicates the port of the MLServer receiving the redirects

34 A summary of the clients that are available to be restarted using the Wake-On-LAN (WOL) option. Only clients that have a MAC address shown can be restarted using the WOL option.

35 Send the WOL Magic Packet to the selected client. The client must be set up to accept/use the WOL Magic Packet for the process to be successful. This is done in the Bios of the PC.

36 Removes the client/MAC address from the table. The client will resend the MAC address on next collection.


Variables Created

MLWMI_[CLIENT_NAME]_ANTIVIRUSINFO

MLWMI_[CLIENT_NAME]_AVUPTODATE

MLWMI_[CLIENT_NAME]_BATTERYINFO

MLWMI_[CLIENT_NAME]_COMPUTERINFO

MLWMI_[CLIENT_NAME]_CPUINFO

MLWMI_[CLIENT_NAME]_CURRENTDATETIME

MLWMI_[CLIENT_NAME]_DRIVE0_NAME

MLWMI_[CLIENT_NAME]_DRIVE0_SPACE

MLWMI_[CLIENT_NAME]_DRIVE0_STATUS

MLWMI_[CLIENT_NAME]_DRIVE1_NAME

MLWMI_[CLIENT_NAME]_DRIVE1_SPACE

MLWMI_[CLIENT_NAME]_DRIVE1_STATUS

MLWMI_[CLIENT_NAME]_DRIVEINFO

MLWMI_[CLIENT_NAME]_HOMESEER_STATUS

MLWMI_[CLIENT_NAME]_LASTREBOOT

MLWMI_[CLIENT_NAME]_LASTWARNINGUPDATE

MLWMI_[CLIENT_NAME]_MACADDRESS

MLWMI_[CLIENT_NAME]_MAINLOBBY_STATUS

MLWMI_[CLIENT_NAME]_MEDIACENTER_STATUS

MLWMI_[CLIENT_NAME]_MEMORYINFO

MLWMI_[CLIENT_NAME]_MLSERVER_STATUS

MLWMI_[CLIENT_NAME]_OUTLOOK_STATUS

MLWMI_[CLIENT_NAME]_PAGEFILEINFO

MLWMI_[CLIENT_NAME]_SCREENSAVERSTATUS

MLWMI_[CLIENT_NAME]_SYSTEMUPTIME

MLWMI_[CLIENT_NAME]_UPDATEINTERVA

MLWMI_[CLIENT_NAME]_UPSINFO

MLWMI_[CLIENT_NAME]_VERSION

MLWMI_[CLIENT_NAME]_WARNINGUPDATEINTERVAL

MLWMI_[CLIENT_NAME]_WMIMESSAGE

MLWMI_[CLIENT_NAME]_WMIUPDATE


These variables will be created for each client registered with the system.

MLServer Commands

“ByName” means the Windows PC name. If “ByIP” works, and “ByName” does not, investigate hosts resolution issue on your PC LAN. This may be resolved by putting an entry in your PC hosts file of your PC name and IP address.


Disconnect Client

Disconnects client from MLWMI Server. MLWMI remains running on client PC.

Command

MLWMIServer|Disconnect~BYIP~192.168.1.1 or

MLWMIServer|Disconnect~BYName~FileServer02


Close Client

Disconnects from MLWMI Server. The MLWMI client is closed.

Command

MLWMIServer|Close~BYIP~192.168.1.1 or

MLWMIServer|Close~BYName~FileServer02


Update Warn Variables

Forces an update of the Warning Variables from the client PC.

Command

MLWMIServer|Warn~BYIP~192.168.1.1 or

MLWMIServer|Warn~BYName~FileServer02


Warn Interval Client

Changes the warning update interval on the client PC.

Command

MLWMIServer|WarnInt~BYIP~192.168.1.1 or

MLWMIServer|WarnInt~BYName~FileServer02


Update WMI Variables

Forces an update of the WMI Variables from the client PC.

Command

MLWMIServer|Update~BYIP~192.168.1.1 or

MLWMIServer|Update~BYName~FileServer02


Update Interval Client

Changes the warning update interval on the client PC.

Command

MLWMIServer|UpdateInt~BYIP~192.168.1.1 or

MLWMIServer|UpdateInt~BYName~FileServer02


Update Files on Client

Updates the MainLobby client files on a client PC.

Command

MLWMIServer|Update_files~BYIP~192.168.1.1

MLWMIServer|Update_files~BYName~FileServer02

Note: This process shuts down the MainLobby client on the machine while the updating takes place. The Mainlobby client is restarted after the update is complete.


Put Client to Sleep

Puts client PC into Sleep mode

Command

Command = SLEEP_CLIENT~ByName{ByIP}~Name{IP}

Note: you may need to wake up the PC locally as it likely will not respond to server calls once in sleep mode.


Put Client into Hibernation

Puts client PC into Hibernate mode

Command

Command = HIBERNATE_CLIENT~ByName{ByIP}~Name{IP}

Note: you may need to un-hibernate the PC locally as it likely will not respond to server calls once in hibernation.


Turn off Screen Saver

Turn off the screen saver on the client PC. Note: the “.scr” file extension must be associated to the default association.

Command

MLWMIServer|ScreenSaver_Off~BYIP~192.168.1.1 or

MLWMIServer|ScreenSaver_Off~BYName~FileServer02


Turn on Screen Saver

Turn on the screen saver on the client PC.

Command

MLWMIServer|ScreenSaver_On~BYIP~192.168.1.1 or MLWMIServer|ScreenSaver_On~BYName~FileServer02


Turn off Monitor

Turn off the Monitor on the client PC (this function may not work on all systems).

Command

MLWMIServer|Monitor_Off~BYIP~192.168.1.1 or

MLWMIServer|Monitor_Off~BYName~FileServer02 or

MLWMIServer|Monitor_Standby~BYIP~192.168.1.1 or

MLWMIServer|Monitor_Standby~BYName~FileServer02


Turn on Monitor

Turn on the Monitor on the client PC (this function may not work on all systems).

Command

MLWMIServer|Monitor_On~BYIP~192.168.1.1 or

MLWMIServer|Monitor_On~BYName~FileServer02


Reboot Client

Reboots the client PC.

Command

MLWMIServer|Reboot~BYIP~192.168.1.1 or MLWMIServer|Reboot~BYName~FileServer02


Shutdown Client

Shuts down the client PC.

Command

MLWMIServer|Shutdown~BYIP~192.168.1.1 or MLWMIServer|Shutdown~BYName~FileServer02


Wake-On-LAN

Wakes the client PC using the Wake-on-Lan Magic Packet method. Client PC must be configured to accept the WOL protocol (typically in the Bios). Some hardware combinations (motherboard / ethernet card / power supply) will not accept a WOL packet.

Command

MLWMIServer|WOL~BYIP~192.168.1.1 or MLWMIServer|WOL~BYName~FileServer02


Start Process on Client

Starts listed program on the client PC. Following programs can be controlled via MLWMI. Internet Explorer, Main Lobby, Main Lobby Server, J. River Media Center, and Homeseer.

Command

MLWMIServer|Start_Process~BYIP~192.168.1.1~Process or

MLWMIServer|Start_Process~BYName~FileServer02~Process

Process can be: MLServer.exe, Homeseer.exe, MediaCenter.Exe, MainLobby.exe, IExplore.exe or Outlook.exe


End Process on Client

Ends listed program on the client PC. Following programs can be controlled via MLWMI. Internet Explorer, Main Lobby, Main Lobby Server, J. River Media Center, and Homeseer.


Command

MLWMIServer|End_Process~BYIP~192.168.1.1~Process or

MLWMIServer|End_Process~BYName~FileServer02~Process

Process can be: MLServer.exe, Homeseer.exe, MediaCenter.Exe, MainLobby.exe, IExplore.exe or Outlook.exe


Compact Databases

When invoked, shuts down MLServer and makes a backup copy and then compacts all databases in the MLServer\data directory. Forces an update of the Warning Variables from the client PC.

Command

MLWMIServer|Compact_DB~BYIP~192.168.1.1 or

MLWMIServer|Compact_DB~BYName~{{CompName}}

Bugs

Feature Requests

Variable for detecting a client PC online or not (use Ping)