vFoglight™ 5.2.
© 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.
Table of Contents Introduction to this Guide ...................................................................................................................................7 About vFoglight ................................................................................................................................................................ 8 About this Guide...........................................................................................................................................
vFoglight Command-Line Reference Guide Stopping the Embedded Database ........................................................................................................................ 47 shutdownDB.................................................................................................................................................. 47 Upgrading the Database ....................................................................................................................................
Table of Contents 5 start..............................................................................................................................................................108 stop..............................................................................................................................................................112 Listing and Retrieving Log Files ...........................................................................................................................
vFoglight Command-Line Reference Guide Exporting, Importing, or Listing UI Modules ......................................................................................................... 147 uilist ............................................................................................................................................................. 147 uiexport ..........................................................................................................................................
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: About vFoglight..............................................................................................................................8 About this Guide..........................................................................................
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.
Introduction to this Guide vFoglight Documentation Suite 9 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 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 •
Introduction to this Guide Text Conventions 11 documentation? All comments are welcome. Please submit your feedback to the following email address: info@vizioncore.com 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 Monospace text represents code, code objects, and commandline input.
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.
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 Visit http://support.dell.com.
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 Support.euro.dell.com Web Address Tech_support_central_europe@dell.
Chile (Santiago) Country Code: 56 City Code: 2 China (Xiamen) Web Address E-Mail Address Sales and Customer Support Technical Support Web Address Technical Support E-Mail Address Country Code: 86 Customer Service E-Mail Address City Code: 592 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 Ser
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) 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 Servic
Guatemala Guyana Hong Kong International Access Code: 001 Country Code: 852 India Web Address E-Mail Address Technical Support, Customer Service, Sales E-Mail Address Technical Support, Customer Service, Sales 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 .
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.
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 Techni
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 Support.ap.dell.
Poland (Warsaw) International Access Code: 011 Country Code: 48 City Code: 22 Portugal International Access Code: 00 Country Code: 351 Puerto Rico St. Kitts and Nevis St. Lucia St.
Spain (Madrid) International Access Code: 00 Country Code: 34 City Code: 91 Sweden (Upplands Vasby) International Access Code: 00 Country Code: 46 City Code: 8 Switzerland (Geneva) International Access Code: 00 Country Code: 41 City Code: 22 Web Address Home and Small Business Technical Support Customer Service Sales Switchboard Fax Corporate Technical Support Customer Service Switchboard Fax Web Address Technical Support Relational Customer Service Home/Small Business Customer Service Employee Purchas
U.K.(Bracknell) International Access Code: 00 Country Code: 44 City Code: 1344 Uruguay U.S.A.
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‐techsupport@dell.com toll‐free: 1‐877‐702‐4360 www.dell.com/ve la‐techsupport@dell.
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.
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: • is a placeholder that represents the path to the vFoglight Management Server installation.
Description Command Domain Database Authentication vFoglight Management Server Server Component About the Command-Line Interface Looking at vFoglight Commands fms Provides command-line interface to the vFoglight Management Server process fmsha Provides command-line interface to the vFoglight Management Server process running in High Availability (HA) mode foglight_db_upgrade Verifies the database version and upgrades it to a higher version if necessary runDB Starts the embedded database shutd
Description Command Domain Agents Component vFoglight Command-Line Reference Guide Administrative Interface 30 activate Activates one or more vFoglight agent instances clients Shows a list of vFoglight client instances clientupgrade Upgrades one or more remote instances of the vFoglight Agent Manager create Creates one or more vFoglight agent instances deactivate Deactivates one or more vFoglight agents delete Deletes one or more vFoglight agent instances deploy Deploys one or more vFogl
Description 31 Command Domain Security Licenses Administrative Interface (continued) Cartridges Component About the Command-Line Interface Looking at vFoglight Commands disable Deactivates a vFoglight cartridge enable Activates an installed vFoglight cartridge install Installs a cartridge on the vFoglight Management Server list Lists all installed vFoglight cartridges uninstall Uninstalls a vFoglight cartridge assigngroup Adds or removes a user from a group assignrole Adds or removes a
Command Description blackoutobject Assigns a blackout schedule bundle Generates a support bundle file configexport Exports the monitoring policy to an XML file configimport Imports the monitoring policy env Outputs the values of server configuration parameters metricexport Exports metric observations to a file using a metric query list Shows a list of all vFoglight schedules run Runs a script topologyexport Exports the value of one or more properties of a topology object to an XML file u
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 Obtain your vFoglight user name and password from the vFoglight Administrator. 3 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.
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: Getting Started with Server Commands ......................................................................................
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.
Managing the vFoglight Management Server Running the vFoglight Management Server 37 1 Copy the /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.
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.
Managing the vFoglight Management Server Running the vFoglight Management Server Options Argument -Dquest.debug-debug_level 39 Description 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.
vFoglight Command-Line Reference Guide Options Argument Description w wait None 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. b start-service None Starts the vFoglight Management Server Windows service. i install-service None Installs the vFoglight Management Server as a Windows service.
Managing the vFoglight Management Server Running the vFoglight Management Server 41 Stopping 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.
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.
Managing the vFoglight Management Server Running the vFoglight Management Server 43 Options Argument Description v version None Displays the version number, copyright, build number, and the installation directory. w wait None 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. b start-service None Starts the vFoglight Management Server Windows service.
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 • “fms” on page 38 • “remotemonitor” on page 44 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.
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 Options Argument Description h help None Displays a list of arguments and their descriptions. j jvm-argument JVM_options Specifies one or more Java Virtual Machine (JVM) options.
vFoglight Command-Line Reference Guide Options Argument Description w wait None 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. b start-service None Starts the vFoglight Management Server Windows service. i install-service None Installs the vFoglight Management Server as a Windows service.
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.
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.
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.
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 /config/mstkey.properties file.
Managing the vFoglight Management Server Managing Passwords Options Option Description addappkey Adds an application key chmstkey Changes the master key delappkey Deletes an application key encpwd Encrypts a password string using an encryption key getapptkn 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 Specifies the key value new_key Specifies the new key va
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.
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
Managing Cartridges and Metrics Using the Command Line for Administration Tasks Note Scope Description agent Manages agents and clients cartridge Manages cartridges license Manages licenses schedule Lists schedules script Runs scripts support Creates support bundles topology Assigns blackout schedules util Contains utility commands 55 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 cartri
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.
Managing Cartridges and Metrics Using the Command Line for Administration Tasks 57 Syntax Description abc 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.
vFoglight Command-Line Reference Guide Syntax Description \uhhhh A string containing a hexadecimal value of 0xhhhh where h is a hexadecimal digit. \t The TAB character ('\u0009'). \n The line feed character ('\u000A'). \r The carriage return character ('\u000D'). \f The form feed character ('\u000C'). \a The alert (bell) character ('\u0007'). \e The ESC character ('\u001B'). \cx The CTRL character followed by a literal. […] An OR expression. Brackets can be nested.
Managing Cartridges and Metrics Using the Command Line for Administration Tasks 59 Syntax Description \s A white space character such as a tab, line feed, blank space, or carriage return. \S Any character other than tab, line feed, blank space, or carriage return. \w Any lowercase or uppercase alphabetic, or a numeric character. \W Any character other than lowercase or uppercase alphabetic, or a numeric character.
vFoglight Command-Line Reference Guide Syntax Description {n}, {n}?, or {n}+ 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}+ {n,}, {n,}?, or {n,}+ When following a character, the construct implies that the preceding character can appear at least n times.
Managing Cartridges and Metrics Using the Command Line for Administration Tasks Syntax 61 Description Groups () 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.
vFoglight Command-Line Reference Guide Syntax Description (?=X) 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. (?!X) Checks if the preceding character is preceded by X in a text string, without making X a part of the search result.
Managing Cartridges and Metrics Using the Command Line for Administration Tasks 63 Syntax Description \B A non-word boundary. Used as a delimiter, \B is the negated version of \b. 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. \A The beginning of the input. It has the same functionality as ^, with the exception that it ignores any new line characters. \G The end of the previous match. \Z The end of the input string.
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.
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 packag
vFoglight Command-Line Reference Guide Agent Package ID: OSCartridge-WindowsXP-5.2.4-OSCartridgeAgent-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.
Managing Cartridges and Metrics Using the Command Line for Administration Tasks Scope 67 Command Name Description Name Description agent Manages agents and clients activate Activates one or more vFoglight agent instances clients Shows a list of vFoglight client instances clientupgrade Upgrades one or more remote instances of the vFoglight Agent Manager create Creates one or more vFoglight agent instances deactivate Deactivates one or more vFoglight agents delete Deletes one or more vFog
vFoglight Command-Line Reference Guide Scope Command Name Description Name Description cartridge Manages cartridges disable Deactivates a vFoglight cartridge enable Activates an installed vFoglight cartridge install Installs a cartridge on the vFoglight Management Server list Lists all installed vFoglight cartridges uninstall Uninstalls a vFoglight cartridge import Installs a vFoglight license list Shows a list of installed vFoglight licenses remove Removes a vFoglight license us
Managing Cartridges and Metrics Using the Command Line for Administration Tasks Scope 69 Command Name Description Name Description topology Assigns blackout schedules blackoutobject Assigns a blackout schedule util Contains utility commands configexport Exports the monitoring policy to an XML file configimport Imports the monitoring policy env Outputs the values of server configuration parameters metricexport Exports metric observations to a file using a metric query topologyexport Ex
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.
Managing Cartridges and Metrics Logging In and Setting the Scope Options and arguments Option Argument Description cmd scope agent Manages agents and clients. cartridge Manages cartridges. commands Lists administrative commands. license Manages licenses. schedule Lists schedules. script Runs scripts. security Manages security entities. support Creates support bundles. topology Assigns blackout schedules. util Contains utility commands. debug None Turns the debugging on.
vFoglight Command-Line Reference Guide Option Argument Description ssl None 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. usr user_name 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.
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” on page 73 • “list” on page 75 • “packages” on page 78 • “types” on page 82 clients The clients command shows a list of vFoglight Agent Manager i
vFoglight Command-Line Reference Guide Option Argument Description clientbuild build_ID An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID. clientid client_ID An explicit text string or a regular expression that identifies one or more instances of the vFoglight Agent Manager.
Managing Cartridges and Metrics Managing Agents 75 OS: windows 5.1 (ia32) For complete information about the regular expression syntax, see “About Regular Expressions” on page 56. 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” on page 75 • “packages” on page 78 • “types” on page 82 list The list command shows a list of vFoglight agent instances.
vFoglight Command-Line Reference Guide Option Argument Description adapter adapter_ID An explicit text string or a regular expression that identifies one or more vFoglight adapters. agentid agent_ID Identifies an instance of a vFoglight agent that is to be listed. all None Indicates that all agent instances should be listed. datacollection true or false Indicates whether to list vFoglight agent instances for which the data collection is (true) or is not enabled (false).
Managing Cartridges and Metrics Managing Agents 77 Option Argument Description type agent_type 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.
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.
Managing Cartridges and Metrics Managing Agents 79 [-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 Option Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager should be selected.
vFoglight Command-Line Reference Guide Option Argument Description clientversion client_version An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version. disable_platform_check None Disables automatic filtering of agent packages, based on platform information provided by agent installers. host host_name An explicit text string or a regular expression that specifies one or more host names.
Managing Cartridges and Metrics Managing Agents 81 Option Argument Description packageos pkg_OS_name 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. packageosversion pkg_OS_version 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.
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-OSCartridgeAgent-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.
Managing Cartridges and Metrics Managing Agents 83 Options and arguments Option Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager should be selected. clientbuild build_ID An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID. clientid client_ID An explicit text string or a regular expression that identifies one or more instances of the vFoglight Agent Manager.
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.
Managing Cartridges and Metrics Managing Agents 85 Options and arguments Option Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager should be selected. clientbuild build_ID An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
vFoglight Command-Line Reference Guide Option Argument Description timeout seconds 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. tobuild build_ID Specifies the build number to which the selected instances of the vFoglight Agent Manager should be upgraded. toversion version Specifies the version to which the selected instances of the vFoglight Agent Manager should be upgraded.
Managing Cartridges and Metrics Managing Agents 87 page 128; to find out how to list available agent packages using fglcmd, see “packages” on page 78.
vFoglight Command-Line Reference Guide Option Argument Description clientbuild build_ID An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID. clientid client_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.
Managing Cartridges and Metrics Managing Agents 89 Option Argument Description installerid agent_installer_ID Selects the agent installer with the specified ID. installername name An explicit text string or a regular expression that selects one or more agent installers based on the specified name.
vFoglight Command-Line Reference Guide Option Argument Description packageosversion pkg_OS_version 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. packageversion version An explicit text string or a regular expression that specifies one or more versions of the agent packages that are to be deployed.
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.
vFoglight Command-Line Reference Guide Scope agent 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 Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager should be selected.
Managing Cartridges and Metrics Managing Agents 93 Option Argument Description name name An explicit text string or a regular expression that specifies one or more agent names. regex None 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.
vFoglight Command-Line Reference Guide Option Argument Description type agent_type 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.
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.
vFoglight Command-Line Reference Guide Scope agent 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 Argument Description activatable true or false Indicates whether to delete agent instances that can (tru
Managing Cartridges and Metrics Managing Agents 97 Option Argument Description host host_name An explicit text string or a regular expression that specifies one or more host names. name agent_name An explicit text string or a regular expression that specifies the name of one or more vFoglight agents that are to be deleted. namespace 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.
vFoglight Command-Line Reference Guide Option Argument Description type agent_type 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.
Managing Cartridges and Metrics Managing Agents 99 -cmd agent:delete -name Agent4 Note If successful, this command does not generate any output.
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 Option Argument Description activatable true or false Indicates whether to activate agent instances that can (true) or cannot be activated (false). active true or false Indicates whether to activate agent instances that are active (true) or inactive (false).
Managing Cartridges and Metrics Managing Agents 101 Option Argument Description namespace 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. nowait None Indicates that the command should not wait for the selected agents to finish processing before activating the selected vFoglight agent instances.
vFoglight Command-Line Reference Guide Option Argument Description type agent_type 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.
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.
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.
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 “activate” on page 99.
vFoglight Command-Line Reference Guide Option Argument Description datacollection true or false Indicates whether to deactivate vFoglight agent instances that are (true) or are not collecting data (false). deletable true or false Indicates whether to deactivate vFoglight agent instances that can (true) or cannot be deleted (false). force None In cases where multiple agents are selected, it indicates that all selected agents should be deactivated.
Managing Cartridges and Metrics Managing Agents 107 Option Argument Description type agent_type 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.
vFoglight Command-Line Reference Guide -cmd agent:deactivate -agentid 14 Note If successful, this command does not generate any output. See also • “deploy” on page 86 • “create” on page 91 • “delete” on page 95 • “activate” on page 99 • “start” on page 108 • “stop” on page 112 Starting or Stopping Data Collection This section describes the following commands: • “start” on page 108 • “stop” on page 112 start The start command initiates data collection for one or more vFoglight agent instances.
Managing Cartridges and Metrics Managing Agents 109 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 Option Argument Description activatable true or false Indicates whether to start agent instances that can (true) o
vFoglight Command-Line Reference Guide Option Argument Description name agent_name An explicit text string or a regular expression that specifies the name of one or more agent instances that are to be started. namespace 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.
Managing Cartridges and Metrics Managing Agents 111 Option Argument Description type agent_type 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.
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 • “deploy” on page 86 • “create” on page 91 • “delete” on page 95 • “activate” on page 99 • “deactivate” on page 104 • “stop” on page 112 stop The stop command terminates the data collection for one or more vFoglight agent instances.
Managing Cartridges and Metrics Managing Agents 113 [-activatable {true|false}] [-active {true|false}] [-regex] [-force] [-nowait] Options and arguments Option Argument Description activatable true or false Indicates whether to stop agent instances that can (true) or cannot be activated (false). active true or false Indicates whether to stop agent instances that are active (true) or inactive (false).
vFoglight Command-Line Reference Guide Option Argument Description namespace 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. nowait None Indicates that the command should not wait for the selected agents to finish processing before stopping the selected vFoglight agent instances.
Managing Cartridges and Metrics Managing Agents 115 Option Argument Description type agent_type 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.
vFoglight Command-Line Reference Guide -cmd agent:stop -agentid 15 Note If successful, this command does not generate any output. See also • “deploy” on page 86 • “create” on page 91 • “delete” on page 95 • “activate” on page 99 • “deactivate” on page 104 • “start” on page 108 Listing and Retrieving Log Files This section describes the following commands: • “logs” on page 116 • “getlog” on page 118 logs The logs command shows a list of agent log files.
Managing Cartridges and Metrics Managing Agents 117 Options and arguments Option Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager should be selected. clientbuild build_ID An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID. clientid client_ID An explicit text string or a regular expression that identifies one or more instances of the vFoglight Agent Manager.
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-bdad2a8916ef3a89 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.
Managing Cartridges and Metrics Managing Agents 119 Options and arguments Option Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager should be selected. clientbuild build_ID An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified build ID.
vFoglight Command-Line Reference Guide Option Argument Description upgradable 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: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.
Managing Cartridges and Metrics Managing Agents 121 [-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 Option Argument Description activatable true or false Indicates whether to select agent instances that can (true) or cannot be deactivated (false).
vFoglight Command-Line Reference Guide Option Argument Description regex None 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 Argument Description type agent_type 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.
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.
Managing Cartridges and Metrics Managing Agents 125 Options and arguments Option Argument Description activatable true or false Indicates whether to select agent instances that can (true) or cannot be deactivated (false). active true or false Indicates whether to select agent instances that are active (true) or inactive (false). adapter adapter_ID An explicit text string or a regular expression that identifies one or more vFoglight adapters.
vFoglight Command-Line Reference Guide Option Argument Description none None Dissociates all schedules from one more selected agent instances. regex None 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. scheduleid schedule_ID Identifies a schedule that is to be assigned to one or more vFoglight agent instances.
Managing Cartridges and Metrics Managing Agents 127 Option Argument Description type agent_type 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.
vFoglight Command-Line Reference Guide -cmd agent:setschedule -agentid 10 -schedulename "Start of Day" Note If successful, this command does not generate any output.
Managing Cartridges and Metrics Managing Cartridges 129 Options and arguments Option Argument Description passive None Indicates that the cartridge should be installed, but not activated. f file_path 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.
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 cartridge Syntax fglcmd connection_options -cmd cartridge:uninstall [-n name] [-v version] Options and arguments Option Argument Description n name Specifies the name of the cartridge that is to be uninstalled. v version Specifies the version of the cartridge that is to be uninstalled.
Managing Cartridges and Metrics Managing Cartridges 131 • “disable” on page 131 • “enable” on page 132 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.
vFoglight Command-Line Reference Guide • “uninstall” on page 129 • “enable” on page 132 • “list” on page 133 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.
Managing Cartridges and Metrics Managing Cartridges 133 See also • “install” on page 128 • “uninstall” on page 129 • “disable” on page 131 • “list” on page 133 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 “install” on page 128.
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.
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.
vFoglight Command-Line Reference Guide Options and arguments Option Argument Description groupname groupname Specifies the name of the group to which the user account is to be added or removed remove None Indicates that the user should be removed from the group username 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 -userna
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 Security role. For information about fglcmd connection options, see “Logging In and Setting the Scope” on page 70.
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 Security role. For information about fglcmd connection options, see “Logging In and Setting the Scope” on page 70. For complete information about users, roles, and groups in vFoglight, see the Administration and Configuration Guide.
Managing Cartridges and Metrics Managing Security Entities 139 Managing Groups This section describes the following commands: • “assignrole” on page 139 • “creategroup” on page 140 • “deletegroup” on page 141 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 Security role.
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.
Managing Cartridges and Metrics Managing Security Entities 141 Options and arguments Option Argument Description groupname 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 • “assignrole” on page 139 • “deletegroup” on page 141 deletegroup The deletegroup command removes a vFoglight group.
vFoglight Command-Line Reference Guide Options and arguments Option Argument Description groupname 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.
Managing Cartridges and Metrics Managing vFoglight Licenses 143 Scope license Syntax fglcmd connection_options -cmd license:import <-f file_path> Options and arguments Option Argument Description f file_path 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.
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
Managing Cartridges and Metrics Running Utility Commands 145 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.
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.
Managing Cartridges and Metrics Running Utility Commands 147 Scope util Syntax fglcmd connection_options -cmd util:configimport [-f file_path] Options and arguments Option Argument Description f file_path 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.
vFoglight Command-Line Reference Guide Scope util 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
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.
vFoglight Command-Line Reference Guide See also • “uiimport” on page 150 • “uilist” on page 147 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.
Managing Cartridges and Metrics Running Utility Commands 151 Exporting Metrics and Topology This section describes the following commands: • “metricexport” on page 151 • “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.
vFoglight Command-Line Reference Guide Option Argument Description metric_query metric_query 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. output_format xml or csv Defines the output format of the file the query is to be exported into: XML or CSV.
startTime endTime samplePeriod count min max avg sum sumSquares stdDev 153 uniqueId Managing Cartridges and Metrics Running Utility Commands a307df8f-63e9-4b65a6d6-a50524a5544b 37:00.0 42:00.0 300000 1 1 1 1 1 1 0 a307df8f-63e9-4b65a6d6-a50524a5544b 42:01.0 47:01.0 300000 1 2 2 2 2 4 0 a307df8f-63e9-4b65a6d6-a50524a5544b 47:02.0 52:02.0 300000 1 1 1 1 1 1 0 a307df8f-63e9-4b65a6d6-a50524a5544b 52:02.0 57:02.
startTime endTime samplePeriod count min max avg sum sumSquares stdDev vFoglight Command-Line Reference Guide uniqueId 154 ac205363-863b-478bb6b7-97e1a444e76a 53:14.0 58:14.0 300000 1 2 2 2 2 4 0 ac205363-863b-478bb6b7-97e1a444e76a 58:15.0 03:15.0 300000 1 1 1 1 1 1 0 ac205363-863b-478bb6b7-97e1a444e76a 03:15.0 08:15.0 300000 1 1 1 1 1 1 0 ac205363-863b-478bb6b7-97e1a444e76a 08:16.0 13:16.
Managing Cartridges and Metrics Running Utility Commands 155 Options and arguments Option Argument Description f 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 property_names Contains one or more property names, separated by commas. topology_query topology_query Contains the topology query.
vFoglight Command-Line Reference Guide
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 /config/foglight.config. You can output the values of all configuration parameters, or use an option to specify a single parameter.
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).
Managing Cartridges and Metrics Running Utility Commands 159 -cmd topology:blackoutobject -query Windows_System_System_Table where agent.host.name = 'tor12991.prod.quest.
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.
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.
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.
Managing Cartridges and Metrics Running Utility Commands 163 Syntax fglcmd connection_options -cmd support:bundle -f file_path Options and arguments Option Argument Description f file_path 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.
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: spid and support_bundle. Additionally, the fglcmd interface supports both agent technologies. Some of the fglcmd commands produce a different command output when you use the vFoglight Client.
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.
Appendix: Command-Line Interface to the vFoglight Client vFoglight Client Commands 167 • Navigate to the directory that contains the vFoglight Client commands: (spid) or /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.
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 Option Argument -Dquest.debug-debug_level Description Runs the vFoglight Client in debug mode.
Appendix: Command-Line Interface to the vFoglight Client vFoglight Client Commands Option Argument Description 169 t thread-dump 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. v version None Displays the version number, copyright, build number, and the installation directory.
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 commandline interface, see “Deploying Agent Packages” on page 86 and “Activating or Deactivating Agent Instances” on page 99, respectively.
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-233/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.
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 /tools/remotemonitor.zip file from the computer that has a running instance of the vFoglight Management Server to the remote computer. 2 Extract the contents of the remotemonitor.zip file to a directory on the remote computer.
Appendix: Command-Line Interface to the vFoglight Client Administrative Commands 173 • “deploy” on page 173 • “list” on page 174 • “logs” on page 174 • “packages” on page 175 • “types” on page 176 For more information about fglcmd 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 .*.
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.
Appendix: Command-Line Interface to the vFoglight Client Administrative Commands 175 OSCartridge\5.2.4\logs\AppMonitor_Agent1_3/20/09-1002_165515_001.log OSCartridge\5.2.4\logs\LogFilter_Agent1_3/20/09-1002_165517_001.log OSCartridge\5.2.4\logs\NetMonitor_Agent1_3/20/09-1002_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-1002_165518_001.log OSCartridge\5.2.4\logs\WebMonitor_Agent1_3/20/09-1002_165524_001.
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.
Index A about vFoglight 8 activating or deactivating agents 99 agent:activate 99 agent:deactivate 104 adding, removing, or listing licenses 142 license:import 142 license:list 143 license:remove 144 administrative commands about 53 agent:activate 99 agent:clients 73 agent:clientupgrade 84 agent:create 91 agent:deactivate 104 agent:delete 95 agent:deploy 86 agent:getlog 118 agent:list 75 agent:logs 116 agent:packages 78 agent:setschedule 124 agent:showschedule 120 agent:start 108 agent:stop 112 agent:types 8
vFoglight Command-Line Reference Guide agent:clients 73 agent:clientupgrade 84 agent:create 91 agent:deactivate 104 agent:delete 95 agent:deploy 86 agent:getlog 118 agent:list 75 agent:logs 116 agent:packages 78 agent:setschedule 124 agent:showschedule 120 agent:start 108 agent:stop 112 agent:types 82 assigning blackouts 157 topology:blackoutobject 157 C cartridge:disable 131 cartridge:enable 132 cartridge:install 128 cartridge:list 133 cartridge:uninstall 129 command-line interface about 27 getting
Index 179 K R keyman 49 remotemonitor 44 runDB 47 running scripts 162 script:run 162 running vFoglight Management Server in HA mode 41 fmsha 41 remotemonitor 44 running vFoglight Management Server in stand-alone mode 38 fms 38 L license:import 142 license:list 143 license:remove 144 listing agents 73 listing agents and clients agent:clients 73 agent:list 75 agent:packages 78 agent:types 82 listing and retrieving logs 116 agent:getlog 118 agent:logs 116 listing blackout schedules agent:showschedule 120
vFoglight Command-Line Reference Guide T text conventions 11 topology:blackoutobject 157 U upgrading the database 48 foglight_db_upgrade 48 upgrading vFoglight Agent 84 upgrading vFoglight Agent Manager agent:clientupgrade 84 util:configexport 145 util:configimport 146 util:env 157 util:metricexport 151 util:topologyexport 154 util:uiexport 149 util:uiimport 150 util:uilist 147 V vFoglight Client commands about 165 spid 167 vFoglight commands 28 vFoglight Management Server commands about 35 fms 38 f
