advertisement
vFoglight™
5.2.4
Command-Line Reference Guide
© 2008 Quest Software, Inc. ALL RIGHTS RESERVED.
This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser's personal use without the written permission of Quest Software, Inc.
If you have any questions regarding your potential use of this material, contact:
Quest Software World Headquarters
LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656 www.quest.com
email: [email protected]
Refer to our Web site for regional and international office information.
Trademarks
Quest, Quest Software, the Quest Software logo, Aelita, Akonix, Akonix L7 Enterprise, Akonix L7 Enforcer,
AppAssure, Benchmark Factory, Big Brother, DataFactory, DeployDirector, ERDisk, Foglight, Funnel Web, I/Watch,
Imceda, InLook, IntelliProfile, InTrust, Invertus, IT Dad, I/Watch, JClass, Jint, JProbe, LeccoTech, LiteSpeed,
LiveReorg, MessageStats, NBSpool, NetBase, Npulse, NetPro, PassGo, PerformaSure, Quest Central, SharePlex,
Sitraka, SmartAlarm, Spotlight, SQL LiteSpeed, SQL Navigator, SQL Watch, SQLab, Stat, StealthCollect, Tag and
Follow, Toad, T.O.A.D., Toad World, vANALYZER, vAUTOMATOR, vCONTROL, vCONVERTER, vEssentials, vFOGLIGHT, vOPTIMIZER, vRANGER PRO, vReplicator, Vintela, Virtual DBA, VizionCore, Xaffire, and XRT are trademarks and registered trademarks of Quest Software, Inc in the United States of America and other countries.
Other trademarks and registered trademarks used in this guide are property of their respective owners.
Disclaimer
The information in this document is provided in connection with Quest products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of
Quest products. EXCEPT AS SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE
LICENSE AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND
DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY
DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING,
WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF
INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and product descriptions at any time without notice. Quest does not make any commitment to update the information contained in this document.
License Credits and Third Party Information
To view license credit information, click the License Credits link on the Welcome to vFoglight online help page
Command-Line Reference Guide
March 2009
Version 5.2.4
Table of Contents
4 vFoglight
Command-Line Reference Guide
Table of Contents 5
6 vFoglight
Command-Line Reference Guide
Introduction to this Guide
This chapter provides information about what is contained in the vFoglight Command
Line Reference Guide. It also provides information about the vFoglight documentation suite and Vizioncore.
This chapter contains the following sections:
8 vFoglight Cartridge for VMware
Command Line Reference Guide
About vFoglight
vFoglight helps IT organizations understand the virtual infrastructure by managing the relationships and interaction between all the components in the environment, including data centers, data stores, clusters, resource pools, hosts and virtual machines. With vFoglight, administrators can quickly determine the root-cause of an incident or problem, track virtual machine (VM) movements and understand their impact, and identify contention for resources between virtual machines.
About this Guide
This Command Line Reference Guide provides information about the vFoglight command-line interface. You can use vFoglight commands to interface with different components of your monitoring environment instead of the browser interface.
This guide is intended for vFoglight System Administrators who want to use the vFoglight commands.
The Command Line Reference Guide is organized as follows:
Chapter 1, About the Command-Line Interface—Explains the command-line syntax, lists vFoglight commands and introduces the command-line interface using a getting started approach. Read this chapter to get an overview of vFoglight commands and how to get started.
Chapter 2, Managing the vFoglight Management Server—Describes the commands that allow you to perform server-related operations through the command-line interface and provides detailed instructions on how to get started with those commands. It provides reference information on server-related commands along with usage examples.
Use the server-related commands to perform a variety of tasks such as starting or stopping the vFoglight Management Server, upgrading the database, or managing encryption keys.
Chapter 3, chapterChapter 3, Managing Agents, Cartridges and Metrics—Provides information about the fglcmd interface that contains commands for managing common vFoglight entities such as agents, cartridges and metrics. It also explains the fglcmd syntax and contains additional getting started instructions that show you how to configure your environment. Use this chapter to find reference information about the
fglcmd commands and usage examples.
Appendix A, vFoglight Client Commands—Describes the commands that allow you to access the vFoglight Client through the command-line interface along with
Introduction to this Guide vFoglight Documentation Suite instructions on how to configure your environment to obtain access to the commands that allow you to start or stop the vFoglight Client display version information, or manage JVM options. Use this chapter to find reference information on the commands for managing the vFoglight Client along with usage examples.
vFoglight Documentation Suite
The vFoglight documentation suite is made up of the core documentation set, plus the documentation set for each vFoglight cartridge that you deploy. Documentation is provided in a combination of online help, PDF and HTML.
• Online Help: You can open the online help by selecting the Help tab from vFoglight’s action panel.
9
• PDF: The Getting Started Guide, What’s New Guide, System Requirements and
Platform Support Guide, Installation and Setup Guide set, Administration and
Configuration Guide, vFoglight User Guide, Command-Line Reference Guide,
Web Component Guide, and Web Component Tutorial, are provided as PDF files.
The PDF guides are included in the zip file downloaded from Vizioncore.
Adobe® Reader® is required.
• HTML: Release Notes are provided in HTML.
Core Documentation Set
The core documentation set consists of the following files:
10 vFoglight Cartridge for VMware
Command Line Reference Guide
• Release Notes (HTML)
• Getting Started Guide (PDF)
• What’s New Guide (PDF)
• System Requirements and Platform Support Guide (PDF)
• Installation and Setup Guide set (all in PDF format):
• Installation and Setup Guide—Installing on Windows with an Embedded
MySQL Database
• Installation and Setup Guide—Installing on Windows with an External
MySQL Database
• Installation and Setup Guide—Installing on Windows with an External Oracle
Database
• Administration and Configuration Guide (PDF and online help)
• vFoglight User Guide (PDF and online help)
• Advanced Configuration Guide set
• Command-Line Reference Guide (PDF and online help)
• Web Component Guide (PDF and online help)
• Web Component Tutorial (PDF and online help)
• Web Component Reference (online help)
Cartridge Documentation Sets
When you deploy a cartridge, the documentation set for the cartridge is installed. The online help for the cartridge is integrated automatically with the core vFoglight help.
When you open the help, the name of the cartridge is displayed in a top level entry within the table of contents.
Some cartridges include additional PDF guides, which may be one or more of the following: a Getting Started Guide, an Installation Guide, a User Guide, and a
Reference Guide.
Feedback on the Documentation
We are interested in receiving feedback from you about our documentation. For example, did you notice any errors in the documentation? Were any features undocumented? Do you have any suggestions on how we can improve the
Introduction to this Guide
Text Conventions documentation? All comments are welcome. Please submit your feedback to the following email address: [email protected]
Please do not submit Technical Support related issues to this email address.
Text Conventions
The following table summarizes how text styles are used in this guide:
Convention Description
Code
Variables
Interface
Monospace text represents code, code objects, and commandline input. This includes:
• Java language source code and examples of file contents
• Classes, objects, methods, properties, constants, and events
• HTML documents, tags, and attributes
Monospace-plus-italic text represents variable code or command-line objects that are replaced by an actual value or parameter.
Bold text is used for interface options that you select (such as menu items) as well as keyboard commands.
Files, components,
and documents
Italic text is used to highlight the following items:
• Pathnames, file names, and programs
• The names of other documents referenced in this guide
11
About Vizioncore Inc.
Vizioncore was formed in July 2002 as a consulting and software-development company with the mission to create easy-to-use software solutions that performed reliable and repeatable automation of datacenter functions specifically for the Citrix platform. A main corporate goal was to enable business partners to offer solutions that targeted real-world IT issues and provided the best possible installation and automation for their clients' systems.
12 vFoglight Cartridge for VMware
Command Line Reference Guide
Vizioncore's solutions have proved successful in organizations from small to mid-sized businesses to large enterprises, in a wide variety of vertical industries, including
Financial Services, Government, Healthcare, Manufacturing, and High Tech.
Vizioncore, Inc. can be found in offices around the globe and at www.vizioncore.com
.
Introduction to this Guide
About Vizioncore Inc.
13
Contacting Dell
Note: If you do not have an active Internet connection, you can find contact information on your purchase invoice, packing slip, bill, or Dell product catalog.
Dell provides several online and telephone-based support and service options. Availability varies by country and product, and some services may not be available in your area. To contact Dell for sales, technical support, or customer service issues:
1
2
3
Visit http://support.dell.com.
Verify your country or region in the Choose A Country/Region drop-down menu at the bottom of the page.
Click Contact Us on the left side of the page.Note: Toll-free numbers are for use within the country for which they are listed.
4
5
Select the appropriate service or support link based on your need.
Choose the method of contacting Dell that is convenient for you.
Country (City) Service Type
International Access
Code
Country Code
City Code
Anguilla
Antigua and Barbuda
Web Address
E-Mail Address
Technical Support., Customer Service, Sales
Web Address
E-Mail Address
Aomen
Technical Support., Customer Service, Sales
Technical Support
Dell
™
Dimension
™
, Dell Inspirion
™
, Dell
Optiplex
™
, Dell Lattitude
™
, and Dell
Argentina (Buenos Aires)
Precision
™
Servers and Storage
Web Address
International Access
E-Mail Address for Desktop/ Portable Computers
Code: 00
E-Mail Address for Servers and EMC
®
Storage
Country Code: 54
Products
City Code: 11
Customer Service
Technical Support
Aruba
Australia (Sydney)
International Access
Code: 0011
Country Code: 61
City Code: 2
Technical Support Services
Sales
Web Address
E-Mail Address
Technical Support., Customer Service, Sales
Web Address
Contact Dell Web Address
Technical Support., Customer Service, Sales
Area Codes,
Local Numbers, and
Toll-Free Numbers
Web and E-Mail Addresses www.Dell.com/ai la‐[email protected]
toll-free: 800-335-0031 www.Dell.com.ag
1-800-805-5924
0800-105
0800-105 www.dell.com.ar
toll-free: 0-800-444-0730 toll-free: 0-800-444-0733 toll-free: 0-800-444-0724
0-800-444-3355 www.Dell.com/aw la‐[email protected]
toll-free: 800-1578 support.ap.dell.com
support.ap.dell.com/contactus
13DELL-133355
Austria (Vienna)
International Access
Code: 900
Country Code: 43
City Code: 1
Bahamas
Barbados
Belgium (Brussels)
Bolivia
Brazil
International Access
Code: 00
Country Code: 55
City Code: 51
British Virgin Islands
Brunei
Country Code: 673
Canada (North York,
Ontario)
International Access
Code: 011
Cayman Islands
Web Address
E-Mail Address
Home/Small Business Sales
Home/Small Business Fax
Home/Small Business Customer Service
Home/Small Business Support
Preferred Accounts/Corporate Customer
Service Preferred Accounts/Corporate Customer
Switchboard
Web Address
E-Mail Address
Technical Support., Customer Service, Sales
Web Address
E-Mail Address
Technical Support., Customer Service, Sales
Web Address
General Support
General Support Fax
Customer Service
Corporate Sales
Fax
Switchboard
Web Address
E-Mail Address
Technical Support., Customer Service, Sales
Web Address
E-Mail Address
Customer Service and Tech Support
Technical Support Fax
Customer Service Fax
Sales
Technical Support, Customer Service, Sales
Technical Support (Penang, Malaysia)
Customer Service (Penang, Malaysia)
Transaction Sales (Penang, Malaysia)
Online Order Status Web Address
AutoTech (automated Hardware and Warranty
Support)
Customer Service
Home/Home Office
Small Business
Medium/Large Business, Government, Education
Hardware Warranty Phone Support
Support.euro.dell.com
0820 240 530 00
0820 240 530 49
0820 240 530 14
0820 240 530 17
0820 240 530 16
0820 240 530 17
0820 240 530 00 www.dell.com/bs la‐[email protected]
toll-free: 1-866-874-3038 www.dell.com/bb la‐[email protected]
1-800-534-3142
Support.euro.dell.com
02 481 92 88
02 481 92 95
02 713 15 65
02 481 91 00
02 481 91 99
02 481 91 00 www.dell.com/bo [email protected]
toll-free: 800-10-0238 www.dell.com/br
0800 970 3355
51 2104 5470
51 2104 5480
0800 722 3498 toll-free: 1-866-278-6820
604 633 4966
604 633 4888
604 633 4955 www.dell.ca/ostatus support.ca.dell.com
toll-free:1-800-247-9362 toll-free:1-800-847-4096 toll-free:1-800-906-3355 toll-free:1-800-387-5757 toll-free:1-800-847-4096 toll-free:1-800-387-5757
Computers for Home/Home Office
Computers for Small/Medium/Large Business
Government
Printers, Projectors, Televisions, Handheld,
Digital
Jukebox, and Wireless Sales
Home and Home Office Sales
Small Business
Medium/Large Business, Government
Spare Parts and Extended Service
E-Mail Address
Technical Support, Customer Service, Sales
1-877-335-5767 toll-free:1-800-999-3355 toll-free:1-800-387-5752 toll-free:1-800-387-5755
1 866 440 3355 la‐[email protected]
1-877-262-5415
Chile (Santiago)
Country Code: 56
City Code: 2
China (Xiamen)
Country Code: 86
City Code: 592
Columbia
Costa Rica
Czech Republic (Prague)
International Access
Code: 00
Country Code: 420
Denmark (Copenhagen)
International Access
Code: 00
Country Code: 45
Dominica
Web Address
E-Mail Address
Sales and Customer Support
Technical Support Web Address
Technical Support E-Mail Address
Customer Service E-Mail Address
Technical Support Fax
Technical Support – Dimension and Inspiron
Technical Support – OptiPlex, Lattitude and Dell
Precision
Technical Support – Servers and Storage
Technical Support – Projectors, PDAs, Switches,
Routers, etc
Technical Support – Printers
Customer Service
Customer Service Fax
Home and Small Business
Preferred Accounts Division
Large Corporate Accounts GCP
Large Corporate Accounts Key Accounts
Large Corporate Accounts North
Large Corporate Accounts North Government and
Education
Large Corporate Accounts East
Large Corporate Accounts East Government and
Education
Large Corporate Accounts Queue Team
Large Corporate Accounts South
Large Corporate Accounts West
Large Corporate Accounts Spare Parts
Web Address
E-Mail Address
Technical Support, Customer Service, Sales
Web Address
E-Mail Address
Technical Support, Customer Service, Sales
Web Address
E-Mail Address
Technical Support
Customer Service
Fax
Technical Fax
Switchboard
Web Address
Technical Support
Customer Service – Relational
Home/Small Business Customer Service
Switchboard – Relational
Switchboard Fax – Relational
Switchboard – Home/Small Business
Switchboard Fax – Home/Small Business
Web Address
E-Mail Address
Technical Support, Customer Service, Sales www.dell.com/cl la‐[email protected]
toll-free: 1230-020-4823 support.dell.com.cn
support.dell.com.cn/email [email protected]
592 818 14350 toll-free: 800 858 2969 toll-free: 800 858 0950 toll-free: 800 858 0960 toll-free: 800 858 2920 toll-free: 800 858 2311 toll-free: 800 858 2060
592 818 1308 toll-free: 800 858 2222 toll-free: 800 858 2557 toll-free: 800 858 2055 toll-free: 800 858 2628 toll-free: 800 858 2999 toll-free: 800 858 2955 toll-free: 800 858 2020 toll-free: 800 858 2669 toll-free: 800 858 2572 toll-free: 800 858 2355 toll-free: 800 858 2811 toll-free: 800 858 2621 www.dell.com/co la‐[email protected]
01-800-915-4755 www.dell.com/cr la‐[email protected]
0800-012-0231 support.euro.dell.com
22537 2727
22537 2707
22537 2714
22537 2728
22537 2711
Support.euro.dell.com
7023 0182
7023 0184
3287 5505
3287 1200
3287 1201
3287 5000
3287 5001 www.dell.com/dm la‐[email protected]
toll-free: 1-866-278-6821
Dominican Republic
Ecuador
El Salvador
Finland (Helsinki)
International Access
Code: 990
Country Code: 358
City Code: 9
France (Paris)
(Montpellier)
International Access
Code: 00
Country Code: 33
City Codes: (1) (4)
Germany (Frankfurt)
International Access
Code: 00
Country Code: 49
City Code: 69
Greece
International Access
Code: 00
Country Code: 49
Grenada
Web Address
E-Mail Address
Technical Support, Customer Service, Sales
Web Address
E-Mail Address
Technical Support, Customer Service, Sales
(Calling from Quito)
Technical Support, Customer Service, Sales
(Calling from Guayaquil)
Web Address
E-Mail Address
Technical Support, Customer Service, Sales
Web Address
E-Mail Address
Technical Support
Customer Service
Switchboard
Sales under 500 employees
Fax
Sales over 500 employees
Fax
Web Address
Home and Small Business
Technical Support
Customer Service
Switchboard
Switchboard (calls from outside of France)
Sales
Fax
Fax (calls from outside of France)
Corporate
Technical Support
Customer Service
Switchboard
Sales
Web Address
E-mail Address
Technical Support
Home/Small Business Customer Service
Global Segment Customer Service
Preferred Accounts Customer Service
Large Accounts Customer Service
Public Accounts Customer Service
Switchboard
Web Address
Technical Support
Gold Service Technical Support
Switchboard
Gold Service Switchboard
Sales
Fax
Web Address
E-Mail Address
Technical Support, Customer Service, Sales www.dell.com/do la‐[email protected]
1-800-156-1588 www.dell.com/ec la‐[email protected]
toll-free: 999-119-877-655-3355 toll-free: 1800-999-119-877-655-3355 www.dell.com/sv la‐[email protected]
800-6132 [email protected]
0207 533 555
0207 533 538
0207 533 533
0207 533 540
0207 533 530
0207 533 533
0207 533 530
Support.euro.dell.com
0825 387 270
0825 832 833
0825 004 700
04 99 75 40 00
0825 004 700
0825 004 701
04 99 75 40 01
0825 004 719
0825 338 339
55 94 71 00
01 55 94 71 00 support.euro.dell.com
069 9792-7200
0180-5-224400
069 9792-7320
069 9792-7320
069 9792-7320
069 9792-7320
069 9792-7000
Support.euro.dell.com
00800-44 14 95 18
00800-44 14 00 83
2108129810
2108129811
2108129800
2108129812 www.dell.com/gd la‐[email protected]
toll-free: 1-866-540-3355
Guatemala
Guyana
Web Address
E-Mail Address
Technical Support, Customer Service, Sales
E-Mail Address
Technical Support, Customer Service, Sales
Hong Kong
International Access
Code: 001
Country Code: 852
India
Web Address
Technical Support E-mail Address
Technical Support - Dimension and Inspiron
Technical Support - OptiPlex, Latitude, and Dell
Precision
Technical Support - Servers and Storage
Technical Support - Projectors, PDAs, Switches,
Routers, etc .
Customer Service
Large Corporate Accounts
Global Customer Programs
Medium Business Division
Home and Small Business Division
Dell Support Website
Portable and Desktop Support
Desktop Support E-mail Address
Portable Support E-mail Address
Phone Numbers www.dell.com/gt la‐[email protected]
1-800-999-0136 la‐[email protected]
toll-free: 1-877-270-4609 support.ap.dell.com
support.dell.com.cn/email
00852-2969 3188
00852-2969 3191
00852-2969 3196
00852-3416 0906
00852-3416 0910
00852-3416 0907
00852-3416 0908
00852-3416 0912
00852-2969 3105 support.ap.dell.com
080-25068032 or 080-25068034 or your city STD code + 60003355 or toll-free: 1-800-425-8045
Server Support
E-mail Address
Phone Numbers [email protected]
080-25068032 or 080-25068034 or your city STD code + 60003355 or toll-free: 1-800-425-8045
Gold Support Only
E-mail Address
Phone Numbers [email protected]
080-25068033 or your city STD code +
60003355 or
toll-free: 1-800-425-9045
Customer Service
Home and Small Business
Large Corporate Accounts
Sales
Large Corporate Accounts
Home and Small Business
toll-free : 1800-4254051
toll free : 1800-4252067
1600 33 8044
1600 33 8046
Ireland (Cherrywood)
International Access
Code: 00
Country Code: 353
City Code: 1
Italy (Milan)
International Access
Code: 00
Country Code: 39
City Code: 02
Jamaica
Web Address
Technical Support
E-mail Address
Business computers
Home computers
At Home Support
Sales
Home
Small Business
Medium Business
Large Business
E-mail Address
Customer Service
Home and Small Business
Business (greater than 200 employees)
General
Fax/Sales fax
Switchboard
U.K. Customer Service (dealing with U.K.only)
Corporate Customer Service (dial within U.K. only)
U.K. Sales (dial within U.K. only)
Web Address
Home and Small Business
Technical Support
Customer Service
Fax
Switchboard
Corporate
Technical Support
Customer Service
Fax
Switchboard
E-mail Address
Technical Support, Customer Service, Sales
(dial from within Jamaica only)
Support.euro.dell.com
1850 543 543
1850 543 543
1850 200 889
1850 333 200
1850 664 656
1850 200 646
1850 200 646
204 4014
1850 200 982
204 0103
204 4444
0870 906 0010
0870 907 4499
0870 907 4000
Support.euro.dell.com
02 577 826 90
02 696 821 14
02 696 821 13
02 696 821 12
02 577 826 90
02 577 825 55
02 575 035 30
02 577 821 [email protected]
1-800-440-920
Japan (Kawasaki)
International Access
Code: 001
Country Code: 81
City Code: 44
Korea (Seoul)
International Access
Code: 001
Country Code: 82
City Code: 2
Latin America
Luxemborg
International Access
Code: 00
Country Code: 352
Macao
Country Code: 83
Web Address
Technical Support - Dimension and Inspiron
Technical Support outside of Japan - Dimension and Inspiron
Technical Support - Dell Precision, OptiPlex, and
Latitude
Technical Support outside of Japan - Dell
Precision, OptiPlex, and Latitude
Technical Support - Dell PowerApp™, Dell
PowerEdge™, Dell PowerConnect™, and Dell
PowerVault™,
Technical Support outside of Japan - PowerApp,
PowerEdge, PowerConnect, and PowerVault
Technical Support - Projectors, PDAs, Printers,
Routers
Technical Support outside of Japan - Projectors,
PDAs, Printers, Routers
Faxbox Service
24-Hour Automated Order Status Service
Customer Service
Business Sales Division - up to 400 employees
Preferred Accounts Division Sales - over 400 employees
Public Sales - government agencies, educational institutions, and medical institutions
Global Segment Japan
Individual User
Individual User Online Sales
Individual User Real Site Sales
Switchboard
Web Address
Technical Support, Customer Service
Technical Support - Dimension, PDA, Electronics, and Accessories
Sales
Fax
Switchboard
Customer Technical Support (Austin, Texas,
U.S.A.)
Customer Service (Austin, Texas, U.S.A.)
Fax (Technical Support and Customer Service)
(Austin, Texas, U.S.A.)
Sales (Austin, Texas, U.S.A.)
SalesFax (Austin, Texas, U.S.A.)
Web Address
Support
Home/Small Business Sales
Corporate Sales
Customer Service
Fax
Technical Support
Customer Service (Xiamen, China)
Transaction Sales (Xiamen, China) support.jp.dell.com
toll-free: 0120-198-26
81-44-520-1435 toll-free: 0120-198-433
81-44-556-3894 toll-free: 0120-198-498
81-44-556-4162 toll-free: 0120-981-690
81-44-556-3468
044-556-3490
044-556-3801
044-556-4240
044-556-1465
044-556-3433
044-556-5963
044-556-3469
044-556-1657
044-556-2203
044-556-4649
044-556-4300
Support.ap.dell.com
toll-free: 080-200-3800 toll-free: 080-200-3801 toll-free: 080-200-3600
2194-6202
2194-6000
512 728-4093
512 728-3619
512 728-3883
512 728-4397
512 728-4600 or 512 728-3772
Support.euro.dell.com
3420808075
+32 (0)2 713 15 96
26 25 77 81
+32 (0)2 481 91 19
26 25 77 82 toll-free: 0800 105
34 160 910
29 693 115
Malaysia (Penang)
International Access
Code: 00
Country Code: 60
City Code: 4
Mexico
International Access
Code: 00
Country Code: 52
Montserrat
Netherlands
Antilles
Netherlands
(Amsterdam)
International Access
Code: 00
Country Code: 31
City Code: 20
New Zealand
International Access
Code: 00
Country Code: 64
Nicaragua
Norway (Lysaker)
International Access
Code: 00
Country Code: 47
Panama
Peru
Web Address
Technical Support - Dell Precision, OptiPlex, and
Latitude
Technical Support - Dimension, Inspiron, and
Electronics and Accessories
Technical Support - PowerApp, PowerEdge,
PowerConnect, and PowerVault
Customer Service
Transaction Sales
Corporate Sales
Web Address
E-mail Address
Customer Technical Support
Sales
Customer Service
Main
E-mail Address
Technical Support, Customer Service, Sales
Support.ap.dell.com
toll-free: 1800 880 193 toll-free: 1800 881 306 toll-free: 1800 881 386 toll-free: 1800 881 306 (option 6) toll-free: 1800 888 202 toll-free: 1800 888 213 www.dell.com/mx la‐[email protected]
001-877-384-8979 or 001-877-269-3383
50-81-8800 or 01-800-888-3355
001-877-384-8979 or 001-877-269-3383
50-81-8800 or 01-800-888-3355 la‐[email protected]
E-mail Address
Web Address
Technical Support
Technical Support Fax
Home/Small Business Customer Service
Relational Customer Service
Home/Small Business Sales
Relational Sales
Home/Small Business Sales Fax
Relational Sales Fax
Switchboard
Switchboard Fax
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Toll-free: 1-866-278-6822 la‐[email protected]
support.euro.dell.com
020 674 45 00
020 674 47 66
020 674 42 00
020 674 43 25
020 674 55 00
020 674 50 00
020 674 47 75
020 674 47 50
020 674 50 00
020 674 47 50
Support.ap.dell.com
Support.ap.dell.com/contactus
0800 441 567
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Web Address
Technical Support
Relational Customer Service
Home/Small Business Customer Service
Switchboard
Fax Switchboard
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Web Address
E-mail Address
Technical Support, Customer Service, Sales www.dell.com/ni la‐[email protected]
001-800-220-1377
Support.euro.dell.com
671 16882
671 17575
231 62298
671 16800
671 16865 www.dell.com/pa la‐[email protected]
011-800-507-1264 www.dell.com/pe la‐[email protected]
0800-50-669
Poland (Warsaw)
International Access
Code: 011
Country Code: 48
City Code: 22
Portugal
International Access
Code: 00
Country Code: 351
Web Address
E-mail Address
Customer Service Phone
Customer Service
Sales
Customer Service Fax
Reception Desk Fax
Switchboard
Web Address
Technical Support
Customer Service
Sales
Puerto Rico
St. Kitts and Nevis
St. Lucia
St. Vincent and the
Grenadines
Singapore
International Access
Code: 005
Country Code: 65
Slovakia (Prague)
International Access
Code: 00
Country Code: 421
Fax
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Web Address
E-mail Address
Technical Support, Customer Service, Sales
NOTE: The phone numbers in this section should be called from within Singapore or Malaysia only.
Web Address
Technical Support - Dimension, Inspiron, and
Electronics and Accessories
Technical Support - OptiPlex, Latitude,
and Dell Precision
Technical Support - PowerApp, PowerEdge,
PowerConnect, and PowerVault
Customer Service
Transaction Sales
Corporate Sales
Web Address
E-mail Address
Technical Support
Customer Service
Fax
Tech Fax
Switchboard (Sales)
South Africa
(Johannesburg)
International Access
Code: 09/091
Country Code: 27
City Code: 11
Web Address
E-mail Address
Gold Queue
Technical Support
Customer Service
Sales support.euro.dell.com
57 95 700
57 95 999
57 95 999
57 95 806
57 95 998
57 95 999
Support.euro.dell.com
707200149
800 300 413
800-300-410 or 800-300 -411 or
800-300-412 or 21-422-07-10
21-424-01-12 www.dell.com/pr la‐[email protected]
1-877-537-3355 www.dell.com/kn la‐[email protected]
toll-free: 1-866-540-3355 www.dell.com/lc la‐[email protected]
toll-free: 1-866-464-4352 www.dell.com/vc la‐[email protected]
toll-free: 1-866-464-4353 support.ap.dell.com
toll-free: 1 800 394 7430 toll-free: 1 800 394 7488 toll-free: 1 800 394 7478 toll-free: 1 800 394 7430 (option 6) toll-free: 1 800 394 7412 toll-free: 1 800 394 7419 support.euro.dell.com
02 5441 5727
420 22537 2707
02 5441 8328
02 5441 8328
02 5441 8328
02 5441 7585 support.euro.dell.com
011 709 7713
011 709 7710
011 709 7707
011 709 7700
Spain (Madrid)
International Access
Code: 00
Country Code: 34
City Code: 91
Web Address
Home and Small Business
Technical Support
Customer Service
Sales
Switchboard
Fax
Corporate
Sweden (Upplands
Vasby)
International Access
Code: 00
Country Code: 46
City Code: 8
Switzerland (Geneva)
Technical Support
Customer Service
Switchboard
Fax
Web Address
Technical Support
Relational Customer Service
Home/Small Business Customer Service
Employee Purchase Program (EPP) Support
Technical Support Fax
Web Address
E-mail Address
International Access
Code: 00
Country Code: 41
City Code: 22
Technical Support – Home and Small Business
Technical Support – Corporate
Customer Service – Home and Small Business
Customer Service – Corporate
Fax
Switchboard
Web Address Taiwan
International Access
Code: 002
Country Code: 886
E-mail Address
Technical Support - OptiPlex, Latitude, Inspiron,
Dimension, and Electronics and Accessories
Technical Support - Servers and Storage
Customer Service
Transaction Sales
Corporate Sales
Web Address Thailand
International Access
Code: 001
Country Code: 66
Trinidad/Tobago
Technical Support (OptiPlex, Latitude, and Dell
Precision)
Technical Support (PowerApp, PowerEdge,
PowerConnect, and PowerVault)
Customer Service
Corporate Sales
Transaction Sales
Web Address
E-mail Address
Turks and Caicos Islands
Technical Support, Customer Service, Sales
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Support.euro.com
902 100 130
902 118 540
902 118 541
902 118 541
902 118 539
902 100 130
902 115 236
91 722 92 00
91 722 95 83 support.euro.dell.com
08 590 05 199
08 590 05 642
08 587 70 527
020 140 14 44
08 590 05 594
Support.euro.dell.com
0844 811 411
0844 822 844
0848 802 202
0848 821 721
022 799 01 90
022 799 01 01 support.ap.dell.com
support.dell.com.cn/email toll-free: 0080 186 1011 toll-free: 0080 160 1256 toll-free: 0080 160 1250 (option 5) toll-free: 0080 165 1228 toll-free: 0080 165 1227
Support.ap.dell.com
toll-free: 1800 0060 07 toll-free: 1800 0600 09 toll-free: 1800 006 007 (option 7) toll-free: 1800 006 009 toll-free: 1800 006 006 www.dell.com/tt la‐[email protected]
toll-free: 1-888-799-5908 www.dell.com/tc la‐[email protected]
toll-free: 1-877-441-4735
U.K.(Bracknell)
International Access
Code: 00
Country Code: 44
City Code: 1344
Uruguay
U.S.A. (Austin, Texas)
International Access
Code: 011
Country Code: 1
Web Address
E-mail Address
Customer Service Website
Sales
Home and Small Business Sales
Corporate/Public Sector Sales
Customer Service
Home and Small Business
Corporate
Preferred Accounts (500-5000 employees)
Global Accounts
Central Government
Local Government & Education
Health
Technical Support
Corporate/Preferred Accounts/PCA (1000+ employees)
Other Dell Products
General
Home and Small Business Fax
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Automated Order-Status Service
AutoTech (portable and desktop computers)
Hardware and Warranty Support (Dell TV,
Printers, and Projectors ) for Relationship customers
Consumer (Home and Home Office) Support for
Dell products
Customer Service
Employee Purchase Program (EPP) Customers
Financial Services Web Address
Financial Services (lease/loans)
Financial Services (Dell Preferred Accounts
[DPA])
Business
Customer Service
Employee Purchase Program (EPP)
Customer s Support for printers, projectors, PDAs, and MP3 players
Public (government, education, and healthcare)
Customer Service and Support
Employee Purchase Program (EPP) Customers
Dell Sales
Dell Outlet Store (Dell refurbished computers)
Software and Peripherals Sales
Spare Parts Sales
Extended Service and Warranty Sales
Fax
Dell Services for the Deaf, Hard-of-Hearing, or
Speech-Impaired upport.euro.dell.com
support.euro.dell.com/uk/en/ECare/ form/home.asp
0870 907 4000
01344 860 456
0870 906 0010
01344 373 185
0870 906 0010
01344 373 186
01344 373 196
01344 373 199
01344 373 194
0870 908 0500
0870 353 0800
0870 907 4006 www.dell.com/uy la‐[email protected]
toll-free: 000-413-598-2521 toll-free: 1-800-433-9014 toll-free: 1-800-247-9362 toll-free: 1-877-459-7298 toll-free: 1-800-624-9896 toll-free: 1-800-624-9897 toll-free: 1-800-695-8133 www.dellfinancialservices.com
toll-free: 1-877-577-3355 toll-free: 1-800-283-2210 toll-free: 1-800-624-9897 toll-free: 1-800-695-8133 toll-free: 1-877-459-7298 toll-free: 1-800-456-3355 toll-free: 1-800-695-8133 toll-free: 1-800-289-3355 or
toll-free: 1-800-879-3355 toll-free: 1-888-798-7561 toll-free: 1-800-671-3355 toll-free: 1-800-357-3355 toll-free: 1-800-247-4618 toll-free: 1-800-727-8320 toll-free: 1-877-DELLTTY
(1-877-335-5889)
U.S. Virgin Islands
Venezuela
Web Address
E-mail Address
Technical Support, Customer Service, Sales
Web Address
E-mail Address
Technical Support, Customer Service, Sales www.dell.com/vi la‐[email protected]
toll‐free: 1‐877‐702‐4360 www.dell.com/ve la‐[email protected]
0800‐100‐4752
0
About the Command-Line Interface
This manual describes the commands that come with your vFoglight installation and allow you to access different components in your monitoring environment without having to use the standard graphical interface such as the Administration dashboards.
This can be useful in situations when you need to either automate your business logic by writing scripts, or use regular expressions to select multiple entities where applicable.
This chapter contains the following sections:
28 vFoglight
Command-Line Reference Guide
About Syntax Conventions
This manual employs a set of conventions that are used in the command syntax. You should review them before getting started with the manual in order to successfully make use of vFoglight commands in your monitoring environment. The syntax conventions are as follows:
• <vfoglight_home> is a placeholder that represents the path to the vFoglight
Management Server installation.
• Unless otherwise specified, vFoglight commands are not case-sensitive.
Looking at vFoglight Commands
vFoglight provides a number of commands that you can use to manage different components in your monitoring environment. The commands reside in the following directories of your vFoglight Management Server installation.
vFoglight Management Server
• <vfoglight_home>/bin: Contains commands that manage the vFoglight
Management Server and administer agents, cartridges, metrics, and other entities.
For more information about these commands, see “ Managing the vFoglight
” on page 35 and “ Managing Cartridges and Metrics ” on page 53.
• <vfoglight_home>/tools: Contains the Remote Monitor utility as well as the administrative commands in ZIP files. For more information about the Remote
Monitor, see the vFoglight Installation and Setup Guide; for information on the
Remote Monitor command syntax, see “ remotemonitor ” on page 44.
If required, you can extract these commands to a remote computer in your
network and issue them from there. For more information, see “ Getting Started with Server Commands
” on page 36 and “ Getting Started with Administrative
For more information about the <vfoglight_home>, see “ About Syntax Conventions ” on page 28.
The following table lists vFoglight commands.
About the Command-Line Interface
Looking at vFoglight Commands
29
Provides command-line interface to the vFoglight Management Server process
Provides command-line interface to the vFoglight Management Server process running in High Availability (HA) mode
Verifies the database version and upgrades it to a higher version if necessary
Starts the embedded database
Stops the embedded database
Provides an interface that lets you change, add, or delete encryption keys, or generate application tokens
30 vFoglight
Command-Line Reference Guide
Activates one or more vFoglight agent instances
Shows a list of vFoglight client instances
Upgrades one or more remote instances of the vFoglight Agent Manager
Creates one or more vFoglight agent instances
Deactivates one or more vFoglight agents
Deletes one or more vFoglight agent instances
Deploys one or more vFoglight agent packages
Retrieves a copy of an agent log file
Shows a list of vFoglight agent instances
Shows a list of agent log files
Shows a list of available agent packages
Assigns a blackout schedule to one or more vFoglight agent instances
Shows the blackout schedule assigned to one or more vFoglight agent instances.
Starts the data collection for one or more vFoglight agent instances
Stops the data collection for one or more vFoglight agent instances
Shows a list of vFoglight agent types sorted by client ID
About the Command-Line Interface
Looking at vFoglight Commands
31
Deactivates a vFoglight cartridge
Activates an installed vFoglight cartridge
Installs a cartridge on the vFoglight
Management Server
Lists all installed vFoglight cartridges
Uninstalls a vFoglight cartridge
Adds or removes a user from a group
Adds or removes a role from a group
Creates a group
Creates a user
Deletes a group
Deletes a user
Installs a vFoglight license
Shows a list of installed vFoglight licenses
Removes a vFoglight license using the license serial number
32 vFoglight
Command-Line Reference Guide
Assigns a blackout schedule
Generates a support bundle file
Exports the monitoring policy to an XML file
Imports the monitoring policy
Outputs the values of server configuration parameters
Exports metric observations to a file using a metric query
Shows a list of all vFoglight schedules
Runs a script
Exports the value of one or more properties of a topology object to an XML file
Exports a UI module into a ZIP file
Imports a UI module from a ZIP file
Shows a list of deployed UI modules
Getting Started with vFoglight Commands
To get started with vFoglight commands:
Note These instructions describe a simple configuration in which the vFoglight Management
Server and the vFoglight Agent Manager are installed on the same platform.
1 Ensure that you have all of the following components installed in your monitoring environment.
A typical setup includes the following components:
About the Command-Line Interface
Getting Started with vFoglight Commands
33
• vFoglight Management Server
• vFoglight Cartridge
For complete information on installing the above components, see the Installation
and Setup Guide.
2
3
Obtain your vFoglight user name and password from the vFoglight
Administrator.
Ensure that your JAVA_HOME system variable points to the location of JRE that comes with vFoglight. For information on the JRE version, see the vFoglight
Installation and Setup Guide.
4
For example, on most Windows systems, JRE 6 is located under C:\Program
Files\Java\jre1.6.0_02.
Start the vFoglight Management Server.
5
For example, on Windows platforms, you can start the vFoglight Management
Server by choosing Start > Programs > Vizioncore > vFoglight 5.2.4 > Start
vFoglight.
If you experience problems starting either the vFoglight Management Server, complete the following steps: a Check the log files. vFoglight stores the log file in the following locations: vFoglight Management Server:
<vfoglight_home>/logs/ManagementServer_date _ time _ file _ ID .
log
Where
• date and time are the date and time the vFoglight Management Server was started
• file_ID identifies the log file b
For information about vfoglight_home , see “ About Syntax Conventions ” on page 28.
If you do not find any indicators as to why the agent is not collecting data, refer to the Release Notes and Administration and Configuration Guide for more information.
c If you do not find any relevant information in the documentation, contact
Vizioncore Support. See “ Contacting Dell ” on page 14.
From here, you can proceed to any of the following procedures as required:
•
“ Getting Started with Administrative Commands ” on page 64
34 vFoglight
Command-Line Reference Guide
0
Managing the vFoglight
Management Server
vFoglight offers a set of commands that allow you to perform server-related operations through the command-line interface. You can use these commands to perform a variety of tasks, such as start or stop the vFoglight Management Server, run or upgrade the database, or manage encryption keys.
This chapter contains the following sections:
36 vFoglight
Command-Line Reference Guide
Getting Started with Server Commands
The majority of server-specific commands access the server directly. As such, you can only issue them on the computer that is running an instance of the vFoglight
Management Server. One exception is the Remote Monitor utility that you can use to communicate with multiple instances of the vFoglight Management Server running in
High Availability (HA) mode. For more information about running the vFoglight
Management Server running in HA mode, see “ fmsha ” on page 41.
Your vFoglight installation includes a compressed file, <vfoglight_home>/tools/
remotemonitor.zip, that contains the Remote Monitor utility. If required, you can extract the contents of that file to a remote computer in your vFoglight network and run the
location of vfoglight_home, see “ About Syntax Conventions ” on page 28.
To get started, make sure the vFoglight Management Server is running, and, if you are planning to access the server commands remotely, copy and extract the contents of the
remotemonitor.zip file to your remote computer.
For more information about the Remote Monitor, see “ remotemonitor ” on page 44.
Note In vFoglight, the vFoglight Agent Manager is used to manage agent instances and their communication with the vFoglight Management Server. Some monitoring environments use the vFoglight Client, which is an older version of the agent manager component. While the syntax and command-line output are the same regardless of the type of the agent management component (vFoglight Client or vFoglight Agent Manager), the configuration process is different in that you may need to extract the Remote Monitor utility to a different directory.
The following procedure describes the configuration of the Remote Monitor in an environment that uses the vFoglight Agent Manager. For information on how to configure
the Remote Monitor utility with the vFoglight Client, see “ Getting Started with Server
To get started with vFoglight Management Server commands:
Note
This procedure continues from “ Getting Started with vFoglight Commands ” on page 32.
Managing the vFoglight Management Server
Running the vFoglight Management Server
37
1
2
Copy the <vfoglight_home>/tools/remotemonitor.zip file from the computer that has a running instance of the vFoglight Management Server to the remote computer.
Note The following procedure describes the configuration of the Remote Monitor in an environment that uses the vFoglight Agent Manager. For information on how to
Extract the contents of the remotemonitor.zip file to a directory on the remote computer.
3 Reference the directory that contains the vFoglight Management Server command <vfoglight_home>/bin, by completing one of the following steps:
• If you want to use the command prompt, open a Command Prompt window and navigate to <vfoglight_home>/bin as required.
or
• If you want to use a vFoglight Management Server command in a script, ensure that your script references <vfoglight_home>/bin.
For more information about vfoglight_home, see “ About Syntax Conventions ” on page 28.
From here, you can proceed to any of the following procedures as required:
•
“ Running the vFoglight Management Server ” on page 37
•
“ Starting, Stopping, or Upgrading the Database ” on page 47
•
“ Managing Passwords ” on page 49
Running the vFoglight Management Server
This section describes the following tasks:
•
“ Running the Server in Stand-Alone Mode ” on page 38
•
“ Running the vFoglight Management Server in High Availability Mode ” on page 41
38 vFoglight
Command-Line Reference Guide
Running the Server in Stand-Alone Mode fms
The fms command provides command-line interface to the vFoglight Management
Server process. It offers a set of options that allow you to perform any of the following operations as required:
• Start or stop the vFoglight Management Server in stand-alone mode
• Install and start the vFoglight Management Server in stand-alone mode as a
Windows service
• Stop and remove a vFoglight Management Server Windows service
• Configure Java Virtual Machine (JVM) options and add entries to the vFoglight classpath
• Assign different names to different vFoglight Management Server process launchers
• Display version information or a list of arguments along with their descriptions
Syntax
fms [-s|--start|-Dquest.debug-debug_level] [-q|--stop]
[-w|--wait] [-n|--name process_name] [-i|--install-service]
[-r|--remove-service] [-b|--start-service]
[-j|--jvm-argument JVM_options] [-p|--classpath classpath]
[-v|--version] [-h|--help] [-t|--thread-dump]
Note If you do not specify any options, fms uses the default option, s, and starts an instance of the vFoglight Management Server.
Options and arguments
Options h help
Argument
None
Description
Displays a list of arguments and their descriptions.
Managing the vFoglight Management Server
Running the vFoglight Management Server
39 t s
Options Argument j
-Dquest.debug-debug_level n p jvm-argument name classpath
Runs the vFoglight Management Server in debug mode. You can set debug_level to one of the following values:
• 1: No debugging
• 2: Minimal debugging
• 3: Detailed debugging
By default, this option outputs the logs to the standard output. You can redirect the output to a file if required. For example: fms -Dquest.debug=3 > debug3.log
JVM_options Specifies one or more Java Virtual
Machine (JVM) options.
process_name Specifies a unique process name for the current instance of the vFoglight
Management Server. vFoglight uses process names to distinguish between different instances of the same process launcher.
classpath Adds entries to the JVM classpath.
q stop None
Description
None
Stops the running vFoglight Management
Server process.
Starts the vFoglight Management Server.
start thread-dump None v version None
Requests a thread output from the running application. This option writes the output to a separate log file in the application's installation directory.
Displays the version number, copyright, build number, and the installation directory.
40 vFoglight
Command-Line Reference Guide r i
Options w wait b start-service install-service remove-service
Argument
None
None
None
None
Description
When sending a shutdown command to an existing vFoglight Management
Server process, this option instructs the command to wait indefinitely for the process to exit before shutting it down.
Starts the vFoglight Management Server
Windows service.
Installs the vFoglight Management
Server as a Windows service.
Stops and removes the vFoglight
Management Server Windows service.
Examples
Displaying version information
C:\Vizioncore\vFoglight\bin>fms -v vFoglight Management Server 5.2.4
Copyright (c) 2002-3/20/09 Vizioncore Inc.
Build Number: 524-3/20/091002-0044
Installation Directory: C:\Vizioncore\vFoglight
Starting the server in stand-alone mode
C:\Vizioncore\vFoglight\bin>fms -s
3/20/09-10-16 11:18:46.807 INFO Starting vFoglight Management
Server.
3/20/09-10-16 11:18:46.901 INFO vFoglight Management Server starting up using database host: localhost
3/20/09-10-16 11:18:46.916 INFO vFoglight Management Server starting up using database port: 13306
3/20/09-10-16 11:18:46.916 INFO vFoglight Management Server starting up using database name: foglight
...
Managing the vFoglight Management Server
Running the vFoglight Management Server
41
Stopp
ing the server running in stand-alone mode
C:\Vizioncore\vFoglight\bin>fms -q
Note This command displays a series of messages in the Command Prompt window instance used to start the vFoglight Management Server. These messages indicate that the server is stopping.
See also
•
•
Running the vFoglight Management Server in High Availability
Mode fmsha
The fmsha command provides a command-line interface to the vFoglight Management
Server process running in High Availability (HA) mode. Running vFoglight in HA mode allows you to manage multiple instances of the vFoglight Management Server in a JBoss partition that supports the HA feature. For more information about the HA mode, see the Installation and Setup Guide.
This command offers a set of options that you can use to perform any of the following operations as required:
• Start or stop the vFoglight Management Server in HA mode
• Install and start the vFoglight Management Server in HA mode as a Windows service
• Stop and remove a vFoglight Management Server HA Windows service
• Configure Java Virtual Machine (JVM) options and add entries to the vFoglight classpath
• Assign different names to different vFoglight Management Server process launchers
• Display version information or a list of arguments along with their descriptions
42 vFoglight
Command-Line Reference Guide
Syntax
fmsha [-s|--start] [-q|--stop] [-w|--wait]
[-n|--name process_name] [-i|--install-service]
[-r|--remove-service] [-b|--start-service]
[-j|--jvm-argument JVM_options] [-p|--classpath classpath]
[-v|--version] [-h|--help] [-t|--thread-dump]
Note If you do not specify any options, fmsha uses the default option, s, and starts an instance of the vFoglight Management Server in HA mode.
Options and arguments
Options h help j n jvm-argument name p q classpath stop t s start thread-dump
Argument Description
None
JVM_options
Displays a list of arguments and their descriptions.
Specifies one or more Java Virtual
Machine (JVM) options.
process_name Specifies a unique process name for the current instance of the vFoglight
Management Server. vFoglight uses process names to distinguish between different instances of the same process launcher.
classpath Adds entries to the JVM classpath.
None
None
None
Stops the running vFoglight Management
Server process.
Starts the vFoglight Management Server.
Requests a thread output from the running application. This option writes the output to a separate log file in the application's installation directory.
Managing the vFoglight Management Server
Running the vFoglight Management Server r i
Options v version w b wait start-service install-service remove-service
Argument
None
None
None
None
None
Description
Displays the version number, copyright, build number, and the installation directory.
When sending a shutdown command to an existing vFoglight Management
Server process, this option instructs the command to wait indefinitely for the process to exit before shutting it down.
Starts the vFoglight Management Server
Windows service.
Installs the vFoglight Management
Server as a Windows service.
Stops and removes the vFoglight
Management Server Windows service.
Examples
Starting the server in HA mode
C:\Vizioncore\vFoglight\bin>fmsha
3/20/09-10-16 12:06:32.632 INFO Starting vFoglight Management
Server with the command bin\fms -Dfoglight.cluster.mode=true...
3/20/09-10-16 12:06:33.398 INFO Starting vFoglight Management
Server.
3/20/09-10-16 12:06:33.538 INFO vFoglight Management Server starting up using database host: localhost
...
Installing the server in HA mode as a Windows service
C:\Vizioncore\vFoglight\bin>fmsha -i
3/20/09-10-16 12:08:43.000 INFO [native] vFoglight High
Availability
Management Server (FoglightHA) service installed
Removing the server HA Windows service
C:\Vizioncore\vFoglight\bin>fmsha -r
43
44 vFoglight
Command-Line Reference Guide
3/20/09-10-16 12:11:24.000 INFO [native] Removed the vFoglight
High
Availability Management Server (FoglightHA) service installed from 'C:\Vizioncore\vFoglight'
See also
•
•
remotemonitor
The remotemonitor command provides command-line interface to the Remote
Monitor application. The Remote Monitor communicates with multiple instances of the vFoglight Management Server running in HA mode. If a server fails to reply, the
Remote Monitor logs an event and sends e-mails to the server administrator. The
Remote Monitor uses a list of host names or host names and port numbers to identify
High Availability servers that it communicates with. This information is stored in the
<vfoglight_home>/config/remote_monitor.config file under the server.urls
entry.
For information on how to install and configure the Remote Monitor, see “ Getting
Started with Server Commands ” on page 36; for additional information about the
Remote Monitor application, see the Installation and Setup Guide.
The remotemonitor command offers a set of options that you can use to perform any of the following operations as required:
• Start or stop the Remote Monitor
• Install and start the Remote Monitor as a Windows service
• Stop and remove the Remote Monitor Windows service
• Configure Java Virtual Machine (JVM) options and add entries to the Remote
Monitor classpath
• Assign different names to different Remote Monitor process launchers
• Display version information or a list of arguments along with their descriptions
Syntax
remotemonitor [-s|--start] [-q|--stop] [-w|--wait]
[-n|--name process_name] [-i|--install-service]
[-r|--remove-service] [-b|--start-service]
[-j|--jvm-argument JVM_options] [-p|--classpath classpath]
Managing the vFoglight Management Server
Running the vFoglight Management Server
45
[-v|--version] [-h|--help] [-t|--thread-dump]
Note If you do not specify any options, remotemonitor uses the default option, s, and starts an instance of the Remote Monitor utility.
Options and arguments j
Options h help jvm-argument n name p q classpath stop t s start thread-dump v version
Argument
None
JVM_options process_name classpath
None
None
None
None
Description
Displays a list of arguments and their descriptions.
Specifies one or more Java Virtual
Machine (JVM) options.
Specifies a unique process name for the current instance of the vFoglight
Management Server. vFoglight uses process names to distinguish between different instances of the same process launcher.
Adds entries to the JVM classpath.
Stops the running vFoglight
Management Server process.
Starts the vFoglight Management Server.
Requests a thread output from the running application. This option writes the output to a separate log file in the application's installation directory.
Displays the version number, copyright, build number, and the installation directory.
46 vFoglight
Command-Line Reference Guide r i
Options w wait b start-service install-service remove-service
Argument
None
None
None
None
Description
When sending a shutdown command to an existing vFoglight Management
Server process, this option instructs the command to wait indefinitely for the process to exit before shutting it down.
Starts the vFoglight Management Server
Windows service.
Installs the vFoglight Management
Server as a Windows service.
Stops and removes the vFoglight
Management Server Windows service.
Examples
Installing Remote Monitor as a Windows service
C:\Vizioncore\vFoglight\bin>remotemonitor -i
3/20/09-10-16 12:26:46.000 INFO [native] RemoteMonitor
(RemoteMonitor) service installed
Removing the Remote Monitor Windows service
C:\Vizioncore\vFoglight\bin>remotemonitor -r
3/20/09-10-16 12:28:37.000 INFO [native] Removed the
RemoteMonitor (RemoteMonitor) service installed from
'C:\Vizioncore\vFoglight'
Displaying Remote Monitor version information
C:\Vizioncore\vFoglight\bin>remotemonitor -v
RemoteMonitor 5.2.4
Copyright (c) 2002-3/20/09 Vizioncore Inc.
Build Number: 524-3/20/091002-0044
Installation Directory: C:\Vizioncore\vFoglight
See also
•
•
Managing the vFoglight Management Server
Starting, Stopping, or Upgrading the Database
Starting, Stopping, or Upgrading the Database
This section describes the following features:
•
“ Starting the Embedded Database ” on page 47
•
“ Stopping the Embedded Database ” on page 47
•
“ Upgrading the Database ” on page 48
Starting the Embedded Database runDB
The runDB command starts the embedded database.
Syntax runDB
Options and arguments
None
Example
C:\Vizioncore\vFoglight\bin>runDB
3/20/09-10-16 12:31:27.924 INFO Starting up the embedded database...
3/20/09-10-16 12:31:31.266 INFO Embedded database successfully started
See also
•
•
“ foglight_db_upgrade ” on page 48
Stopping the Embedded Database shutdownDB
The shutdownDB command stops the embedded database.
47
48 vFoglight
Command-Line Reference Guide
Syntax shutdownDB
Options and arguments
None
Example
C:\Vizioncore\vFoglight\bin>shutdownDB
3/20/09-10-16 12:32:42.539 INFO Checking if the embedded database still running...
3/20/09-10-16 12:32:46.599 INFO Successfully shutdown the embedded database
See also
•
•
“ foglight_db_upgrade ” on page 48
Upgrading the Database foglight_db_upgrade
The foglight_db_upgrade command verifies the database version and upgrades it to a higher version if necessary. This command is useful when you need to migrate data from a vFoglight environment that is running a lower version of the embedded database.
This typically happens when the database upgrade that is initiated through the installer fails to complete.
Syntax foglight_db_upgrade
Options and arguments
None
Example
C:\Vizioncore\vFoglight\bin>foglight_db_upgrade
Managing the vFoglight Management Server
Managing Passwords
49
3/20/09-10-16 12:35:47.249 INFO Starting up the embedded database...
3/20/09-10-16 12:35:50.590 INFO Embedded database successfully started log4j:WARN No appenders could be found for logger
(org.springframework.beans.factory.xml.
XmlBeanDefinitionReader).log4j:WARN Please initialize the log4j system properly.
3/20/09-10-16 12:35:51.231 INFO Current database schema version:
5.2.4
3/20/09-10-16 12:35:51.231 INFO The database schema is up-todate.
No upgrade is required.
3/20/09-10-16 12:35:51.231 INFO Shutting down the embedded database...
3/20/09-10-16 12:35:51.293 INFO Checking if the embedded database still running...
3/20/09-10-16 12:35:55.400 INFO Successfully shutdown the embedded database
3/20/09-10-16 12:35:58.039 INFO Upgrade completed successfully.
See also
•
•
Managing Passwords
Managing Encryption Keys keyman
The keyman command allows you to change, add, or delete encryption keys, or generate application tokens.
vFoglight stores encrypted passwords, with the exception of the database password in the <vfoglight_home>/config/foglight.keystore file, and uses application tokens to look up encryption keys in that file. The database password is stored in one of the following entries of the <vfoglight_home>/config/foglight.config file, depending on the type of the database:
50 vFoglight
Command-Line Reference Guide
• foglight.database.password
stores the password of the external database.
• foglight.database.embedded.password
stores the password of the embedded database.
By default, the installation process encrypts the database password at installation time using an encryption key. vFoglight stores the value of the encryption key in the foglight.defaultkey
entry of the <vfoglight_home>/config/mstkey.properties file.
To change the database password, issue the keyman command with the encpwd option to encrypt a password string using foglight.defaultkey
, and then use the output of that command to replace the value of the foglight.database.password
or foglight.database.embedded.password
entry in <vfoglight_home>/config/
foglight.config as required. For example:
2
3
1 Open a Command Prompt window.
In the Command Prompt, navigate to the <vfoglight_home>/bin directory.
Issue the keyman command with the encpwd option to encrypt a password string.
For example:
4
5
6
C:\Vizioncore\vFoglight\bin>keyman encpwd my_new_password foglight.defaultkey
Encrypted Password: q40799f927b44ba22192f3a4fa2f1cc91
Open the <vfoglight_home>/config/foglight.config file for editing.
In the foglight.config file, replace the value of the appropriate entry
( foglight.database.password for external database or foglight.database.embedded.password
for embedded database) with the output that you generated in
.
Caution You must enclose the generated value in double quotes.
Save and close the foglight.config file.
Syntax
keyman [chmstkey old_key new_key]
[addappkey key_name key_text key_pwd] [delappkey key_name]
[encpwd pwd_str key_name] [getapptkn key_name key_pwd]
Managing the vFoglight Management Server
Managing Passwords
51
Options
Option addappkey chmstkey delappkey encpwd getapptkn
Description
Adds an application key
Changes the master key
Deletes an application key
Encrypts a password string using an encryption key
Generates an application token
Arguments
Argument Description key_name Specifies the name of the application key key_pwd Specifies the password that protects the key key_text new_key
Specifies the key value
Specifies the new key value old_key pwd_str
Specifies the old key value
Specifies the password value that is to be encrypted
Example
C:\Vizioncore\vFoglight\bin>keyman addappkey my_key my_key_text my_key_pwd
KeyToken: f3f3d72d81b1959bdf32416357b57e97aa63b199
52 vFoglight
Command-Line Reference Guide
0
Managing Cartridges and Metrics
In addition to the vFoglight Administration module that allows you to perform administrative tasks using Administration dashboards, vFoglight Management Server offers a command-line interface that you can use to manage agents, cartridges and metrics. For example, you can use the command-line interface to install and activate cartridges, manage licenses, and many other tasks.
The range and type of actions you can perform depends on the set of permissions defined by your vFoglight user account.
This chapter contains the following sections:
54 vFoglight
Command-Line Reference Guide
Using the Command Line for Administration Tasks
This section describes the following concepts:
•
“ Understanding the Command-Line Structure ” on page 54
•
“ About Regular Expressions ” on page 56
•
“ Getting Started with Administrative Commands ” on page 64
•
“ Running Administrative Commands: Example ” on page 65
•
“ Looking at Scope-Specific Commands ” on page 66
Understanding the Command-Line Structure
The command-line expression used to issue administrative commands on the vFoglight
Management Server is comprised of two commands that are separated by a colon ‘:’ and appear in the following order:
• fglcmd. Logs into the vFoglight Management Server and specifies the scope. The scope defines the type of commands and the target entity they are to be issued against. For example, the cartridge scope includes commands for installing and activating cartridges.The scope can be set to one of the following values:
Managing Cartridges and Metrics
Using the Command Line for Administration Tasks
55
Scope
agent cartridge license schedule script support topology util
Description
Manages agents and clients
Manages cartridges
Manages licenses
Lists schedules
Runs scripts
Creates support bundles
Assigns blackout schedules
Contains utility commands
Note The fglcmd part in the command-line expression that verifies the user and specifies the scope is required each time you issue commands for managing cartridges, agents, and metrics that are described in this chapter.
For complete information about fglcmd, see “ Logging In and Setting the Scope ” on page 70.
• Scope-specific command. Carries out an administrative task such as a cartridge deployment or license installation, and is compatible with the scope specified with fglcmd . For a complete list of vFoglight commands and their respective
scope, see “ Looking at Scope-Specific Commands ” on page 66.
fglcmd connection_options -cmd scope:command options
fglcmd Command separator
Scope-specific command
See also
•
“ About Regular Expressions ” on page 56
•
“ Getting Started with Administrative Commands ” on page 64
56 vFoglight
Command-Line Reference Guide
•
“ Running Administrative Commands: Example ” on page 65
•
“ Looking at Scope-Specific Commands ” on page 66
About Regular Expressions
A regular expression describes one or more text strings using predefined syntactic elements. Regular expressions allow you to identify a list of text entries with a single text string. A number of fglcmd commands support regular expressions. This is useful in situations when you want to issue a single command against multiple objects.
The backslash character ‘\’ escapes a character or construct in order to process them as a literal sequence. For example, “\\” matches a single backslash while “\{” matches a left brace.
The following table lists the constructs that can be used in regular expressions and describes their usage.
\0n
\0nn
\0mnn
\xhh
Syntax abc
\\
Managing Cartridges and Metrics
Using the Command Line for Administration Tasks
57
Description
The literal string contained within the construct.
In fglcmd , using a literal string in a regular expression as a command argument and enabling the command to use regular expressions causes the command to return matches that contain that text string. For example, typing mydomain.corp
as a regular expression finds matches that contain that text string.
A backslash character in regular expressions can have one of the following roles:
• Switch (or option). When it follows a command and is followed by an appropriate character or text string, it can provide additional input to the command.
• Escape character. Signifies that the character or text string that follows should be interpreted as a literal character. For example, on the command line, the construct rm * deletes all files in the current directory while rm \* deletes only the file whose name is * .
In regular expressions, the first backslash in a doublebackslash construct acts as an escape character while the second is interpreted as a literal.
For example, the construct "\\(hello world\\) " matches "\(hello world\) ".
A one-digit number with a value between zero ‘0’ and seven ‘7’.
A two-digit number with each digit having a value between zero ‘0’ and seven ‘7’.
A three-digit number with the first digit having a value between zero ‘0’ and three ‘3’, and the other two digits with a value between zero ‘0’ and seven ‘7’.
A string containing a hexadecimal value of 0xhh where h is a hexadecimal digit.
58 vFoglight
Command-Line Reference Guide
Syntax
\uhhhh
Description
A string containing a hexadecimal value of 0xhhhh where h is a hexadecimal digit.
The TAB character ('\u0009').
\a
\e
\cx
\r
\f
\t
\n The line feed character ('\u000A').
The carriage return character ('\u000D').
The form feed character ('\u000C').
The alert (bell) character ('\u0007').
The ESC character ('\u001B').
The CTRL character followed by a literal.
\d
\D
[…]
[^…]
An OR expression. Brackets can be nested. Matches one of the characters within the brackets.
For example, [xyz] matches x , y , or z .
A negative OR expression. Matches any character that is not contained within the brackets.
For example, [xyz] matches any character other than x , y , or z
-
&&
A range.
For example, [a-d] matches a , b , c , and d .
A logical AND operator.
For example, [a-d]&&[m-p] matches a , b , c , d , m , n , o , and p .
Tip The precedence of constructs used for combining the operators escape '\', grouping “[ ]“, range '-'. union “[ ][ ]“, or intersections “&&” (for example, in [a-z&&[aeiou]]) is done in the following order: escape, grouping, range, union, and intersection.
.
Any character
Any decimal digit.
Any character other than a decimal digit
\S
\w
Syntax
\s
\W
?, ??, or ?+
*, *?, or *+
+, +?, or ++
Managing Cartridges and Metrics
Using the Command Line for Administration Tasks
59
Description
A white space character such as a tab, line feed, blank space, or carriage return.
Any character other than tab, line feed, blank space, or carriage return.
Any lowercase or uppercase alphabetic, or a numeric character.
Any character other than lowercase or uppercase alphabetic, or a numeric character.
When following a character, the construct implies that the preceding character can appear one or zero times.
For example, each of the following constructs mean that the character X can appear once or not at all in the result:
• X?
• X??
• X?+
When following a character, the construct implies that the preceding character can appear zero or more times.
For example, each of the following constructs mean that the character X can appear zero or more times in the result:
• X*
• X*?
• X*+
When following a character, the construct implies that the preceding character can appear one or more times.
For example, each of the following constructs mean that the character X can appear one or more times in the result:
• X+
• X+?
• X++
60 vFoglight
Command-Line Reference Guide
|
\Q
Syntax
{n}, {n}?, or {n}+
{n,}, {n,}?, or {n,}+
{n,m}, {n,m}?, or {n,m}+
NM
\E
Description
When following a character, the construct implies that the preceding character can appear exactly n times.
For example, each of the following constructs mean that the character X can appear exactly three times in the result:
• X{3}
• X{3}?
• X{3}+
When following a character, the construct implies that the preceding character can appear at least n times.
For example, each of the following constructs mean that the character X can appear at least five times in the result:
• X{5,}
• X{5,}?
• X{5,}+
When following a character, the construct implies that the preceding character can appear at least n, but no more than m times.
For example, each of the following constructs mean that the character X can appear at least four, but no more than eight times in the result:
• X{4,8}
• X{4,8}?
• X{4,8}+
The construct implies that both characters appear in the given order: the first one (N) is followed by the second character (M) in the result, treating the two-character construct as a literal expression. For example, the expression XY returns XY as a match.
The logical OR operator. For example, the construct X|Y mean that either X or Y can appear in the result.
Quotes all characters in the expression until it reaches \E .
For example, the construct \Qabc\E has the same meaning as "abc ".
Ends the quoting started by \Q.
Syntax
Groups
()
\n
(?:N)
Managing Cartridges and Metrics
Using the Command Line for Administration Tasks
Description
61
Parentheses are used to create capturing groups. A capturing group in a text pattern is used to match substrings in expressions. For example, in the construct
X(Y*)Z , the capturing group (Y*) matches both Y and
YY from the input, returning both XYZ and XYYZ as the result of the expression.
Capturing groups can be nested and numbered using their opening parentheses from left to right. For example, in the construct (X(Y))(Z)) , the groups are numbered as follows:
• ((X(Y))(Z)) : group 1
• (X(Y)) : group 2
• (Y) : group 3
• (Z) : group 4
Following a series of capturing groups, it acts as a back reference to match of the nth group.
For example, the expression ([a-d])X\1X\1 has only one capturing group whose number is one ‘1’. It returns the following matches:
• aXaXa
• bXbXb
• cXcXc
• cXcXc
Indicates that N is a non-capturing group in a construct.
For example, in the construct (X(?:Y))(Z) , the group
(?:Y) is not considered as a capturing group. The groups in the above construct are numbered as follows.
• (X(?:Y))(Z) : group 1
• (X(?:Y)) : group 2
• (Z) : group 3
For information about capturing groups and their syntax,
62 vFoglight
Command-Line Reference Guide
Syntax
(?=X)
(?!X)
(?<=X)
(?<!X)
Description
Checks if the preceding character is followed by X in a text string, without making X a part of the search result.
For example, when the construct H(?=e) is matched against Hello world , it returns the H in the string without making the e that follows it a part of the result.
Checks if the preceding character is preceded by X in a text string, without making X a part of the search result.
For example, when the construct e(?!H) is matched against Hello world , it returns the e in the string without making the H that precedes it a part of the result.
Checks if the following character is followed by X in a text string, without making X a part of the search result.
For example, when the construct (?<=w)o is matched against Hello world , it returns the o in world, without making the w a part of the result, but not the o in Hello .
Returns A via zero-width positive look behind.
Checks if the following character is preceded by X, without making X a part of the search result.
For example, when the construct (?<!o)w is matched against Hello world , it returns the w in world, without making the w a part of the result.
$
\b
Boundary matching
^ The beginning of a line.
The end of a line.
A word boundary. Used as a delimiter, it implies that the construct between the delimiters should be matched only in those text strings that contain alpha-numeric characters and are delimited by non-word character such as spaces or punctuation marks. For example, the construct
\bdog\b finds one match of dog in the string My dog is black , and no matches in My dogs are black .
Managing Cartridges and Metrics
Using the Command Line for Administration Tasks
Syntax
\B
\A
\G
\Z
\z
Description
A non-word boundary. Used as a delimiter, \B is the negated version of
For example, the construct \Bdog\B finds a match of dog in the string My dog is black , and one in My dogs are black .
The beginning of the input. It has the same functionality
, with the exception that it ignores any new line characters.
The end of the previous match.
The end of the input string.It has the same functionality
as $ , with the exception that it ignores any final
terminators.
The end of the input string.It has the same functionality
as $ , with the exception that it ignores any line
terminators.
Unicode blocks
\p{Lu}
[\p{L}&&[^\p{Lu}]]
Any uppercase alphanumeric character.
Any lowercase alphanumeric character.
Note Regular expressions in vFoglight follow the Java guidelines for regular expressions. For complete information, you can refer to JDK documentation.
See also
•
“ Understanding the Command-Line Structure ” on page 54
•
“ Getting Started with Administrative Commands ” on page 64
•
“ Running Administrative Commands: Example ” on page 65
•
“ Looking at Scope-Specific Commands ” on page 66
63
64 vFoglight
Command-Line Reference Guide
Getting Started with Administrative Commands
You can issue the administrative commands on the computer running the vFoglight
Management Server, or on a remote computer in your network. Your vFoglight installation includes a compressed file, fglcmd.zip, that contains all of the administrative commands. To get started, make sure you have the vFoglight Management Server running, and, if you are planning to access the administrative interface remotely, copy and extract the contents of the compressed file to your remote computer.
To get started with administrative commands:
Note
This procedure continues from “ Getting Started with vFoglight Commands ” on page 32.
1 If you want to use the fglcmd interface on a remote computer in your monitoring network, complete the following steps: a Copy the <vfoglight_home>/tools/fglcmd.zip file from the computer that has a running instance of the vFoglight Management Server to the remote computer, where vfoglight_home refers to the installation directory of the vFoglight
Management Server.
b Extract the contents of the fglcmd.zip file to the remote computer.
2 Specify the directory that contains the vFoglight Management Server commands, either <vfoglight_home>/bin or the directory on the remote computer (see
), by completing one of the following steps.
• If you want to use the command prompt, open a Command Prompt window and navigate to the appropriate directory.
3 or
• If you want to use a vFoglight Management Server command in a script, ensure that your script references the appropriate directory.
For more information about vfoglight_home, see “ About Syntax Conventions ” on page 28.
Issue one or more administrative commands using command prompt or a script.
From here, you can proceed to any of the following procedures as required:
•
“ Logging In and Setting the Scope ” on page 70
•
“ Managing Agents ” on page 72
•
“ Managing Cartridges ” on page 128
•
“ Managing vFoglight Licenses ” on page 142
Managing Cartridges and Metrics
Using the Command Line for Administration Tasks
65
•
“ Running Utility Commands ” on page 145
See also
•
“ Understanding the Command-Line Structure ” on page 54
•
“ About Regular Expressions ” on page 56
•
“ Running Administrative Commands: Example ” on page 65
•
“ Looking at Scope-Specific Commands ” on page 66
•
“ Listing Administrative Commands ” on page 69
Running Administrative Commands: Example
In this example, you will issue an administrative command that lists the agent packages that can be deployed to the vFoglight Agent Manager using the packages command.
The syntax of the packages command is as follows:
fglcmd connection_options -cmd agent:packages options
For more information about the command syntax, see “ Understanding the Command-
In this example, you will issue the
packages administrative command (see page 78) to
list all vFoglight Agent Manager instances and the agent packages that can be deployed to each Agent Manager instance.
To list agent packages:
Note
This procedure continues from “ Getting Started with Administrative Commands ” on page 64.
• In the Command Prompt window type the following command: fglcmd -usr foglight -pwd foglight -cmd agent:packages
-allclients
A list of all available agent packages appears in the Command Prompt or terminal window. A sample of that output is similar to the following listing:
Client ID: tor012991.prod.quest.corp#32b1c51d-6208-435c
-bdad-2a8916ef3a89
Installer ID: tor012991.prod.quest.corp#32b1c51d-6208-
435c-bdad-2a8916ef3a89#FglAM:tor012991.prod.quest.corp/
32b1c51d-6208-435c-bdad-2a8916ef3a89/installer
66 vFoglight
Command-Line Reference Guide
Agent Package ID: OSCartridge-WindowsXP-5.2.4-OSCartridge-
Agent-WindowsXP-windows-/5\.1.*/-ia32,x86_64
Agent Package Cartridge Name: OSCartridge-WindowsXP
Agent Package Cartridge Version: 5.2.4
Agent Package OS: windows
Agent Package OS Version: /5\.1.*/
Agent Package OS Architecture: ia32,x86_64
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ packages ” on page 175.
See also
•
“ Understanding the Command-Line Structure ” on page 54
•
“ About Regular Expressions ” on page 56
•
“ Getting Started with Administrative Commands ” on page 64
•
“ Looking at Scope-Specific Commands ” on page 66
Looking at Scope-Specific Commands
vFoglight includes a selection of commands that allow one to perform administrative tasks using a command-line interface, such as installing and deploying agents, adding or removing licenses, assigning schedules, or exporting various types of metrics. The table below lists vFoglight commands in alphabetical order and identifies their scope. For
more information about command scope, see “ Understanding the Command-Line
Managing Cartridges and Metrics
Using the Command Line for Administration Tasks
67
Name
Scope
Description Name
Manages agents and clients
Command
Description
Activates one or more vFoglight agent instances
Shows a list of vFoglight client instances
Upgrades one or more remote instances of the vFoglight Agent Manager
Creates one or more vFoglight agent instances
Deactivates one or more vFoglight agents
Deletes one or more vFoglight agent instances
Deploys one or more vFoglight agent packages
Retrieves a copy of an agent log file
Shows a list of vFoglight agent instances
Shows a list of agent log files
Shows a list of available agent packages
Assigns a blackout schedule to one or more vFoglight agent instances
Shows the blackout schedule assigned to one or more vFoglight agent instances.
Starts the data collection for one or more vFoglight agent instances
Stops the data collection for one or more vFoglight agent instances
Shows a list of vFoglight agent types sorted by client ID
68 vFoglight
Command-Line Reference Guide
Name
Scope
Description Name
Manages cartridges
license schedule script security support
Manages licenses
Lists schedules
Runs scripts
Manages users and groups
Creates support bundles
Command
Description
Deactivates a vFoglight cartridge
Activates an installed vFoglight cartridge
Installs a cartridge on the vFoglight
Management Server
Lists all installed vFoglight cartridges
Uninstalls a vFoglight cartridge
Installs a vFoglight license
Shows a list of installed vFoglight licenses
Removes a vFoglight license using the license serial number
Shows a list of all vFoglight schedules
Runs a script
Adds or removes a user from a group
Adds or removes a role from a group
Creates a group
Creates a user
Deletes a group
Deletes a user
Generates a support bundle file
Managing Cartridges and Metrics
Using the Command Line for Administration Tasks
69
Name
Scope
Description Name
Assigns blackout schedules
Contains utility commands
Command
Description
Assigns a blackout schedule
Exports the monitoring policy to an XML file
Imports the monitoring policy
Outputs the values of server configuration parameters
Exports metric observations to a file using a metric query
Exports the value of one or more properties of a topology object to an XML file
Exports a UI module into a ZIP file
Imports a UI module from a ZIP file
Shows a list of deployed UI modules
Listing Administrative Commands
The fglcmd command includes an option that you can use to list all of the administrative commands and their descriptions, grouped by their respective scope.
To list administrative commands:
Note
This procedure continues from “ Getting Started with Administrative Commands ” on page 64.
• At the command prompt, use the following syntax to list vFoglight commands:
fglcmd connection_options -cmd commands
For complete information about the fglcmd command syntax, see
in
70 vFoglight
Command-Line Reference Guide
For example: fglcmd -usr foglight -pwd foglight -cmd commands
A list of vFoglight commands appears in the Command Prompt window, grouped by the scope. Here is a portion of that output: agent: activate clients clientupgrade create deactivate
Activates an agent.
Shows a list of known clients.
Upgrades a remote client.
Creates an instance of an agent.
Deactivates an agent.
For complete information about fglcmd, see “ Logging In and Setting the Scope ” on page 70.
See also
•
“ Understanding the Command-Line Structure ” on page 54
•
“ Getting Started with Administrative Commands ” on page 64
•
“ Running Administrative Commands: Example ” on page 65
Logging In and Setting the Scope fglcmd
The fglcmd command connects to the vFoglight Management Server and sets the scope for the administrative command.
Syntax
fglcmd -usr user_name -pwd password [-debug] [-port server_port]
[-srv {server_name|server_IP_address}] [-ssl]
-cmd {scope:command command_options|commands}
Managing Cartridges and Metrics
Logging In and Setting the Scope
71
Options and arguments
Option cmd debug port pwd srv
Argument scope
Description agent cartridge commands license schedule script security support topology util
Manages agents and clients.
Manages cartridges.
Lists administrative commands.
Manages licenses.
Lists schedules.
Runs scripts.
Manages security entities.
Creates support bundles.
Assigns blackout schedules.
Contains utility commands.
Turns the debugging on.
None server_port Specifies the server’s port number. The default port number is 8080 (HTTP) or 8443 (HTTPS).
For more information on default port assignments, see the Administration and
Configuration Guide.
Specifies the vFoglight password.
password server_name Specifies the server’s name.
server_IP_address Specifies the server’s IP address.
72 vFoglight
Command-Line Reference Guide
Option ssl usr
Argument
None user_name
Description
Connects to the vFoglight Management Server through a secure HTTP connection (HTTPS).
Unless this option is specified, fglcmd uses an
HTTP connection. For information about default
port numbers, see “ port ” on page 71.
Specifies the user name for logging into vFoglight.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:clients -host .*.corp -regex
Client ID: tor012991.prod.quest.corp#32b1c51d-6208-435c-bdad-
2a8916ef3a89
Client Name: tor012991.prod.quest.corp
Adapter ID: FglAM
Client Version: 5.2.4 (524-20080811-0230)
Host Name: tor012991.prod.quest.corp
OS: windows 5.1 (ia32)
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ clients ” on page 173.
See also
•
“ Understanding the Command-Line Structure ” on page 54
•
“ Looking at Scope-Specific Commands ” on page 66
•
“ Running Administrative Commands: Example ” on page 65
Managing Agents
This section describes the following tasks:
•
“ Listing Agent and Agent Manager Instances ” on page 73
•
“ Deploying Agent Packages ” on page 86
•
“ Creating or Deleting Agent Instances ” on page 91
Managing Cartridges and Metrics
Managing Agents
•
“ Activating or Deactivating Agent Instances ” on page 99
•
“ Starting or Stopping Data Collection ” on page 108
•
“ Listing and Retrieving Log Files ” on page 116
•
“ Listing and Setting Blackout Schedules ” on page 120
Listing Agent and Agent Manager Instances
This section describes the following commands:
•
•
•
•
clients
The clients command shows a list of vFoglight Agent Manager instances.
Scope
Syntax
fglcmd connection_options -cmd agent:clients [-regex]
[-host host_name] [-clientname display_name]
[-clientid client_ID] [-clientbuild build_ID]
[-clientversion version] [-allclients]
[-upgradable {true|false}]
Options and arguments
73
Option allclients
Argument
None
Description
Indicates that all instances of the vFoglight Agent
Manager should be listed.
74 vFoglight
Command-Line Reference Guide
Option clientbuild clientid clientname clientversion host regex upgradable
Argument Description build_ID client_ID display_name An explicit text string or a regular expression that specifies the name of one or more display devices that are running an instance of the vFoglight Agent
Manager.
version An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version.
host_name
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
An explicit text string or a regular expression that identifies one or more instances of the vFoglight
Agent Manager.
None
An explicit text string or a regular expression that specifies the name of one or more hosts that are running an instance of the vFoglight Agent
Manager.
Interprets the client_ID, diplay_name, host_name, or upgradable arguments as regular expressions.
For a sample regular expression used to specify a
host name, see “ Example ” on page 74.
true or false Indicates whether one or more vFoglight Agent
Manager instances can (true) or cannot be upgraded
(false). It can be set to a regular expression.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:clients -host .*.corp -regex
Client ID: tor012991.prod.quest.corp#32b1c51d-6208-435c-bdad-
2a8916ef3a89
Client Name: tor012991.prod.quest.corp
Adapter ID: FglAM
Client Version: 5.2.4 (524-20080811-0230)
Host Name: tor012991.prod.quest.corp
Managing Cartridges and Metrics
Managing Agents
75
OS: windows 5.1 (ia32)
For complete information about the regular expression syntax, see “ About Regular
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ clients ” on page 173.
See also
•
•
•
list
The list command shows a list of vFoglight agent instances.
Scope
Syntax
fglcmd connection_options -cmd agent:list [-agentid agent_ID]
[-regex] [-adapter adapter_ID] [-host host_name]
[-deletable {true|false}] [-name agent_name]
[-namespace agent_namespace] [-datacollection {true|false}]
[-all] [-type agent_type] [-activatable {true|false}]
[-active {true|false}]
Options and arguments
Option activatable active
Argument
true or false
true or false
Description
Indicates whether to list agent instances that can (true) or cannot be activated (false).
Indicates whether to list agent instances that are active (true) or inactive (false).
76 vFoglight
Command-Line Reference Guide
Option adapter agentid all datacollection deletable host name namespace regex
Argument Description adapter_ID agent_ID
None
true or false
An explicit text string or a regular expression that identifies one or more vFoglight adapters.
Identifies an instance of a vFoglight agent that is to be listed.
Indicates that all agent instances should be listed.
Indicates whether to list vFoglight agent instances for which the data collection is
(true) or is not enabled (false).
true or false host_name
Indicates whether to list vFoglight agent instances that can (true) or cannot be deleted
(false).
An explicit text string or a regular expression that specifies the name of one or more hosts that are running an instance of a vFoglight agent.
agent_name agent_namespace An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space.
None
An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances that are to be listed.
Interprets the adapter_ID, agent_name,
agent_namespace, agent_type, or host_name arguments as regular expressions.
For a sample regular expression used to
specify a host name, see “ Example ” on page 74.
Managing Cartridges and Metrics
Managing Agents
77
Option type
Argument agent_type
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management
Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for
Operating Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating Systems, see the Cartridge for
Operating Systems User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of
OSCartridge/AppMonitor result in an error.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
78 vFoglight
Command-Line Reference Guide
-cmd agent:list -host tor012991.prod.quest.corp -active false
Host: tor012991.prod.quest.corp
ID: 3
Name: OSCartridge/AppMonitor_on_tor012991.prod.quest.corp
Type: AppMonitor
Version: 5.2.4 (Build: 524-20080811-0500)
Namespace: SPI
Adapter ID: FglAM
Status: Not active
------------------------------------
Host: tor012991.prod.quest.corp
ID: 4
Name: OSCartridge/LogFilter_on_tor012991.prod.quest.corp
Type: LogFilter
Version: 5.2.4 (Build: 524-20080811-0500)
Namespace: SPI
Adapter ID: FglAM
Status: Not active
------------------------------------
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ list ” on page 174.
See also
•
•
•
packages
The packages command shows a list of available agent packages.
Scope
Syntax
fglcmd connection_options -cmd agent:packages
[-packageosversion OS_version] [-regex] [-host host_name]
[-clientname display_name] [-packageversion version]
[-arch architecture] [-packageid pkg_ID] [-allclients]
Managing Cartridges and Metrics
Managing Agents
[-allpackages] [-allinstallers] [-osversion OS_version]
[-packagearch OS_architecture] [-clientid client_ID]
[-clientbuild build_ID] [-clientversion client_version]
[-packageos OS_name] [-osname OS_name] [-installername name]
[-upgradable {true|false}] [-disable_platform_check]
Options and arguments
79
Option allclients allinstallers allpackages arch clientbuild clientid clientname
Argument
None
None
None architecture build_ID client_ID display_name
Description
Indicates that all instances of the vFoglight Agent Manager should be selected.
Indicates that all agent installers should be selected.
Indicates that all agent packages should be listed.
An explicit text string or a regular expression that specifies the platform architecture.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
An explicit text string or a regular expression that identifies one or more instances of the vFoglight
Agent Manager.
An explicit text string or a regular expression that specifies one or more display devices that are running an instance of the vFoglight Agent
Manager.
80 vFoglight
Command-Line Reference Guide
Option clientversion disable_platform_check host installername osname osversion packagearch packageid
Argument client_version
None host_name name
OS_name
OS_version
OS_architecture pkg_ID
Description
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version.
Disables automatic filtering of agent packages, based on platform information provided by agent installers.
An explicit text string or a regular expression that specifies one or more host names.
An explicit text string or a regular expression that selects one or more agent installers based on the specified name.
An explicit text string or a regular expression that specifies the name of one or more operating systems with which the agent packages are compatible.
An explicit text string or a regular expression that specifies the version of one or more operating systems with which the agent packages are compatible.
An explicit text string or a regular expression that specifies one or more operating system architectures with which the agent packages are compatible.
An explicit text string or a regular expression that identifies one or more packages.
Managing Cartridges and Metrics
Managing Agents
81
Option packageos packageosversion packageversion
Argument pkg_OS_name pkg_OS_version version
Description
An explicit text string or a regular expression that specifies the name of one or more operating systems of the agent packages that are to be selected.
An explicit text string or a regular expression that specifies one or more operating system versions of the agent packages that are to be selected.
An explicit text string or a regular expression that specifies one or more package versions.
regex upgradable true or false
client_ID, client_version,
display_name, host_name, name,
OS_architecture, OS_name,
OS_version, pkg_ID, pkg_OS_name,
pkg_OS_version, version, or
upgradable arguments as regular expressions.
For a sample regular expression, see
Indicates whether one or more vFoglight Agent Manager instances can (true) or cannot be upgraded
(false). It can be set to a regular expression.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:packages -allclients
Client ID: tor012991.prod.quest.corp#cf238d96-3a56-45d6-a33eb88bb7d4ff55
Installer ID: tor012991.prod.quest.corp#cf238d96-3a56-45d6-
82 vFoglight
Command-Line Reference Guide a33e-b88bb7d4ff55#FglAM:tor012991.prod.quest.corp/ cf238d96-3a56-45d6-a33e-b88bb7d4ff55/installer
Agent Package ID: OSCartridge-WindowsXP-5.2.4-OSCartridge-
Agent-WindowsXP-windows-/5\.1.*/-ia32,x86_64
Agent Package Cartridge Name: OSCartridge-WindowsXP
Agent Package Cartridge Version: 5.2.4
Agent Package OS: windows
Agent Package OS Version: /5\.1.*/
Agent Package OS Architecture: ia32,x86_64
------------------------------------
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ packages ” on page 175.
See also
•
•
•
types
The types command shows a list of vFoglight agent types sorted by the Agent Manager
ID.
Scope
Syntax
fglcmd connection_options -cmd agent:types [-regex]
[-host host_name] [-clientname display_name]
[-clientid client_ID] [-clientbuild build_ID]
[-clientversion version] [-allclients]
[-upgradable {true|false}]
Managing Cartridges and Metrics
Managing Agents
83
Options and arguments
Option allclients clientbuild clientid clientname clientversion host regex upgradable
Argument Description
None build_ID client_ID display_name An explicit text string or a regular expression that specifies one or more display devices that are running an instance of the vFoglight Agent
Manager.
version
An explicit text string or a regular expression that identifies one or more instances of the vFoglight
Agent Manager.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version.
host_name
Indicates that all instances of the vFoglight Agent
Manager should be selected.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
None
An explicit text string or a regular expression that specifies one or more host names.
Interprets the build_ID, client_ID, display_name,
host_name, version, or upgradable arguments as regular expressions.
For a sample regular expression used to specify a
host name, see “ Example ” on page 74.
true or false Indicates whether one or more vFoglight Agent
Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:types -clientname tor012991.prod.quest.corp
84 vFoglight
Command-Line Reference Guide
Client ID: tor012991.prod.quest.corp#cf238d96-3a56-45d6-a33eb88bb7d4ff55
Client Name: tor012991.prod.quest.corp
Agent Types:
OSCartridge/NetMonitor
OSCartridge/LogFilter
OSCartridge/WebMonitor
OSCartridge/ApacheSvr
OSCartridge/SNMP
OSCartridge/AppMonitor
OSCartridge/Windows_System
------------------------------------
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ types ” on page 176.
See also
•
•
•
Upgrading the vFoglight Agent Manager clientupgrade
The clientupgrade command can be used to upgrade one or more remote instances of the vFoglight Agent Manager.
Scope
Syntax
fglcmd connection_options -cmd agent:clientupgrade
{-clientname display_name|-clientid client_ID|
-clientbuild build_ID|-clientversion version|-allclients}
[-host host_name] {{-to version [-tobuild build_id] [-regex]
[-timeout seconds] [-force]}|-list}
[-upgradable {true|false}]}|
Managing Cartridges and Metrics
Managing Agents
85
Options and arguments
Option allclients clientbuild clientid clientname clientversion force host list regex
Argument Description
None build_ID client_ID display_name An explicit text string or a regular expression that specifies the name of one or more display devices that are running an instance of the vFoglight Agent
Manager.
version
An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the vFoglight Agent
Manager.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version.
None
Indicates that all instances of the vFoglight Agent
Manager should be selected.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
host_name
None
In cases where multiple agents are selected, it indicates that the command should be performed against all selected agent installers and packages.
An explicit text string or a regular expression that specifies one or more host names.
Lists available upgrade versions.
None Interprets the architecture, build_ID, client_ID,
display_name, host_name, name, OS_architecture,
OS_name, OS_version, package_ID,
pkg_OS_name, pkg_OS_version, version, or
upgradable arguments as regular expressions.
For a sample regular expression used to specify a
host name, see “ Example ” on page 74.
86 vFoglight
Command-Line Reference Guide
Option timeout tobuild toversion upgradable
Argument seconds build_ID version
true or false
Description
Specifies the maximum time in seconds for the timeout period. If the timeout i not specified or is set to zero '0', the command waits for the upgrade to complete.
Specifies the build number to which the selected instances of the vFoglight Agent Manager should be upgraded.
Specifies the version to which the selected instances of the vFoglight Agent Manager should be upgraded.
Indicates whether one or more vFoglight Agent
Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:clientupgrade -list -allclients -upgradable true
Client ID: tor012991.prod.quest.corp#32b1c51d-6208-435c-bdad-
2a8916ef3a89
Client Name: tor012991.prod.quest.corp
Client Version: 5.2.4 (524-20080811-0230)
Upgradable: true
No upgrades are available for this client at this moment
Deploying Agent Packages deploy
The deploy command deploys one or more vFoglight agent packages.
In most cases, vFoglight cartridges include one or more agent packages that are used to collect metrics from monitored hosts. You can deploy an agent package after installing the cartridge that includes that agent package on the vFoglight Management Server. For information on how to install a cartridge using the fglcmd
Managing Cartridges and Metrics
Managing Agents
87
page 128; to find out how to list available agent packages using
fglcmd , see
Scope
Syntax
fglcmd connection_options -cmd agent:deploy
{-packageversion version|-packageid package_ID|-allpackages|
-allinstallers} {-host host_name|-clientname display_name|
-clientid client_ID|-clientbuild build_ID|
-clientversion version|-allclients} [-packageos pkg_OS_name]
[-packageosversion pkg_OS_version]
[-packagearch OS_architecture] [-osversion OS_version]
[-osname OS_name] [-arch architecture]
[-installerid agent_installer_ID]
[-installername agent_installer_name] [-regex] [-test]
[-disable_platform_check] [-force] [-upgradable {true|false}]
Options and arguments
Option allclients allinstallers allpackages arch
Argument
None
None
None architecture
Description
Indicates that all instances of the vFoglight Agent Manager should be selected.
Indicates that all agent installers should be selected.
Indicates that all agent packages should be deployed.
An explicit text string or a regular expression that specifies one or more platform architectures.
88 vFoglight
Command-Line Reference Guide
Option clientbuild clientid clientname clientversion disable_platform_check force host
Argument build_ID client_ID display_name version
None
None host_name
Description
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build
ID.
An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the vFoglight Agent Manager.
An explicit text string or a regular expression that specifies the name of one or more display devices that are running an instance of the vFoglight Agent Manager.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version.
Disables automatic filtering of agent packages based on platform information provided by agent installers.
In cases where multiple agents are selected, it indicates that the command should be performed against all selected agent installers and packages.
An explicit text string or a regular expression that specifies one or more host names.
Option installerid installername osname osversion packagearch packageid packageos
Managing Cartridges and Metrics
Managing Agents
89
Argument agent_installer_ID name
OS_name
OS_version
OS_architecture package_ID pkg_OS_name
Description
Selects the agent installer with the specified ID.
An explicit text string or a regular expression that selects one or more agent installers based on the specified name.
An explicit text string or a regular expression that specifies the name of one or more operating systems with which the agent packages are compatible
An explicit text string or a regular expression that specifies one or more operating system versions the agent packages are compatible with.
An explicit text string or a regular expression that specifies one or more operating system architectures the agent packages are compatible with.
An explicit text string or a regular expression that identifies one or more agent packages that are to be deployed.
An explicit text string or a regular expression that specifies the name of one or more operating systems of the agent packages that are to be deployed.
90 vFoglight
Command-Line Reference Guide
Option packageosversion packageversion regex test upgradable
Argument pkg_OS_version version
None
None
true or false
Description
An explicit text string or a regular expression that specifies one or more operating system versions of the agent packages that are to be deployed.
An explicit text string or a regular expression that specifies one or more versions of the agent packages that are to be deployed.
Interprets the architecture,
build_ID, client_ID,
display_name, host_name, name,
OS_architecture, OS_name,
OS_version, package_ID,
pkg_OS_name, pkg_OS_version,
version, or upgradable arguments as regular expressions.
For a sample regular expression used to specify a host name, see
Issues the command in test mode without deploying any agents.
Indicates whether one or more vFoglight Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:deploy -host tor012991.prod.quest.corp -clientid tor012991.prod.quest.corp#cf238d96
-3a56-45d6-a33e-b88bb7d4ff55 -packageid OSCartridge-
WindowsXP-5.2.4-OSCartridge-Agent-WindowsXP-windows-/5\.1.*/ia32,x86_64
Successfully installed package OSCartridge-WindowsXP-5.2.4-
Managing Cartridges and Metrics
Managing Agents
91
OSCartridge-Agent-WindowsXP-windows-/5\.1.*/-ia32,x86_64 on tor012991.prod.quest.corp#cf238d96-3a56-4
5d6-a33e-b88bb7d4ff55#FglAM:tor012991.prod.quest.corp/ cf238d96-3a56-45d6-a33e-b88bb7d4ff55/installer
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ deploy ” on page 173.
See also
•
•
•
•
•
•
Creating or Deleting Agent Instances
This section describes the following commands:
•
•
create
The create command produces one or more vFoglight agent instances.
You can create an agent instance after deploying the agent package on the vFoglight
Management Server. To create an agent instance that collects data, you first create the agent instance, activate it, and then start the data collection for that agent instance.
Similarly, when you want to remove an agent instance, use a reverse order of actions: first stop the agent instance, deactivate it, and then delete it.
For information on how to deploy an agent package using the fglcmd interface, see
” on page 86; for information on how to delete agent instances, see “ delete ” on page 95.
92 vFoglight
Command-Line Reference Guide
Scope
Syntax
fglcmd connection_options -cmd agent:create -name name
-type agent_type {-clientname display_name|
-clientid client_ID|-clientbuild build_ID|
-clientversion version|-allclients} [-host host_name]
[-force] [-regex] [-upgradable {true|false}]
Options and arguments
Option allclients clientbuild clientid clientname clientversion force host
Argument Description
None build_ID host_name
Indicates that all instances of the vFoglight Agent
Manager should be selected.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
client_ID display_name An explicit text string or a regular expression that specifies one or more display devices that are running an instance of the vFoglight Agent
Manager.
version
An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the vFoglight Agent
Manager.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version.
None In cases where multiple agents are selected, it indicates that all selected agents should be created.
An explicit text string or a regular expression that specifies one or more host names.
Option name regex
Argument name
None
Managing Cartridges and Metrics
Managing Agents
93
Description
An explicit text string or a regular expression that specifies one or more agent names.
Interprets the build_ID., client_ID, display_name,
host_name, version, or upgradable arguments as regular expressions.
For a sample regular expression used to specify a
host name, see “ Example ” on page 74.
94 vFoglight
Command-Line Reference Guide
Option type upgradable
Argument agent_type
true or false
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for Operating
Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating
Systems, see the Cartridge for Operating Systems
User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of OSCartridge/
AppMonitor result in an error.
Indicates whether one or more vFoglight
Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.
Managing Cartridges and Metrics
Managing Agents
95
Example
Using a regular expression to select hosts
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:create -type OSCartridge/Windows_System
-host .*.corp -name MyAgentX -regex -force
Note If successful, this command does not generate any output.
Using a literal value to select a vFoglight Agent Manager instance
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:create -type OSCartridge/Windows_System
-name Agent5 -clientname tor012991.prod.quest.corp
Note If successful, this command does not generate any output.
See also
•
•
•
•
•
•
delete
The delete command removes one or more vFoglight agent instances.
To delete an agent instance, a typical flow of actions requires you to first stop the agent’s data collection, deactivate it, and then delete the instance. However, the delete command includes options and arguments, such as -active true and
-datacollection true , that let you override that flow and delete active agent instances that are collecting data.
For information on how to deactivate an agent instance using the fglcmd interface, see
96 vFoglight
Command-Line Reference Guide
Scope
Syntax
fglcmd connection_options -cmd agent:delete {-agentid agent_ID|
-name agent_name|-namespace agent_namespace|-all}
[-type agent_type] [-host host_name] [-adapter adapter_ID]
[-deletable {true|false}] [-datacollection {true|false}]
[-activatable {true|false}] [-active {true|false}] [-regex]
[-force] [-nowait]
Options and arguments
Option activatable active adapter agentid all deletable force
Argument
true or false
true or false adapter_ID agent_ID
None datacollection true or false
true or false
None
Description
Indicates whether to delete agent instances that can (true) or cannot be activated (false).
Indicates whether to delete agent instances that are active (true) or inactive (false).
An explicit text string or a regular expression that identifies one or more vFoglight adapters.
Identifies an instance of a vFoglight agent that is to be deleted.
Indicates that all agent instances should be deleted.
Indicates whether to delete vFoglight agent instances that are (true) or are not collecting data (false).
Indicates whether to delete vFoglight agent instances that can (true) or cannot be deleted
(false).
In cases where multiple agents are selected, it indicates that all selected agents should be deleted.
Managing Cartridges and Metrics
Managing Agents
Option host name namespace nowait regex
Argument host_name agent_name agent_namespace
None
None
Description
An explicit text string or a regular expression that specifies one or more host names.
An explicit text string or a regular expression that specifies the name of one or more vFoglight agents that are to be deleted.
An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space.
Indicates that the command should not wait for the selected agents to finish processing before deleting the selected vFoglight agent instances.
Interprets the adapter_ID, agent_name,
agent_namespace, agent_type, or host_name arguments as regular expressions.
For a sample regular expression used to
specify a host name, see “ Example ” on page 74.
97
98 vFoglight
Command-Line Reference Guide
Option type
Argument agent_type
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management
Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for
Operating Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating Systems, see the Cartridge for
Operating Systems User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of
OSCartridge/AppMonitor result in an error.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
Managing Cartridges and Metrics
Managing Agents
99
-cmd agent:delete -name Agent4
Note If successful, this command does not generate any output.
See also
•
•
•
•
•
•
Activating or Deactivating Agent Instances
This section describes the following commands:
•
•
activate
The activate command enables one or more vFoglight agent instances.
To create an agent instance that collects data, you first create the agent instance, activate it, and then start the data collection for that agent instance. Similarly, when you want to remove an agent instance, use a reverse order of actions: first stop the agent instance, deactivate it, and then delete it.
For information on how to create an agent instance, see “ create ” on page 91; to find out
how to deactivate an agent, see “ deactivate ” on page 104.
Scope
Syntax
fglcmd connection_options -cmd agent:activate
{-agentid agent_ID|-name agent_name|
-namespace agent_namespace|-all} [-host host_name]
100 vFoglight
Command-Line Reference Guide
[-adapter adapter_ID] [-type agent_type]
[-deletable {true|false}] [-datacollection {true|false}]
[-activatable {true|false}] [-active {true|false}] [-regex]
[-force] [-nowait]
Options and arguments force host name
Option activatable active adapter agentid all
Argument
true or false
true or false adapter_ID agent_ID
None datacollection true or false deletable true or false
None host_name agent_name
Description
Indicates whether to activate agent instances that can (true) or cannot be activated (false).
Indicates whether to activate agent instances that are active (true) or inactive (false).
An explicit text string or a regular expression that identifies one or more vFoglight adapters.
Identifies an instance of a vFoglight agent that is to be activated.
Indicates that all agent instances should be activated.
Indicates whether to activate vFoglight agent instances that are (true) or are not collecting data (false).
Indicates whether to activate vFoglight agent instances that can (true) or cannot be deleted
(false).
In cases where multiple agents are selected, it indicates that all selected agents should be activated.
An explicit text string or a regular expression that specifies one or more host names.
An explicit text string or a regular expression that specifies the name of one or more vFoglight agents that are to be activated.
Managing Cartridges and Metrics
Managing Agents
101
Option namespace nowait regex
Argument agent_namespace
None
None
Description
An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space.
Indicates that the command should not wait for the selected agents to finish processing before activating the selected vFoglight agent instances.
Interprets the adapter_ID, agent_name,
agent_namespace, agent_type, or host_name arguments as regular expressions.
For a sample regular expression used to
specify a host name, see “ Example ” on page 74.
102 vFoglight
Command-Line Reference Guide
Option type
Argument agent_type
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management
Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for
Operating Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating Systems, see the Cartridge for
Operating Systems User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of
OSCartridge/AppMonitor result in an error.
Managing Cartridges and Metrics
Managing Agents
103
Example
The first command in this example, shown in “ Listing agents ” on page 103, lists agent
IDs using the agent:list command with the all option set. For more information on
how to list agent instances, see “ list ” on page 75.
The second command, shown in “ Activating an agent instance ” on page 104, uses an ID
of an inactive agent from the output of the first command to activate an agent.
Listing agents
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:list -all
Host: tor012991.prod.quest.corp
ID: 9
Name: My_Agent_A
Type: Windows_System
Version: 5.2.4 (Build: 524-3/20/090625-0500)
Namespace: SPI
Adapter ID: FglAM
Status: Not active
------------------------------------
Host: tor012991.prod.quest.corp
ID: 10
Name: My_Agent_B
Type: Windows_System
Version: 5.2.4 (Build: 524-3/20/090625-0500)
Namespace: SPI
Adapter ID: FglAM
Status: Not active
------------------------------------
Host: tor012991.prod.quest.corp
ID: 12
Name: Agent1
Type: Windows_System
Version: 5.2.4 (Build: 524-3/20/090625-0500)
Namespace: SPI
Adapter ID: FglAM
Status: Not active
------------------------------------
Host: tor012991.prod.quest.corp
ID: 13
Name: Agent2
Type: NetMonitor
Version: 5.2.4 (Build: 524-3/20/090625-0500)
104 vFoglight
Command-Line Reference Guide
Namespace: SPI
Adapter ID: FglAM
Status: Not active
------------------------------------
Host: tor012991.prod.quest.corp
ID: 16
Name: Agent3
Type: ApacheSvr
Version: 5.2.4 (Build: 524-3/20/090625-0500)
Namespace: SPI
Adapter ID: FglAM
Status: Not active
------------------------------------
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ list ” on page 174.
Activating an agent instance
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:activate -agentid 9
Note If successful, this command does not generate any output.
See also
•
•
•
•
•
•
deactivate
The deactivate command disables one or more vFoglight agent instances.
If you want to delete an agent instance, you first stop the agent’s data collection, deactivate it, and then delete the instance.
Managing Cartridges and Metrics
Managing Agents
105
To delete an agent instance, a typical flow of actions requires you to first stop the agent’s data collection, deactivate it, and then delete the instance. However, the deactivate command includes options and arguments, such as -datacollection true , that allow you to override that flow and agent instances that are collecting data.
For information on how to activate an agent instance using the fglcmd interface, see
Scope
Syntax
fglcmd connection_options -cmd agent:deactivate
{-agentid agent_ID|-name agent_name|
-namespace agent_namespace|-all} [-host host_name]
[-adapter adapter_ID] [-type agent_type]
[-deletable {true|false}] [-datacollection {true|false}]
[-activatable {true|false}] [-active {true|false}] [-regex]
[-force] [-nowait]
Options and arguments
Option activatable active adapter agentid all
Argument
true or false
true or false adapter_ID agent_ID
None
Description
Indicates whether to deactivate agent instances that can (true) or cannot be deactivated (false).
Indicates whether to deactivate agent instances that are active (true) or inactive
(false).
An explicit text string or a regular expression that identifies one or more vFoglight adapters.
Identifies an instance of a vFoglight agent that is to be deactivated.
Indicates that all agent instances should be deactivated.
106 vFoglight
Command-Line Reference Guide
Option datacollection deletable force host name namespace nowait regex
Argument
true or false
true or false
None host_name agent_name agent_namespace
None
None
Description
Indicates whether to deactivate vFoglight agent instances that are (true) or are not collecting data (false).
Indicates whether to deactivate vFoglight agent instances that can (true) or cannot be deleted (false).
In cases where multiple agents are selected, it indicates that all selected agents should be deactivated.
An explicit text string or a regular expression that specifies one or more host names.
An explicit text string or a regular expression that specifies the name of one or more vFoglight agents that are to be deactivated.
An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space.
Indicates that the command should not wait for the selected agents to finish processing before deactivating the selected vFoglight agent instances.
Interprets the adapter_ID, agent_name,
agent_namespace, agent_type, or host_name arguments as regular expressions.
For a sample regular expression used to
specify a host name, see “ Example ” on page 74.
Managing Cartridges and Metrics
Managing Agents
107
Option type
Argument agent_type
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management
Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for
Operating Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating Systems, see the Cartridge for
Operating Systems User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of
OSCartridge/AppMonitor result in an error.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
108 vFoglight
Command-Line Reference Guide
-cmd agent:deactivate -agentid 14
Note If successful, this command does not generate any output.
See also
•
•
•
•
•
•
Starting or Stopping Data Collection
This section describes the following commands:
•
•
start
The start command initiates data collection for one or more vFoglight agent instances.
To create an agent instance that collects data, you first create the agent instance, activate it, and then start the data collection for that agent instance. Similarly, when you want to remove an agent instance, use a reverse order of actions: first stop the agent instance, deactivate it, and then delete it.
You should issue this command after creating and/or activating an agent instance. For information on how to activate agent instances using the fglcmd interface, see
Scope
Managing Cartridges and Metrics
Managing Agents
Syntax
fglcmd connection_options -cmd agent:start {-agentid agent_ID|
-name agent_name|-namespace agent_namespace|-all}
[-host host_name] [-adapter adapter_ID] [-type agent_type]
[-deletable {true|false}] [-datacollection {true|false}]
[-activatable {true|false}] [-active {true|false}] [-regex]
[-force] [-nowait]
Options and arguments
109
Option activatable active adapter agentid all
Argument
true or false
true or false adapter_ID agent_ID
None datacollection true or false deletable true or false force host
None host_name
Description
Indicates whether to start agent instances that can (true) or cannot be activated (false).
Indicates whether to start agent instances that are active (true) or inactive (false).
An explicit text string or a regular expression that identifies one or more vFoglight adapters.
Identifies an instance of a vFoglight agent that is to be started.
Indicates that all agent instances should be started.
Indicates whether to start vFoglight agent instances that are (true) or are not collecting data (false).
Indicates whether to start vFoglight agent instances that can (true) or cannot be deleted
(false).
In cases where multiple agents are selected, it indicates that all selected agents should be started.
An explicit text string or a regular expression that specifies one or more host names.
110 vFoglight
Command-Line Reference Guide
Option name namespace nowait regex
Argument Description agent_name agent_namespace An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space.
None
An explicit text string or a regular expression that specifies the name of one or more agent instances that are to be started.
Indicates that the command should not wait for the selected agents to finish processing before starting the selected vFoglight agent instances.
None Interprets the agent_name, agent_namespace,
agent_type, or host_name arguments as regular expressions.
For a sample regular expression used to
specify a host name, see “ Example ” on page 74.
Managing Cartridges and Metrics
Managing Agents
111
Option type
Argument agent_type
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management
Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for
Operating Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating Systems, see the Cartridge for
Operating Systems User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of
OSCartridge/AppMonitor result in an error.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
112 vFoglight
Command-Line Reference Guide
-cmd agent:start -host tor012991.prod.quest.corp -active true
-force
Note If successful, this command does not generate any output.
See also
•
•
•
•
•
•
stop
The stop command terminates the data collection for one or more vFoglight agent instances.
If you want to delete an agent instance, you first stop the agent’s data collection, deactivate it, and then delete the instance.
To delete an agent instance, a typical flow of actions requires you to first stop the agent’s data collection, deactivate it, and then delete the instance. However, the
(see page 104) and delete (see page 95) commands that allow you to
deactivate and delete agent instances, include options and arguments that let you override that flow and delete active agent instances that are collecting data without first stopping their data collection.
For information on how to start an agent’s data collection using the command line, see
Scope
Syntax
fglcmd connection_options -cmd agent:stop {-agentid agent_ID|
-name agent_name|-namespace agent_namespace|-all}
[-host host_name] [-adapter adapter_ID] [-type agent_type]
[-deletable {true|false}] [-datacollection {true|false}]
Managing Cartridges and Metrics
Managing Agents
[-activatable {true|false}] [-active {true|false}] [-regex]
[-force] [-nowait]
Options and arguments
113 deletable true or false force host name
Option activatable active adapter agentid all
Argument
true or false
true or false adapter_ID agent_ID
None datacollection true or false
None host_name agent_name
Description
Indicates whether to stop agent instances that can (true) or cannot be activated (false).
Indicates whether to stop agent instances that are active (true) or inactive (false).
An explicit text string or a regular expression that identifies one or more vFoglight adapters.
Identifies an instance of a vFoglight agent that is to be stopped.
Indicates that all agent instances should be stopped.
Indicates whether to stop vFoglight agent instances that are (true) or are not collecting data (false).
Indicates whether to stop vFoglight agent instances that can (true) or cannot be deleted
(false).
In cases where multiple agents are selected, it indicates that all selected agents should be stopped.
An explicit text string or a regular expression that specifies one or more host names.
An explicit text string or a regular expression that specifies the name of one or more agent instances that are to be stopped.
114 vFoglight
Command-Line Reference Guide
Option namespace nowait regex
Argument agent_namespace
None
None
Description
An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space.
Indicates that the command should not wait for the selected agents to finish processing before stopping the selected vFoglight agent instances.
Interprets the adapter_ID, agent_name,
agent_namespace, agent_type, or host_name arguments as regular expressions.
For a sample regular expression used to
specify a host name, see “ Example ” on page 74.
Managing Cartridges and Metrics
Managing Agents
115
Option type
Argument agent_type
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management
Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for
Operating Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating Systems, see the Cartridge for
Operating Systems User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of
OSCartridge/AppMonitor result in an error.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
116 vFoglight
Command-Line Reference Guide
-cmd agent:stop -agentid 15
Note If successful, this command does not generate any output.
See also
•
•
•
•
•
•
Listing and Retrieving Log Files
This section describes the following commands:
•
•
logs
The logs command shows a list of agent log files.
For information on how to retrieve a log file using the fglcmd
interface, see “ getlog ” on page 118.
Scope
Syntax
fglcmd connection_options -cmd agent:logs
{-clientname display_name|-clientid client_ID|
-clientbuild build_ID|-clientversion version|-allclients}
[-host host_name] [-regex] [-force] [-upgradable {true|false}]
Managing Cartridges and Metrics
Managing Agents
117
Options and arguments
Option allclients clientbuild clientid clientname clientversion force host regex upgradable
Argument Description
None build_ID client_ID display_name An explicit text string or a regular expression that specifies one or more display devices that are running an instance of the vFoglight Agent
Manager.
version
An explicit text string or a regular expression that identifies one or more instances of the vFoglight
Agent Manager.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version.
None
Indicates that all instances of the vFoglight Agent
Manager should be selected.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
host_name
In cases where multiple client instances are selected, it indicates that all selected instances should be stopped.
An explicit text string or a regular expression that specifies one or more host names.
None
true or false
Interprets the build_ID, client_ID, display_name,
host_name, version, or upgradable arguments as regular expressions.
For a sample regular expression used to specify a
host name, see “ Example ” on page 74.
Indicates whether one or more vFoglight Agent
Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.
118 vFoglight
Command-Line Reference Guide
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:logs -clientid tor012991.prod.quest.corp# cf238d96-3a56-45d6-a33e-b88bb7d4ff55
Client ID: tor012991.prod.quest.corp#32b1c51d-6208-435c-bdad-
2a8916ef3a89
Client Name: tor012991.prod.quest.corp
Host Name: tor012991.prod.quest.corp
2 log files found.
C:\Vizioncore\vFoglight_Agent_Manager\state\.\logs\OSCartridge
\5.2.4\Windows_System\My_Agent_A_3/20/09-07-09_110837_001.log
C:\Vizioncore\vFoglight_Agent_Manager\state\.\logs\OSCartridge
\5.2.4\Windows_System\My_Agent_A_3/20/09-07-08_120923_001.log
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Client, see “ logs ” on page 174.
See also
•
getlog
The getlog command retrieves a copy of an agent’s log file. This command is useful in situations when you do not have access to the installation directory of the vFoglight
Management Server.
For information on how to get a list of log files using the fglcmd
interface, see “ logs ” on page 116.
Scope
Syntax
fglcmd connection_options -cmd agent:getlog -log log_file_name
-f file_path [-host host_name] [-clientname display_name]
[-clientid client_ID] [-clientbuild build_ID]
[-clientversion version] [-allclients] [-regex]
[-upgradable {true|false}]
Managing Cartridges and Metrics
Managing Agents
119
Options and arguments f
Option allclients clientbuild clientid clientname clientversion host log regex
Argument
None build_ID client_ID display_name version file_path host_name log_file_name
None
Description
Indicates that all instances of the vFoglight Agent
Manager should be selected.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the vFoglight Agent
Manager.
An explicit text string or a regular expression that specifies one or more display devices that are running an instance of the vFoglight Agent
Manager.
An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version.
Specifies the path and name of the destination file.
An explicit text string or a regular expression that specifies one or more host names.
Specifies the path and name of the log file that is to be retrieved.
Interprets the build_ID, client_ID, display_name,
host_name, version, or upgradable arguments as regular expressions.
For a sample regular expression used to specify a
host name, see “ Example ” on page 74.
120 vFoglight
Command-Line Reference Guide
Option upgradable
Argument
true or false
Description
Indicates whether one or more vFoglight Agent
Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:getlog -clientid tor012991.prod.quest.corp#cf238d96
-3a56-45d6-a33e-b88bb7d4ff55 -log ..\..\glue\state\logs\
OSCartridge\5.2.4\Windows_System\
My_Agent_A_3/20/09-07-09_110837_001.log -f AgentA.log
Note If successful, this command does not generate any output.
See also
•
Listing and Setting Blackout Schedules
This section describes the following commands:
•
•
showschedule
The showchedule command shows the blackout schedule assigned to one or more vFoglight agent instances.
Scope
Syntax
fglcmd connection_options -cmd agent:showschedule
{-agentid agent_ID|-name agent_name|
-namespace agent_namespace|-all}
Managing Cartridges and Metrics
Managing Agents
[-host host_name] [-adapter adapter_ID] [-type agent_type]
[-deletable {true|false}] [-datacollection {true|false}]
[-activatable {true|false}] [-active {true|false}] [-regex]
Options and arguments
121
Option activatable active adapter agentid all datacollection deletable host name namespace
Argument Description
true or false
true or false adapter_ID agent_ID
None
true or false
true or false host_name
Indicates whether to select agent instances that can (true) or cannot be deactivated (false).
Indicates whether to select agent instances that are active (true) or inactive (false).
An explicit text string or a regular expression that identifies one or more vFoglight adapters.
Identifies an instance of a vFoglight agent whose blackout schedule is to be set.
Indicates that all agent instances should be selected.
Indicates whether to select vFoglight agent instances that are (true) or are not collecting data (false).
Indicates whether to select vFoglight agent instances that can (true) or cannot be deleted
(false).
An explicit text string or a regular expression that specifies one or more host names.
agent_name An explicit text string or a regular expression that specifies one or more vFoglight agents whose blackout schedule is to be set.
agent_namespace An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space.
122 vFoglight
Command-Line Reference Guide
Option regex
Argument
None
Description
Interprets the adapter_ID, agent_name,
agent_namespace, agent_type, or host_name arguments as regular expressions.
For a sample regular expression used to
specify a host name, see “ Example ” on page 74.
Managing Cartridges and Metrics
Managing Agents
123
Option type
Argument agent_type
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management
Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for
Operating Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating Systems, see the Cartridge for
Operating Systems User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of
OSCartridge/AppMonitor result in an error.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
124 vFoglight
Command-Line Reference Guide
-cmd agent:showschedule -active true
ID: 2
Host: tor012991.prod.quest.corp
Name: OSCartridge/Windows_System_on_tor012991.prod.quest.corp
Type: Windows_System
Status: Active/Collecting data
Blackout Schedule: First day of week (id: 013f57d1-1e7e-4098a7a5-2b2763364cb5)
------------------------------------
ID: 4
Host: tor012991.prod.quest.corp
Name: test
Type: Windows_System
Status: Active/Collecting data
Blackout Schedule: First day of month (id: 3e3e1877-7b55-4c7a-
9a40-975bdc96f8e2)
------------------------------------
See also
•
setschedule
The setschedule command assigns a blackout schedule to one or more vFoglight agent instances.
For information on how to get a list of blackout schedules assigned to agent instances files using the fglcmd
interface, see “ showschedule ” on page 120.
Scope
Syntax
fglcmd connection_options -cmd agent:setschedule
{-agentid agent_ID|-name agent_name|
-namespace agent_namespace|-all}
{-schedulename schedule_name|-scheduleid schedule_ID-none}
[-host host_name] [-adapter adapter_ID] [-type agent_type]
[-deletable {true|false}] [-datacollection {true|false}]
[-activatable {true|false}] [-active {true|false}] [-regex]
[-force]
Managing Cartridges and Metrics
Managing Agents
125
Options and arguments
Option activatable active adapter agentid all datacollection deletable force host name namespace
Argument Description
true or false
true or false adapter_ID agent_ID
None
true or false
true or false
None host_name
Indicates whether to select agent instances that can (true) or cannot be deactivated (false).
Indicates whether to select agent instances that are active (true) or inactive (false).
An explicit text string or a regular expression that identifies one or more vFoglight adapters.
Identifies an instance of a vFoglight agent whose blackout schedule is to be set.
Indicates that all agent instances should be selected.
Indicates whether to select vFoglight agent instances that are (true) or are not collecting data (false).
Indicates whether to select vFoglight agent instances that can (true) or cannot be deleted
(false).
In cases where multiple agents are selected, it indicates that the command should be performed against all selected agent instances.
An explicit text string or a regular expression that specifies one or more host names.
agent_name An explicit text string or a regular expression that specifies one or more vFoglight agents whose blackout schedule is to be set.
agent_namespace An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space.
126 vFoglight
Command-Line Reference Guide
Option none regex
Argument
None
None scheduleid schedule_ID schedulename schedule_name
Description
Dissociates all schedules from one more selected agent instances.
Interprets the adapter_ID, agent_name,
agent_namespace, agent_type, or host_name arguments as regular expressions.
For a sample regular expression used to
specify a host name, see “ Example ” on page 74.
Identifies a schedule that is to be assigned to one or more vFoglight agent instances.
Specifies a schedule name. You can use any of the following values:
• Daily Off Values
• End of Day
• Hourly
• Monthly Off Hours
• Start of Day
• Quarterly Off Hours
• Weekly Off Hours
Note If you choose a schedule name that contains spaces, such as Start Of Day , enclose it in quotation marks.
Managing Cartridges and Metrics
Managing Agents
127
Option type
Argument agent_type
Description
An explicit text string or a regular expression that specifies one or more vFoglight agent types.
The selection of available agent types depends on the collection of deployed cartridges. For example, a basic vFoglight Management
Server installation that includes the Cartridge for Operating Systems can offer a number of different agent types. For example:
• OSCartridge/ApacheSvr
• OSCartridge/AppMonitor
• OSCartridge/LogFilter
• OSCartridge/NetMonitor
• OSCartridge/SNMP
• OSCartridge/WebMonitor
• OSCartridge/Windows_System
Note The above list is just a subset of the agent types that come with the Cartridge for
Operating Systems and should be used only as an illustration. For a complete list of agents that are included with the Cartridge for Operating Systems, see the Cartridge for
Operating Systems User Guide.
Always use the fully qualified name of the agent type. For example, the agent types that come with the OS Cartridge agent are named using the following syntax:
OSCartridge/agent_name
For example, the fully qualified name of the
AppMonitor agent type is OSCartridge/
AppMonitor . Any attempts to use a partial type name, without the OSCartridge/ prefix, for example, AppMonitor instead of
OSCartridge/AppMonitor result in an error.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
128 vFoglight
Command-Line Reference Guide
-cmd agent:setschedule -agentid 10 -schedulename "Start of
Day"
Note If successful, this command does not generate any output.
See also
•
Managing Cartridges
This section describes the following features:
•
“ Installing or Uninstalling Cartridges ” on page 128
•
“ Enabling or Disabling Cartridges ” on page 130
•
“ Listing Cartridges ” on page 133
Installing or Uninstalling Cartridges
This section describes the following commands:
•
•
install
The install command installs a cartridge on the vFoglight Management Server.
Scope
Syntax
fglcmd connection_options -cmd cartridge:install [-passive]
[-f file_path]
Managing Cartridges and Metrics
Managing Cartridges
129
Options and arguments f
Option passive
Argument
None file_path
Description
Indicates that the cartridge should be installed, but not activated.
Specifies the path and file name of the cartridge file that is to be installed.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd cartridge:install -f C:\Vizioncore\carts\
OSCartridge-WindowsXP-5_2_3.car
Cartridges installed:
Name: OSCartridge-WindowsXP version: 5.2.4
Name: OS-Common version: 5.2.4
Name: OS-ApacheSvr version: 5.2.4
Name: OS-AppMonitor version: 5.2.4
Name: OS-LogFilter version: 5.2.4
Name: OS-NetMonitor version: 5.2.4
Name: OS-SNMP version: 5.2.4
Name: OS-WebMonitor version: 5.2.4
Name: OS-Windows_System version: 5.2.4
Name: OS-OnlineHelp version: 5.2.4
Name: OS-HostModel-Windows version: 5.2.4
All cartridges are activated.
See also
•
•
•
•
uninstall
The uninstall command uninstalls a vFoglight cartridge.
130 vFoglight
Command-Line Reference Guide
You can only uninstall a disabled cartridge. For information on how to disable a cartridge using the fglcmd
interface, see “ disable ” on page 131.
Scope
Syntax
fglcmd connection_options -cmd cartridge:uninstall [-n name]
[-v version]
Options and arguments
Option n v
Argument name version
Description
Specifies the name of the cartridge that is to be uninstalled.
Specifies the version of the cartridge that is to be uninstalled.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd cartridge:uninstall -n OSCartridge-WindowsXP -v 5.2.4
Note If successful, this command does not generate any output.
See also
•
•
•
•
Enabling or Disabling Cartridges
This section describes the following commands:
Managing Cartridges and Metrics
Managing Cartridges
131
•
•
disable
The disable command deactivates a vFoglight cartridge.
When you install a cartridge on the vFoglight Management Server using default options either through the fglcmd interface or the Administration dashboards, vFoglight activates that cartridge upon creation. For information on how to install a cartridge using the fglcmd
interface, see “ install ” on page 128; to find out how to activate an
inactive cartridge using fglcmd
Scope
Syntax
fglcmd connection_options -cmd cartridge:disable [-n name]
[-v version]
Options and arguments
Option n v
Argument name version
Description
Specifies the name of the cartridge that is to be disabled.
Specifies the version of the cartridge that is to be disabled.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd cartridge:disable -n OSCartridge-WindowsXP -v 5.2.4
Note If successful, this command does not generate any output.
See also
•
132 vFoglight
Command-Line Reference Guide
•
•
•
enable
The enable command activates an installed vFoglight cartridge.
When you install a cartridge on the vFoglight Management Server using default options either through the fglcmd interface or the Administration dashboards, vFoglight activates that cartridge upon creation. For information on how to install a cartridge using the fglcmd
interface, see “ install ” on page 128; to find out how to deactivate an
active cartridge using fglcmd
Scope
Syntax
fglcmd connection_options -cmd cartridge:enable [-n name]
[-v version]
Options and arguments
Option n v
Argument name version
Description
Specifies the name of the cartridge that is to be enabled.
Specifies the version of the cartridge that is to be enabled.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd cartridge:enable -n OSCartridge-WindowsXP -v 5.2.4
Note If successful, this command does not generate any output.
Managing Cartridges and Metrics
Managing Cartridges
133
See also
•
•
•
•
Listing Cartridges list
The list command generates a list of all installed vFoglight cartridges.
For information on how to install a vFoglight cartridge using the fglcmd interface, see
Scope
Syntax
fglcmd connection_options -cmd cartridge:list
Options and arguments
None
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd cartridge:list
Name: BSM-Integration
Version: 5.2.4
Build: 524-3/20/090811-1655
Status: ACTIVATED
------------------------------------
Name: Core-AppMonitor-Application
Version: 5.2.4
Build: 524-3/20/090811-1655
Status: ACTIVATED
------------------------------------
134 vFoglight
Command-Line Reference Guide
Name: Core-ApplicationTopologyModel
Version: 5.2.4
Build: 524-3/20/090811-1655
Status: ACTIVATED
------------------------------------
Name: Core-BusinessServiceModel
Version: 5.2.4
Build: 524-3/20/090811-1655
Status: ACTIVATED
-----------------------------------
Name: Core-CustomModel
Version: 5.2.4
Build: 524-3/20/090811-1655
Status: ACTIVATED
------------------------------------
Name: Core-DB2-Transformations
Version: 5.2.4
Build: 524-3/20/090811-1655
Status: ACTIVATED
------------------------------------
Name: Core-Dashboards
Version: 5.2.4
Build: 524-3/20/090811-1655
Status: ACTIVATED
------------------------------------
Name: Core-DeploymentHandler
Version: 5.2.4
Build: 524-3/20/090811-1655
Status: ACTIVATED
------------------------------------
…
See also
•
•
•
•
Managing Cartridges and Metrics
Managing Security Entities
135
Managing Security Entities
This section describes the following tasks:
•
“ Managing Users ” on page 135
•
“ Managing Groups ” on page 139
This section contains reference information on commands that can be used to manage security entities in vFoglight. For complete information about security principles in vFoglight, see the Administration and Configuration Guide.
Managing Users
This section describes the following commands:
•
•
•
assigngroup
The assigngroup command adds or removes a vFoglight user account from a group.
A user can belong to one or more groups.
Note You can run this command only if the user account you are using to log into fglcmd has a
vFoglight, see the Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd security:assigngroup
-username username -groupname groupname [-remove]
136 vFoglight
Command-Line Reference Guide
Options and arguments
Option groupname remove username
Argument Description groupname Specifies the name of the group to which the user account is to be added or removed
None Indicates that the user should be removed from the group username Specifies the name of the user account that is to be added or removed from the group
Example
Adding a user to a group
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd security:assigngroup -username Demo -groupname MyGroup
Note If successful, this command does not generate any output.
Removing a user from a group
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd security:assigngroup -username Demo -groupname MyGroup
-remove
Note If successful, this command does not generate any output.
See also
•
•
Managing Cartridges and Metrics
Managing Security Entities
137
createuser
The createuser command creates a vFoglight user account. When you create a user account, you can add it to a group using the
assigngroup command (see page 135).
Note You can run this command only if the user account you are using to log into fglcmd has a
vFoglight, see the Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd security:createuser -username
username -password password
Options and arguments
Option password username
Argument password username
Description
Specifies the password of the user account that is to be created
Specifies the name of the user account that is to be created
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd security:createuser -username Demo -password Demo123
Note If successful, this command does not generate any output.
See also
•
•
138 vFoglight
Command-Line Reference Guide
deleteuser
The deleteuser command removes a vFoglight user account.
Note You can run this command only if the user account you are using to log into fglcmd has a
vFoglight, see the Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd security:deleteuser
-username username
Options and arguments
Option username
Argument username
Description
Specifies the user name of the account that is to be deleted
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd security:deleteuser -username Demo
Note If successful, this command does not generate any output.
See also
•
•
Managing Cartridges and Metrics
Managing Security Entities
139
Managing Groups
This section describes the following commands:
•
•
•
assignrole
The assignrole command adds or removes a vFoglight role from a group. A group can have one or more roles.
Note You can run this command only if the user account you are using to log into fglcmd has a
vFoglight, see the Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd security:assignrole
-groupname groupname -rolename rolename [-remove]
Options and arguments
Option groupname
Argument Description groupname Specifies the name of the group to which the role is to be added or removed
None Indicates that the role should be removed from the group remove rolename rolename Specifies the name of the role that is to be added or removed from the group
140 vFoglight
Command-Line Reference Guide
Example
Adding a role to a group
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd security:assignrole -groupname MyGroup -rolename Operator
Note If successful, this command does not generate any output.
Removing a role from a group
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd security:assignrole -groupname MyGroup -rolename Operator
-remove
Note If successful, this command does not generate any output.
See also
•
•
creategroup
The creategroup command creates a vFoglight group. A group can have one or more users, and can be assigned one or more vFoglight roles. When you create a group, that group has no roles assigned to it. Use the
assignrole command to add a role to a group
Note You can run this command only if the user account you are using to log into fglcmd has a
vFoglight, see the Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd security:creategroup
-groupname groupname
Managing Cartridges and Metrics
Managing Security Entities
141
Options and arguments
Option groupname
Argument Description groupname Specifies the name of the group that is to be created
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd security:creategroup -groupname MyGroup
Note If successful, this command does not generate any output.
See also
•
•
deletegroup
The deletegroup command removes a vFoglight group.
Note You can run this command only if the user account you are using to log into fglcmd has a
vFoglight, see the Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd security:deletegroup
-groupname groupname
142 vFoglight
Command-Line Reference Guide
Options and arguments
Option groupname
Argument Description groupname Specifies the name of the group that is to be deleted
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd security:deletegroup -groupname MyGroup
Note If successful, this command does not generate any output.
See also
•
•
Managing vFoglight Licenses
Adding, Removing, or Listing Licenses
This section describes the following commands:
•
•
•
import
The import command installs a vFoglight license. Use it to install a vFoglight license file whose name and location are specified by the argument.
For information on how to remove a license using the fglcmd
interface, see “ remove ” on page 144.
Managing Cartridges and Metrics
Managing vFoglight Licenses
Scope
Syntax
fglcmd connection_options -cmd license:import <-f file_path>
Options and arguments
143 f
Option Argument file_path
Description
Specifies the path and file name of the license file that is to be installed.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd license:import -f ..\license\foglight.license
Note If successful, this command does not generate any output.
See also
•
•
list
The list command generates a list of installed vFoglight licenses.
Scope
Syntax
fglcmd connection_options -cmd license:list
Options and arguments
None
144 vFoglight
Command-Line Reference Guide
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd license:list
License Serial: 123-4567890
License Expiration Date: Fri Aug 01 00:00:00 EDT 3/20/09
Licensed Server Features: agents_connection ldap_integration config_management performance_calendars request_trace_analysis cartridge_installation data_archiving high_availability
Agent Licenses:
------------------------------------
remove
The remove command deletes a vFoglight license given a license serial number.
For information on how to add a vFoglight license using the fglcmd interface, see
Scope
Syntax
fglcmd connection_options -cmd license:remove [-serial
serial_number]
Options and arguments
Option serial
Argument Description serial_number Specifies the serial number of the license file that is to be removed.
Managing Cartridges and Metrics
Running Utility Commands
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd license:remove -serial 123-4567890
Note If successful, this command does not generate any output.
See also
•
•
145
Running Utility Commands
This section describes the following tasks:
•
“ Exporting or Importing a Monitoring Policy ” on page 145
•
“ Exporting, Importing, or Listing UI Modules ” on page 147
•
“ Exporting Metrics and Topology ” on page 151
•
“ Looking Up Server Parameters ” on page 157
•
“ Assigning Blackouts ” on page 157
•
“ Listing Schedules ” on page 159
•
“ Running Scripts ” on page 162
•
“ Creating a Server Support Bundle ” on page 162
Exporting or Importing a Monitoring Policy
This section describes the following commands:
•
•
configexport
The configexport command exports the monitoring policy to an XML file. A monitoring policy describes all customizations to rules, derived metrics, registry variables, agent settings and persistence policies. It is useful to export this information
146 vFoglight
Command-Line Reference Guide for technical analysis and modification purposes even though that data is not meant to be readable by end-users. The configexport command saves the current monitoring policy to an XML file given the file path and its name. If required, you can use the
Scope
Syntax
fglcmd connection_options -cmd util:configexport [-f file_path]
Options and arguments f
Option Argument file_path
Description
Specifies the path and file name of the XML file to which the monitoring policy is to be exported.
Note When specifying the file name, use XML as the file extension.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd util:configexport -f policy.xml
Note If successful, this command does not generate any output.
See also
•
configimport
The configimport command imports a monitoring policy. The source of the import is
an XML file that has been previously exported with the configexport
command (see
page 145). A monitoring policy describes all customizations to rules, derived metrics,
registry variables, agent settings and persistence policies and is useful in technical analysis and modification tasks.
Managing Cartridges and Metrics
Running Utility Commands
147
Scope
Syntax
fglcmd connection_options -cmd util:configimport [-f file_path]
Options and arguments f
Option Argument file_path
Description
Specifies the path and file name of the XML file that is to be imported.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd util:configimport -f policy.xml
Note If successful, this command does not generate any output.
See also
•
Exporting, Importing, or Listing UI Modules
This section describes the following commands:
•
•
•
uilist
The uilist command shows a list of deployed UI modules. Each UI module is a collection of vFoglight operational elements such as views, dashboards, and other resources.
148 vFoglight
Command-Line Reference Guide
Scope
Syntax
fglcmd connection_options -cmd util:uilist
Options and arguments
None
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd util:uilist system:schemadatasource_typelist system:foglight_transaction system:foglight_services_catalystalarmstate system:ApacheSvrtypes system:core_changes system:core_ipmap system:fsmreporting system:core_mb system:SNMP system:NetMonitor system:WebMonitor system:Windows_System system:corereporting system:fsmcore system:core_core system:oshostresources system:core_log system:administration_userssecurity system:fsmapplicationtriage
…
See also
•
•
Managing Cartridges and Metrics
Running Utility Commands
149
uiexport
The uiexport command exports a UI module into a ZIP file. Use this command to export any modifications to vFoglight operational elements such as views, dashboards, and other resources. Given a valid module name and a file path and name, the uiexport command exports the contents of that module into a ZIP file. If required, you can use the output file to re-import that module into the same or a different vFoglight
server at a later time using the uiimport command (see page 150).
Scope
Syntax
fglcmd connection_options -cmd util:uiexport [-m module_name]
[-f file_path]
Options and arguments f
Option Argument file_path module_name
Description
Specifies the path and name of the ZIP file that the UI module is to be exported to.
Note When specifying the file name, use ZIP as the file extension.
Specifies the name of the UI module.
m
Example
The following example shows you how to export a module to a ZIP file using the
module name as an argument. To get a list of module names, use the uilist
command
(see page 147), as shown in “ Example ” on page 148.
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd util:uiexport -m system:fsmagents
-f c:\temp\sys_fsmagents.zip
Note If successful, this command does not generate any output.
150 vFoglight
Command-Line Reference Guide
See also
•
•
uiimport
The uiimport command imports a UI module from a ZIP file. It uses the ZIP file that
has been previously imported with the uiexport command (see page 149) as the source
of import. A UI module is a collection of vFoglight operational elements such as views, dashboards, and other resources.
Scope
Syntax
fglcmd connection_options -cmd util:uiimport [-f file_path]
Options and arguments f
Option Argument file_path
Description
Specifies the path and name of the ZIP file containing the UI module that is to be imported.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd util:uiimport -f c:\temp\sys_fsmagents.zip
Note If successful, this command does not generate any output.
See also
•
•
Managing Cartridges and Metrics
Running Utility Commands
151
Exporting Metrics and Topology
This section describes the following commands:
•
•
“ topologyexport ” on page 154
metricexport
The metricexport command exports metric observations to a file using a metric query. String and metric observations that exist in vFoglight can be retrieved with this command for automation and analysis. This command writes its output using a CSV or
XML format and takes an observation query as a parameter.
Note Query writing requires an understanding of the monitored topology and object naming conventions and depends on data availability for the specified collection period (see
“ Example ” on page 152). For complete information on topology queries, see the
Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd util:metricexport
-output_format {xml|csv} -metric_query metric_query
-f file_path
Options and arguments f
Option Argument file_path
Description
Specifies the path and name of the file into which the results of the query are to be exported.
Note When specifying the file name, use XML or
CSV as the file extension, depending on the
option.
152 vFoglight
Command-Line Reference Guide
Option metric_query output_format
Argument metric_query
xml or csv
Description
Contains the metric query. Typically, a metric query specifies topology and object names and collection periods as parameters to retrieve metric observations. For full syntax information, see the Administration and
Configuration Guide.
Defines the output format of the file the query is to be exported into: XML or CSV.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd util:metricexport -output_format csv -metric_query
"CPU_User_Utilization from Windows_System_System_Table for 1 hour" -f my_metric_query.csv
Note If successful, this command does not generate any output in the Command Prompt window.
The above command creates a CSV file showing the value of the
CPU_User_Utilization metric for all known Windows_System_System_Table objects that were collected in the past hour. The content of the generated CSV file will be similar to the information in the following table: a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b
21:58.0
26:58.0
300000 1 1 1 1 1 1 0
26:59.0
31:59.0
300000 1 2 2 2 2 4 0
32:00.0
37:00.0
300000 1 2 2 2 2 4 0
Managing Cartridges and Metrics
Running Utility Commands
153 a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b a307df8f-63e9-4b65a6d6-a50524a5544b ac205363-863b-478bb6b7-97e1a444e76a ac205363-863b-478bb6b7-97e1a444e76a ac205363-863b-478bb6b7-97e1a444e76a ac205363-863b-478bb6b7-97e1a444e76a
37:00.0
42:00.0
300000 1 1 1 1 1 1 0
42:01.0
47:01.0
300000 1 2 2 2 2 4 0
47:02.0
52:02.0
300000 1 1 1 1 1 1 0
52:02.0
57:02.0
300000 1 1 1 1 1 1 0
57:03.0
02:03.0
300000 1 1 1 1 1 1 0
02:03.0
07:03.0
300000 1 1 1 1 1 1 0
07:04.0
12:04.0
300000 1 4 4 4 4 16 0
12:05.0
17:05.0
300000 1 1 1 1 1 1 0
17:05.0
22:05.0
300000 1 8 8 8 8 64 0
33:12.0
38:12.0
300000 1 1 1 1 1 1 0
38:12.0
43:12.0
300000 1 1 1 1 1 1 0
43:13.0
48:13.0
300000 1 2 2 2 2 4 0
48:13.0
53:13.0
300000 1 1 1 1 1 1 0
154 vFoglight
Command-Line Reference Guide ac205363-863b-478bb6b7-97e1a444e76a ac205363-863b-478bb6b7-97e1a444e76a ac205363-863b-478bb6b7-97e1a444e76a ac205363-863b-478bb6b7-97e1a444e76a ac205363-863b-478bb6b7-97e1a444e76a ac205363-863b-478bb6b7-97e1a444e76a
53:14.0
58:14.0
300000 1 2 2 2 2 4 0
58:15.0
03:15.0
300000 1 1 1 1 1 1 0
03:15.0
08:15.0
300000 1 1 1 1 1 1 0
08:16.0
13:16.0
300000 1 4 4 4 4 16 0
13:16.0
18:16.0
300000 1 3 3 3 3 9 0
18:17.0
23:17.0
300000 1 6 6 6 6 36 0
topologyexport
The topologyexport command exports the value of one or more properties of a topology object to an XML file. Given a topology query, the property name, and the path and name of the output file, this command generates an XML file containing the value of the specified property. For complete information on how to write a topology query, see the Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd util:topologyexport
-property_names property_names -topology_query topology_query
-f file_path
Managing Cartridges and Metrics
Running Utility Commands
155
Options and arguments f
Option property_names topology_query
Argument Description file_path Specifies the path and name of the file into which the results of the query are to be exported.
Note When specifying the file name, use XML as the file extension.
property_names Contains one or more property names, separated by commas.
topology_query Contains the topology query. Typically, a topology query specifies topology and object names as parameters to retrieve one or more object instances. For full syntax information, see the Administration and Configuration
Guide.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd util:topologyexport -f tor018008_alarm_count.xml topology_query Windows_Host where name=tor018008
-property_names alarmTotalCount
Note If successful, this command does not generate any output in the Command Prompt window.
The above command generates an XML file showing the value of the alarmTotalCount property for a particular Windows host. The content of the generated CSV file is similar to the following listing:
<?xml version=”1.0” encoding=”UTF-8”?>
<top-objects>
<top-obj uniqueId=”c380ae79-2d36-45fc-a07f-136509fec207”>
<property name=”uniqueId” value=”c380ae79-2d36-45fc-a07f-
136509fec207”/>
<property name=”topologyObjectId” value=”175”/>
<property name=”topologyObjectVersionId” value=”280”/>
<property name=”topologyObjectVersion” value=”1”/>
156 vFoglight
Command-Line Reference Guide
<property name=”effectiveStartDate” value=”3/20/09-01-02
17:29:14.82”/>
<property name=”effectiveEndDate” value=”5138-11-16 04:46:40.0”/>
<property name=”lastUpdated” value=”3/20/09-01-02 17:29:14.929”/>
<property name=”name” value=”tor013008.prod.quest.corp”/>
<property name=”longName” value=”tor013008.prod.quest.corp
(Windows_Host)”/>
<property name=”scheduleIds” value=”[]”/>
<property name=”isBlackedOut” value=”false”/>
<property name=”annotations” value=”[]”/>
<property name=”alarms” value=”[]”/>
<property name=”aggregateAlarms” value=”[]”/>
<property name=”localState” value=”0”/>
<property name=”aggregateState” value=”0”/>
<property name=”aggregateAlarmState” value=”DataObject of type
'foglight-5:AlarmStateObservation' for datasource: 'foglight-
5:foglight-5':/observations/c380ae79-2d36-45fc-a07f-136509fec207/ aggregateAlarmState”/>
<property name=”alarmWarningCount” value=”0”/>
<property name=”alarmCriticalCount” value=”0”/>
<property name=”alarmFatalCount” value=”0”/>
<property name=”alarmTotalCount” value=”0”/>
<property name=”alarmAggregateWarningCount” value=”0”/>
<property name=”alarmAggregateCriticalCount” value=”0”/>
<property name=”alarmAggregateFatalCount” value=”0”/>
<property name=”alarmAggregateTotalCount” value=”0”/>
<property name=”changeSummary” value=”[]”/>
<property name=”changeCount” value=”0”/>
<property name=”aggregateChangeCount” value=”0”/>
<property name=”topologyTypeName” value=”Windows_Host”/>
<property name=”monitoredHost” value=”foglight-
5:Windows_Host:c380ae79-2d36-45fc-a07f-136509fec207:1 datasource=foglight-5:foglight-5”/>
<property name=”sourceIds” value=”[]”/>
<property name=”serviceLevelPolicies” value=”[]”/>
<property name=”ipAddresses” value=”[]”/>
<property name=”interfaces” value=”[]”/>
<property name=”running” value=”[]”/>
<property name=”detail” value=”[]”/>
<property name=”agents” value=”[]”/>
</top-obj>
</top-objects>
Managing Cartridges and Metrics
Running Utility Commands
157
Looking Up Server Parameters env
The env command shows the values of server configuration parameters. The parameters are specified in <vfoglight_home>/config/foglight.config
. You can output the values of all configuration parameters, or use an option to specify a single parameter.
Scope
Syntax
fglcmd connection_options -cmd util:env [-n parameter_name]
Options and arguments
Option n
Argument Description parameter_name Specifies the name of the parameter whose value is to be retrieved. If you do not provide a parameter name, the command lists all of the configuration parameters.
Example
Displaying the vFoglight database port number
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd util:env -n foglight.database.port
13306
Assigning Blackouts blackoutobject
The blackoutobject command assigns a blackout schedule to topology objects. A blackout schedule defines the periods of time during which there is no data collection for a specified object instance. The command uses either the schedule name or its ID to
158 vFoglight
Command-Line Reference Guide assign one or more topology objects that are specified either by their IDs or using a topology query. Blacking out a topology object means that no rules analyze that object for the duration of the blackout. This command can make use of topology queries to retrieve one or more object instances which allows you to automate blackouts (for example, cron-driven changes in blackout policies). For complete information on how to write a topology query, see the Administration and Configuration Guide.
Scope
Syntax
fglcmd connection_options -cmd topology:blackoutobject
{-object object_ID|-query query} {-schedule schedule_ID|
-schedulename schedule_name} [-remove]
Options and arguments
Option object query remove schedule
Argument object_ID query
None schedule_ID schedulename schedule_name
Description
Identifies the topology object.
Contains the topology query that specifies a topology object. Typically, a topology query specifies topology types and object names as parameters to retrieve one or more object instances. For full syntax information, see the
Administration and Configuration Guide.
Indicates that the specified schedule should be removed from one or more specified objects.
Identifies the blackout schedule. To find out
the ID for a schedule, use the list command.
For more information, see “ list ” on page 159.
Specifies the schedule name.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
Managing Cartridges and Metrics
Running Utility Commands
159
-cmd topology:blackoutobject -query
Windows_System_System_Table where agent.host.name =
'tor12991.prod.quest.corp' -schedule 1e698670-f5e1-449e-94ba-
942a76795602
Updated the following topology objects:
97eebe55-b04b-4483-a632-7ad0ac96da82:
Windows_System_System_Table 'System_Table' d14b986a-c079-429a-9c0b-54fbc9e1ff99:
Windows_System_System_Table 'System_Table' f7c4f461-bd1a-404f-ba21-a8418d51100c:
Windows_System_System_Table 'System_Table'
Listing Schedules list
The list command generates a list of all vFoglight schedules.
Scope
Syntax
fglcmd connection_options -cmd schedule:list
Options and arguments
None
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd schedule:list
ID: 259833b6-d7b0-4b27-a5c4-e2e612cbf77a
Name: Frequent [Test]
Description: A schedule that runs very frequently. Primarily used for testing.This schedule is used to trigger an activity.
As a result it does not have a significant duration.
------------------------------------
ID: 30afa315-3131-48c2-b0e8-71fea187af4e
Name: Always
Description: A schedule that includes all the time
160 vFoglight
Command-Line Reference Guide
------------------------------------
ID: 013f57d1-1e7e-4098-a7a5-2b2763364cb5
Name: First day of week
Description: Whole days Monday
------------------------------------
ID: 004c98d4-c278-4af2-81f7-4264fd30003f
Name: Daily Database Maintenance
Description: Schedule on which daily operations to rollup and purge information in the database are performed. This schedule is used to trigger an activity. As a result it does not have a significant duration.
------------------------------------
ID: d7619930-807e-406e-9e6e-15ec30edc23c
Name: End of Day
Description: A schedule that runs at the end of the day. This schedule is used to trigger an activity. As a result it does not have a significant duration.
------------------------------------
ID: 46fc602a-8931-4907-a93b-e1c16c0fdbb5
Name: Start of Day
Description: A schedule that runs at the start of the day.
This schedule is used to trigger an activity. As a result it does not have a significant duration.
------------------------------------
ID: eb7e213d-f14d-4d09-ba9d-2a266274d443
Name: Monthly Off Hours
Description: A schedule that runs every month off hours. This schedule is used to trigger an activity. As a result it does not have a significant duration.
------------------------------------
ID: 0749990a-c878-4d1d-8002-fc80b9a31bd6
Name: Beginning of the day
Description: 00:00AM of every day
------------------------------------
ID: deaf446f-bc2b-4ff5-b351-137baef609ff
Name: Quarterly Off Hours
Description: A schedule that runs at the start of every quarter, off hours. This schedule is used to trigger an activity. As a result it does not have a significant duration.
------------------------------------
ID: 3e3e1877-7b55-4c7a-9a40-975bdc96f8e2
Name: First day of month
Description: Whole days the first day of every month
Managing Cartridges and Metrics
Running Utility Commands
------------------------------------
ID: 1e698670-f5e1-449e-94ba-942a76795602
Name: Hourly
Description: A schedule that runs every hour. This schedule is used to trigger an activity. As a result it does not have a significant duration.
------------------------------------
ID: a74dc804-4b42-4589-be5f-0aab6ca568d3
Name: Business hours
Description: 9AM to 5PM Monday to Friday
------------------------------------
ID: d6bc50e7-0748-4356-909e-404aa7f377ef
Name: Daily Off Hours
Description: A schedule that runs every day off hours. This schedule is used to trigger an activity. As a result it does not have a significant duration.
------------------------------------
ID: d601fef9-dd66-4584-af72-e4660138e93e
Name: Beginning of the month
Description: 00:00AM of the first day of every month
------------------------------------
ID: ce5bcb30-c5d8-4388-89aa-8da82b8c666b
Name: Business week
Description: Whole days Monday to Friday
------------------------------------
ID: e6816241-a745-4763-84ab-77766a2b5049
Name: Beginning of the week
Description: 00:00AM of every Monday
------------------------------------
ID: 670bb364-7a3a-44ba-80b7-58419c060496
Name: Weekly Off Hours
Description: A schedule that runs every week off hours. This schedule is used to trigger an activity. As a result it does not have a significant duration.
------------------------------------
ID: 94e5034b-42f1-448d-8b88-291915234109
Name: Weekends
Description: Whole days Saturday and Sunday
------------------------------------
161
162 vFoglight
Command-Line Reference Guide
Running Scripts run
The run command runs a script.
Typically, this command is used to run scripts that are deployed with vFoglight cartridges, and is used in maintenance and support tasks when required.
Scope
Syntax
fglcmd connection_options -cmd script:run -f file_path
Options and arguments f
Option Argument file_path
Description
Specifies the path and name of the script file that is to be executed
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd script:run -f my.script
Note If successful, this command does not generate any output in the Command Prompt window.
Creating a Server Support Bundle bundle
The bundle command generates a server support bundle file in ZIP format.
Scope
Managing Cartridges and Metrics
Running Utility Commands
Syntax
fglcmd connection_options -cmd support:bundle -f file_path
Options and arguments
163 f
Option Argument file_path
Description
Specifies the path and name of the support bundle file that is to be generated.
Note When specifying the file name, use ZIP as the file extension.
Example
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd support:bundle -f support.bundle
Note If successful, this command does not generate any output.
164 vFoglight
Command-Line Reference Guide
Appendix: Command-Line Interface to the vFoglight Client
While the new versions of vFoglight use the vFoglight Agent Manager to communicate with vFoglight agents, previous versions used the vFoglight Client. The vFoglight
Client comes with a set of commands that you can use to access it from the command line:
. Additionally, the fglcmd interface supports both agent technologies. Some of the
commands produce a different command output when you use the vFoglight Client.
This appendix contains information about the
commands, and
fglcmd code samples that are generated with the vFoglight Client.
For information about the vFoglight Agent Manager commands, see “ Managing the vFoglight Agent Manager
” on page 29. For details about fglcmd
“Managing Cartridges and Metrics”.
This appendix contains the following sections:
166 vFoglight
Command-Line Reference Guide
About the Command-Line Interface
vFoglight provides a number of commands that you can use to manage different components in your monitoring environment. Some of these commands come with the vFoglight Client while others are included with the vFoglight Management Server and interact with the vFoglight Client.
This section describes three groups of commands whose output and configuration is different in environments that use the vFoglight Client for agent management. They are as follows:
•
“ vFoglight Client Commands ” on page 166
•
“ Getting Started with Server Commands ” on page 172
•
“ Administrative Commands ” on page 172
Note In this appendix, <vfoglight_client _home> is a placeholder that represents the path to the vFoglight Client installation.
vFoglight Client Commands
This section describes the following tasks:
•
“ Getting Started with vFoglight Client Commands ” on page 166
•
“ Using vFoglight Client Commands ” on page 167
Getting Started with vFoglight Client Commands
The vFoglight Client is an application that manages vFoglight agents that are installed on monitored hosts. vFoglight offers a set of commands that allow you to perform client-related operations through the command-line interface. You can use these commands to perform a variety of tasks, such as start or stop the vFoglight Client, display the version information, manage JVM options, or create a client support bundle.
To get started with vFoglight Client commands:
Note
This procedure continues from “ Getting Started with vFoglight Commands ” on page 32.
Appendix: Command-Line Interface to the vFoglight Client vFoglight Client Commands
167
• Navigate to the directory that contains the vFoglight Client commands:
<vfoglight_client_home> ( spid ) or <vfoglight_client_home>/spid/5.2.4/bin
( support_bundle )
Where foglight_client_home refers to the installation directory of the vFoglight
Client.
To do that, complete one of the following steps.
• If you want to use the command prompt, open a Command Prompt window and navigate to the appropriate directory.
or
• If you want to use a vFoglight Client command in a script, ensure that your script references the appropriate directory.
For more information about vfoglight_client_home, see “ About Syntax
Using vFoglight Client Commands
This section describes the following commands:
•
•
“ support_bundle ” on page 170
spid
The spid command provides command-line interface to the vFoglight Client process. It offers a set of options that you can use to perform any of the following operations as required:
• Start or stop the vFoglight Client
• Install and start the vFoglight Client as a Windows service
• Stop and remove the vFoglight Client Windows service
• Configure Java Virtual Machine (JVM) options and add entries to the vFoglight classpath
• Assign a names to the vFoglight Client process launcher
• Display version information or a list of arguments along with their descriptions
168 vFoglight
Command-Line Reference Guide
Syntax
spid [-s|--start|-Dquest.debug-debug_level] [-q|--stop]
[-w|--wait] [-n|--name process_name] [-i|--install-service]
[-r|--remove-service] [-b|--start-service]
[-j|--jvm-argument JVM_options] [-p|--classpath classpath]
[-v|--version] [-h|--help] [-t|--thread-dump]
Options and arguments q s
Option Argument Description j
-Dquest.debug-debug_level h n p help jvm-argument name classpath
None
Runs the vFoglight Client in debug mode.
You can set debug_level to one of the following values
• 1: No debugging
• 2: Minimal debugging
• 3: Detailed debugging
By default, this option outputs the logs to the standard output. You can redirect the output to a file if required. For example: spid -Dquest.debug=2 > debug2.log
Displays a list of arguments and their descriptions.
JVM_options Specifies one or more Java Virtual Machine
(JVM) options.
process_name Specifies a unique process name for the current instance of the vFoglight Client. vFoglight uses process names to distinguish between different instances of the same process launcher.
classpath Adds entries to the JVM classpath.
None Stops the running vFoglight Client process.
stop start None Starts the vFoglight Client.
Appendix: Command-Line Interface to the vFoglight Client vFoglight Client Commands
169 i t
Option thread-dump v w b version wait start-service install-service
Argument
None
None
None
None
None
Description
Requests a thread output from the running application. This option writes the output to a separate log file in the application's installation directory.
Displays the version number, copyright, build number, and the installation directory.
When sending a shutdown command to an existing vFoglight Client process, this option instructs the command to wait indefinitely for the process to exit before shutting it down.
Starts the vFoglight Client Windows service.
Installs the vFoglight Client as a Windows service.
Stops and removes the vFoglight Client
Windows service.
r removeservice
None
Examples
Displaying version information
C:\Vizioncore\vFoglight_SPID\spid\5.2.4\bin>spid -v vFoglight 5 SPID Agent 5.2.4
Copyright (c) 3/20/09 Vizioncore Inc.
Build Number: 517-3/20/090822-0031
Installation Directory:
C:\Vizioncore\vFoglight_SPID\spid\5.2.4
Starting the vFoglight Client
C:\Vizioncore\vFoglight_SPID\spid\5.2.4\bin>spid -s
3/20/09-10-19 12:43:15.653 INFO vFoglight SPID 5.2.4 (build 524-
3/20/091001-1706) on Windows XP x86 5.1 using Sun Microsystems
Inc. Java HotSpot(TM) Server VM 1.5.0_11
3/20/09-10-19 12:43:16.278 INFO Deployment watchdog initialized; scanning: [C:\Vizioncore\vFoglight_SPID\spid\5.2.4\deploy,
C:\Vizioncore\vFoglight_SPID\spid\5.1.3\deploy,
170 vFoglight
Command-Line Reference Guide
C:\Vizioncore\vFoglight_SPID\spid\5.1.1\deploy,
C:\Vizioncore\vFoglight_SPID\spid\5.1.0\deploy,
C:\Vizioncore\vFoglight_SPID\spid\5.0.5\deploy,
C:\Vizioncore\vFoglight_SPID\spid\5.0.0\deploy]
…
For information on how to deploy and activate a vFoglight agent using the command-
line interface, see “ Deploying Agent Packages
” on page 86 and “ Activating or
Deactivating Agent Instances ” on page 99, respectively.
Stopping the vFoglight Client
C:\Vizioncore\vFoglight_SPID\spid\5.2.4\bin> spid -q
Similarly to the previous example, if there are any active agents running on the vFoglight Client, this command stops the agents’ data collection and closes their
Command Prompt windows (or terminal window).
support_bundle
The support_bundle command generates a client support bundle file. A support bundle is a compressed file that contains diagnostic data, such as vFoglight Client log files as well as agent log files. The command saves the support bundle file in the
<vfoglight_client_home>/spid/5.2.4/support directory and uses the following syntax when naming the file:
support-bundle-date-T-time
For more information about foglight_client_home, see “ About Syntax Conventions ” on page 28.
Syntax support_bundle
Options and arguments
None
Example
C:\Vizioncore\vFoglight_SPID\spid\5.2.4\bin>support_bundle
A subdirectory or file
C:\Vizioncore\vFoglight_SPID\spid\5.2.4\support already exists.
.
Appendix: Command-Line Interface to the vFoglight Client vFoglight Management Server Commands
171
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Collecting log files in
C:\Vizioncore\vFoglight_SPID\spid\5.2.4\support\Tue 10-23-
3/20/09T13-07-36
.97
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
...
. C:\Vizioncore\vFoglight_SPID\spid\5.2.4\support\Tue 10-23-3/20/
09T13-07-36.97\spid\5.2.4\logs\spid_3/20/09-10-22_091403_001.log
3/20/09-10-23 13:07:45.900 com.quest.common.util.supportbundle.Bundle [INFO] Adding
C:\Vizioncore\vFoglight_SPID\spid\5.2.4\support\Tue 10-23-3/20/
09T13-07-36.97\spid\5.2.4\logs\spid_3/20/09-10-23_122931_001.log
3/20/09-10-23 13:07:45.915 com.quest.common.util.supportbundle.CmdLine [INFO] Support bundle successfully created
.
A support bundle has been created in
"C:\Vizioncore\vFoglight_SPID\spid\5.2.4\support"
.
vFoglight Management Server Commands
This section describes the process of configuring the Remote Monitor utility that can communicate with multiple instances of the vFoglight Management Server running in
HA mode. While the syntax and command-line output are the same, regardless of the type of the agent management component (vFoglight Client or vFoglight Agent
Manager), the configuration process is different in that you may need to extract the
Remote Monitor utility to a different directory.
Note For information on how to configure the Remote Monitor utility with the vFoglight Agent
Manager, see “ Getting Started with Server Commands ” on page 36.
172 vFoglight
Command-Line Reference Guide
Getting Started with Server Commands
To get started with vFoglight Management Server commands:
Note
This procedure continues from “ Getting Started with vFoglight Commands ” on page 32.
1 Copy the <vfoglight_home>/tools/remotemonitor.zip file from the computer that has a running instance of the vFoglight Management Server to the remote computer.
2
3
Extract the contents of the remotemonitor.zip file to a directory on the remote computer. For example, if you want to run the Remote Monitor on a vFoglight
Agent Manager computer, extract the remotemonitor.zip file to the
<foglight_client_home>/spid/5.2.4 directory.
Reference the directory that contains the vFoglight Management Server commands, either <vfoglight_home>/bin or <foglight_client_home>/spid/5.2.4, by completing one of the following steps:
• If you want to use the command prompt, open a Command Prompt window and navigate to <vfoglight_home>/bin or <foglight_client_home>/spid/5.2.4 as required.
or
• If you want to use a vFoglight Management Server command in a script, ensure that your script references <vfoglight_home>/bin or
<foglight_client_home>/spid/5.2.4 as applicable.
For more information about vfoglight_home, see “ About Syntax Conventions ” on
page 28. For information about the location of foglight_client_home, see “ About the
Command-Line Interface ” on page 166.
Administrative Commands
This section contains fglcmd command examples and their output that appears when the agent instances in your monitoring environment use the vFoglight Client for communication with the vFoglight Management Server.
It includes examples for the following commands:
•
Appendix: Command-Line Interface to the vFoglight Client
Administrative Commands
173
•
•
•
•
•
For more information about
and the command-line output that is generated in environments that use the vFoglight Agent Manager for managing agent instances, see
Chapter 0, “Managing Cartridges and Metrics”.
clients
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:clients -host .*.corp -regex
Client ID: tor012991.prod.quest.corp#SPI:// tor012991.prod.quest.corp:0/MS
Client Name: MS
Host Name: tor012991.prod.quest.corp
Client ID: tor012991.prod.quest.corp#SPI:// tor012991.prod.quest.corp:0
Client Name: SPI://tor012991.prod.quest.corp:0
Host Name: tor012991.prod.quest.corp
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Agent Manager, see “ clients ” on page 73.
deploy
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight
-cmd agent:deploy -host tor012991.prod.quest.corp -clientid tor012991.prod.quest.corp#SPI://tor012991.prod.quest.corp:0
- packageid OSCartridge-WindowsXP-5.2.4-AgentPackage
Successfully installed package OSCartridge-WindowsXP-5.2.4-
AgentPackage on tor012991.prod.quest.corp#SPI:// tor012991.prod.quest.corp:0#SpiInstaller/admin
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Agent Manager, see “ deploy ” on page 86.
174 vFoglight
Command-Line Reference Guide list
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight
-pwd foglight -cmd agent:list -host tor014004.prod.quest.corp
-active false
Host: tor014004.prod.quest.corp
ID: 10
Name: tor014004.prod.quest.corp/0/NetMonitor/NetMonitor/Agent1
Type: NetMonitor
Adapter ID: SPI
Status: Not active
------------------------------------
Host: tor014004.prod.quest.corp
ID: 16
Name: tor014004.prod.quest.corp/0/ApacheSvr/ApacheSvr/Agent1
Type: ApacheSvr
Adapter ID: SPI
Status: Not active
------------------------------------
Host: tor014004.prod.quest.corp
ID: 17
Name: tor014004.prod.quest.corp/0/SNMP/SNMP/Agent1
Type: SNMP
Adapter ID: SPI
Status: Not active
------------------------------------
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Agent Manager, see “ list ” on page 75.
logs
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight
-pwd foglight -cmd agent:logs -clientid tor014004.prod.quest.corp#SPI://tor014004.prod.quest.corp:0
Client ID: tor014004.prod.quest.corp#SPI:// tor014004.prod.quest.corp:0
Client Name: SPI://tor014004.prod.quest.corp:0
Host Name: tor014004.prod.quest.corp
12 log files found.
Foglight_SPID_5.2.4_InstallLog.log
OSCartridge\5.2.4\logs\ApacheSvr_Agent1_3/20/09-10-
02_165710_001.log
Appendix: Command-Line Interface to the vFoglight Client
Administrative Commands
175
OSCartridge\5.2.4\logs\AppMonitor_Agent1_3/20/09-10-
02_165515_001.log
OSCartridge\5.2.4\logs\LogFilter_Agent1_3/20/09-10-
02_165517_001.log
OSCartridge\5.2.4\logs\NetMonitor_Agent1_3/20/09-10-
02_165512_001.log
OSCartridge\5.2.4\logs\SNMP_Agent1_3/20/09-10-02_165736_001.log
OSCartridge\5.2.4\logs\TerminalServer_Agent1_3/20/09-10-
02_165518_001.log
OSCartridge\5.2.4\logs\WebMonitor_Agent1_3/20/09-10-
02_165524_001.log
OSCartridge\5.2.4\logs\Windows_System_Agent1_3/20/09-10-
02_165513_001.log
spid\5.2.4\logs\spid_3/20/09-10-02_164836_001.log
spid\5.2.4\logs\spid_3/20/09-10-02_165922_001.log
spid\5.2.4\logs\spid_3/20/09-10-05_151601_001.log
spid\5.2.4\logs\spid_3/20/09-10-09_100928_001.log
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Agent Manager, see “ logs ” on page 116.
packages
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight
-pwd foglight -cmd agent:packages -allclients
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight cmd agent:packages -allclients
Client ID: tor012991.prod.quest.corp#SPI:// tor012991.prod.quest.corp:0
Installer ID: tor012991.prod.quest.corp#SPI:// tor012991.prod.quest.corp:0#SpiInstaller/admin
Agent Package ID: OSCartridge-WindowsXP-5.2.4-OSCartridge-
Agent-WindowsXP-windows-/5\.1.*/-ia32,x86_64
Agent Package Cartridge Name: OSCartridge-WindowsXP
Agent Package Cartridge Version: 5.2.4
Agent Package OS: windows
Agent Package OS Version: /5\.1.*/
Agent Package OS Architecture: ia32,x86_64
176 vFoglight
Command-Line Reference Guide
------------------------------------
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Agent Manager, see “ Running Administrative Commands: Example ” on page 65.
types
C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight
-pwd foglight -cmd agent:types -clientname SPI:// tor014004.prod.quest.corp:0
Client ID: tor014004.prod.quest.corp#SPI:// tor014004.prod.quest.corp:0
Client Name: SPI://tor014004.prod.quest.corp:0
Agent Types:
NetMonitor
Windows_System
WebMonitor
AppMonitor
LogFilter
SNMP
ApacheSvr
TerminalServer
------------------------------------
Note For a sample output of this command in a monitoring environment that uses the vFoglight
Agent Manager, see “ types ” on page 82.
Index
A
about vFoglight
activating or deactivating agents
agent:activate
agent:deactivate
adding, removing, or listing licenses
license:list
administrative commands
agent:activate agent:clients
agent:clientupgrade
agent:create
agent:deactivate
agent:deploy
agent:list agent:logs
agent:packages
agent:setschedule
agent:showschedule
agent:start agent:stop
cartridge:disable cartridge:enable cartridge:install
cartridge:list
command-line structure
fglcmd
getting started license:import license:list
license:remove
listing
looking at
schedule:list
script:run
security:assignrole
security:creategroup security:createuser
security:deletegroup security:deleteuser
support:bundle
util:configexport util:configimport
util:env
util:metricexport
util:uiexport util:uiimport
util:uilist
178 vFoglight
Command-Line Reference Guide agent:clients
assigning blackouts
agent:deactivate
agent:delete
agent:getlog
agent:list agent:logs
agent:setschedule
agent:start
agent:types
topology:blackoutobject
C
cartridge:disable cartridge:enable
cartridge:install cartridge:list
command-line interface about
getting started
syntax conventions vFoglight commands
contacting
creating or deleting agents agent:create agent:delete
creating support bundle support:bundle
D
deploying agents agent:deploy
cartridge
core
suite
E
enabling or disabling cartridges cartridge:disable cartridge:enable
exporting metrics and topology
util:metricexport
util:topologyexport
exporting or importing monitoring policies util:configexport
exporting, importing, or listing UI modules
util:uilist
F
fms
G
getting started administrative commands command-line interface
vFoglight Management Server commands 36
I
installing or uninstalling cartridges cartridge:install 128
cartridge:uninstall
K
L
listing agents and clients agent:clients
agent:list
agent:packages
agent:logs
listing blackout schedules agent:showschedule
listing cartridges cartridge:list
listing schedules schedule:list
logging in fglcmd
looking up server parameters util:env
M
managing encryption keys keyman
managing groups
security:assignrole
security:creategroup security:deletegroup
managing users
security:assigngroup security:createuser
security:deleteuser
Index 179
R
runDB
running scripts script:run
running vFoglight Management Server in HA mode fmsha
running vFoglight Management Server in stand-alone
fms
S
schedule:list script:run
security:assigngroup
security:createuser
setting blackout schedules agent:setschedule
spid
starting embedded database
starting or stopping data collection agent:start agent:stop
starting or stopping vFoglight Client
spid
shutdownDB
suite
180 vFoglight
Command-Line Reference Guide
T
topology:blackoutobject
U
foglight_db_upgrade
upgrading vFoglight Agent
upgrading vFoglight Agent Manager
util:configexport
util:env
util:metricexport
util:uiexport
util:uilist
V
vFoglight Client commands about
vFoglight commands
vFoglight Management Server commands about fms
fmsha
foglight_db_upgrade getting started
remotemonitor
runDB
vfoglight_db_upgrade
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
advertisement
Table of contents
- 7 Introduction to this Guide
- 8 About vFoglight
- 8 About this Guide
- 9 vFoglight Documentation Suite
- 9 Core Documentation Set
- 10 Cartridge Documentation Sets
- 10 Feedback on the Documentation
- 11 Text Conventions
- 11 About Vizioncore Inc.
- 14 Contacting Dell
- 27 About the Command-Line Interface
- 28 About Syntax Conventions
- 28 Looking at vFoglight Commands
- 32 Getting Started with vFoglight Commands
- 35 Managing the vFoglight Management Server
- 36 Getting Started with Server Commands
- 37 Running the vFoglight Management Server
- 38 Running the Server in Stand-Alone Mode
- 41 Running the vFoglight Management Server in High Availability Mode
- 47 Starting, Stopping, or Upgrading the Database
- 47 Starting the Embedded Database
- 47 Stopping the Embedded Database
- 48 Upgrading the Database
- 49 Managing Passwords
- 49 Managing Encryption Keys
- 53 Managing Cartridges and Metrics
- 54 Using the Command Line for Administration Tasks
- 54 Understanding the Command-Line Structure
- 56 About Regular Expressions
- 64 Getting Started with Administrative Commands
- 65 Running Administrative Commands: Example
- 66 Looking at Scope-Specific Commands
- 70 Logging In and Setting the Scope
- 72 Managing Agents
- 73 Listing Agent and Agent Manager Instances
- 84 Upgrading the vFoglight Agent Manager
- 86 Deploying Agent Packages
- 91 Creating or Deleting Agent Instances
- 99 Activating or Deactivating Agent Instances
- 108 Starting or Stopping Data Collection
- 116 Listing and Retrieving Log Files
- 120 Listing and Setting Blackout Schedules
- 128 Managing Cartridges
- 128 Installing or Uninstalling Cartridges
- 130 Enabling or Disabling Cartridges
- 133 Listing Cartridges
- 135 Managing Security Entities
- 135 Managing Users
- 139 Managing Groups
- 142 Managing vFoglight Licenses
- 142 Adding, Removing, or Listing Licenses
- 145 Running Utility Commands
- 145 Exporting or Importing a Monitoring Policy
- 147 Exporting, Importing, or Listing UI Modules
- 151 Exporting Metrics and Topology
- 157 Looking Up Server Parameters
- 157 Assigning Blackouts
- 159 Listing Schedules
- 162 Running Scripts
- 162 Creating a Server Support Bundle
- 165 Appendix: Command-Line Interface to the vFoglight Client
- 166 About the Command-Line Interface
- 166 vFoglight Client Commands
- 166 Getting Started with vFoglight Client Commands
- 167 Using vFoglight Client Commands
- 171 vFoglight Management Server Commands
- 172 Getting Started with Server Commands
- 172 Administrative Commands
- 177 Index