Smarts SAM Console How to create and implement a client tool.
Article ID: 331768
Updated On:
Products
VMware Smart Assurance
Issue/Introduction
Symptoms:
To provide an example of a working script that displays environment variables and outputs several SM_OBJ values so that users can have a visual reference to the client tools functionality. Also present screen shots of the Client Tool Creation Wizard using a SAM 9.3 Console.
Clarification on how to invoke a custom script that reviews Notification Properties and outputs the response from the script.
The documentation in the SAM Configuration Guide provides the steps needed use the client tool method to invoke a script however it does not provide an example or screen shots to help explain and understand all of the steps needed.
See Chapter 8 "Tool Configuration for the Global Manager" Pages 140 through 155 for the documentation for Client Tools
https://support.emc.com/docu46529_Smarts-Service-Assurance-Manager-9.2-Configuration-Guide.pdf?language=en_US
To provide an example of a working script that displays environment variables and outputs several SM_OBJ values so that users can have a visual reference to the client tools functionality. Also present screen shots of the Client Tool Creation Wizard using a SAM 9.3 Console.
Clarification on how to invoke a custom script that reviews Notification Properties and outputs the response from the script.
The documentation in the SAM Configuration Guide provides the steps needed use the client tool method to invoke a script however it does not provide an example or screen shots to help explain and understand all of the steps needed.
See Chapter 8 "Tool Configuration for the Global Manager" Pages 140 through 155 for the documentation for Client Tools
https://support.emc.com/docu46529_Smarts-Service-Assurance-Manager-9.2-Configuration-Guide.pdf?language=en_US
Environment
VMware Smart Assurance - SMARTS
Resolution
The Client Tool Creation Wizard can be used to create a new Client Tool and with the attached script you can test the functionality of the client tools in the Smarts SAM Console and review the output of the script.
From the document here the steps are as follows.
To configure a tool by using the Global Manager Administration Console:
1. Select the type of tool you need to configure from the Edit menu or click the appropriate toolbar button. This displays one of the following wizards:
Automated Tool Creation Wizard
Client Tool Creation Wizard
Server Tool Creation Wizard
2. Type a name for the tool. This name is displayed in the Global Manager Administration Console, and, for server and client tools, in the Global Console.
3. Do one of the following:
Click Create New.
Click Copy Existing.
When you copy an existing tool, the configuration parameters for the tool are the same as the copied tool.
4. Click Next.
5. Define the following tool parameters:
Program to run
Time-out Interval
Trace
Display (client and server tools only)
User Profiles (client and server tools only)
6. Click Next.
7. Use the Filter Builder to specify the Context Criteria for a server or client tool and click Next.
8. Use the Filter Builder to specify the Status Criteria for a server or client and click Next to advance to the confirmation screen.
9. Click Finish to create the tool. You will receive an error message or a success message based on the result.
Several Notes here: This example is using a Windows 2008 R2 Server with the Smarts 9.3 SAM Console Thick Client installed and the attached script is a modified SmGetEnv.cmd script found in the <BaseDir>CONSOLE\smarts\actions\client folder.
This is using the Client Tool Creation Wizard.
A client script must be located on the host where the Global Console is installed. The proper location is the BASEDIR/smarts/local/actions/client directory. The console user must be able to execute the script. Server and client tools are configured in the Global Manager Administration Console.
Once the script is in the proper directory, then the following steps can be completed to run the attached script. The Program drop down box will show all of the scripts that are currently in the BASEDIR/smarts/local/actions/client directory. This screen shot below shows you the available settings for your Client Tool Script. Make sure the correct user is assigned to the Client Tool
For the attached script to run correctly the following Context object must be changed to ICIM_Notification as showing below.
Specify A Title if desired in the next screen prompt.
Click Next to disable the tool or Finish to enable the tool.
Restart the Console for the tool to show in Client Tools.
This is the sample output of using the Client Tool on a notification on the attached SAM domain from the Notification Log Console
From the document here the steps are as follows.
To configure a tool by using the Global Manager Administration Console:
1. Select the type of tool you need to configure from the Edit menu or click the appropriate toolbar button. This displays one of the following wizards:
Automated Tool Creation Wizard
Client Tool Creation Wizard
Server Tool Creation Wizard
2. Type a name for the tool. This name is displayed in the Global Manager Administration Console, and, for server and client tools, in the Global Console.
3. Do one of the following:
Click Create New.
Click Copy Existing.
When you copy an existing tool, the configuration parameters for the tool are the same as the copied tool.
4. Click Next.
5. Define the following tool parameters:
Program to run
Time-out Interval
Trace
Display (client and server tools only)
User Profiles (client and server tools only)
6. Click Next.
7. Use the Filter Builder to specify the Context Criteria for a server or client tool and click Next.
8. Use the Filter Builder to specify the Status Criteria for a server or client and click Next to advance to the confirmation screen.
9. Click Finish to create the tool. You will receive an error message or a success message based on the result.
Several Notes here: This example is using a Windows 2008 R2 Server with the Smarts 9.3 SAM Console Thick Client installed and the attached script is a modified SmGetEnv.cmd script found in the <BaseDir>CONSOLE\smarts\actions\client folder.
This is using the Client Tool Creation Wizard.
A client script must be located on the host where the Global Console is installed. The proper location is the BASEDIR/smarts/local/actions/client directory. The console user must be able to execute the script. Server and client tools are configured in the Global Manager Administration Console.
Once the script is in the proper directory, then the following steps can be completed to run the attached script. The Program drop down box will show all of the scripts that are currently in the BASEDIR/smarts/local/actions/client directory. This screen shot below shows you the available settings for your Client Tool Script. Make sure the correct user is assigned to the Client Tool
For the attached script to run correctly the following Context object must be changed to ICIM_Notification as showing below.
Specify A Title if desired in the next screen prompt.
Click Next to disable the tool or Finish to enable the tool.
Restart the Console for the tool to show in Client Tools.
This is the sample output of using the Client Tool on a notification on the attached SAM domain from the Notification Log Console
Feedback
Yes
No
Powered by
