Home

Dell Vizioncore Command Line Reference Guide

1. 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 util Syntax fglemd connection_options cmd util topologyexport property_names property names topology_query topology_query f file path Managing Cartridges and Metrics 155 Running Utility Commands 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 opology_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 gt fglemd usr foglight pwd foglight cmd util topologyexport f tor018008_alarm_count xml topology_query Windows_Host where name tor018008 property_names alarmTotalCount Note If succ
2. Grenadines E mail Address la techsupport dell com Technical Support Customer Service Sales toll free 1 866 464 4353 Singapore NOTE The phone numbers in this section should International Access Code 005 Country Code 65 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 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 Slovakia Prague International Access Code 00 Country Code 421 Web Address E mail Address Technical Support Customer Service Fax Tech Fax Switchboard Sales support euro dell com czech _dell dell com 02 5441 5727 420 22537 2707 02 5441 8328 02 5441 8328 02 5441 8328 02 5441 7585 South Africa Web Address support euro dell com J ohannesburg E mail Address dell_za_suppor dell com International Access Cd Queue 011 709 7713 Code 09 091 Technical Support 011 709 7710 Country Code 27 Customer Service 011 709 7707 Sales 011 709 7700 City Code 11 Spain Madrid Web Address Support euro com Home and Small Business International Access Technical i
3. 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 deactivate agent instances that can true or cannot be deactivated false active true or false Indicates whether to deactivate 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 agentid agent_ID Identifies an instance of a vFoglight agent that is to be deactivated all None Indicates that all agent instances should be deactivated 106 vF oglight 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
4. 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 An explicit text string or a regular expression that specifies one or more vFoglight agents whose blackout schedule is to be set 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 vF oglight 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 schedulename schedule_name Specifies a schedule name You can use any of the following values e Daily Off Values e End of Day Hourly Monthly Off Hours e Start of Day e Quarterly Off Hours e 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 127
5. Managing Agents 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 For example e OSCartridge ApacheS vr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e 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 oSCart ridge prefix for example AppMonitor instead of OSCartridge AppMonitor result in an error Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight 128 vF oglight Command Line Reference Guide
6. 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 has the same meaning as abc Ends the quoting started by Q Managing Cartridges and Metrics 61 Using the Command Line for Administration Tasks Syntax Description Groups Parentheses are used to create capturing groups A capturing group in a text pattern is used to match sub strings 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 e X Y 2 group 1 e X Y group 2 e Y group 3 e Z group 4 n 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 1 X 1 has only one capturing group whose number is one 1 It returns the following matches a
7. 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 Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager should be selected allinstallers None Indicates that all agent installers should be selected allpackages None Indicates that all agent packages should be deployed arch architecture An explicit text string or a regular expression that specifies one or more platform architectures 88 vF oglight 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
8. on page 128 to find out how to deactivate an active cartridge using fglcmd see enable on page 132 Scope cartridge Syntax fglcmd connection_options cmd cartridge enable n name v version Options and arguments Option Argument Description n name Specifies the name of the cartridge that is to be enabled v version Specifies the version of the cartridge that is to be enabled Example C Vizioncore vFoglight bin gt fglemd 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 133 Managing Cartridges See also e install on page 128 e uninstall on page 129 e disable on page 131 e list on page 133 Listing Cartridges list The 1ist command generates a list of all installed vFoglight cartridges For information on how to install a vFoglight cartridge using the fglcma interface see install on page 128 Scope cartridge Syntax fglemd connection_options cmd cartridge list Options and arguments None Example C Vizioncore vFoglight bin gt fglemd 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 vF oglight Command Line Reference Guide N
9. cartridge list 133 cartridge uninstall 129 command line structure 54 example 65 fglcmd 70 getting started 64 license import 142 license list 143 license remove 144 listing 69 looking at 66 schedule list 159 script run 162 security assigngroup 135 security assignrole 139 security creategroup 140 security createuser 137 security deletegroup 141 security deleteuser 138 support bundle 162 topology blackoutobject 157 util configexport 145 util configimport 146 utiltenv 157 util metricexport 151 util topologyexport 154 util uiexport 149 util uiimport 150 util uilist 147 agent activate 99 178 vF oglight 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 agentilist 75 agentilogs 116 agent packages 78 agent setschedule 124 agent showschedule 120 agent start 108 agentistop 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 started 32 syntax conventions 28 166 vFoglight commands 28 contacting Vizioncore 12 creating or deleting agents 91 agent create 91 agent delete 95 creating support bundle support bundle 162 D deploying agents 86 agent deploy 86 documentation 9 cartridge 10 core 9 feedback 10 suite 9 enabling or disabling ca
10. e 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 fg1cmd commands support regular expressions This is useful in situations when you want to issue a single command against multiple objects The backslash character V 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 Syntax abc 0n Onn Omnn xhh Managing Cartridges and Metrics 57 Using the Command Line for Administration Tasks Description The literal string contained within the construct In fglcma 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 e Switch or option When it follows a command and is followed by an appropriate character or text string it can provide additional input to
11. 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 lt vfoglight_home gt 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 lt vfoglight_home gt config foglight config as required For example 1 2 Open a Command Prompt window In the Command Prompt navigate to the lt vfoglight_home gt bin directory Issue the keyman command with the encpwd option to encrypt a password string For example C Vizioncore vFoglight bin gt keyman encpwd my_new_password foglight defaultkey Encrypted Password q40799f927b44ba22192f3a4fa2flccIl Open the lt vfoglight_home gt 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 step 3 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 delappk
12. 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 ONaab6ca568d3 Name Business hours Description 9AM to 5PM Monday to Friday ID d6bc50e7 0748 4356 909e 404aa7f 377ef 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 6816241 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 94e 5034b 42f1 448d 8b88 291915234109 Name Weekends Description Whole days Saturday and Sunday 162 vF oglight 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
13. Namespace SPI Adapter ID Fg1AM 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 Fg1AM 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 e clients on page 73 e packages on page 78 e types on page 82 packages The packages command shows a list of available agent packages Scope agent Syntax fglemd 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 79 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 Option Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager should be selected allinstallers None Indicates that all agent installers should be selected allpackages None Indicates that all agent packages should be listed a
14. They are as follows e vFoglight Client Commands on page 166 e Getting Started with Server Commands on page 172 e Administrative Commands on page 172 Note In this appendix lt vfoglight_client_home gt is a placeholder that represents the path to the vFoglight Client installation vFoglight Client Commands This section describes the following tasks e Getting Started with vFoglight Client Commands on page 166 e 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 vF oglight Client 167 vFoglight Client Commands Navigate to the directory that contains the vFoglight Client commands lt vfoglight_client_home gt spid or lt vfoglight_client_home gt spid 5 2 4 bin support_bundle Where foglight_client_home refers to the installation directory of the vFogligh
15. 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 Option host name namespace nowait regex Argument host_name agent_name agent_namespace None None Managing Cartridges and Metrics 97 Managing Agents 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 98 vF oglight 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
16. on page 108 e stop on page 112 Activating or Deactivating Agent Instances This section describes the following commands e activate on page 99 e deactivate on page 104 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 agent Syntax fglemd connection_options cmd agent activate agentid agent_ID name agent_name namespace agent_namespace all host host_name 100 vF oglight Command Line Reference Guide adapter adapter_ID deletable activatable force nowait Options and arguments Option activatable active adapter agentid all datacollection deletable force host name Argument true or false true or false adapter_ID agent_ID None true or false true or false None host_name agent_name type agent_type true false true false active true false regex datacollection true false Description Indi
17. spid and support_bundle Additionally the g1cmd interface supports both agent technologies Some of the fglcmd commands produce a different command output when you use the vFoglight Client This appendix contains information about the spid and support_bundle 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 see Chapter 0 Managing Cartridges and Metrics This appendix contains the following sections About the Command Line Interface csceestcueesecseeesterisecsneeaieetsrieeaienieritsenesnsenieensey 166 yf gglight Client Commands sce isis scscscscsestsobsisecesccsscscsovsscsiastassveatebiseveseteacsaieascusstestvniaenissiestiens 166 Getting Started with Server COMMANAS isinin eiriisriieniirnirni nainii 172 Administrative Command Siira iraniani ian 172 166 vF oglight 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
18. 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 to date 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 e runDB on page 47 e shutdownDB on page 47 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 lt vfoglight_home gt 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 lt vfoglight_home gt config foglight config file depending on the type of the database 50 vF oglight 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
19. 001 877 384 8979 or 001 877 269 3383 Sales 50 81 8800 or 01 800 888 3355 Country Code 52 Customer Service 001 877 384 8979 or 001 877 269 3383 Main 50 81 8800 or 01 800 888 3355 Montserrat E mail Address la techsupport dell com Technical Support Customer Service Sales Toll free 1 866 278 6822 Netherlands E mail Address Ta techsupport dell com Web Address support euro dell com Antilles Netherlands Technical Support 020 674 45 00 i Technical Support Fax 020 674 47 66 Amsterdam International Access Code 00 Country Code 31 City Code 20 Home Small Business Customer Service Relational Customer Service Home Small Business Sales Relational Sales Home Small Business Sales Fax Relational Sales Fax 020 674 42 00 020 674 43 25 020 674 55 00 020 674 50 00 020 674 47 75 020 674 47 50 Switchboard 020 674 50 00 Switchboard Fax 020 674 47 50 New Zealand Web Address Support ap dell com International Access Code 00 Country Code 64 E mail Address Technical Support Customer Service Sales Support ap dell com contactus 0800 441 567 Nicaragua Web Address E mail Address Technical Support Customer Service Sales www dell com ni la techsupport dell com 001 800 220 1377 Norway Lysaker Web Address Support euro dell com er Technical Support 671 16882 International Access Code 00 Relational Customer Service 671 17575 c Home Small Business Customer Service 231 622
20. 146 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 147 Running Utility Commands 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 gt fglemd usr foglight pwd foglight cmd util configimport f policy xml Note If successful this command does not generate any output See also e configexport on page 145 Exporting Importing or Listing UI Modules This section describes the following commands e uilist on page 147 e uiexport on page 149 e uiimport on page 150 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 vF oglight Command Line Reference Guide Scope util Syntax fglcmd connection_options cmd util uilist Options and arguments None Example C Vizioncore vFogligh
21. 2 4 Cartridge Name Cartridge Version OS windows OS Version 5 1 OS Architecture 1a32 x86_64 176 vF oglight 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 gt fglemd 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 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 agentilist 75 agentilogs 116 agent packages 78 agentsetschedule 124 agent showschedule 120 agent start 108 agent stop 112 agent types 82 cartridge disable 131 cartridge enable 132 cartridge install 128
22. 2 4 Name OS WebMonitor version 5 2 4 Name OS Windows_System version 5 2 4 Nam OS OnlineHelp version 5 2 4 Name OS HostModel Windows version 5 2 4 All cartridges are activated See also uninstall on page 129 disable on page 131 enable on page 132 list on page 133 uninstall The uninstall command uninstalls a vFoglight cartridge 130 vF oglight Command Line Reference Guide You can only uninstall a disabled cartridge For information on how to disable a cartridge using the f g1cmd interface see disable on page 131 Scope cartridge Syntax fglemd 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 Example C Vizioncore vFoglight bin gt 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 e install on page 128 e disable on page 131 e enable on page 132 e list on page 133 Enabling or Disabling Cartridges This section describes the following commands Managing Cartridges and Metrics 131 Managing Cartridges e disable on page 131 e enable on page 132 disable The disable command deactivates a vFo
23. 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 vF oglight 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 lt vfoglight_home gt tools remotemonitor zip file from
24. 45d6 a33 b88bb7d4ff55 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 e clients on page 73 e list on page 75 e packages on page 78 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 agent Syntax fglemd 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 Options and arguments Option Argument Managing Cartridges and Metrics 85 Managing Agents Description allclients clientbuild clientid clientname clientversion force host list regex None build_ID client_ID display_name version None host_name None 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 th
25. 701 04 99 75 40 01 0825 004 719 nana ee 0825 338 339 Switchboard 55 94 71 00 01 55 9471 00 Sales Germany Frankfurt Web Address support euro dell com International Access E mail Address tech support central europe dell com Code 00 Technical Support 069 9792 7200 Country Code 49 Home Small Business Customer Service Global Segment Customer Service 0180 5 224400 069 9792 7320 City Code 69 Preferred Accounts Customer Service 069 9792 7320 Large Accounts Customer Service 069 9792 7320 Public Accounts Customer Service 069 9792 7320 Switchboard 069 9792 7000 Greece Web Address Support euro dell com International Access Code 00 Technical Support Gold Service Technical Support 00800 44 14 95 18 00800 44 14 00 83 Switchboard 2108129810 Country Code 49 Gold Service Switchboard 2108129811 Sales 2108129800 Fax 2108129812 Grenada Web Address www dell com gd E Mail Address Technical Support Customer Service Sales la techsuppo dell com toll free 1 866 540 3355 Guatemala Web Address www dell com gt E Mail Address la techsupport dell com Technical Support Customer Service Sales 1 800 999 0136 Guyana E Mail Address Ta techsupport dell com Technical Support Customer Service Sales toll free 1 877 270 4609 Hong Kong Web Address support ap dell com International Access Code 001 Country Code 852 Technical Support E mail Address Technical Support Dimension and Inspi
26. Client see Getting Started with Server Commands on page 172 To get started with vFoglight Management Server commands Note This procedure continues from Getting Started with vFoglight Commands on page 32 Managing the vF oglight Management Server 37 Running the vFoglight Management Server 1 Copy the lt vfoglight_home gt 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 configure the Remote Monitor utility with the vFoglight Client see Getting Started with Server Commands on page 172 2 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 lt vfoglight_home gt bin by completing one of the following steps e If you want to use the command prompt open a Command Prompt window and navigate to lt vfoglight_home gt bin as required or e If you want to use a vFoglight Management Server command in a script ensure that your script references lt vfoglight_home gt 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 e Runni
27. 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 vF oglight Cartridge for VMware Command Line Reference Guide e Release Notes HTML e Getting Started Guide PDF e What s New Guide PDF e System Requirements and Platform Support Guide PDF e Installation and Setup Guide set all in PDF format e Installation and Setup Guide Installing on Windows with an Embedded MySQL Database e Installation and Setup Guide Installing on Windows with an External MySQL Database e Installation and Setup Guide Installing on Windows with an External Oracle Database e Administration and Configuration Guide PDF and online help e vFoglight User Guide PDF and online help e Advanced Configuration Guide set e Command Line Reference Guide PDF and online help e Web Component Guide PDF and online help e Web Component Tutorial PDF and online help e 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 i
28. None build_ID client_ID display_name version host_name None true or false Managing Cartridges and Metrics 83 Managing Agents 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 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 An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version 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 Indicates whether one or more vFoglight Agent Manager instances can true or cannot be upgraded false It can be set to a regular expression C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd agent types clientname tor012991 prod quest corp 84 vF oglight Command Line Reference Guide Client ID tor012991 prod quest corp cf238d96 3a56
29. Sales toll free 080 200 3600 i Fax 2194 6202 Switchboard 2194 6000 Latin America Customer Technical Support Austin Texas 512 728 4093 U S A Customer Service Austin Texas U S A 512 728 3619 Fax Technical Support and Customer Service 512 728 3883 Austin Texas U S A Sales Austin Texas U S A 512 728 4397 SalesFax Austin Texas U S A 512 728 4600 or 512 728 3772 Luxemborg Web Address Support euro dell com International Access Support 3420808075 Code 00 Home Small Business Sales 32 0 2 713 15 96 Corporate Sales 26 25 77 81 Country Code 352 Customer Service 32 0 2 481 91 19 Fax 26 25 77 82 Macao Technical Support toll free 0800 105 Country Code 83 Customer Service Xiamen China 34 160 910 Transaction Sales Xiamen China 29 693 115 Malaysia Penang International Access Code 00 Country Code 60 Web Address Technical Support Dell Precision OptiPlex and Latitude Technical Support Dimension Inspiron and Electronics and Accessories Support ap dell com toll free 1800 880 193 toll free 1800 881 306 City Code 4 i Technical Support PowerApp PowerEdge toll free 1800 881 386 PowerConnect and PowerVault Customer Service toll free 1800 881 306 option 6 Transaction Sales toll free 1800 888 202 Corporate Sales toll free 1800 888 213 Mexico Web Address www dell com mx International Access Code 00 E mail Address Customer Technical Support la techsupport dell com
30. Scripts on page 162 e Creating a Server Support Bundle on page 162 Exporting or Importing a Monitoring Policy This section describes the following commands e configexport on page 145 e configimport on page 146 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 vF oglight 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 output file to re import the monitoring policy at a later time using the configimport command see page 146 Scope util Syntax fglemd connection_options cmd util configexport f file_path Options and arguments Option Argument Description f file_path 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 gt fglemd usr foglight pwd foglight cmd util configexport f policy xml Note If successful this command does not generate any output See also e configimport on page
31. Visit http support dell com 2 Verify your country or region in the Choose A Country Region drop down menu at the bottom of the page 3 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 Select the appropriate service or support link based on your need 5 Choose the method of contacting Dell that is convenient for you Country City Service Type Area Codes International Access Local Numbers and Code Toll Free Numbers Country Code Web and E Mail Addresses City Code Anguilla Web Address WwWw Dell com ai E Mail Address Technical Support Customer Service Sales la techsupport dell com toll free 800 335 0031 Antigua and Barbuda Web Address E Mail Address Technical Support Customer Service Sales www Dell com ag la techsupport dell com 1 800 805 5924 Aomen Technical Support Dell Dimension Dell Inspirion Dell Optiplex Dell Lattitude and Dell os TM Precision Servers and Storage 0800 105 0800 105 Argentina Buenos Aires Web Address Intemational 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 Technical Support Services Sales Aruba e TESS E Mail Address Technical Support Customer Service Sales www dell com ar la techsupport dell com la_enterpris
32. 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 f g1cmd interface see activate on page 99 Scope agent Syntax Managing Cartridges and Metrics 109 Managing Agents fglcmd connection_options cmd agent start agentid agent_ID name agent_name namespace agent_namespace all host host_name nowait Options and arguments adapter adapter_ID type agent_type deletable true false activatable force datacollection true false true false active true false regex Option Argument Description activatable true or false Indicates whether to start agent instances that can true or cannot be activated false active true or false Indicates whether to start 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 agentid agent_ID Identifies an instance of a vFoglight agent that is to be started all None Indicates that all agent instances should be datacollection deletable force host true or false true or false None host_name started Indicates whether to start vFoglight agent instances that are true or are not collecting data false Indicates whether to star
33. agent types For example e OSCartridge ApacheS vr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e 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 oSCart ridge prefix for example AppMonitor instead of OSCartridge AppMonitor result in an error Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight 112 vF oglight 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 e deploy on page 86 e create on page 91 e delete on page 95 e activate on page 99 e deactivate on page 104 e stop on page 112 stop The stop command terminates the data collection for one or more vFogli
34. 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 Example C Vizioncore vFoglight bin gt fglemd 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_Tabl 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 8 i i nin nex ag sum stdiDev a307df8f 63e9 4b65 21 58 0 26 58 0 300000 1 1 1 1 1 1 O a6d6 a50524a5544b a307df8f 63e9 4b65 26 59 0 31 59 0 300000 1 2 2 2 2 4 JO a6d6 a50524a5544b a307df8f 63e9 4b65 32 00 0 37 00 0 300000 1 2 2 2 24 O a6d6 a50524a5544b Managing Cartridges and Metrics Running Utility Commands 153 g ak E a307df8f 63e9 4b65 37 00 0 42 00 0 300000 1 0 a6d6 a50524a5544b a307df8f 63e9 4b65 42 01 0 47 01 0 300000 2 4 0 a6d6 a
35. can run this command only if the user account you are using to log into fglcmd has a Security role For information about fglemd 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 Scope security Syntax fglemd connection_options cmd security assigngroup username username groupname groupname remove 136 vF oglight 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 gt fglemd 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 gt 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 e createuser on page 137 e deleteuser on page 138 Managing Cartridges and Metrics 137 Managing Security Entities create
36. character is preceded by X without making X a part of the search result For example when the construct lt o wis matched against Hello world it returns the w in world without making the w a part of the result 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 63 Using the Command Line for Administration Tasks 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 It has the same functionality as with the exception that it ignores any final terminators z The end of the input string It has the same functionality Unicode blocks piLu pL amp k amp p Lu as with the exception that it ignores any line terminators Any uppercase alphanumeric character Any
37. free 0080 160 1250 option 5 toll free 0080 165 1228 toll free 0080 165 1227 Thailand International Access Code 001 Country Code 66 Web Address Technical Support OptiPlex Latitude and Dell Precision Technical Support PowerApp PowerEdge PowerConnect and PowerVault Customer Service Corporate Sales Transaction Sales 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 Trinidad Tobago Web Address E mail Address Technical Support Customer Service Sales Wwww dell com tt la techsupport dell com toll free 1 888 799 5908 Turks and Caicos Islands Web Address E mail Address Technical Support Customer Service Sales www dell com tc la techsupport dell com toll free 1 877 441 4735 U K Bracknell International Access Code 00 Country Code 44 City Code 1344 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 amp Education upport euro dell com dell _direct_support 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 0134
38. 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 89 Argument agent_installer_ID name OS_name OS_version OS_architecture package_ID pkg_OS_name Managing Agents 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 a
39. regular expression Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd agent packages allclients Client ID tor012991 prod quest corp cf238d96 3a56 45d6 a33 b88bb7d4ff55 Installer ID tor012991 prod quest corp cf238d96 3a56 45d6 82 vF oglight Command Line Reference Guide a33e b88bb7d4ff55 FG1AM tor012991 prod quest corp cf238d96 3a56 45d6 a33e b8 8bb7d4f 55 installer Agent Package ID OSCartridge WindowsxP 5 2 4 OSCartridge Agent WindowsXP windows 5 1 ia32 x86_64 Agent Package Cartridge Name OSCartridge WindowsxXP 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 e clients on page 73 e list on page 75 e types on page 82 types The types command shows a list of vFoglight agent types sorted by the Agent Manager ID Scope agent Syntax fglemd connection_options cmd agent types regex host host_name clientname display_name clientid client_ID clientbuild build_ID clientversion version allclients upgradable true false Options and arguments Option allclients clientbuild clientid clientname clientversion host regex upgradable Example Argument
40. see the Administration and Configuration Guide Scope security Syntax fglcmd connection_options cmd security creategroup groupname groupname Managing Cartridges and Metrics 141 Managing Security Entities Options and arguments Option Argument Description groupname groupname Specifies the name of the group that is to be created Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd security creategroup groupname MyGroup Note If successful this command does not generate any output See also e assignrole on page 139 e deletegroup on page 141 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 Security role For information about fglemd 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 Scope security Syntax fglcmd connection_options cmd security deletegroup groupname groupname 142 vF oglight 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 gt fglemd usr foglight pwd foglight cmd security deletegroup groupname MyGroup Note If successful this c
41. 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 107 Managing Agents 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 For example e OSCartridge ApacheS vr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e 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 il
42. 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 55 Using the Command Line for Administration Tasks 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 Note The fgicmd 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 e 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 fglemd connection options cmd scope command options i Scope specific d o feme Command command separator See also e About Regular Expressions on page 56 e Getting Started with Administrative Commands on page 64 56 vF oglight Command Line Reference Guide e Running Administrative Commands Example on page 65
43. tor012991 prod quest corp 32b1 c51d 6208 435c bdad 2a8916ef3a89 tor012991 prod quest corp Adapter ID Fg1AM Client Name Client Version 5 2 4 524 20080811 0230 Host Name tor012991 prod quest corp Managing Cartridges and Metrics 75 Managing Agents 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 e list on page 75 e packages on page 78 e types on page 82 list The 1ist command shows a list of vFoglight agent instances Scope agent 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 Argument Description activatable true or false Indicates whether to list agent instances that can true or cannot be activated false active true or false Indicates whether to list agent instances that are active true or inactive false 76 vF oglight Command Line Reference Guide Option Argument Description adapter adapter_ID An explicit text string or a regular expression t
44. 00 Bolivia Web Address www dell com bo E Mail Address la_techsupport dell com Technical Support Customer Service Sales toll free 800 10 0238 Brazil Web Address www dell com br International Access Code 00 Country Code 55 City Code 51 E Mail Address Customer Service and Tech Support Technical Support Fax Customer Service Fax Sales BR_TechSupport dell com 0800 970 3355 51 2104 5470 51 2104 5480 0800 722 3498 British Virgin Islands Technical Support Customer Service Sales toll free 1 866 278 6820 Brunei Technical Support Penang Malaysia 604 633 4966 Country Code 673 Customer Service Penang Malaysia 604 633 4888 Transaction Sales Penang Malaysia 604 633 4955 Canada North York Online Order Status Web Address www dell ca ostatus Ontario AutoTech automated Hardware and Warranty International Access Code 011 Support Customer Service Home Home Office Small Business Medium Large Business Government Education Hardware Warranty Phone Support 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 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 to
45. 07 136509fec207 teAlarmState gt ws rce foglight 5 foglight 5 gt name effectiveEndDate value 5138 11 16 04 46 40 0 gt name lastUpdated value 3 20 09 01 02 17 29 14 929 gt name name value tor013008 prod quest corp gt name longName value tor013008 prod quest corp s_Host gt name scheduleIds value gt name isBlackedOut value false gt name annotations value gt name alarms value gt name aggregateAlarms value gt name localState value 0 gt name aggregateState value 0 gt name aggregateAlarmState value DataObject of type 5 AlarmStateObservation for datasource foglight name alarmWarningCount value 0 gt name alarmCriticalCount value 0 gt name alarmFatalCount value 0 gt name alarmTotalCount value 0 gt name alarmAggregateWarningCount value 0 gt name alarmAggregateCriticalCount value 0 gt name alarmAggregateFatalCount value 0 gt name alarmAggregateTotalCount value 0 gt name ChangeSummary value gt name changeCount value 0 gt name aggregateChangeCount value 0 gt name topologyTypeName value Windows_Host gt name monitoredHost value foglight Host c380ae79 2d36 45fc a07f 136509fec207 1 name sourcelds value gt name serviceLevelPolic
46. 173 Appendix Command Line Interface to the vF oglight Client 173 Administrative Commands e deploy on page 173 e list on page 174 e logs on page 174 e packages on page 175 e 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 gt fglemd 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 gt fglemd 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 WindowsxXP 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 m
47. 21001 Code 00 echnica Support 902 100 130 Customer Service 902 118 540 Country Code 34 City Code 91 Sales 902 118 541 Switchboard 902 118 541 Fax 902 118 539 Corporate Technical Support 902 100 130 Customer Service 902 115 236 Switchboard 91 722 92 00 Fax 91 722 95 83 Sweden Upplands Web Address support euro dell com Vasby Technical Support 08 590 05 199 International Access Code 00 Country Code 46 City Code 8 Relational Customer Service Home Small Business Customer Service Employee Purchase Program EPP Support Technical Support Fax 08 590 05 642 08 587 70 527 020 140 14 44 08 590 05 594 Switzerland Geneva International Access Code 00 Country Code 41 City Code 22 Web Address E mail Address Technical Support Home and Small Business Technical Support Corporate Customer Service Home and Small Business Customer Service Corporate Support euro dell com Tech support central Europe dell com 0844 811 411 0844 822 844 0848 802 202 0848 821 721 Fax 022 799 01 90 Switchboard 022 799 01 01 Taiwan Web Address support ap dell com 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 support dell com cn email toll free 0080 186 1011 toll free 0080 160 1256 toll
48. 238d96 3a56 45d6 a33e b88bb7d4ff55 packageid OSCartridge WindowsXP 5 2 4 0SCartridge Agent WindowsXP windows 5 1 ia32 x86_64 Successfully installed package OSCartridge WindowsxP 5 2 4 Managing Cartridges and Metrics 91 Managing Agents OSCartridge Agent WindowsXP windows 5 1 ia32 x86_64 on tor012991 prod quest corp cf238d96 3a56 4 5d6 a33e b88bb7d4ff55 FgG1AM tor012991 prod quest corp cf238d96 3a56 45d6 a33e b8 8bb7d4f 55 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 e create on page 91 e delete on page 95 e activate on page 99 e deactivate on page 104 e start on page 108 e stop on page 112 Creating or Deleting Agent Instances This section describes the following commands e create on page 91 e delete on page 95 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 us
49. 4 373 199 Health 01344 373 194 Technical Support Corporate Preferred Accounts PCA 1000 0870 908 0500 employees Other Dell Products 0870 353 0800 General Home and Small Business Fax 0870 907 4006 Uruguay Web Address www dell com uy E mail Address Technical Support Customer Service Sales la techsupport dell com toll free 000 413 598 2521 U S A Austin Texas International Access Code O11 Country Code 1 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 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 to
50. 50524a5544b a307df8f 63e9 4b65 47 02 0 52 02 0 300000 1 0 a6d6 a50524a5544b a307df8f 63e9 4b65 52 02 0 57 02 0 300000 1 0 a6d6 a50524a5544b a307df8f 63e9 4b65 57 03 0 02 03 0 300000 1 0 a6d6 a50524a5544b a307df8f 63e9 4b65 02 03 0 07 03 0 300000 1 0 a6d6 a50524a5544b a307df8f 63e9 4b65 07 04 0 12 04 0 300000 4 16 0 a6d6 a50524a5544b a307df8f 63e9 4b65 12 05 0 17 05 0 300000 1 0 a6d6 a50524a5544b a307df8f 63e9 4b65 17 05 0 22 05 0 300000 8 64 0 a6d6 a50524a5544b ac205363 863b 478b 33 12 0 38 12 0 300000 1 0 b6b7 97e1a444e76a ac205363 863b 478b 38 12 0 43 12 0 300000 1 0 b6b7 97e1a444e76a ac205363 863b 478b 43 13 0 48 13 0 300000 2 4 0 b6b7 97e1a444e76a ac205363 863b 478b 48 13 0 53 13 0 300000 1 0 b6b7 97e1a444e76a 154 vF oglight Command Line Reference Guide TBE ac205363 863b 478b 53 14 0 58 14 0 300000 1 2 2 2 2 4 JO b6b7 97e1a444e76a mn ac205363 863b 478b 58 15 0 03 15 0 300000 1 1 1 1 1 1 JO b6b7 97e1a444e76a ac205363 863b 478b 03 15 0 08 15 0 300000 1 1 1 1 1 1 O b6b7 97e1a444e76a ac205363 863b 478b 08 16 0 13 16 0 300000 1 4 4 4 4 16 0 b6b7 97e1a444e76a ac205363 863b 478b 13 16 0 18 16 0 300000 1 13 3 13 13 9 0 b6b7 97e1a444e76a ac205363 863b 478b 18 17 0 23 17 0 300000 1 6 6 6 6 36 0 b6b7 97e1a444e76a
51. 98 ountry Code 47 Switchboard 671 16800 Fax Switchboard 671 16865 Panama Web Address www dell com pa E mail Address la techsupport dell com Technical Support Customer Service Sales 011 800 507 1264 Peru Web Address www dell com pe E mail Address Technical Support Customer Service Sales la techsupport dell com 0800 50 669 Poland Warsaw International Access Web Address E mail Address support euro dell com pl support tech dell com Customer Service Phone 57 95 700 Code 011 Customer Service 57 95 999 Country Code 48 Sales 57 95 999 City Code 22 Customer Service Fax 57 95 806 Reception Desk Fax 57 95 998 Switchboard 57 95 999 Portugal Web Address Support euro dell com nternational Access Technical Support 707200149 Code 00 Customer Service 800 300 413 Sales 800 300 410 or 800 300 411 or Country Code 351 800 300 412 or 21 422 07 10 Fax 21 424 01 12 Puerto Rico Web Address www dell com pr E mail Address Technical Support Customer Service Sales la techsupport dell com 1 877 537 3355 St Kitts and Nevis Web Address E mail Address Technical Support Customer Service Sales www dell com kn la techsupport dell com toll free 1 866 540 3355 St Lucia Web Address E mail Address Technical Support Customer Service Sales www dell com Ic la techsupport dell com toll free 1 866 464 4352 St Vincent and the Web Address www dell com vc
52. 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 fglemd interface that contains commands for managing common vFoglight entities such as agents cartridges and metrics It also explains the fglemd syntax and contains additional getting
53. Access Support euro dell com Code 00 Technical Support c E mail Address dell_direct_support dell com ountry Code 353 i City Code 1 Business computers 1850 543 543 Home computers 1850 543 543 At Home Support 1850 200 889 Sales Home 1850 333 200 Small Business 1850 664 656 Medium Business 1850 200 646 Large Business 1850 200 646 E mail Address Dell IRL Outlet dell com Customer Service Home and Small Business 204 4014 Business greater than 200 employees 1850 200 982 General Fax Sales fax 204 0103 Switchboard 204 4444 U K Customer Service dealing with U K only 0870 906 0010 Corporate Customer Service dial within U K 0870 907 4499 only U K Sales dial within U K only 0870 907 4000 Italy Milan Web Address Support euro dell com International Access Home and Small Business Code 00 Technical Support 02 577 826 90 f Customer Service 02 696 821 14 Country Code 39 City Code 02 Fax 02 696 821 13 Switchboard 02 696 821 12 Corporate Technical Support 02 577 826 90 Customer Service 02 577 825 55 Fax 02 575 035 30 Switchboard 02 577 821 Jamaica E mail Address Technical Support Customer Service Sales dial from within Jamaica only Ta techsupport dell com 1 800 440 920 J apan Kawasaki International Access Code 001 Country Code 81 City Code 44 Web Address Technical Support Dimension and Inspiron Technical Support outside of Japan Dimension and Inspiron Tech
54. 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 Line Structure on page 54 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 Inthe 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 32blc5ld 6208 435c bdad 2a8916ef3a89 Installer ID tor012991 prod quest corp 32blc51d 6208 435c bdad 2a8 91 6ef3a8 9 FG1IAM tor012991 prod quest corp 32b1c51d 6208 435c bdad 2a8916ef3a89 installer 66 vF oglight 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 O
55. Follow Toad T O A D Toad World VANALYZER vVAUTOMATOR vCONTROL vCONVERTER vEssentials VFOGLIGHT vOPTIMIZER vVRANGER 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 con
56. Metrics 159 Running Utility Commands 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 7ad0ac9b6da82 Windows_System_System_Tabl System_Table a14b98 6a c079 429a 9c0b 54fbc9elff99I Windows_System_System_Tabl System_Table 7c4 461 bdla 404f ba21 a8418d51100c Windows_System_System_Tabl System_Table Listing Schedules list The list command generates a list of all vFoglight schedules Scope schedule Syntax fglemd connection_options cmd schedule list Options and arguments None Example C Vizioncore vFoglight bin gt fglemd 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 71feal87af4e Name Always Description A schedule that includes all the time 160 vF oglight Command Line Reference Guide ID 013 57d1 le7e 4098 a7a5 2b2763364cb5 Name First day of week Description Whole days Monday ID 004c98d4 c278 4af2 81f 7 4264fd30003f Name Daily Database Maintenance Description Schedule on which daily ope
57. S 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 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 Managing Cartridges and Metrics 95 Managing Agents Example Using a regular expression to select hosts C Vizioncore vFoglight bin gt fglemd 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 selecta vFoglight Agent Manager instance C Vizioncore vFoglight bin gt 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 e deploy on page 86 e delete on page 95 e activate on page 99 e deactivate on page 104 e start on page 108 e stop on page 112 delete The delete command removes one or more vFoglight agent instances To delete an agent instance a typical flow of actions requires
58. SCartridge WindowsxXP 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 e Understanding the Command Line Structure on page 54 e About Regular Expressions on page 56 e Getting Started with Administrative Commands on page 64 e 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 Structure on page 54 Managing Cartridges and Metrics 67 Using the Command Line for Administration Tasks Scope Command Name Description Name Description agent Manages activate Activates one or more vFoglight agent instances agents and clients clients Shows a list of vFoglight client instances clientupgrade Upgrades one or more remote instances of the vFoglight Agent Manager create Creat
59. Scope script Syntax fglcmd connection_options cmd script run f file_path Options and arguments Option Argument Description f file_path Specifies the path and name of the script file that is to be executed Example C Vizioncore vFoglight bin gt fglemd 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 support Managing Cartridges and Metrics 163 Running Utility Commands 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 gt fglcmd usr foglight pwd foglight cmd support bundle f support bundle Note If successful this command does not generate any output 164 vF oglight 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
60. XaXa bXbXb CXCXC CXCXC N 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 e X Y Z group 1 e X Y group 2 e Z group 3 For information about capturing groups and their syntax see on page 61 62 vF oglight Command Line Reference Guide Syntax 2 x X lt X lt IX Boundary matching A b Description Checks if the preceding character is followed by X ina 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 ina 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 lt 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
61. age 116 Listing and Setting Blackout Schedules This section describes the following commands e showschedule on page 120 e setschedule on page 124 showschedule The showchedule command shows the blackout schedule assigned to one or more vFoglight agent instances Scope agent Syntax fglemd connection_options cmd agent showschedule agentid agent_ID name agent_name namespace agent_namespace all host host_name deletable true false activatable Options and arguments Option Argument Managing Cartridges and Metrics 121 Managing Agents adapter adapter_ID type agent_type datacollection true false true false active true false regex Description activatable active adapter agentid datacollection deletable host name namespace true or false true or false adapter_ID agent_ID None true or false true or false host_name agent_name agent_namespace 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 instan
62. ame 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 e install on page 128 e uninstall on page 129 e disable on page 131 e enable on page 132 Managing Cartridges and Metrics 135 Managing Security Entities Managing Security Entities This section describes the following tasks e Managing Users on page 135 e 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 e assigngroup on page 135 e createuser on page 137 e deleteuser on page 138 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
63. 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 e OSCartridge ApacheSvr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e 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 oSCart ridge prefix for example AppMonitor instead of OSCartridge AppMonitor result in an error Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight Managing Cartridges and Metrics 99 Managing Agents cmd agent delete name Agent4 Note If successful this command does not generate any output See also e deploy on page 86 e create on page 91 e activate on page 99 e deactivate on page 104 e start
64. cates 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 Option namespace nowait regex Argument agent_namespace None None Managing Cartridges and Metrics 101 Managing Agents 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 agen
65. ces 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 An explicit text string or a regular expression that specifies one or more vFoglight agents whose blackout schedule is to be set 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 vF oglight 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 123 Managing Agents 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 For example e OSCartridge ApacheS vr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e OSCartridge Windows_Syst
66. cmd agent setschedule agentid 10 schedulename Start of Day Note If successful this command does not generate any output See also e showschedule on page 120 Managing Cartridges This section describes the following features e Installing or Uninstalling Cartridges on page 128 e Enabling or Disabling Cartridges on page 130 e Listing Cartridges on page 133 Installing or Uninstalling Cartridges This section describes the following commands e install on page 128 e uninstall on page 129 install The install command installs a cartridge on the vFoglight Management Server Scope cartridge Syntax fglcmd connection_options cmd cartridge install passive file_path Managing Cartridges and Metrics 129 Managing Cartridges 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 gt fglemd 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
67. complete information about users roles and groups in vFoglight see the Administration and Configuration Guide Scope security Syntax fglemd connection_options cmd security deleteuser username username Options and arguments Option Argument Description username username Specifies the user name of the account that is to be deleted Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd security deleteuser username Demo Note If successful this command does not generate any output See also e assigngroup on page 135 e createuser on page 137 Managing Cartridges and Metrics 139 Managing Security Entities Managing Groups This section describes the following commands e assignrole on page 139 e creategroup on page 140 e 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 For information about fglemd 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 Scope security Syntax fglcmd connection_options cmd security assignrole groupname groupname rolename rolename remove Options and arguments O
68. d 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 r remove service None Stops and removes the vFoglight Management Server Windows service Examples Starting the server in HA mode C Vizioncore vFoglight bin gt 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 gt 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 gt fmsha r 44 vF oglight 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 e fms on page 38 e remotemonitor on page 44 remotemonitor The remotemonitor command provides command line interface to the Remote Monitor application The Remote Monitor communicates with multiple instances o
69. e C Vizioncore vFoglight bin gt 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 e fmsha on page 41 e remotemonitor on page 44 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 e Start or stop the vFoglight Management Server in HA mode e Install and start the vFoglight Management Server in HA mode as a Windows service e Stop and remove a vFoglight Management Server HA Windows service e Configure Java Virtual Machine JVM options and add entries to the vFoglight classpath e Assign different names to different vFoglight Management Server process launchers e Display version information or a list of arguments along with their descriptions 42 vF oglight Command Line Reference Guide Syntax fmsha s start q stop w wait n name process_nam
70. e 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 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 n name 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 p classpath classpath Adds entries to the JVM classpath q stop None Stops the running vFoglight Management Server process s start None Starts the vFoglight Management Server 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 Managing the vFoglight Management Server 43 Running the vFoglight Management Server 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 comman
71. e 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 amp amp A logical AND operator For example a d amp amp 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 amp amp for example in a z amp amp aeiou is done in the following order escape grouping range union and intersection Any character d Any decimal digit D Any character other than a decimal digit Managing Cartridges and Metrics 59 Using the Command Line for Administration Tasks 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 0r 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 2 or t W
72. e dell com 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 techsupport dell com toll free 800 1578 Australia Sydney Web Address ere Contact Dell Web Address International Access Code 0011 Technical Support Customer Service Sales Country Code 61 City Code 2 support ap dell com support ap dell com contactus 13DELL 133355 Austria Vienna International Access Web Address E Mail Address Support euro dell com Tech_support_central_europe dell com Code 900 Home Small Business Sales 0820 240 530 00 Country Code 43 Home Small Business Fax l 0820 240 530 49 City Code 1 Home Small Business Customer Service 0820 240 530 14 Home Small Business Support 0820 240 530 17 Preferred Accounts Corporate Customer 0820 240 530 16 Service Preferred Accounts Corporate Customer 0820 240 530 17 Switchboard 0820 240 530 00 Bahamas Web Address www dell com bs E Mail Address la techsupport dell com Technical Support Customer Service Sales toll free 1 866 874 3038 Barbados Web Address www dell com bb E Mail Address Technical Support Customer Service Sales la techsupport dell com 1 800 534 3142 Belgium Brussels Web Address Support euro dell com General Support 02 481 92 88 General Support Fax 02 481 92 95 Customer Service 02 713 15 65 Corporate Sales 02 481 91 00 Fax 02 481 91 99 Switchboard 02 481 91
73. e 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 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 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 vF oglight 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
74. e vFoglight Management Server 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 jvm argument name classpath stop start thread dump version None JVM_options process_name classpath None None None None 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 vF oglight 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 th
75. e vFoglight Management Server Windows service i install service None Installs the vFoglight Management Server as a Windows service r remove service None Stops and removes the vFoglight Management Server Windows service Examples Installing Remote Monitor as a Windows service C Vizioncore vFoglight bin gt 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 gt 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 gt 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 e fms on page 38 e fmsha on page 41 Managing the vFoglight Management Server 47 Starting Stopping or Upgrading the Database Starting Stopping or Upgrading the Database This section describes the following features e Starting the Embedded Database on page 47 e Stopping the Embedded Database on page 47 e 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 vFogl
76. em 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 oSCart ridge prefix for example AppMonitor instead of OSCartridge AppMonitor result in an error Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight 124 vF oglight 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 le7e 4098 a7a5 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 e setschedule on page 124 setschedule The set schedule command assigns a blackout schedule to one or more vF
77. es 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 vFoglight agent packages getlog Retrieves a copy of an agent log file list Shows a list of vFoglight agent instances logs Shows a list of agent log files packages Shows a list of available agent packages setschedule Assigns a blackout schedule to one or more vFoglight agent instances showschedule Shows the blackout schedule assigned to one or more vFoglight agent instances start Starts the data collection for one or more vFoglight agent instances stop Stops the data collection for one or more vFoglight agent instances types Shows a list of vFoglight agent types sorted by client ID 68 vF oglight Command Line Reference Guide Scope Command Name Description Name Description cartridge Manages disable Deactivates a vFoglight cartridge cartridges 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 license Manages import Installs a vFoglight license licenses list Shows a list of installed vFoglight licenses remove Removes a vFoglight license using the license serial number schedule Lists list Shows a list of all vFoglight schedules schedules script Ru
78. essful 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 lt xml version 1 0 encoding UTF 8 gt lt top objects gt lt top obj uniquelId c380ae79 2d36 45fc a07f 136509fec207 gt lt property name uniqueld value c380ae79 2d36 45fc a07Ff 136509fec207 gt lt property name topologyObjectId value 175 gt lt property name topologyObjectVersionId value 280 gt lt property name topologyObjectVersion value 1 gt 156 vF oglight Command Line Reference Guide lt proper Cy name effectiveStartDate value 3 20 09 01 02 17 29 14 82 gt lt proper lt proper lt proper lt proper Window lt proper lt proper lt proper lt proper lt proper lt proper lt proper lt proper foglig 5 fogli aggrega lt proper lt proper lt proper lt proper lt proper lt proper lt proper lt proper lt proper lt proper lt proper lt proper lt proper 5 Windo datasou lt proper lt proper lt proper lt proper lt proper lt proper lt proper lt top obj gt Cy CY CY CY CY CY CY CY CY Cy CY Cy CY CY CY CY CY CY Cy CY Cy Cy CY CY CY CY Cy CY CY Cy CY CY Ae ght 5 observations c380ae79 2d36 45fc a
79. ession that identifies one or more vFoglight adapters agentid agent_ID Identifies an instance of a vFoglight agent that is to be stopped all None Indicates that all agent instances should be datacollection deletable force host name true or false true or false None host_name agent_name 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 vF oglight 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 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 Exa
80. ey key_name encpwd pwd_str key_name getapptkn key_name key_pwd Options Option addappkey chmstkey delappkey encpwd getapptkn Arguments Argument key_name key_pwd key_text new_key old_key pwd_str Example Managing the vF oglight Management Server 51 Managing Passwords 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 Description Specifies the name of the application key Specifies the password that protects the key Specifies the key value Specifies the new key value Specifies the old key value Specifies the password value that is to be encrypted C Vizioncore vFoglight bin gt keyman addappkey my_key my_key text my_key pwd KeyToken 3 3d72d81b195 9bdf32416357b57e97aab3b199 52 vF oglight Command Line Reference Guide O 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
81. f 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 lt vfoglight_home gt config remote_monitor config file under the server url1s 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 e Start or stop the Remote Monitor e Install and start the Remote Monitor as a Windows service e Stop and remove the Remote Monitor Windows service e Configure Java Virtual Machine JVM options and add entries to the Remote Monitor classpath e Assign different names to different Remote Monitor process launchers e 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 v version Managing the vFoglight Management Server 45 Running th
82. following sections Using the Command Line for Administration TaSKS c scssssssssessssessesssssssssssssessssrsssrssssssssssnses 54 Logaitg Mand Setting Me Scone iach dtd aaa 70 Petia Me PQS a oss attend aaa a aea e a at 72 Managing CAVA GES nieces G eaaa aeaa enian EE EE EANA EETAS TaN A 128 Managing Security EMINES saint cant inindin ain aai i ai 135 Managing vFoglight LICENSES csssssssessssessesssssssssssssssssesessssssessssssrsssnsesssnessseerssseasessansessenees 142 Running COTA COMMANDS cess ces ascssscesisssssciend sassseiissaseceicedsssassseessicai aresrvevaatsasvsavusaseuantstsvaiiees 145 54 vF oglight Command Line Reference Guide Using the Command Line for Administration Tasks This section describes the following concepts e Understanding the Command Line Structure on page 54 e About Regular Expressions on page 56 e Getting Started with Administrative Commands on page 64 e Running Administrative Commands Example on page 65 e 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 e fgicmd 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
83. g Started with Administrative Commands on page 64 34 vF oglight Command Line Reference Guide 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 COMMANAS uo eects eeseesnsenteetessseateeteritseneaneenieeeeey 36 Running the vF oglight Management Servel ssssssssesssssssssssessessrsssssrssssssssseserssserssseeersseees 37 Starting Stopping or Upgrading the Database esessestseseesnsesestssseaeenmrisnesnseaeeees 47 Managing PASSWOMKS icenian aenea EEN 49 36 vF oglight 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 lt vfoglight_home gt tool
84. gent instances deactivate Deactivates one or more vFoglight agents delete Deletes one or more vFoglight agent instances deploy Deploys one or more vFoglight agent packages getlog Retrieves a copy of an agent log file list Shows a list of vFoglight agent instances logs Shows a list of agent log files packages Shows a list of available agent packages setschedule Assigns a blackout schedule to one or more vFoglight agent instances showschedule Shows the blackout schedule assigned to one or more vFoglight agent instances start Starts the data collection for one or more vFoglight agent instances stop Stops the data collection for one or more vFoglight agent instances types Shows a list of vFoglight agent types sorted by client ID About the Command Line Interface 31 Looking at vFoglight Commands Actrinistrative Interface continued Donsin i disable Deactivates a vFoglight cartridge enable Activates an installed vFoglight cartridge l 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 role from a group creategroup Creates a group i createuser Creates a user deletegroup Deletes a group deleteuser Deletes a user import Installs a vFoglight license list Shows a list of installed vFoglight
85. ght 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 deactivate 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 start on page 108 Scope agent 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 activatable force nowait Options and arguments Managing Cartridges and Metrics 113 Managing Agents true false active true false regex 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 adapter adapter_ID An explicit text string or a regular expr
86. ging Cartridges and Metrics 151 Running Utility Commands Exporting Metrics and Topology This section describes the following commands e metricexport on page 151 e topologyexport on page 154 metricexport The met ricexport 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 util Syntax fglemd connection_options cmd util metricexport output_format xml csv metric_query metric_query f file path 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 or CSV as the file extension depending on the setting of the output_format option 152 vF oglight Command Line Reference Guide Option Argument Description metric_query metric_query Contains the metric query Typically a metric query specifies topology and object names
87. glight Management Server in stand alone mode 38 fms 38 S schedule list 159 script run 162 security assigngroup 135 security assignrole 139 security creategroup 140 security createuser 137 security deletegroup 141 security deleteuser 138 setting blackout schedules agent setschedule 124 shutdownDB 47 spid 167 starting embedded database 47 runDB 47 starting or stopping data collection 108 agent start 108 agent stop 112 starting or stopping vFoglight Client 167 spid 167 stopping embedded database 47 shutdownDB 47 suite 9 support bundle 162 syntax conventions 28 166 180 vF oglight 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 utienv 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 fmsha 41 foglight_db_upgrade 48 getting started 36 keyman 49 remotemonitor 44 runDB 47 shutdownDB 47 vfoglight_db upgrade 48
88. glight 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 fglcma see enable on page 132 Scope cartridge Syntax fglemd connection_options cmd cartridge disable n name v version Options and arguments Option Argument Description n name Specifies the name of the cartridge that is to be disabled v version Specifies the version of the cartridge that is to be disabled Example C Vizioncore vFoglight bin gt 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 e install on page 128 132 vF oglight Command Line Reference Guide e uninstall on page 129 e enable on page 132 e 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 For information on how to install a cartridge using the fglcmd interface see install
89. hat 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 vF oglight 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 gt fglemd 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 e logs on p
90. hat 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 datacollection deletable host name namespace regex true or false true or false host_name agent_name agent_namespace None listed Indicates whether to list vFoglight agent instances for which the data collection is true or is not enabled false 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 An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances that are to be listed An explicit text string or a regular expression that specifies the name of one or more vFoglight agent instances in the specified name space 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 71 Managing Agents 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 t
91. he 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 e OSCartridge ApacheS vr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e 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 oSCart ridge prefix for example AppMonitor instead of OSCartridge AppMonitor result in an error Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight 78 vF oglight 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
92. hen 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 2 Or 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 lt X X X 60 vF oglight Command Line Reference Guide Syntax n fn or fn n fn P or n n m n m or fhm NM Q 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
93. hich 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 81 Managing Agents 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 packageversion version An explicit text string or a regular expression that specifies one or more package versions regex None Interprets the architecture build_ID 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 Example on page 74 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
94. hould be listed 74 vF oglight Command Line Reference Guide Option clientbuild clientid clientname clientversion host regex upgradable Example Argument build_ID client_ID display_name version host_name None true or false 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 instances 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 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 Indicates whether one or more vFoglight Agent Manager instances can true or cannot be upgraded false It can be set to a regular expression C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd agent clients host corp regex Client ID
95. ies value gt name ipAddresses value gt name interfaces value gt name running value gt name detail value gt name agents value gt lt top objects gt Managing Cartridges and Metrics 157 Running Utility Commands Looking Up Server Parameters env The env command shows the values of server configuration parameters The parameters are specified in lt vfoglight_home gt config foglight config You can output the values of all configuration parameters or use an option to specify a single parameter Scope util Syntax fglemd connection_options cmd util env n parameter_name Options and arguments Option Argument Description n 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 gt fglemd 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 vF oglight Command Line Reference Guide assign one or more t
96. ight bin gt 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 e shutdownDB on page 47 e foglight_db_upgrade on page 48 Stopping the Embedded Database shutdownDB The shutdownDB command stops the embedded database 48 vF oglight Command Line Reference Guide Syntax shutdownDB Options and arguments None Example C Vizioncore vFoglight bin gt 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 e runDB on page 47 e 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 gt foglight_db_upgrade Managing the vF oglight Management Server 49 Managing Passwords 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
97. iia a O RAN OER N RRNA 49 Managing Cartridges and Metrics sssssssssnsnsnsnsnsssnnnnnnnnnnnnnnnnonanannnnnnnnnnnnnnnnnnnnnnnnonannnnnnnnnnnnnnnnnnonananannnnnnnnnnnnnnnnn nnana 53 Using the Command Line for Administration TaSkS ssssesssssessssssessssssessessecsessecssesssssssssusssssssesneesssssssusesneesseaneesess 54 Understanding the Command Line Structure 54 About Regular Expressions irmi aa mated 56 Getting Started with Administrative COMMANAS ssssssesecsesseessesseessecssessesssesssesssssseessseseesneesneesnesneesiesneesiesneesees 64 Running Administrative Commands EXAMple scssessessesssssssssseesessesessesseesessesssessscssessecssssssesneessssneeseeaneesnes 65 Looking at Scope Specific COMMANAS eesseestecssecsstesssecsstessteeestecsneesuteesueesseeseesuessteesieesnessiteestesnteerinesnaessaees 66 Listing Administrative Commands wu ssscsssssecsesssessesssessssssesssssssssssesneeseesneessesscsessesssessscssesssssssssssesneessesneesnss 69 Listing Agent and Agent Manager Instances O AE AE dabandyauieda dain tidied T E E doe iaa idk teens Activating or Deactivating Agent Instances acia tintaina ina a a a a A Ae OAN 99 ATAN EEE E AEE AE AEA E E te 104 Starting or Stopping Data Collection siei escecsessssssecstesstesssesteesseesneessesseesueseesseesnessineesseseeseesneeseneeseaesnss 108 Table of Contents 5 Listing and Setting Blackout Schedules ceesesseestessteesstesstessteessessteesstessuesseeeseesness
98. ing the fglcmd interface see deploy on page 86 for information on how to delete agent instances see delete on page 95 92 vF oglight Command Line Reference Guide Scope agent Syntax fglemd 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 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 clientname 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 clientversion version An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version force None In cases where multiple agents are selected it indicates that all selected agents should be created host host_name An explicit text string or a regular expression that specifie
99. isplays the version number copyright build number and the installation directory 40 vF oglight 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 r remove service None Stops and removes the vFoglight Management Server Windows service Examples Displaying version information C Vizioncore vFoglight bin gt 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 gt 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 vF oglight Management Server 41 Running the vFoglight Management Server Stopping the server running in stand alone mod
100. issiisiissnssnissstssnnssnnesy 166 VEOGlight Client COMMANGS sais ia decsasteiascviedadi ave ad hdiesdeiiediadienl Madaid dilintedaaananediia Aa 166 Getting Started with vFoglight Client COMMANAS sssssssesessesssesseessessesssssssssssssneessesneessessesnesssessessesssessesssesees 166 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 BO o Sec tescscihcc dees cxsrsdedecsnsindsteivisiesnilotertatraaadecateatisi anita idtraiiensaleteanaiiasts 8 About Mig GUE ss onset dicta naitnenidininiaandnitiad diario dee a aaa 8 Wroglight Documentation SURE iiini aniiguiienies 9 TOR CONOS e cia ie catenin nha el Rainn E E elaine ll About VENCE Mrenea a A a a vintners catbevatteds 11 8 vF oglight 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
101. le name use ZIP as the file extension m module_name Specifies the name of the UI module 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 gt fglemd 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 vF oglight Command Line Reference Guide See also e uiimport on page 150 e 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 Scope util Syntax fglcmd connection_options cmd util uiimport f file_path Options and arguments Option Argument Description f file_path Specifies the path and name of the ZIP file containing the UI module that is to be imported Example C Vizioncore vFoglight bin gt fglemd 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 e uiexport on page 149 e uilist on page 147 Mana
102. 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 fglcmad interface see import on page 142 Scope license Syntax fglemd connection_options cmd license remove serial serial_number Options and arguments Option Argument Description serial serial_number Specifies the serial number of the license file that is to be removed Managing Cartridges and Metrics 145 Running Utility Commands Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd license remove serial 123 4567890 Note If successful this command does not generate any output See also e import on page 142 e list on page 143 Running Utility Commands This section describes the following tasks e Exporting or Importing a Monitoring Policy on page 145 e Exporting Importing or Listing UI Modules on page 147 e Exporting Metrics and Topology on page 151 e Looking Up Server Parameters on page 157 e Assigning Blackouts on page 157 e Listing Schedules on page 159 e Running
103. licenses remove Removes a vFoglight license using the license serial number Command Line Reference Guide 32 vF oglight i 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 j env Outputs the values of server configuration parameters q metricexport Exports metric observations to a file using a 2 metric query 4 i list Shows a list of all vFoglight schedules l run Runs a script topologyexport Exports the value of one or more properties of a topology object to an XML file uiexport Exports a UI module into a ZIP file uiimport Imports a UI module from a ZIP file uilist 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 33 Getting Started with vFoglight Commands e vFoglight Management Server e vFoglight Cartridge For complete information on installing the above components see the Installation and Setup Guide 2 Obtain your vFog
104. light 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 For example on most Windows systems JRE 6 is located under C Program Files Java jre1 6 0_02 4 Start the vFoglight Management Server For example on Windows platforms you can start the vFoglight Management Server by choosing Start gt Programs gt Vizioncore gt vFoglight 5 2 4 gt Start vFoglight 5 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 lt vfoglight_home gt ogs ManagementServer_date_time_file_ID log Where e date and time are the date and time the vFoglight Management Server was started e file_ID identifies the log file For information about vfoglight_home see About Syntax Conventions on page 28 b 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 e Gettin
105. ll free 1 800 387 5757 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 Cayman Islands E Mail Address Technical Support Customer Service Sales la techsupport dell com 1 877 262 5415 Chile Santiago Country Code 56 City Code 2 Web Address E Mail Address Sales and Customer Support www dell com cl la techsupport dell com toll free 1230 020 4823 China Xiamen Country Code 86 City Code 592 Technical Support Web Address Technical Support E Mail Address Customer Service E Mail Address Technical Support Fax supp support del customer ort dell com cn com cn email cn dell com 592 818 14350 Technical Support Dimension and Inspiron toll free 800 858 2969 Technical Support OptiPlex Lattitude and Dell toll free 800 858 0950 Precision Technical Support Servers and Storage toll free 800 858 0960 Technical Support Projectors PDAs Switches toll free 800 858 2920 Routers etc Technical Support Printers toll free 800 858 2311 Customer Service toll free 800 858 2060 Customer Service Fax 592 818 1308 Home and Small Business toll free 800 858 2222 Preferred Accounts Division toll free 800 858 2557 Large Corporate Accounts GCP toll free 800 858 2055 Large Corporate Accounts Key Accounts toll free 800 858 2628 Large Corporate Accounts North toll free 800 858 2999 Large Corporate Acco
106. ll 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 Web Address E mail Address Technical Support Customer Service Sales www dell com vi la techsupport dell com toll free 1 877 702 4360 Venezuela Web Address E mail Address Technical Support Customer Service Sales www dell com ve la techsupport dell com 0800 100 4752 O 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 About Syntax Convenio ieii eTa EEN E REE 28 L oking atyF ogight C omma cso 28 Getting Started with vF oglight COMMANAS sssscesssscessessesse
107. 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 e Understanding the Command Line Structure on page 54 e Getting Started with Administrative Commands on page 64 e Running Administrative Commands Example on page 65 e Looking at Scope Specific Commands on page 66 64 vF oglight 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 If you want to use the fglcmd interface on a remote computer in your monitoring network complete the following steps a Copy the lt vfoglight_home gt tools fglcmd zip file from the computer that has a running instance of the vFoglight Management Server to the remote computer where vf
108. lowing items e Pathnames file names and programs e The names of other documents referenced in this guide 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 vF oglight 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 13 AboutVizioncore 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
109. lustration 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 gt fglemd usr foglight pwd foglight 108 vF oglight Command Line Reference Guide cmd agent deactivate agentid 14 Note If successful this command does not generate any output See also e deploy on page 86 e create on page 91 e delete on page 95 e activate on page 99 e start on page 108 e stop on page 112 Starting or Stopping Data Collection This section describes the following commands e start on page 108 e stop on page 112 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
110. mple on page 74 Managing Cartridges and Metrics 115 Managing Agents 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 For example e OSCartridge ApacheS vr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e 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 gt fglemd usr foglight pwd f
111. n 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 11 TextC onventions 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 Code Description Monospace text represents code code objects and command line input This includes e Java language source code and examples of file contents e Classes objects methods properties constants and events e HTML documents tags and attributes Variables Monospace plus italic text represents variable code or command line objects that are replaced by an actual value or parameter Interface 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 fol
112. n name process_name p classpath classpath q stop None S start None j jvm argument JVM_options q stop i install service p classpath classpath t thread dump Description Runs the vFoglight Client in debug mode You can set debug_level to one of the following values e 1 No debugging e 2 Minimal debugging e 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 gt debug2 log 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 Client vFoglight uses process names to distinguish between different instances of the same process launcher Adds entries to the JVM classpath Stops the running vFoglight Client process Starts the vFoglight Client Appendix Command Line Interface to the vF oglight Client 169 vFoglight Client Commands Option Argument Description 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 w wait None When sending a shutdown command to an existing vFoglight Client process this option i
113. ng the vFoglight Management Server on page 37 e Starting Stopping or Upgrading the Database on page 47 e Managing Passwords on page 49 Running the vFoglight Management Server This section describes the following tasks e Running the Server in Stand Alone Mode on page 38 e Running the vFoglight Management Server in High Availability Mode on page 41 38 vF oglight 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 e Start or stop the vFoglight Management Server in stand alone mode e Install and start the vFoglight Management Server in stand alone mode as a Windows service e Stop and remove a vFoglight Management Server Windows service e Configure Java Virtual Machine JVM options and add entries to the vFoglight classpath e Assign different names to different vFoglight Management Server process launchers e 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 no
114. nical 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 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 98 1 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 Korea Seoul International Access Web Address Technical Support Customer Service Technical Support Dimension PDA Electronics Support ap dell com toll free 080 200 3800 toll free 080 200 3801 Code 001 Country Code 82 and Accessories City Code 2
115. ns scripts run Runs a script security Manages assigngroup Adds or removes a user from a group users and groups assignrole Adds or removes a role from a group creategroup Creates a group createuser Creates a user deletegroup Deletes a group deleteuser Deletes a user support Creates bundle Generates a support bundle file support bundles Managing Cartridges and Metrics 69 Using the Command Line for Administration Tasks Scope Command Name Description Name Description topology Assigns blackoutobject Assigns a blackout schedule blackout schedules util Contains configexport Exports the monitoring policy to an XML file utility commands 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 Exports the value of one or more properties of a topology object to an XML file uiexport Exports a UI module into a ZIP file uiimport Imports a UI module from a ZIP file uilist 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 page 64 This procedure continues from Getting Started with Administrative Commands on e At the command promp
116. nstructs the command to wait indefinitely for the process to exit before shutting it down b start service None Starts the vFoglight Client Windows service i install service None Installs the vFoglight Client as a Windows service r remove None Stops and removes the vFoglight Client service Windows service Examples Displaying version information C Vizioncore vFoglight_SPID spid 5 2 4 bin gt 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 gt 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 vF oglight Command Line Reference Guide Vizioncore vFoglight_SPID spid 5 1 1 deploy Vizioncore vFoglight_SPID spid 5 1 0 deploy Vizioncore vFoglight_SPID spid 5 0 5 deploy Vizioncore vFoglight_SPID spid 5 0 0 deploy OGO QQG 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
117. o Simameni a aie 28 Looking atvFoglight Commands wits sce seeaiediatid Adca hiiei A ibaa ira aR 28 Getting Started with vFoglight COMMANAS ssssscsessssessessesnsssessecssessecssesssssssssussssssssesssesssssesneesnssneesnssneesnesseesessseetees 32 Managing the vFoglight Management Server sssssssssssssssssssssssssssssscssssscsossacscsosssesaceacsoceaessseaeeeceaceeseseeanaaeeteas 35 Getting Started with Server Commands cescssecstecstssseessteesseesueestessieesneeseesseesnessiteeseesneesneeseessteeaneesnesseneanesnaes Running the vF oglight Management Server Running the Server in Stand Alone Mode ISa Meted edie age Noaack R Wiad adn kana T A A Running the vF oglight Management Server in High Availability Mode TMSNasvcdetesb treat aitersitn aed sect ecd dee T A bewuceaia A A iad ana ieds 41 remo Emon Oedi aa a aaa a a a a a ATA 44 Starting Stopping or Upgrading the Database 47 Starting the Embedded Database 4 vF oglight Command Line Reference Guide Stopping the Embedded Database oc essecsstecsscssecsstessesnsesssssseesuesseesusesneesieesnsessteeseesnsessnssusesnseesissnaessas 47 SHU OWNDB icc5 stared hau sad hata deh iii i aad Oa dea ae des 47 Uporading the Database minnanna cit iten aiiadunn cian tuna EE aA OREN aeta AREA 48 foglight_db_upgrade 48 Managing Passwords iiaccss cia eanauhiebinianasteaia dase hahinnina dan a N a a 49 Managing Encryption KEYS iinan ah AA AAAA AAS agai AAAA LiTTLE SAAE esas Ea AAE 49 Keyman
118. oglight 116 vF oglight Command Line Reference Guide cmd agent stop agentid 15 Note If successful this command does not generate any output See also e deploy on page 86 e create on page 91 e delete on page 95 e activate on page 99 e deactivate on page 104 e start on page 108 Listing and Retrieving Log Files This section describes the following commands e logs on page 116 e getlog on page 118 logs The logs command shows a list of agent log files For information on how to retrieve a log file using the g1cmd interface see getlog on page 118 Scope agent 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 Options and arguments Option allclients clientbuild clientid clientname clientversion force host regex upgradable Argument None build_ID client_ID display_name version None host_name None true or false Managing Cartridges and Metrics 117 Managing Agents 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 exp
119. oglight agent instances For information on how to get a list of blackout schedules assigned to agent instances files using the g1cmd interface see showschedule on page 120 Scope agent 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 Options and arguments Managing Cartridges and Metrics 125 Managing Agents 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 agentid agent_ID Identifies an instance of a vFoglight agent whose blackout schedule is to be set all None Indicates that all agent instances should be datacollection deletable force host name namespace true or false true or false None host_name agent_name agent_namespace selected Indicates whether to select vFoglight agent instances that are true or are not collecting data false
120. oglight_home refers to the installation directory of the vFoglight Management Server b Extract the contents of the fglcmd zip file to the remote computer Specify the directory that contains the vFoglight Management Server commands either lt vfoglight_home gt bin or the directory on the remote computer see step 1 by completing one of the following steps e If you want to use the command prompt open a Command Prompt window and navigate to the appropriate directory or e 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 e Logging In and Setting the Scope on page 70 e Managing Agents on page 72 e Managing Cartridges on page 128 e Managing vFoglight Licenses on page 142 Managing Cartridges and Metrics 65 Using the Command Line for Administration Tasks e Running Utility Commands on page 145 See also e Understanding the Command Line Structure on page 54 e About Regular Expressions on page 56 e Running Administrative Commands Example on page 65 e Looking at Scope Specific Commands on page 66 e Listing Administrative Commands on page 69 Running
121. ommand does not generate any output See also e assignrole on page 139 e creategroup on page 140 Managing vFoglight Licenses Adding Removing or Listing Licenses This section describes the following commands e import on page 142 e list on page 143 e remove on page 144 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 143 Managing vFoglight Licenses Scope license Syntax fglcmd connection_options cmd license import lt f file_path gt 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 gt fglemd usr foglight pwd foglight cmd license import f license foglight license Note If successful this command does not generate any output See also e remove on page 144 e list on page 143 list The list command generates a list of installed vFoglight licenses Scope license Syntax fglcmd connection_options cmd license list Options and arguments None 144 vF oglight Command Line Reference Guide Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd
122. onitoring environment that uses the vFoglight Agent Manager see deploy on page 86 174 vF oglight Command Line Reference Guide list C Vizioncore vFoglight bin gt fglemd 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 Agentl Type NetMonitor Adapter ID SPI Status Not active Host tor014004 prod quest corp ID 16 Name tor014004 prod quest corp 0 ApacheSvr ApacheSvr Agent1l Type ApacheSvr Adapter ID SPI Status Not active Host tor014004 prod quest corp ID 17 Name tor014004 prod quest corp 0 SNMP SNMP Agent 1 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 gt fglemd 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 OosSCartridge 5 2 4 logs ApacheSvr_Agent1_3 20 09 10 02_165710_001 log OSCartridge 5 02_165515_001 OSCartridge 5 02_165517_001 OSCartridge 5 02_165512_001 OSCartridge 5 OSCa
123. opology 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 topology Syntax fglemd connection_options cmd topology blackoutobject object object_ID query query schedule schedule_ID schedulename schedule_name remove Options and arguments Option Argument Description object object_ID Identifies the topology object query query 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 remove None Indicates that the specified schedule should be removed from one or more specified objects schedule schedule_ID Identifies the blackout schedule To find out the ID for a schedule use the list command For more information see list on page 159 schedulename schedule_name Specifies the schedule name Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight Managing Cartridges and
124. page 99 respectively Stopping the vFoglight Client C Vizioncore vFoglight_SPID spid 5 2 4 bin gt 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 lt vfoglight_client_home gt 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 gt support_bundle A subdirectory or file C Vizioncore vFoglight_SPID spid 5 2 4 support already exists Appendix Command Line Interface to the vF oglight Client 171 vFoglight Management Server Commands Collecting log files in C Vizioncore vFoglight_SPID spid 5 2 4 support Tue 10 23 3 20 09T13 07 36 s97 C Vizioncore vFoglight_SPID spid 5 2 4 support Tue 10 23 3
125. pport Customer Service Sales www dell com dm la techsupport dell com toll free 1 866 278 6821 Dominican Republic Web Address E Mail Address Technical Support Customer Service Sales www dell com do la techsupport dell com 1 800 156 1588 Ecuador Web Address www dell com ec E Mail Address la techsupport dell com Technical Support Customer Service Sales Calling from Quito toll free 999 119 877 655 3355 Technical Support Customer Service Sales Calling from Guayaquil toll free 1800 999 119 877 655 3355 EI Salvador Web Address www dell com sv E Mail Address la techsupport dell com Technical Support Customer Service Sales 800 6132 Finland Helsinki International Access Web Address E Mail Address Technical Support support euro dell com fi_support dell com 0207 533 555 Code 990 Customer Service 0207 533 538 Country Code 358 City Code 9 Switchboard 0207 533 533 Sales under 500 employees 0207 533 540 Fax 0207 533 530 Sales over 500 employees 0207 533 533 Fax 0207 533 530 France Paris Web Address Support euro dell com Montpellier Home and Small Business International Access Technical Support 0825 387 270 Code 00 Customer Service 0825 832 833 Country Code 33 Switchboard 0825 004 700 City Codes 1 4 Switchboard calls from outside of France Sales Fax Fax calls from outside of France Corporate 04 99 75 40 00 0825 004 700 0825 004
126. ption Argument Description groupname 9 groupname Specifies the name of the group to which the role is to be added or removed remove None Indicates that the role should be removed from the group rolename rolename Specifies the name of the role that is to be added or removed from the group 140 vF oglight Command Line Reference Guide Example Adding a role to a group C Vizioncore vFoglight bin gt fglemd 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 gt 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 e creategroup on page 140 e deletegroup on page 141 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 see page 139 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 fglemd connection options see Logging In and Setting the Scope on page 70 For complete information about users roles and groups in vFoglight
127. r 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 Commands on page 64 For more information about the lt vfoglight_home gt see About Syntax Conventions on page 28 The following table lists vFoglight commands About the Command Line Interface 29 Looking at vFoglight Commands VFoglight Management Server Donsin i 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 Aathentication runDB Starts the embedded database shutdownDB Stops the embedded database keyman Provides an interface that lets you change add or delete encryption keys or generate application tokens Command Line Reference Guide 30 vF oglight Adininistrative Interface Donin i 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 a
128. rations 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 a7619930 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 elcl6c0fdbb5 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 4f 5 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 161 Running Utility Commands ID 1 698670 f5e1 449e 94ba 942a76795602
129. rch architecture An explicit text string or a regular expression that specifies the platform architecture 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 clientname 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 80 vF oglight 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 w
130. re 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 vF oglight Command Line Reference Guide Option Argument packageosversion pkg_OS_version packageversion version regex None test None upgradable true or false Example 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 Example on page 74 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 C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd agent deploy host tor012991 prod quest corp clientid tor012991 prod quest corp cf
131. re 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 e getlog on page 118 getlog The get log 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 g1cmd interface see logs on page 116 Scope agent Syntax fglemd 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 Options and arguments 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 Managing Cartridges and Metrics 119 Managing Agents 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 t
132. ression 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 An explicit text string or a regular expression that selects one or more vFoglight Agent Manager instances with the specified version 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 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 vF oglight Command Line Reference Guide Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd agent logs clientid tor012991 prod quest corp cf238d96 3a56 45d6 a33e b88bb7d4ff55 Client ID tor012991 prod quest corp 32b1 c51d 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 Vizionco
133. ron 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 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 India Dell Support Website Portable and Desktop Support Desktop Support E mail Address Portable Support E mail Address Phone Numbers Server Support E mail Address Phone Numbers Gold Support Only E mail Address Phone Numbers Customer Service Home and Small Business Large Corporate Accounts Sales Large Corporate Accounts Home and Small Business support ap dell com india support _desktop dell com india support notebook dell com 080 25068032 or 080 25068034 or your city STD code 60003355 or toll free 1 800 425 8045 india support Server dell com 080 25068032 or 080 25068034 or your city STD code 60003355 or toll free 1 800 425 8045 eec_ap dell com 080 25068033 or your city STD code 60003355 or toll free 1 800 425 9045 India care HSB dell com toll free 1800 4254051 India care REL dell com toll free 1800 4252067 1600 33 8044 1600 33 8046 Ireland Cherrywood Web Address International
134. rtridge 5 02_165518_001 OSCartridge 5 02_165524_001 OSCartridge 5 02_165513_001 spid 5 2 4 logs spid_3 20 09 10 02_164836_001 spid 5 2 4 logs spid_3 20 09 10 02_165922_001 spid 5 2 4 logs spid_3 20 09 10 05_151601_001 spid 5 2 4 logs spid_3 20 09 10 09_100928_001 Appendix Command Line Interface to the vF oglight Client 175 Administrative Commands 2 4 logs AppMonitor_Agent1_3 20 09 10 log 2 4 logs LogFilter_Agent1_3 20 09 10 log 2 4 logs NetMonitor_Agent1_3 20 09 10 log 2 4 logs SNMP_Agent1_3 20 09 10 02_165736_001 log 2 4 logs TerminalServer_Agent1_3 20 09 10 log 2 4 logs WebMonitor_Agent1_3 20 09 10 log 2 4 logs Windows_System_Agent1_3 20 09 10 log log log stog 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 gt fglemd usr foglight pwd foglight cmd agent packages allclients C Vizioncore vFoglight bin gt 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 WindowsxXP 5 2 4 OSCartridge Agent WindowsXP windows 5 1 ia32 x86_64 Agent Agent Agent Agent Agent Package Package Package Package Package OSCartridge WindowsxXP 5
135. rtridges 130 cartridge disable 131 cartridge enable 132 exporting metrics and topology 151 util metricexport 151 util topologyexport 154 exporting or importing monitoring policies 145 util configexport 145 util configimport 146 exporting importing or listing UI modules 147 util uiexport 149 util uiimport 150 util uilist 147 F fgicmd 70 fms 38 fmsha 41 G getting started administrative commands 64 command line interface 32 vFoglight Management Server commands 36 l installing or uninstalling cartridges 128 cartridge install 128 cartridge uninstall 129 K keyman 49 L license import 142 license list 143 license remove 144 listing agents 73 listing agents and clients agent clients 73 agentilist 75 agentipackages 78 agent types 82 listing and retrieving logs 116 agent getlog 118 agentilogs 116 listing blackout schedules agent showschedule 120 listing cartridges 133 cartridge list 133 listing schedules 159 schedule list 159 logging in 70 fglcmd 70 looking up server parameters 157 util env 157 M managing encryption keys keyman 49 managing groups 139 security assignrole 139 security creategroup 140 security deletegroup 141 managing users 135 security assigngroup 135 security createuser 137 security deleteuser 138 Index 179 R remotemonitor 44 runDB 47 running scripts 162 script run 162 running vFoglight Management Server in HA mode 41 fmsha 41 remotemonitor 44 running vFo
136. s 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 Remote Monitor utility from that computer as described in To get started with vFoglight Management Server commands on page 36 For information about 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
137. s one or more host names Managing Cartridges and Metrics 93 Managing Agents 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 94 vF oglight 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 For example e OSCartridge ApacheS vr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e 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 O
138. ssrssesssssssnsssssnsersssserssseessseeerseeees 32 28 vF oglight 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 e lt vfoglight_home gt is a placeholder that represents the path to the vFoglight Management Server installation e 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 e lt vfoglight_home gt 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 Management Server on page 35 and Managing Cartridges and Metrics on page 53 e lt vfoglight_home gt 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 remotemonito
139. started instructions that show you how to configure your environment Use this chapter to find reference information about the fglemd 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 9 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 e Online Help You can open the online help by selecting the Help tab from vFoglight s action panel B foot Sip ut Wekome to Foghgt 5 2 4 ser Conde hdirinistr ation and Configuration Guide Command Line Reference Guide Web Component Guide Web Component Tutorial AILI Web Component Reference e 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
140. steesseesnaessieesneesnaeeeseesnseseas 120 SHOWSCHECUIE sihisiedrsviviremienuh anaemia an aaa a aan 120 AE I AEEA EETA ATEOA AAEE 124 Managing Cartridges seken a A A Mec ee RA 128 lstalling or Uninstalling Garnridde Sintimu aana a aa a i 128 install uninstall Enabling or Disabling Cartridges disable Managing Security Entities Managing U Selsam a aaia edie an ee Sal assigngroup createuser deleteUS Tiisin inaani i aii ia Managing Groups O E E E E E E E caviar creategroup deletegroup Managing VEOOlONELICENSE Stiaan na a aaa a Adding Removing or Listing Licenses LO AE A E E E E E Running Utility Commands niinn aaia Exporting or Importing a Monitoring Policy configexport configimport 6 vF oglight Command Line Reference Guide Exporting Importing or Listing Ul Modules sssssccrcccccccccrennnnncccccccccnnnnnnninnnnninnii 147 UNIS unien naaa neva eda daiibad da wtahiditietea lan Gdeadanwa basal uiexport uiimport Exporting Metrics and Topology MEICENDE RAE A ANAA A AA AN N ARN Atak ASTD TOpologyeXpolts Aiwkkwani nitian ata a a a a a Looking Up Server Parameters ceccecscsecsesesecsssstesseesteseesesseseceeseseteesseesnessieesnesseeeneesnaesseennesens Assigning Blackouts blackoutobject Appendix Command Line Interface to the VFoglight Client sssssssssssssssssscssssscsscssssscssssecssseesesssesrsssesnsaees 165 About the Command Line Interface cesessnsssssssiissisnissiisniisnssisss
141. t Client To do that complete one of the following steps e If you want to use the command prompt open a Command Prompt window and navigate to the appropriate directory or e 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 Conventions on page 28 Using vFoglight Client Commands This section describes the following commands spid spid on page 167 support_bundle on page 170 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 vF oglight Command Line Reference Guide Syntax spid s start Dquest debug debug_level n name process_name b start service w wait r remove service v version h help Options and arguments Option Argument Dquest debug debug_leve h help None j jvm argument JVM_options
142. t use the following syntax to list vVFoglight commands fglemd connection_options cmd commands For complete information about the fglcmd command syntax see Syntax in fglcmd on page 70 70 vF oglight 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 Activates an agent clients Shows a list of known clients clientupgrade Upgrades a remote client create Creates an instance of an agent deactivate Deactivates an agent For complete information about fglemd see Logging In and Setting the Scope on page 70 See also e Understanding the Command Line Structure on page 54 e Getting Started with Administrative Commands on page 64 e Running Administrative Commands Example on page 65 Logging In and Setting the Scope fglcmd The fgl1cmd 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 Options and arguments Option cmd debug port pwd srv Argument scope None server_port password server_name server_IP_address Managing Cartridges and Metrics 71 Logging In and Set
143. t bin gt fglemd usr foglight pwd foglight cmd util uilist system system system system schemadatasource_typelist foglight_transaction foglight_services_catalystalarmstate ApacheSvrtypes system system system system system system system system system system system system system system system See also core_changes core_ipmap fsmreporting core_mb SNMP NetMonitor WebMonitor Windows_System corereporting fsmcore core_core oshostresources core_log administration_userssecurity fsmapplicationtriage e uiexport on page 149 e uiimport on page 150 Managing Cartridges and Metrics 149 Running Utility Commands 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 util Syntax fglemd connection_options cmd util uiexport m module_name file_path Options and arguments Option Argument Description f file_path Specifies the path and name of the ZIP file that the UI module is to be exported to Note When specifying the fi
144. t specify any options fms uses the default option s and starts an instance of the vFoglight Management Server Options and arguments Options Argument Description h help None Displays a list of arguments and their descriptions Options Dquest debug debug_level j jvm argument n name p classpath q stop s start t thread dump vV version Managing the vFoglight Management Server 39 Running the vFoglight Management Server Argument JVM_options process_name classpath None None None None Description Runs the vFoglight Management Server in debug mode You can set debug_level to one of the following values e 1 No debugging e 2 Minimal debugging e 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 gt debug3 log 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 D
145. t 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 vF oglight 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 nowait None Indicates that the command should not wait for the selected agents to finish processing before starting the selected vFoglight agent instances regex 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 111 Managing Agents 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
146. t3 Type ApacheSvr Version 5 2 4 Build 524 3 20 090625 0500 Namespace SPI Adapter ID Fg1AM 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 gt fglemd usr foglight pwd foglight cmd agent activate agentid 9 Note If successful this command does not generate any output See also e deploy on page 86 e create on page 91 e delete on page 95 e deactivate on page 104 e start on page 108 e stop on page 112 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 105 Managing Agents 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 fg cmd interface see activate on page 99 Scope agent Syntax fglemd connection_options cmd agent deactivate agentid agent_ID name agent_name
147. t_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 vF oglight 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 For example e OSCartridge ApacheS vr e OSCartridge AppMonitor e OSCartridge LogFilter e OSCartridge NetMonitor e OSCartridge SNMP e OSCartridge WebMonitor e 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 oSCart ridge prefix for example AppMonitor ins
148. tead of OSCartridge AppMonitor result in an error Managing Cartridges and Metrics 103 Managing Agents Example The first command in this example shown in Listing agents on page 103 lists agent IDs using the agent 1ist command with the a11 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 gt fglemd 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 Fg1AM 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 Fg1AM Status Not active Host tor012991 prod quest corp ID 12 Name Agenti Type Windows_System Version 5 2 4 Build 524 3 20 090625 0500 Namespace SPI Adapter ID Fg1AM Status Not active Host tor012991 prod quest corp TD 13 Name Agent2 Type NetMonitor Version 5 2 4 Build 524 3 20 090625 0500 104 vF oglight Command Line Reference Guide Namespace SPI Adapter ID Fg1AM Status Not active Host tor012991 prod quest corp ID 16 Name Agen
149. tents 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 Introduction to this Guide sssssssssssssccsscessoessocesscesecesscoesecesncesecesaceeacessceesoeeseesecesnceeacesaieesacesueeeseesoeesniesereeniieegy 7 ADOUEVFOOIQNE sects terriers catia anid iain hints Melia Gaaaaniid Sein A hime Monae dd aaa 8 About this Guide niinniin naana a a ai 8 VF oglight Documentation Suite sesssesseessesssessnesssssssessesssesuessessessuessecsscssssssscsssssscsusesnssssesnesnseseesneeseesnesseessesseessesssessessss Core Documentation Set 4 Cartridge Documentation Sets Feedback ori the Documentations icrai a ita iaa aa 10 TOXECONVENUONS anna a a unit tendered anata diaeh tin ania a 11 About Vizioncore SING scisuscsec es cases acecdsncisdares cistivs coateastichesencvaherundinsiua Acbiaas ARREO iia 11 Contacting Dellic isiss ni cncvadatedaeiintiaed dota Madea aia nadia nda ad iia tia 14 About the Command Line Interface ssssssssssssssssssssssecssssesssssescsseescssssocsacsacsoceacsoceaeeocsaeeecesceeseansesessseaceaeeeteaseeseas 27 About Syntax Convent
150. the command e 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 double backslash 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 vF oglight 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 L An OR expression Brackets can be nested Matches one of th
151. 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 For example if you want to run the Remote Monitor on a vFoglight Agent Manager computer extract the remotemonitor zip file to the lt foglight_client_home gt spid 5 2 4 directory 3 Reference the directory that contains the vFoglight Management Server commands either lt vfoglight_home gt bin or lt foglight_client_home gt spid 5 2 4 by completing one of the following steps e Ifyou want to use the command prompt open a Command Prompt window and navigate to lt vfoglight_home gt bin or lt foglight_client_home gt spid 5 2 4 as required or e Ifyou want to use a vFoglight Management Server command in a script ensure that your script references lt vfoglight_home gt bin or lt foglight_client_home gt 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 fglemd 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 e clients on page
152. ting the 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 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 Specifies the server s name Specifies the server s IP address 72 vF oglight 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 fglemd 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 gt fglemd usr foglight pwd foglight cmd agent clients host corp regex Client ID tor012991 prod quest corp 32bl1c51d 6208 435c bdad 2a8916ef3a89 Client Name tor012991 prod quest corp Adapter ID Fg1AM Client Version 5 2 4 524 20080811 0230 Host Name tor012991 prod quest corp OS windows 5 1 ia32 Note For a sample outp
153. unts North Government and toll free 800 858 2955 Education Large Corporate Accounts East toll free 800 858 2020 Large Corporate Accounts East Government and toll free 800 858 2669 Education Large Corporate Accounts Queue Team toll free 800 858 2572 Large Corporate Accounts South toll free 800 858 2355 Large Corporate Accounts West toll free 800 858 2811 Large Corporate Accounts Spare Parts toll free 800 858 2621 Columbia Web Address Wwww dell com co E Mail Address la techsupport dell com Technical Support Customer Service Sales 01 800 915 4755 Costa Rica Web Address www dell com cr E Mail Address Technical Support Customer Service Sales la techsupport dell com 0800 012 0231 Czech Republic Prague Web Address support euro dell com E Mail Address czech _dell dell com International Access Technical 22537 2727 Code 00 echnica Support 53 c i Customer Service 22537 2707 ountry Code 420 ax 22537 2714 Technical Fax 22537 2728 Switchboard 22537 2711 Denmark Copenhagen Web Address Support euro dell com Intemational Acteks Technical Support l 7023 0182 Code 00 Customer Service Relational 7023 0184 Country Code 45 Home Small Business Customer Service 3287 5505 Switchboard Relational 3287 1200 Switchboard Fax Relational 3287 1201 Switchboard Home Small Business 3287 5000 Switchboard Fax Home Small Business 3287 5001 Dominica Web Address E Mail Address Technical Su
154. user 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 fglemd 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 Scope security Syntax fglemd connection_options cmd security createuser username username password password Options and arguments Option Argument Description password password Specifies the password of the user account that is to be created username username Specifies the name of the user account that is to be created Example C Vizioncore vFoglight bin gt fglemd usr foglight pwd foglight cmd security createuser username Demo password Demo123 Note If successful this command does not generate any output See also e assigngroup on page 135 e deleteuser on page 138 138 vF oglight 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 fglemd connection options see Logging In and Setting the Scope on page 70 For
155. ut of this command in a monitoring environment that uses the vFoglight Client see clients on page 173 See also e Understanding the Command Line Structure on page 54 e Looking at Scope Specific Commands on page 66 e Running Administrative Commands Example on page 65 Managing Agents This section describes the following tasks e Listing Agent and Agent Manager Instances on page 73 e Deploying Agent Packages on page 86 e Creating or Deleting Agent Instances on page 91 Managing Cartridges and Metrics 73 Managing Agents e Activating or Deactivating Agent Instances on page 99 e Starting or Stopping Data Collection on page 108 e Listing and Retrieving Log Files on page 116 e Listing and Setting Blackout Schedules on page 120 Listing Agent and Agent Manager Instances This section describes the following commands e clients on page 73 e list on page 75 e packages on page 78 e types on page 82 clients The clients command shows a list of vFoglight Agent Manager instances Scope agent 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 Option Argument Description allclients None Indicates that all instances of the vFoglight Agent Manager s
156. 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 legal quest com 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
157. version Specifies the version to which the selected instances of the vFoglight Agent Manager should be upgraded 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 gt fglemd usr foglight pwd foglight cmd agent clientupgrade list allclients upgradable true Client ID tor012991 prod quest corp 32b1 c51d 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 g1cmd interface see install on Managing Cartridges and Metrics 87 Managing Agents page 128 to find out how to list available agent packages using fglcmd see packages on page 78 Scope agent Syntax fglcmd connection_options cmd agent deploy packageversion version packageid package_ID allpackages allinstallers host host_name clientname display_name
158. 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 deactivate on page 104 96 vF oglight 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 true or cannot be activated false active true or false Indicates whether to delete 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 agentid agent_ID Identifies an instance of a vFoglight agent that is to be deleted all None Indicates that all agent instances should be datacollection deletable force true or false true or false None deleted Indicates whether to delete vFoglight agent

Dell Vizioncore Command Line Reference Guide

Contents

Download Pdf Manuals

Related Search

Related Contents