vFoglight™ 5.2.
© 2008 Quest Software, Inc. ALL RIGHTS RESERVED. This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement.
Table of Contents Introduction to this Guide ...................................................................................................................................9 About vFoglight .............................................................................................................................................................. 10 About this Guide............................................................................................................................................
vFoglight Administration and Configuration Guide Managing Support Bundles ............................................................................................................................................ 75 Accessing the Manage Support Bundles Dashboard ............................................................................................ 76 Creating Server Support Bundles ....................................................................................................................
Table of Contents 5 Accessing the Configure Password Settings Dashboard .....................................................................................136 Editing Password Settings....................................................................................................................................137 Changing Database Credentials ..........................................................................................................................138 Configuring Directory Services..
vFoglight Administration and Configuration Guide Working with Rules ....................................................................................................................................................... 223 Managing Rules ................................................................................................................................................... 225 Creating Rules .......................................................................................................
Table of Contents 7 Creating Retention Policies ..................................................................................................................................388 Example: Addressing Data Storage Concerns.....................................................................................................390 Enabling the Collection of Data with Older Timestamps ...............................................................................................392 Using Schedules ............
vFoglight Administration and Configuration Guide Using the Query Language to Set the Rule or Derived Metric Scope .......................................................................... 474 Setting the Scope for a Rule or Derived Metric.................................................................................................... 474 Using the Query Language in Rule Conditions or Derived Metric Expressions............................................................
Introduction to this Guide This chapter provides information about what is contained in the vFoglight Administration and Configuration Guide. It also provides information about the vFoglight documentation suite and Vizioncore. This chapter contains the following sections: About vFoglight............................................................................................................................10 About this Guide.................................................................................
vFoglight Administration and Configuration Guide About vFoglight vFoglight helps IT organizations understand the virtual infrastructure by managing the relationships and interaction between all the components in the environment, including data centers, data stores, clusters, resource pools, hosts and virtual machines.
Introduction to this Guide About this Guide 11 cartridge-related concepts in vFoglight and to find out how to install and manage cartridges using the Cartridges dashboards. Chapter 5, Managing Agents—Includes conceptual and hands-on information about collection agents and explains their purpose in vFoglight. It contains instructions on how to edit agent properties when required using the Agents dashboards.
vFoglight Administration and Configuration Guide vFoglight Documentation Suite The vFoglight documentation suite is made up of the core documentation set, plus the documentation set for each vFoglight cartridge that you deploy. Documentation is provided in a combination of online help, PDF and HTML. • Online Help: You can open the online help by selecting the Help tab from vFoglight’s action panel.
Introduction to this Guide vFoglight Documentation Suite 13 • Installation and Setup Guide set (all in PDF format): • Installation and Setup Guide—Installing on Windows with an Embedded MySQL Database • Installation and Setup Guide—Installing on Windows with an External MySQL Database • Installation and Setup Guide—Installing on Windows with an External Oracle Database • Administration and Configuration Guide (PDF and online help) • vFoglight User Guide (PDF and online help) • Advanced Configuration Guide
vFoglight Administration and Configuration Guide Text Conventions The following table summarizes how text styles are used in this guide: Convention Description Code Monospace text represents code, code objects, and commandline input.
Introduction to this Guide About Vizioncore Inc.
Contacting Dell Note: If you do not have an active Internet connection, you can find contact information on your purchase invoice, packing slip, bill, or Dell product catalog. Dell provides several online and telephone-based support and service options. Availability varies by country and product, and some services may not be available in your area. To contact Dell for sales, technical support, or customer service issues: 1 Visit http://support.dell.com.
Austria (Vienna) International Access Code: 900 Country Code: 43 City Code: 1 Bahamas Barbados Belgium (Brussels) Bolivia Brazil International Access Code: 00 Country Code: 55 City Code: 51 British Virgin Islands Brunei Country Code: 673 Canada (North York, Ontario) International Access Code: 011 Support.euro.dell.com Web Address Tech_support_central_europe@dell.
Chile (Santiago) Country Code: 56 City Code: 2 China (Xiamen) Web Address E-Mail Address Sales and Customer Support Technical Support Web Address Technical Support E-Mail Address Country Code: 86 Customer Service E-Mail Address City Code: 592 Technical Support Fax Technical Support – Dimension and Inspiron Technical Support – OptiPlex, Lattitude and Dell Precision Technical Support – Servers and Storage Technical Support – Projectors, PDAs, Switches, Routers, etc Technical Support – Printers Customer Ser
Dominican Republic Ecuador El Salvador Finland (Helsinki) International Access Code: 990 Country Code: 358 City Code: 9 France (Paris) (Montpellier) International Access Code: 00 Country Code: 33 City Codes: (1) (4) Web Address E-Mail Address Technical Support, Customer Service, Sales Web Address E-Mail Address Technical Support, Customer Service, Sales (Calling from Quito) Technical Support, Customer Service, Sales (Calling from Guayaquil) Web Address E-Mail Address Technical Support, Customer Servic
Guatemala Guyana Hong Kong International Access Code: 001 Country Code: 852 India Web Address E-Mail Address Technical Support, Customer Service, Sales E-Mail Address Technical Support, Customer Service, Sales Web Address Technical Support E-mail Address Technical Support - Dimension and Inspiron Technical Support - OptiPlex, Latitude, and Dell Precision Technical Support - Servers and Storage Technical Support - Projectors, PDAs, Switches, Routers, etc .
Ireland (Cherrywood) International Access Code: 00 Country Code: 353 City Code: 1 Italy (Milan) International Access Code: 00 Country Code: 39 City Code: 02 Jamaica Web Address Technical Support E-mail Address Business computers Home computers At Home Support Sales Home Small Business Medium Business Large Business E-mail Address Customer Service Home and Small Business Business (greater than 200 employees) General Fax/Sales fax Switchboard U.K. Customer Service (dealing with U.K.
Japan (Kawasaki) International Access Code: 001 Country Code: 81 City Code: 44 Korea (Seoul) International Access Code: 001 Country Code: 82 City Code: 2 Latin America Luxemborg International Access Code: 00 Country Code: 352 Macao Country Code: 83 Web Address Technical Support - Dimension and Inspiron Technical Support outside of Japan - Dimension and Inspiron Technical Support - Dell Precision, OptiPlex, and Latitude Technical Support outside of Japan - Dell Precision, OptiPlex, and Latitude Techni
Malaysia (Penang) International Access Code: 00 Country Code: 60 City Code: 4 Mexico International Access Code: 00 Country Code: 52 Montserrat Netherlands Antilles Netherlands (Amsterdam) International Access Code: 00 Country Code: 31 City Code: 20 New Zealand International Access Code: 00 Country Code: 64 Nicaragua Norway (Lysaker) International Access Code: 00 Country Code: 47 Panama Peru Support.ap.dell.
Poland (Warsaw) International Access Code: 011 Country Code: 48 City Code: 22 Portugal International Access Code: 00 Country Code: 351 Puerto Rico St. Kitts and Nevis St. Lucia St.
Spain (Madrid) International Access Code: 00 Country Code: 34 City Code: 91 Sweden (Upplands Vasby) International Access Code: 00 Country Code: 46 City Code: 8 Switzerland (Geneva) International Access Code: 00 Country Code: 41 City Code: 22 Web Address Home and Small Business Technical Support Customer Service Sales Switchboard Fax Corporate Technical Support Customer Service Switchboard Fax Web Address Technical Support Relational Customer Service Home/Small Business Customer Service Employee Purchas
U.K.(Bracknell) International Access Code: 00 Country Code: 44 City Code: 1344 Uruguay U.S.A.
U.S. Virgin Islands Venezuela Web Address E-mail Address Technical Support, Customer Service, Sales Web Address E-mail Address Technical Support, Customer Service, Sales www.dell.com/vi la‐techsupport@dell.com toll‐free: 1‐877‐702‐4360 www.dell.com/ve la‐techsupport@dell.
1 About the Administration Module The Administration module allows you to manage vFoglight in a way that best implements your business logic. It offers a set of dashboards that allow you to manage vFoglight cartridges, agents, data, rules, and security. This chapter contains the following section: About Models and Scope in vFoglight .........................................................................................30 Getting Started with the Administration Module ......................................
vFoglight Administration and Configuration Guide About Models and Scope in vFoglight A model is a principle for organizing monitoring data that vFoglight gathers from host systems. vFoglight models have a tree-like structure that contains nodes. Each node in the model can have properties, metrics, alarms and other nodes associated with it. vFoglight adds these entities to the nodes in the data model as it collects them. vFoglight can create different types of models. Collection models include raw data.
About the Administration Module About Models and Scope in vFoglight 31 vFoglight makes use of a topology model to describe the logical and physical relationships between data nodes. Hierarchy in topology models provides the context for metrics and properties. vFoglight stores context information only once. The relationship between nodes, metrics, properties, and other nodes propagates the context across multiple data elements. vFoglight stores metrics and properties next to one another.
vFoglight Administration and Configuration Guide Getting Started with the Administration Module Each vFoglight module contains a set of dashboards that you can configure and use to monitor your environment in real time.You can access them from the navigation pane on the left of the display area. Figure 1 The Administration module includes a set of dashboards that allow you to manage agents, cartridges, users, and other entities.
About the Administration Module Getting Started with the Administration Module 33 Node Task See Agents Manage agents and hosts Chapter 5, “Managing Agents” on page 165 Cartridges Manage cartridges and download agent packages Chapter 4, “Managing Cartridges” on page 147 Data Work with topology types, metrics, thresholds, and retention policies Chapter 7, “Working with Data” on page 327 Rules & Notifications Create and manage rules and registry variables Chapter 6, “Working with vFoglight Rule
vFoglight Administration and Configuration Guide 1 Ensure that your vFoglight Management Server is running. For example, on Windows platforms, you can start the vFoglight Management Server by choosing Start > Programs > Vizioncore > vFoglight 5.2.4 > Start vFoglight. For more information, refer to the Installation and Setup Guide. 2 Obtain your vFoglight user name and password.
About the Administration Module Getting Started with the Administration Module 35 5 Provide the user name and password you obtained in step 2. a In the vFoglight login page, in the User box, type your vFoglight user name. b In the Password box, type your vFoglight password. c Click Login.
vFoglight Administration and Configuration Guide Navigation panel Display area Action panel The Welcome page contains the following elements: • Navigation panel shows the dashboards that the current user can access. For more information about users and security in vFoglight, see Chapter 3, “Managing Users and Security”. • Display area contains the current dashboard. When you log into vFoglight the Welcome to vFoglight page appears in the display area.
About the Administration Module Getting Started with the Administration Module 37 Users whose account includes the Administration role Users whose account does not include the Administration role If your user account includes the Administration role, in the Unlicensed Server View, click Install License. In the Manage Licenses dashboard that appears, install the license for the vFoglight Management Server. For instructions on how to add a license, see Chapter 2, “Installing Licenses” on page 70.
vFoglight Administration and Configuration Guide 7 Select a dashboard and look at its contents in the display area. For example, to look at the Cartridge Inventory dashboard that allows you to manage vFoglight cartridges, on the navigation panel, under Dashboards, choose Administration > Cartridges > Cartridge Inventory. The Cartridge Inventory dashboard appears in the display area. You have successfully logged into vFoglight and located the dashboards that are available in the Administration module.
About the Administration Module Viewing the Administration Dashboard 39 Viewing the Administration Dashboard The Administration dashboard contains links to administration dashboards that are grouped in a logical way, along with some high-level information about your environment.
vFoglight Administration and Configuration Guide Entry Dashboard or View Use it to Thresholds Manage Thresholds List, add, edit, or delete thresholds. For more information, see “Managing Thresholds” on page 353. Topology Types Add Topology Type Add topology types. For more information, see “Adding Topology Types” on page 329. Rules and Notifications Registry Variables Manage Registry Variables List, edit, or delete registry variables.
About the Administration Module Viewing the Administration Dashboard Entry 41 Dashboard or View Use it to Manage Schedules List, edit, or delete schedules. For more information, see “Using Schedules” on page 395. Schedules Schedule Management Tooling and Diagnostics Server Log Overview Overview Lists server log entries. Server Performance Overview Overview Contains a series of tabs, each containing a dashboard about the performance of a monitoring component.
vFoglight Administration and Configuration Guide Entry Dashboard or View Use it to Topology Type Add Topology Type Add topology types. For more information, see “Adding Topology Types” on page 329. Derived Metric Create Derived Metric Add derived metrics. For more information, see “Creating Derived Metrics” on page 342. Threshold Create Threshold Add thresholds. For more information, see “Creating Thresholds” on page 361. Registry Variable Create Registry Variable Add registry variables.
About the Administration Module Viewing the Administration Dashboard Entry Dashboard or View Use it to Directory Services Configure Directory Services View or edit directory services. For more information, see “Configuring Directory Services” on page 139. Password Settings Configure Password Services View or edit password settings. For more information, see “Configuring Password Settings” on page 135. 43 • Current Statistics.
vFoglight Administration and Configuration Guide 3 In the Administration dashboard, observe the Navigation view. The Navigation view contains links to Administration dashboards, grouped into task-specific categories. Drill down to another dashboard in the Administration module using a link in the Navigation view. For example, to drill down to the Agent Hosts dashboard, under Explore > Agents, click Properties by Type. The Agent Properties dashboard appears in the display area.
About the Administration Module Viewing the Administration Dashboard 45 To return to the Administration dashboard, click Administration in the breadcrumb trail. 4 In the Administration dashboard, observe the Current Statistics view. The Current Statistic view shows the number of cartridges, rules, and users in your monitoring environment, and shows the version of the vFoglight Management Server and its OS version.
vFoglight Administration and Configuration Guide For complete information about the Cartridge Inventory dashboard, see Chapter 4, “Installing and Managing Cartridges” on page 149. To return to the Administration dashboard, click Administration in the breadcrumb trail. • To find out more about the rules that exist in your environment, in the Current Statistic view, click Rules. The Manage Rules dashboard appears in the display area.
About the Administration Module Viewing the Administration Dashboard 47 For complete information about the Manage Rules dashboard, see Chapter 6, “Managing Rules” on page 225. To return to the Administration dashboard, click Administration in the breadcrumb trail. • To find out more about the server configuration, that exist in your environment, in the Current Statistic view, click Server Version or Server OS. The vFoglight Configuration dashboard appears in the display area.
vFoglight Administration and Configuration Guide To return to the Administration dashboard, click Administration in the breadcrumb trail. 5 In the Administration dashboard, observe the Currently Licensed Capabilities view. The Currently Licensed Capabilities view lists license-related features, indicating which features are included in your license. An icon appears to the right of each capability, indicating if the capability is licensed or not.
About the Administration Module Viewing the Administration Dashboard 49 To return to the Administration dashboard, click Administration in the breadcrumb trail. 7 In the Administration dashboard, observe the Federation view. The Federation view shows the federation mode of the vFoglight Management Server and the number of its children in the topology model. To find out more about the federation configuration, click an entry in the Federation view.
vFoglight Administration and Configuration Guide To return to the Administration dashboard, click Administration in the breadcrumb trail. 8 In the Administration dashboard, observe the Audited Activities view. The Audited Activities view lists log entries that show information about operations performed on the vFoglight Management Server. For example, this list includes information about agent activation, agent package deployment, user authentication, and other types of tasks.
About the Administration Module Looking at Administration Tasks 51 Task See Add topology types “Adding Topology Types” on page 329 Add derived metrics “Working with Derived Metrics” on page 332 Add thresholds “Working with Thresholds” on page 353 List, edit or delete derived metrics “Working with Derived Metrics” on page 332 List, edit or delete retention policies “Managing Retention Policies” on page 372 List, add, edit, or delete thresholds “Working with Thresholds” on page 353 Add registr
vFoglight Administration and Configuration Guide Task See View or edit password settings “Managing Groups” on page 118 List, add, edit, or delete groups “Managing Groups” on page 118 List, add, edit, or delete roles “Managing Roles” on page 127 List, add, edit, or delete users “Managing Users” on page 107
2 Setting Up vFoglight Once you get started with the Administration module, you can use the Setup & Support dashboards to administer vFoglight. Note In order to complete each of the procedures in this chapter, your user account must belong to a group with the Administration role. For more information about users, groups, and roles, see “Managing Users and Security” on page 105. This chapter contains the following sections: About vFoglight Setup .............................................................
vFoglight Administration and Configuration Guide About vFoglight Setup The Administration module includes a number of features that allow you to gather data about vFoglight while it is running, such as audit logs and diagnostic data that can be sent to Vizioncore Support. Additionally, it includes a set of dashboards that you can use to view vFoglight connection status, port numbers, database properties, or manage licenses and server support bundles.
Setting Up vFoglight Viewing Connection Status 55
vFoglight Administration and Configuration Guide Viewing vFoglight Configuration The vFoglight Configuration dashboard provides information about vFoglight configuration items. The configuration settings that appear in this dashboard reflect the settings that you specify at or after the installation while others can be set at run-time.
Setting Up vFoglight Viewing vFoglight Configuration 57 the data from one or more federated servers. For information on how to set up a federated environment, see the Installation and Setup Guide. The Federation view displays the following settings: • Federation Mode. The Federation Mode setting indicates if the vFoglight Management Server whose configuration items you are viewing runs in federation mode. • Number of Children.
vFoglight Administration and Configuration Guide • Version. The version number of the vFoglight Management Server whose configuration items you are viewing. • Build. The build version of the vFoglight Management Server whose configuration items you are viewing. • vFoglight Home. The installation directory of the vFoglight Management Server on the computer on which it is installed. • JBoss Server Directory.
Setting Up vFoglight Viewing vFoglight Configuration 59 • Topology Queries. A list of one or more topology queries that identify topology objects that are be merged with the federated topology model. This setting is defined by the TopologyQueries parameter. • Topology Refresh Period (millis). The number of milliseconds between major topology refresh operations.
vFoglight Administration and Configuration Guide • User. The database user name. This setting is defined by the foglight.database.user parameter. • Location. Indicates if the database is embedded or external. This setting is defined by the foglight.database.embedded parameter. Figure 4 For information on how to view the information on the vFoglight Configuration dashboard, see “Accessing the vFoglight Configuration Dashboard” on page 67. JVM The JVM view displays the following settings: • Name.
Setting Up vFoglight Viewing vFoglight Configuration 61 OS The OS view displays the following settings: • Type. The name and version of the operating system on which the vFoglight Management Server is running. • Patch. The patch level of the operating system on which the vFoglight Management Server is running. Figure 6 For information on how to view the information on the vFoglight Configuration dashboard, see “Accessing the vFoglight Configuration Dashboard” on page 67.
vFoglight Administration and Configuration Guide administrators when certain thresholds are reached. For more information, see “Viewing email settings and configuring email actions” on page 279. Important In some situations you need to create or receive email alerts that contain a URL to the browser interface. To ensure the URL points to the computer on which the vFoglight Management Server is running, ensure that the CATALYST_URL registry variable contains the correct computer name and port number.
Setting Up vFoglight Viewing vFoglight Configuration 63 Figure 8 For information on how to view the information on the vFoglight Configuration dashboard, see “Accessing the vFoglight Configuration Dashboard” on page 67. Ports This view contains information about port settings. The port settings are defined in the file /config/foglight.config. For more information about this file, see the Installation and Setup Guide.
vFoglight Administration and Configuration Guide • HA Pooled Invoker Port. Pooled invoker port when vFoglight is running in HA mode. This setting is defined by the foglight.ha.pooled.invoker.port parameter. • HA JNDI UDPGroup Port. Port for the UDP group when vFoglight is running in HA mode. This setting is defined by the foglight.ha.jndi.udpgroup.port parameter. • HTTP Port. HTTP/1.1 connector used for HTTP connections. This setting is defined by the foglight.http.port parameter. • HTTPS SSL Port.
Setting Up vFoglight Viewing vFoglight Configuration 65 Figure 9 For information on how to view the information on the vFoglight Configuration dashboard, see “Accessing the vFoglight Configuration Dashboard” on page 67. Default port assignments The following table shows the default port assignments. The port numbers are defined in the file /vFoglight/config/foglight.config. Their default values appear during installation.
vFoglight Administration and Configuration Guide Port Name Default Port Number Description HA JNDI JNP Port 1100 Port for the bootstrap JNP service when vFoglight is running in HA mode. For more information about High Availability mode, see the Installation and Setup Guide. HA JNDI RMI Port 1101 Port for the Remote Method Invocation (RMI) naming service when vFoglight is running in HA mode.
Setting Up vFoglight Viewing vFoglight Configuration Port Name Default Port Number Description QP5 Application Port 8448 Port for the SQL parser. ORB (IIOP) Port 3528 Corba ORB port used by the Agent Adapter. vFoglight Agent Manager 3529 Corba ORB SSL port used by the Agent Adapter.
vFoglight Administration and Configuration Guide 3 In the vFoglight Configuration dashboard, locate the view that contains information about a set of configuration items, as required. For example, to find out what is the name of the database host, scroll down to the Database view, and inspect the Host setting.
Setting Up vFoglight Managing Licenses 69 • “OS” on page 61 • “WCF” on page 61 • “Mail (Global Settings)” on page 61 • “Ports” on page 63 Managing Licenses You can manage vFoglight licenses using any of the following interfaces: • Manage Licenses dashboard. Allows you install or delete vFoglight licenses, and to view licensing capabilities for each license.
vFoglight Administration and Configuration Guide The Manage Licenses dashboard appears in the display area, showing the list of installed licenses. 3 To sort the list by license serial number or expiry date, click Serial Number or Expiry Date as required. 4 To filter the list of licenses, in the area that shows the list of installed licenses, use the Filter by Serial Number, Expire After, and Expire Before boxes as required. To clear the filters, click Clear Filters.
Setting Up vFoglight Managing Licenses 71 Alternatively, you can install a license using the command line using the license:import command that comes with the fglcmd interface. For details, see the Command-Line Reference Guide. To install a license: Note This procedure continues from “Accessing the Manage Licenses Dashboard” on page 69.
vFoglight Administration and Configuration Guide Once the vFoglight Management Server reads the license file, it stores it internally in the database and no longer requires the physical file. Viewing License Capabilities The Licensed Capability Summary area provides an overview of the licensed capabilities currently enabled on the vFoglight Management Server.
Setting Up vFoglight Managing Licenses 73 To view license capabilities: Note This procedure continues from “Accessing the Manage Licenses Dashboard” on page 69. 1 In the Manage Licenses dashboard, in the area that lists installed licenses, select a license whose capabilities you want to view. The Licensed Capability Summary area lists the capabilities of the selected license and the cartridges that are included in the license.
vFoglight Administration and Configuration Guide For information on how to install a cartridge, see Chapter 4, “Managing Cartridges” on page 147. • If a license includes a license for one or more agents, it shows agent icons ( ). When you point your mouse over that icon, a tooltip appears, showing the agent name along with the number of licensed agents. Deleting Licenses The license list pane allows you to delete any license currently enabled on vFoglight.
Setting Up vFoglight Managing Support Bundles 75 The License Confirmation dialog box closes. The list of installed licenses refreshes and a message indicating that the delete process was successful appears above the list. Managing Support Bundles vFoglight allows you to gather diagnostic data from the vFoglight Management Server or the vFoglight Agent Manager. and save it in a support bundle. There are two types of support bundles that you can create in vFoglight: • Server support bundles.
vFoglight Administration and Configuration Guide Accessing the Manage Support Bundles Dashboard Using the Administration module, you can gather diagnostic data from the vFoglight Management Server and save it in a support bundle for analysis by Vizioncore Support. To access the Manage Support Bundles dashboard: Note This procedure continues from “Getting Started with the Administration Module” on page 32. 1 Ensure that the navigation panel is open.
Setting Up vFoglight Managing Support Bundles 77 • “Creating Server Support Bundles” on page 77 • “Retrieving Server Support Bundles” on page 79 • “Viewing the Content of Server Support Bundles” on page 80 Creating Server Support Bundles A server support bundle contains diagnostic data gathered from the vFoglight Management Server. vFoglight saves this data in a .ZIP file. When you click Create Bundle on the Manage Support Bundles dashboard, the vFoglight Management Server creates the .
vFoglight Administration and Configuration Guide Note The appearance of the above dialog box may be different, depending on the type and version of your Web browser. 3 Save the generated ZIP file to disk. The newly-generated support bundle appears in the Support Bundle Inventory view. In addition to the bundle name, the Support Bundle Inventory view shows the bundle description, the date and time at which it was created, and the name of the user who created it.
Setting Up vFoglight Managing Support Bundles 79 Retrieving Server Support Bundles vFoglight stores support bundles in the /support/ directory on the computer hosting the vFoglight Management Server. You can retrieve a copy of an existing support bundle as a file download using the Support Bundle Inventory view immediately after its creation or at a later time.
vFoglight Administration and Configuration Guide Viewing the Content of Server Support Bundles Server support bundles contain diagnostic data gathered from the vFoglight Management Server. To view the content of a server support bundle: Note This procedure continues from “Retrieving Server Support Bundles” on page 79. 1 Locate the server support bundle whose content you want to view by completing one of the following steps.
Setting Up vFoglight Managing Support Bundles 81 AuditingLog_*.xml A listing of recent auditable changes to the vFMS/registry/rules/cartridges/security/etc It contains information about the before and after states of a configuration object, including rules, registry variables, agent properties, schedules, derived metrics, or thresholds, for changes that occur within the applicable default time range. DiagnosticSnapshot_*.
vFoglight Administration and Configuration Guide restart_monitor.config vFMS restart configuration parameters (as a service) server_restarter.log.config Logging parameters for the vFMS logs/ ManagementServer_*.log The three most recent vFMS logs server/ default/ conf/ jacorb.properties vFMS JacORB configuration parameters deploy/ nitro-dyn-ds.xml vFMS data source definition jbosswebtomcat55.sar/ Note context.xml JBoss application configuration file server.
Setting Up vFoglight Viewing Audit Information 83 The View Audit Information dashboard allows you to select the time period for which you want to view administration logs. Each log includes information such as the name of the user who made the change, the date and time at which the change was made, the action performed, and (if applicable) the name of the item that was changed (for example, the name of the rule).
vFoglight Administration and Configuration Guide The Zonar displays the current date, time, and time range, and allows you to modify the current time range. The list below the Zonar displays the audit logs that the vFoglight Management Server records within the time range specified in the Zonar. For more information about the Zonar and its functionality, see the vFoglight User Guide. 3 Optional. Reduce the number of columns that appear in the audit log table.
Setting Up vFoglight Viewing Audit Information 85 Since all of the four columns appear in the View Audit Information dashboard by default, all of the check boxes that correspond to the columns appear selected. b To hide a column, in the Show columns dialog box, clear the corresponding check box. or To show a column, clear the corresponding check box.
vFoglight Administration and Configuration Guide a In the audit log table, in the Operation Name (Name) column, click the Show/Hide columns button. Show/Hide columns The Show columns dialog box appears. b In the Show Columns dialog box, under Actions, click one of the following links: Export as CSV, to export the table contents to a Comma Separated Values (CSV) file. Export as PDF, to export the table contents to a PDF file.
Setting Up vFoglight Viewing Audit Information 87 When exporting the table contents to a CSV file, a dialog box appears, allowing you open the exported file, or to save it to disk. Note The appearance of the above dialog box may be different, depending on the type and version of your Web browser.
vFoglight Administration and Configuration Guide To specify the period start and end times, click and drag the edges of the grey area in the Zonar. For complete information on how to use the Zonar in vFoglight, see the vFoglight User Guide. The log entries for the selected time period appear in the log table.
Setting Up vFoglight Backing Up, Upgrading, and Restoring vFoglight 89 Backing Up, Upgrading, and Restoring vFoglight Backup and restore processes are important aspects of database administration. This section provides suggested end-to-end backup, upgrade, and restore procedures for vFoglight installations.
vFoglight Administration and Configuration Guide Option 2 • Issue a mysqldump command to export the MySQL database. Alternatively, use the InnoDB HotBackup tool to back up the embedded MySQL database. Tip To restore the database after backing it up with the mysql command, use MySQL.
Setting Up vFoglight Backing Up, Upgrading, and Restoring vFoglight 91 vFoglight Management Server on Windows with Oracle on a remote computer Option 1 • Use Oracle tools to back up the database. Tip To restore the database after choosing this backup method, use Oracle tools. • Stop the vFoglight Management Server. • Use backup tools from your Windows environment to back up the vFoglight installation directory.
vFoglight Administration and Configuration Guide • If your system uses an Oracle database, refer to “To back up an Oracle database used by the vFoglight Management Server” on page 92 for instructions. • If your system uses a MySQL database, refer to “To back up a MySQL database using MySQL commands:” on page 94 for instructions. The vFoglight backup on a Windows system is now complete.
Setting Up vFoglight Backing Up, Upgrading, and Restoring vFoglight c Click the Advanced tab and click Environment Variables. The Environment Variables window is displayed.
vFoglight Administration and Configuration Guide d Visually inspect the values associated with the PATH and LD_LIBRARY_PATH & ORACLE_HOME variables. 3 Export the Oracle database. Use the following syntax in the Oracle command shell: cd $ORACLE_HOME/bin exp /@ file=.dbdump A .dbdump file is created. The backup of the Oracle database is now complete. To back up a MySQL database using MySQL commands: 1 Log in to the MySQL server machine.
Setting Up vFoglight Backing Up, Upgrading, and Restoring vFoglight 95 • database_name is the database name, as configured by the foglight.database.name parameter in /config/ foglight.config. • database_port_number is the database port number, as configured by the foglight.database.port parameter in /config/ foglight.config. • backupfile_name is the name of the backup SQL file. 3 After the backup SQL file is created, stop the MySQL database by issuing the shutdownDb.
vFoglight Administration and Configuration Guide innodb_log_group_home_dir="vfoglight_home/mysql/data" set-variable=innodb_log_files_in_group=2 set-variable=innodb_log_file_size=64 backup.
Setting Up vFoglight Backing Up, Upgrading, and Restoring vFoglight Contents of ..\..\backup\config\my.cnf: innodb_data_home_dir got value ... Contents of ..\..\backup\config\backup.cnf: innodb_data_home_dir got value ... ibbackup: Found checkpoint at lsn 0 282033535 ibbackup: Starting log scan from lsn 0 282033152 ...
vFoglight Administration and Configuration Guide ibbackup: Compressed 210 MB of data files to 36 MB (compression 82%). 080922 15:29:54 ibbackup: Full backup completed! 5 View the contents of the backup directory by issuing the following command: C:\Vizioncore\vFoglight\mysql\bin>dir C:\Vizioncore\vFoglight\backup\data Volume in drive C is System Volume Serial Number is BCD1-A216 Directory of C:\Vizioncore\vFoglight\backup\data 10/24/2008 10/24/2008 10/24/2008 10/24/2008 Note 10:55 AM
.Setting Up vFoglight Backing Up, Upgrading, and Restoring vFoglight Note 99 The code line above illustrate the process of applying logs to an uncompressed backup. If you are applying logs to a compressed backup, use the --uncompress option. For example: C:\Vizioncore\vFoglight\mysql\bin>ibbackup --apply-log --uncompress C:\Vizioncore\vFoglight\backup\config \backup.cnf For more information about the command-line options for creating compressed and uncompressed backups, see step 4 on page 96.
vFoglight Administration and Configuration Guide 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 Setting log file size to 0 134217728 InnoDB: Progress in MB: 100 Setting log file size to 0 134217728 InnoDB: Progress in MB: 100 ibbackup: We were able to parse ibbackup_logfile up to ibbackup: l
Setting Up vFoglight Backing Up, Upgrading, and Restoring vFoglight 101 Your embedded MySQL database is successfully backed up. For instructions on how to restore the database MySQL database using these files, see “To restore an embedded MySQL database previously backed up using the InnoDB tools:” on page 104. For complete information about the InnoDB Hot Backup tool, visit the following URL: http://www.innodb.
vFoglight Administration and Configuration Guide Restoring vFoglight “Restoring” a physical backup means reconstructing it and making it available to users. This section outlines how to restore an old vFoglight installation. Note In order to restore a previous vFoglight installation, you must have a backed up copy of that version. For information about how to back up a vFoglight system, see “Backing Up vFoglight” on page 89.
Setting Up vFoglight Backing Up, Upgrading, and Restoring vFoglight 103 SQL> @ /scripts/sql/oracle_drop_db.sql Note The files oracle_drop_dp.sql and oracle_drop_db.sql are included with vFoglight when you use an Oracle database, The are located in the /scripts/sql directory.
vFoglight Administration and Configuration Guide SOURCE Note The “.sql” is the backup file you must create in order to restore your MySQL database (see “To back up a MySQL database using MySQL commands:” on page 94). The MySQL database is now restored. To restore the previous vFoglight installation directory: 1 cd to the directory where you want to install vFoglight. 2 If the backup of the old installation is not compressed, continue with step .
3 Managing Users and Security This chapter introduces you to the concepts and terms related to managing security in vFoglight and looks into security-related components that you can manage using the Administration module. It also takes you through the process of creating and managing users, groups, and roles in vFoglight. Note In order to complete each of the procedures in this chapter, your user account must belong to a group with the Security role. For more information, see “Managing Groups” on page 118.
vFoglight Administration and Configuration Guide About Security in vFoglight In vFoglight, user management consists of three related entities: • Users. A user has a user name and a password and can belong to one or more groups. Logging in to vFoglight as a specific user authorizes you to perform a certain set of actions (based on the roles that have been assigned to the group(s) to which the user belongs).
Managing Users and Security Managing Users 107 Figure 1 Managing Users There are three types of users in vFoglight: • Internal. Internal users include the users that are created after the installation. When you create an internal user in vFoglight, you assign a user name and password to that user. There are restrictions surrounding password formatting. See “Configuring Password Settings” on page 135 for details. • Built In. Built-in users include the users that come with vFoglight.
vFoglight Administration and Configuration Guide Roles are assigned to a user through groups: when a user belongs to a group, the roles that are assigned to that group are also assigned to the user. A user can belong to one or more groups. For more information about groups, see “Managing Roles” on page 127. If you belong to a group that includes the Security role, the Manage Users dashboard allows you to manage user accounts, add users to groups, and manage user passwords.
Managing Users and Security Managing Users 109 2 On the navigation panel, under Dashboards, choose Administration > Users & Security > Manage Users. The Manage Users dashboard appears in the display area, showing a list of all existing users: 3 To sort the list by name, group, role, or type, click the Name, Groups, Roles (Read Only), or Type column headings as required.
vFoglight Administration and Configuration Guide To clear the filters, click Clear Filters. The Manage Users list refreshes, showing the list of all users.
Managing Users and Security Managing Users 111 • “Forcing Password Changes” on page 115 • “Unlocking Passwords” on page 115 • “Deleting Internal Users” on page 117 Creating Users Use the Create User button on the Manage Users dashboard to add a user account to vFoglight, as outlined below. Alternatively, use the security:createuser fglcmd command to create a user. For more information, see the Command-Line Reference Guide.
vFoglight Administration and Configuration Guide As you type the password into the Password and Confirm Password boxes, asterisk ‘*’ characters appear. Note Passwords must meet certain criteria. For example, by default, each password must be between seven (7) and sixteen (16) characters long. For more information, see “Configuring Password Settings” on page 135. If you specify a password that is longer than sixteen (16) characters for an end-user, that user cannot log into vFoglight. c Click Create.
Managing Users and Security Managing Users 113 To add a user to groups: Note This procedure continues from “Creating Users” on page 111. 1 In the Manage Users dashboard, select the row containing the user account whose groups you want to edit. 2 Click the Edit Groups button in the lower-right corner. The Edit Groups dialog box appears. Note The dialog box lists default vFoglight groups. If you previously added any groups, they also appear in the dialog.
vFoglight Administration and Configuration Guide The Edit Groups dialog box closes and the Manage Users dashboard refreshes to show the groups that you added to the user account. Changing Passwords Use the Change Password button on the Manage Users dashboard to change a user’s password, as outlined below. To change a user’s password: Note This procedure continues from “Creating Users” on page 111.
Managing Users and Security Managing Users 115 b Click OK. 4 The Change Password dialog box closes and vFoglight updates the user password in the database. Forcing Password Changes When you create a user account for a user that has no access to the Manage Users dashboard, use the Force Password-Change button to ensure that the user changes their password the first time they attempt to log into vFoglight.
vFoglight Administration and Configuration Guide using the Configure Password Settings dashboard. For more information, see “Editing Password Settings” on page 137. By default any user passwords that become locked stay in that state for 15 minutes after which vFoglight unlocks them. To unlock a user account, use the Unlock button on the Manage Users dashboard. To unlock a user’s password: Note This procedure continues from “Accessing the Manage Users Dashboard” on page 108.
Managing Users and Security Managing Users 117 Deleting Internal Users Use the Delete button on the Manage Users dashboard to delete user accounts from vFoglight. You can only delete those users that you add to vFoglight after the installation. Their type appears as Internal on the Manage Users dashboard. You cannot delete the user accounts that are included with vFoglight. Their type appears as Built In. If a Built In or Internal User is the current user, their type appears as Current User.
vFoglight Administration and Configuration Guide 3 In the Confirm Delete dialog box, click OK. The dialog box closes and the Manage Users dashboard refreshes. 4 Observe the Manage Users dashboard. The user account that you deleted no longer appears in the list. Managing Groups A group can contain users. Roles are assigned to groups. In turn, a role that is assigned to a group is also assigned to each member of that group. There are three types of roles in vFoglight: • Internal.
Managing Users and Security Managing Groups 119 For more information about configuring vFoglight to use an external directory service, see “Configuring Directory Services” on page 139. Roles are assigned to a user through groups: when a user belongs to a group, the roles that are assigned to that group are also assigned to the user. A user can belong to one or more groups.
vFoglight Administration and Configuration Guide 3 To sort the list by name, users, role, or type, click the Name, Users, Roles, or Type column headings as required. 4 To filter the list of groups, use one or more of the following boxes at the top of the Manage Users list: • Name: Enter the group name for which you want to filter. • Users: Enter the user name for which you want to filter. • Roles: Enter the role name for which you want to filter.
Managing Users and Security Managing Groups To clear the filters, click Clear Filters. The Manage Groups list refreshes, showing the list of all groups.
vFoglight Administration and Configuration Guide • “Deleting Internal Groups” on page 126 Creating Groups Use the Create Group button on the Manage Groups dashboard to add a group to vFoglight, as outlined below. Alternatively, you can create groups using the security:createuser command that comes with the fglcmd interface. For more information, see the Command-Line Reference Guide. To create a group: Note This procedure continues from “Accessing the Manage Groups Dashboard” on page 119.
Managing Users and Security Managing Groups 123 Editing Users in Groups Use the Edit Users button on the Manage Groups dashboard to quickly edit users in one or more groups. Alternatively, if you need to edit groups for a single user account, use the Manage Users dashboard. For information, see “Adding Users to Groups” on page 112. Another way to assign or remove users from groups is to use the security:assigngroup command that comes with the fglcmd interface.
vFoglight Administration and Configuration Guide • • : The user account has been removed from or does not have access to this group. : There is no change in user assignment. For example, to add the default foglight user account to the group, ensure that the green plus sign appears to the left of the foglight entry, and that the red minus sign appears to the left of the other groups in the Edit Users dialog box. 4 Click Save.
Managing Users and Security Managing Groups Note 125 The dialog box lists existing vFoglight roles. If you previously added any roles, they also appear in the dialog. For information on how to add roles, see “Creating Roles” on page 131. 3 In the Edit Roles dialog box, select the roles that you want to assign to the group by clicking the appropriate symbol to the left of the group name. • : The role is added or already belongs to this group.
vFoglight Administration and Configuration Guide Deleting Internal Groups Use the Delete button on the Manage Groups dashboard to delete user accounts from vFoglight. You can only delete those groups that you add to vFoglight after the installation. Their type appears as Internal on the Manage Users dashboard. You cannot delete any of the groups accounts that are included with vFoglight. Their type appears as Built In.
Managing Users and Security Managing Roles 127 The message box closes and vFoglight deletes the user account. 4 Observe the Manage Groups dashboard. The user account that you deleted no longer appears in the list. Managing Roles Roles are assigned to groups. A role that is assigned to a group is also assigned to each member of that group. There are two types of roles in vFoglight: • Built-In. They dictate what actions users can perform.
vFoglight Administration and Configuration Guide the Schema Browser. This role is for users who design dashboards using these advanced dashboard tools. • Dashboard User. This role is similar to the Console User role, but with additional access to any additional dashboards associated with the user. This role also includes permission to create new dashboards, new reports, and to edit the dashboard environment. • General Access. This role is for pre-5.2 cartridges installed on a version 5.
Managing Users and Security Managing Roles 129 Accessing the Manage Roles Dashboard The Manage Roles dashboard contains a table that lists roles, their type, and the groups that are assigned to each role. It also allows you to create and manage roles, and to assign roles to groups. To access the Manage Roles dashboard: Note This procedure continues from “Getting Started with the Administration Module” on page 32. 1 Ensure that the navigation panel is open.
vFoglight Administration and Configuration Guide • Type: Type the type name for which you want to filter. For example, to list only the roles whose name starts with “Dashboard”, in the Name box, type Dashboard. The Manage Roles list refreshes, showing the list of roles whose name matches the filter pattern. To clear the filters, click Clear Filters. The Manage Roles list refreshes, showing the list of all groups.
Managing Users and Security Managing Roles 131 From here, you can proceed to any of the following procedures: • “Creating Roles” on page 131 • “Editing Groups for a Role” on page 132 • “Deleting Internal Roles” on page 133 Creating Roles Use the Create Role button on the Manage Roles dashboard to add a role to vFoglight, as outlined below. To create a role: Note This procedure continues from “Accessing the Manage Roles Dashboard” on page 129.
vFoglight Administration and Configuration Guide 2 Specify the name of the role that you want to create. a In the Create Role dialog box, in the Name box, type the user name. For example: test. b Click Create. The Create Role dialog box closes and the Manage Roles dashboard refreshes to show the newly-created role. When you create roles, their type appears as Internal on the listing.
Managing Users and Security Managing Roles Note 133 The dialog box lists existing vFoglight groups. If you previously added any groups, they also appear in the dialog. For information on how to add groups, see “Creating Groups” on page 122. 3 In the Edit Groups dialog box, select the users to which you want to assign the role by clicking the appropriate symbol to the left of the group name. • : The group is added to this role. • : The group has no access to the role.
vFoglight Administration and Configuration Guide You can only delete those roles that you add to vFoglight after the installation. Their type appears as Internal on the Manage Users dashboard. You cannot delete any of the groups accounts that are included with vFoglight. Their type appears as Built In. Figure 4 Roles that you create Roles that come with vFoglight For more information about the types of roles that exist in vFoglight, see “Managing Roles” on page 127.
Managing Users and Security Configuring Password Settings 135 Configuring Password Settings vFoglight automatically times out after 60 minutes of inactivity. The following are the default restrictions that apply to passwords for administrators and for other types of internal users. For more information about the types of users in vFoglight, see “Managing Users” on page 107. • An internal user’s password expires after ninety (90) days. • An administrator’s password expires after forty-five (45) days.
vFoglight Administration and Configuration Guide Accessing the Configure Password Settings Dashboard The Configure Password Settings dashboard contains settings for password policies that apply to administrators and internal users are set. The default settings for these policies are described in “Configuring Password Settings” on page 135. To view password settings: Note This procedure continues from “Getting Started with the Administration Module” on page 32.
Managing Users and Security Configuring Password Settings 137 Editing Password Settings Use the Configure Password Settings dashboard to edit any policies that you want to change. To edit password settings: Note This procedure continues from “Accessing the Configure Password Settings Dashboard” on page 136. 1 In the Configure Password Settings dashboard, click the Edit button in the lower- left corner. The Configure Password Settings dashboard refreshes, showing a box to the right of each setting.
vFoglight Administration and Configuration Guide • Minimum password length • Number of old passwords that will be remembered • Number of days before password expiry to warn user • User cache expiry in minutes (login is fast until cache expires) 3 Edit the password complexity levels. You can set the complexity level that must be used in the passwords of internal users and the users with the Security role. vFoglight uses the following levels: • 1: Passwords are not checked for complexity.
Managing Users and Security Configuring Directory Services 139 To avoid compromising the password, users must insert an updated encrypted password. To change the vFoglight database password: 1 Delete the current vFoglight database key from vFoglight’s key store: > bin\keyman delappkey dbpwd.[foglight db username] 2 Create a new key store entry for the updated password: > bin\keyman addappkey dbpwd.
vFoglight Administration and Configuration Guide You can track user login credentials using the Manage Users dashboard. This dashboard lists the users who have logged in to vFoglight using their external account credentials. For more information, see “Managing Users” on page 107.
Managing Users and Security Configuring Directory Services From here, you can proceed to “Editing Directory Settings” on page 142.
vFoglight Administration and Configuration Guide Editing Directory Settings Default settings for these LDAP directory servers are different. The table below shows examples of these settings for different types of LDAP directory servers. Use the following settings as guidelines; they should be substituted with the most appropriate values. Refer to the documentation for your specific LDAP server for more information about settings and values.
Managing Users and Security Configuring Directory Services Setting Active Directory The second group namespace OU=Dynamic Groups,DC=MyCompany,DC=com The third group namespace N/A The LDAP context for user searching OU=People,DC=example,DC=com o=novell Role attribute ID name cn istweb Is Role attribute a DN false User alias attribute ID sAMAccountName uid uniqueId User attribute ID to search for groups member uniqueMember CN=foglight_a dmin, O=services Match on User DN true JAAS1 Lo
vFoglight Administration and Configuration Guide Setting Active Directory Parent group attribute ID memberOf Group attribute for nested group searching member Maximum level of group nesting 15 LDAP search timeout (milliseconds) 10000 Mode of group searching direct Account is anonymous false Sun Java Systems Directory Server/ OpenLDAP Novell eDirectory uniqueMember member indirect direct 1 Java™ Authentication and Authorization Service Do not change this setting 3 Do not change thi
Managing Users and Security Configuring Directory Services 145 3 In the Configure Directory Services dashboard, click the Edit button in the lower- left corner. The Configure Directory Services dashboard refreshes, showing a box to the right of each setting. 4 Edit the settings as required. To restore the default values, click Restore Defaults. 5 Click Save.
vFoglight Administration and Configuration Guide
4 Managing Cartridges This chapter introduces you to vFoglight cartridges and provides information on how to install and manage cartridges. It contains the following sections: Note In order to complete each of the procedures in this chapter, your user account must belong to a group with the Administration role. For more information about users, groups, and roles, see “Managing Users and Security” on page 105. About vFoglight Cartridges ......................................................................
vFoglight Administration and Configuration Guide About vFoglight Cartridges A cartridge is a unit that is distributed separately from the vFoglight Management Server, but can be added to the Management Server. A cartridge contains components that extend the functionality of vFoglight, such as agent installers, communication capabilities, modifications to the way that data is transformed or handled, model definitions, rules, reports, and views.
Managing Cartridges Installing and Managing Cartridges 149 See “Managing Agents” on page 165 for more information about agents. • Agent adapters. Agent adapters are components that allow agents to communicate with the vFoglight Management Server. • Monitoring policy. A monitoring policy contains information and settings that help vFoglight analyze the data that the agents collect, such as rules, registry variables, schedules, and derived metrics.
vFoglight Administration and Configuration Guide Use the Cartridge Inventory dashboard to view information about installed cartridges, and to install, enable, disable, and remove cartridges.
Managing Cartridges Installing and Managing Cartridges 3 View information about one or more cartridges. • Move the mouse pointer over the Cartridge Name column in the row containing the cartridge about which you want to view information. A dwell appears, showing the cartridge information.
vFoglight Administration and Configuration Guide or • To view cartridge information and any dependencies with other cartridges, click the Cartridge Name column in the row containing the cartridge about which you want to view information. The View Cartridge Details view appears in the Cartridge Inventory dashboard. To return to the Cartridge Inventory dashboard, in the View Cartridge Details view, click Go to Cartridge Inventory.
Managing Cartridges Installing and Managing Cartridges 153 4 To sort the list of cartridges, click any of the Status, Cartridge Name, or Version column headings as required. 5 To filter the list of cartridges, use one or more of the following boxes above the cartridge table: • Name: Type the cartridge name for which you want to filter. • Version: Type the cartridge version for which you want to filter.
vFoglight Administration and Configuration Guide The Cartridge Inventory dashboard refreshes, showing the list of all cartridges.
Managing Cartridges Installing and Managing Cartridges 155 Installing Cartridges Installation is the first step in adding a cartridge to the vFoglight Management Server. A cartridge file has the extension .car. Installing the CAR file causes the Management Server to be aware of all cartridges in the CAR file. Use the Cartridge Inventory dashboard to install a single cartridge at a time. To install multiple cartridges at the same time, use the cartridge:install command.
vFoglight Administration and Configuration Guide For example, if the name of the CAR file is Virtual-VMware.car, and it resides in the /cartridge directory on the vFoglight Management Server computer, in the File on Server box, type the following: cartridge/Virtual-VMware-5_2_3.car 2 Optional. To enable the cartridge immediately after its installation, select the Enable on install check box. Alternatively, you can enable the cartridge at a later time.
Managing Cartridges Installing and Managing Cartridges The Status column contain icons that indicate if a cartridge is enabled enabled pending dependency , partially enabled , or disabled . 157 , If you chose not to enable the cartridge immediately after the installation in step 2, you can do that at a later time. For instructions, see “Enabling Cartridges” on page 157. From here, you can proceed to “Enabling Cartridges” on page 157.
vFoglight Administration and Configuration Guide 3 In the Cartridge Inventory dashboard, observe the Status column of the cartridges that you enabled. The Status column of each newly-enabled cartridge contains an icon ( indicating that the operation was successful.
Managing Cartridges Installing and Managing Cartridges The Status column contain icons that indicate if a cartridge is enabled enabled pending dependency , partially enabled , or disabled . Tip 159 , To select multiple cartridges, press the CTRL or SHIFT key while selecting the rows containing the cartridges that you want to disable. 2 Click the Disable Selected button at the bottom of the Cartridge Inventory dashboard. The Cartridge Confirmation dialog box appears.
vFoglight Administration and Configuration Guide A CAR file can contain multiple cartridges. When you remove all of the cartridges that come in a CAR file, the CAR file will be deleted. Caution If you remove a cartridge while the agents that were included in that cartridge are deployed and actively collecting data, it can cause communication problems between the agents and the vFoglight Management Server. For example, the agents may not be able to connect to the Management Server.
Managing Cartridges Downloading Agent Components 161 3 In the Cartridge Confirmation dialog box, click OK. The Cartridge Confirmation dialog box closes. If the operation is successful, a message appears above the cartridge list. 4 In the Cartridge Inventory dashboard, observe the list of cartridges. The cartridges that you removed no longer appear in the list. Downloading Agent Components There are two types of agent components that you can download using this dashboard: • Executable agent installers.
vFoglight Administration and Configuration Guide To download agent components: Note This procedure continues from “Getting Started with the Administration Module” on page 32. 1 Ensure that the navigation panel is open. To open the navigation panel, click the right-facing arrow on the left. 2 On the navigation panel, under Dashboards, choose Administration > Cartridges > Components for Download.
Managing Cartridges Downloading Agent Components 163 5 To sort the list of components, click any of the Name, Cartridge Name, Component Name, OS, Architecture, or the Manual Installer icon ( headings as required. ) column 6 To filter the list of cartridges, use one or more of the following boxes above the component table: • Name: Type the component name for which you want to filter. • Cartridge Name: Type the cartridge name for which you want to filter.
vFoglight Administration and Configuration Guide To download an agent component: Note This procedure continues from “Accessing the Components for Download Dashboard” on page 161. 1 In the Components for Download dashboard, click the Name column of the row containing the agent component that you want to download. Your Web browser displays a dialog box that allows you to open or save the support bundle.
5 Managing Agents This chapter introduces you to vFoglight agents and provides information on how to install and manage them. It contains the following sections: Note In order to complete each of the procedures in this chapter, your user account must belong to a group with the Administration role. For more information about users, groups, and roles, see “Managing Users and Security” on page 105. This chapter contains the following sections: About vFoglight Agents ..........................................
vFoglight Administration and Configuration Guide About vFoglight Agents A vFoglight agent monitors a specific part of your environment, such as a VirtualCenter, application, or server. There are two categories of agents: agents that run remotely (on a monitored host) and touchless agents, which monitor remote systems from within the vFoglight Management Server. Each cartridge that you install on the vFoglight Management Server includes one or more agent types.
Managing Agents Managing Agent Properties by Type 167 Managing Agent Properties by Type When an agent connects to the vFoglight Management Server, it is provided with sets of properties that it uses to configure its correct running state. vFoglight stores agent properties in the vFoglight Management Server. Any passwords that are defined in agent properties, and stored in the database, are encrypted.
vFoglight Administration and Configuration Guide • You want a set of default agent properties to use different lists at different times. For example, you may want to create a clone of a list and configure it to have different settings during testing. • You want to use lists with different settings in different agent instances. You can view and edit type-specific agent properties using the Agent Properties dashboard.
Managing Agents Managing Agent Properties by Type Namespace pane Note Types pane Agent pane 169 List pane For a sample screen capture of this dashboard in a monitoring environment that uses the vFoglight Client, see “Agent Properties dashboard” on page 501. The Agent Properties dashboard contains three panes: • Namespace: Contains a list of vFoglight adapters that allow the agent to communicate with the vFoglight Management Server.
vFoglight Administration and Configuration Guide 4 Select an agent type. In the Agent Properties dashboard, in the Type pane, click an agent type. The Agent pane refreshes, showing the agent properties for the selected agent type. 5 Observe agent properties. A list-based property has the Edit and Clone buttons to its right.
Managing Agents Managing Agent Properties by Type 171 List property A primary property appears as a box or an option. Primary properties For complete information about any agent properties that appear in the Agent pane, refer to your cartridge documentation. Editing Type-Specific Agent Properties The Agent pane of the Agent Properties dashboard contains simple (primary) properties and list-based properties.
vFoglight Administration and Configuration Guide You can edit a primary property simply by specifying the desired value or option for the selected agent type. Editing list-based properties is somewhat different in that it allows you to either edit an existing list, or copy a list and make edits to it.
Managing Agents Managing Agent Properties by Type 173 3 Click the Save button. The Agent pane refreshes. Cloning lists in secondary properties Each secondary property can have one or more lists to which it can be set. Cloning a list allows you to create multiple instances of the same list and assign them to different agent instances as required.
vFoglight Administration and Configuration Guide A dialog box appears. 3 In the dialog box, in the Clone name box, specify the name of the cloned list either by editing the value that appears. As you edit the list name, a Clone button appears in the dialog box to the left of the Cancel button. 4 Click the Clone button that appears to the left of the Cancel button in the dialog box. The dialog box closes and the secondary property refreshes, with its value set to the newly-cloned list.
Managing Agents Managing Agent Properties by Type 175 Use this type of approach when you want to use different lists at different times, or to assign different versions of the same list to agent instances of the same agent type. Use the Edit button on the Agent pane to edit lists that are assigned to secondary agent properties, as outlined below. Caution Changes made to lists can affect multiple agents.
vFoglight Administration and Configuration Guide Note The appearance of the dialog box depends on the nature and complexity of the list entry. Note All text boxes have a limit of 64 characters. b Edit the entry in the dialog box and click the OK button that appears. As you edit the list entry, its name and value appear red in the dialog box to indicate the change. c To save your changes, click the Save button that appears in the dialog box.
Managing Agents Managing Agent Properties by Type 177 c To save your changes, click the Save button that appears in the dialog box. The dialog box closes and the List pane refreshes, showing the newly-added entry. 5 To delete one or more rows from the list, complete the following steps. a In the List pane, select the rows containing the entries that you want to delete from the list. To select multiple entries, press the CTRL key while clicking rows.
vFoglight Administration and Configuration Guide A message box appears, asking you to confirm the delete operation. 3 Click Remove in the message box. The message box closes and the list is removed from the collection of lists that are available for selection from the secondary property. The property from which you removed the secondary list appears red, indicating unsaved edits. 4 Save your changes to the agent properties. In the Agent pane, in the lower-right corner, click the Save button.
Managing Agents Assigning Blackouts to Agent Instances 179 Assigning Blackouts to Agent Instances A schedule defines a period of time during which an action occurs. Blackout schedules prevent agents from collecting data. You can use an existing schedule or create another one if required. For more information about schedules, see Chapter 8, “Using Schedules” on page 395. An agent blackout is a scheduled event during which the agent does not collect data for set intervals.
vFoglight Administration and Configuration Guide 3 To sort the list by their ID, host name, instance name, agent type, or schedule name, click the ID, Hostname, Agent Name, Type, or Schedule Name column headings as required. 4 To filter the list of agents by the host name, instance name, agent type, or schedule name, use the Hostname, Agent Name, Type, or Schedule Name boxes at the top of the Agent Blackouts list.
Managing Agents Assigning Blackouts to Agent Instances To clear the filters, click Clear Filters. 5 Assign or remove a blackout schedule for an agent. a Select the row containing that agent. b Click the Assign Blackout button at the bottom. The Selected Agents dialog box appears. c Choose a blackout schedule for the selected agent. Click Schedule. A list of all available schedules appears.
vFoglight Administration and Configuration Guide The list reflects the entries in Manage Schedules dashboard. For more information, see “Managing Schedules” on page 397. To remove a schedule, select None in the list. To assign a schedule, select any other entry in the list, as required. For example, to black out the selected agent on the first day of each month, select First day of month. 6 Click Apply.
6 Working with vFoglight Rules and Registry This chapter introduces you to vFoglight rules and registry and provides information on how to create and manage these entities. It contains the following sections: Note In order to complete each of the procedures in this chapter, your user account must belong to a group with the Administration role. For more information about users, groups, and roles, see “Managing Users and Security” on page 105.
vFoglight Administration and Configuration Guide About Rules, Registry, and Topology in vFoglight vFoglight collects data about your system and dynamically builds topology models at run-time. A topology model organizes the data in a way that represents the logical and physical relationship between items in your monitored environment and provides the context for the collected metrics. Each topology model includes one or more topology types, and each type has an associated set of metrics.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 185 • “Editing Registry Variables” on page 200 • “Viewing Registry Values” on page 209 • “Example: Assigning Multiple Values to a Registry Variable” on page 216 • “Example: Using Performance Calendars” on page 216 • “Example: Assigning Host-Specific Email Addresses of vFoglight System Administrators” on page 217 Managing Registry Variables The Manage Registry Variables dashboard allows you to create new registry variables
vFoglight Administration and Configuration Guide 3 To sort the list of variables by their name or type, click the Variable Name or Type column headings as required. 4 Optional. Filter the list of variables. • To show only the variables whose name matches a text pattern, type that pattern into the Variable Name box at the top of the list. The Manage Registry Variables dashboard refreshes, showing only the variables whose name matches the text pattern.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 187 The Manage Registry Variables dashboard refreshes, showing only the variables that do not have a global default value. • To show only the variables that come with a specific cartridge, in the By Cartridge box, type the cartridge name. The Manage Registry Variables dashboard refreshes, showing only the variables that come with the cartridge whose name that matches the expression.
vFoglight Administration and Configuration Guide • “Viewing and editing variable definitions” on page 194 Editing permissions of registry variables vFoglight allows you to control access to registry variables. For each variable you can grant or deny read, write, or control access to roles or users. For more information about security concepts in vFoglight, see Chapter 3, “Managing Users and Security” on page 105.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 189 2 To add permissions to a variable, complete the following steps. a Click the role or user to which you want to assign permissions. Tip The Not Assigned icons in the Permissions columns indicate that the role has no permissions assigned to it. The Add Role Permission or Add User Permission dialog box appears.
vFoglight Administration and Configuration Guide b In the dialog box that appears, use the Read, Write, and Control check boxes to assign permissions as required, and click Save. The dialog box closes and the selected entry refreshes, showing three check marks in the Permission columns, one for each of the read, write, and control permissions. Permission granted Permission denied 3 To edit or delete permissions for a variable, complete the following steps.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 191 b To edit the permissions, ensure that the Edit option is selected and use the Read, Write, and Control check boxes as required. To delete the permissions, select the Delete option. c Click Save. The dialog box closes and the selected entry refreshes, showing the newlyedited permissions.
vFoglight Administration and Configuration Guide 2 In the Copy Registry Variable dialog box, click OK. The Copy Registry Variable dialog box closes and another dialog box appears, asking you to specify the name of the destination variable. 3 Type the name of the variable and click OK. Note You must use a unique name. The dialog box closes and the Edit Registry Variable pane appears in the display area.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 193 4 If required, edit the newly-copied variable. For more information, see “Editing Registry Variables” on page 200. Deleting registry variables Use the Delete Selected button on the Manage Registry Variables dashboard to delete a registry variable, as outlined below. Note When a registry variable is deleted, all references to that variable in rule conditions and expressions become invalid.
vFoglight Administration and Configuration Guide 1 In the Manage Registry Variables dashboard, select the row containing the variable that you want to delete. 2 Click the Delete Selected button at the bottom. The Registry Variable Confirmation dialog box appears. 3 In the Registry Variable Confirmation dialog box, click OK. The Registry Variable Confirmation dialog box closes. 4 Observe the Manage Registry Variables dashboard. The newly-deleted variable no longer shows in the list.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 195 2 Observe the variable definitions. 3 Edit the variable if required. For complete instructions, see “Specifying values” on page 201. Creating Registry Variables vFoglight allows you to create registry variables using the Create Registry Variable dashboard. You can access this dashboard from the navigation panel, or through the Manage Registry Variables dashboard.
vFoglight Administration and Configuration Guide 2 Open the Create Registry Variable dashboard by completing one of the following steps: • On the navigation panel, under Dashboards, choose Administration > Rules & Notifications > Manage Registry Variables. In the Manage Registry Variables dashboard that appears in the display area, click the Add Variable button in the lower-left corner.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 197 • Description/Comments: Any comments about the variable or its usage. • Registry Value Type: The data type of the variable. There are 6 possible data types to which a variable can be set, as listed below. Note The registry variable type cannot be changed once the registry variable has been added. Registry Value Type Description Example Boolean A boolean value: true or false. true String A text string.
vFoglight Administration and Configuration Guide Registry Value Type Description Example Timestamp Contains a date and time. For example, valid values include 06/ 12/06, 2006-06-21 15:30:21.0, June 7, 2006 3:08:21 PM. Invalid date or time formats cannot be saved to the database and any attempts to save them result in an error. If the time is not provided, or the values are invalid, vFoglight treats the time as midnight.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables Registry Value Type Description Example PasswordValue A password value. Prior to storing the value of the PasswordValue data type in the registry, vFoglight encrypts it and saves the encrypted value in the database. This is useful in cases where you need to secure password values when passing it to command or remote command actions.
vFoglight Administration and Configuration Guide 6 To verify if the variable appears in the Manage Registry Variables dashboard, click Go to Registry Variable List. To edit the newly-created variable, click Edit Registry Variable. For information on how to edit registry variables, see “Editing Registry Variables” on page 200.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables Note 201 The name and value type of a registry variable cannot be changed after the variable creation. Registry variables are referred to by their names in rule conditions and expressions and changing them would invalidate these references. However, you can copy a registry variable and give the copy a different name. 2 Optional.
vFoglight Administration and Configuration Guide Multiple Values to a Registry Variable” on page 216 for an example of how to use this feature. For more information about schedules, see Chapter 8, “Using Schedules” on page 395. The values that you assign to a variable must be consistent with the data type that you specify at variable creation time. For example, if you selected Integer as the data type, type 10 when specifying the value, not ten.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables Data Type String Long Integer Double Timestamp Password Value Global Default Area 203 To specify the value Type the value in the box, making sure that the value is compatible with the data type. For example, if the variable is of a String type, type a text string. Type the password into each box.
vFoglight Administration and Configuration Guide Note The value that you specify in this field applies to all topology types and objects other than those that you specify in the Registry Values table, as described in “Scoping variables to topology types or object instances” on page 206. It is effective at all times except at the times set in the schedules added to the Default Value Performance Calendar, as described in “Using performance calendars” on page 204.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 205 To add schedules to a performance calendar: Note This procedure continues from “Specifying values” on page 201. 1 Choose a schedule. Click Schedule Name and select a schedule from the list that appears. The list reflects the existing schedules. For information on how to add schedules to vFoglight, see Chapter 8, “Using Schedules” on page 395. 2 Specify the value for the newly-selected schedule.
vFoglight Administration and Configuration Guide To move a threshold bound up or down, in the Default Value Performance Calendar table, in the Schedule Name column, use the Move up the selected performance calendar ( ) or Move down the selected performance calendar ( ) buttons as required. From here, you can proceed to “Scoping variables to topology types or object instances” on page 206.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 207 2 Click Topology Type and select a type from the list that appears. 3 Optional. Narrow down your scope to a particular object Click Topology Object and select an object from the list that appears. 4 Specify the default value that you want the variable to use when scoping on the newly-specified topology type or object.
vFoglight Administration and Configuration Guide Use the Value box to specify the value with which you want to replace the default value during the period defined by the schedule. c Click Add. The schedule and alternate value appear in the Default Value Performance Calendars table, as specified. d Click Done. In the Edit Registry Variable pane, the Registry Value table refreshes, showing the newly-added registry value scoped to a topology type or object, as specified.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 209 Viewing Registry Values A registry variable can have a global value that is available to all topology types and objects. It can also have multiple additional values associated with specific topology types or objects, or calendar dates. To find out what is the value of a registry variable for a particular topology type or object, and, if applicable, during a specific time period, use the Check Registry Value dashboard.
vFoglight Administration and Configuration Guide • Registry Value: The value to which the variable is set during a specified date and time range. If there are multiple time ranges during which the registry value changes, the table shows the registry value for each range. 4 Specify the name of the variable whose values you want to view. For example, we will look at the SYSADMIN variable that is scoped to two topology object instances and two different performance calendars.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 211 b In the Registry Variable list, scroll down until you find SYSADMIN and select that entry. 5 Select the topology type to which the SYSADMIN variable is scoped. a In the View Registry Variable view, click the link that appears on the right of Topology Type Name. The Topology Type list appears, showing all topology types that exist in your vFoglight environment.
vFoglight Administration and Configuration Guide b In the Topology Object list, select an object instance. 7 Specify the date and time range during which you want to see the registry values. In the View Registry Variable view, on the right of Date Time Range, drag the edges of the Zonar to set the range. For more information about the Zonar, see the vFoglight User Guide. The Registry Value table refreshes, showing different registry values for different date and time periods. 8 Optional.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 213 Since all of the four columns appear in the Registry Value table by default, all of the check boxes that correspond to the columns appear selected. b To hide a column, in the Show columns dialog box, clear the corresponding check box. or To show a column, clear the corresponding check box.
vFoglight Administration and Configuration Guide Show/Hide columns The Show columns dialog box appears. b In the Show Columns dialog box, under Actions, click one of the following links: Export as CSV, to export the table contents to a Comma Separated Values (CSV) file. Export as PDF, to export the table contents to a PDF file. Important If you previously show or hide one or more columns in the audit table, this layout is reflected in the exported file.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables Note 215 The appearance of the above dialog box may be different, depending on the type and version of your Web browser. 10 Change the object instance and the date and time range. The Registry Value table refreshes, showing the values scoped to the selected object instance and date and time range. 11 View the logic that determines a registry value that appears in the list. Click a row containing a registry value.
vFoglight Administration and Configuration Guide Example: Assigning Multiple Values to a Registry Variable You have several groups of servers in your monitored environment. You want an email to be sent to the system administrator if one of the servers becomes unavailable, but a different administrator is responsible for each group.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 217 that is set to the recur daily at the times when it is acceptable for response times for the servlet instances to exceed eight seconds. You then navigate to the Manage Registry Variables dashboard, and select the variable ResponseTimeTooLong.
vFoglight Administration and Configuration Guide 3 On the Manage Registry Variables dashboard, locate the row containing the SYSADMIN variable. Tip You can filter the list of variables using filters. At the top of the Manage Registry Variables dashboard, in the Filter By Variable Name box, type SYSADMIN. The Manage Registry Variables dashboard refreshes, showing only the SYSADMIN variable. 4 Open the SYSADMIN variable for editing. Click the Variable Name column of the row containing SYSADMIN entry.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables 219 5 Assign an email address to each monitored host by adding two host-specific values to the SYSADMIN variable. To add a topology-scoped value to the registry variable, complete the following steps. a At the bottom of the Edit Registry Variable view, click Add Registry Value. The Manage Registry Variables dashboard refreshes, showing the Create Registry Value—Step 1 view.
vFoglight Administration and Configuration Guide b Set the scope of the SYSADMIN variable to the Host type. In the Create Registry Value—Step 1 view, on the right of Topology Type, click Select Type. In the list that appears, under Core, select Host. c Narrow down the scope of the value by setting the value scope to a particular instance of the Host type. On the right of Topology Object, click All Objects In the list that appears, select a monitored host.
Working with vFoglight Rules and Registry Working with vFoglight Registry Variables f 221 In the bottom-right, click Done. The Manage Registry Variables dashboard refreshes, showing the newlyadded value in the Registry Values table. To add another email address, scoped to the other monitored host, repeat step a to step f. When you add the second topology-scoped value, the Registry Values table shows two entries, one for each host.
vFoglight Administration and Configuration Guide
Working with vFoglight Rules and Registry Working with Rules 223 Working with Rules vFoglight allows you to create flexible rules that can be applied to complex, interrelated data from multiple sources within your distributed system. You can associate several different actions with a rule, configure a rule so that it does not fire repeatedly, and associate a rule with schedules that define when it should and should not be evaluated.
vFoglight Administration and Configuration Guide • Registry Variable. A variable stored in the vFoglight registry that can be used in rule conditions, actions, and expressions. The value of a registry variable can be configured to change over time. Variables can be scoped to specific topology types or objects. • Metric. A metric is a value measured over time. There are two types of metrics in vFoglight: raw and derived.
Working with vFoglight Rules and Registry Working with Rules 225 • “Example: Configuring Rule Action Parameters” on page 314 • “Example: Creating Rules with Different Topology Types” on page 315 • “Example: Implementing Command Actions in Rules” on page 322 Managing Rules The Manage Rules dashboard contains a table that lists all of the simple rules and multiple-severity rules that are currently defined, the scope of each rule, and the cartridge with which each rule is associated (if applicable).
vFoglight Administration and Configuration Guide To open the navigation panel, click the right-facing arrow on the left. 2 On the navigation panel, under Dashboards, choose Administration > Rules & Notifications > Manage Rules. The Manage Rules dashboard appears in the display area. 3 Newly-installed cartridges. In the upper-right corner, click . The list of rules refreshes, showing any rules that come with newly-installed cartridges.
Working with vFoglight Rules and Registry Working with Rules 227 • To show only the rules that belong to a particular cartridge, in the Cartridge Name box at the top, type the cartridge name. The Manage Rules dashboard refreshes, showing only the rules that come with the specified cartridge. • To clear the filters, click Clear Filters. The Manage Rules dashboard refreshes, showing the list of all rules.
vFoglight Administration and Configuration Guide • “Viewing and editing rule definitions” on page 245 Editing rule permissions vFoglight allows you to control access to rules. For each rule you can grant or deny read, write, or control access to roles or users. For more information about security concepts in vFoglight, see Chapter 3, “Managing Users and Security” on page 105.
Working with vFoglight Rules and Registry Working with Rules 229 2 To add permissions to a rule, complete the following steps. a Click the role or user to which you want to assign permissions. Tip The Not Assigned icons in the Permissions columns indicate that the role has no permissions assigned to it. The Add Role Permission or Add User Permission dialog box appears.
vFoglight Administration and Configuration Guide b In the dialog box that appears, use the Read, Write, and Control check boxes to assign permissions as required, and click Save. The dialog box closes and the selected entry refreshes, showing three check marks in the Permission columns, one for each of the read, write, and control permissions. Permission granted Permission denied 3 To edit or delete permissions for a rule, complete the following steps.
Working with vFoglight Rules and Registry Working with Rules 231 b To edit the permissions, ensure that the Edit option is selected and use the Read, Write, and Control check boxes as required. c To delete the permissions, select the Delete option d Click Save. The dialog box closes and the selected entry refreshes, showing the newlyedited permissions. Copying rules Use the Copy Rule button on the Manage Rules dashboard to copy a rule, as outlined below.
vFoglight Administration and Configuration Guide 2 In the Rule Confirmation dialog box, click OK. The Rule Confirmation dialog box closes and the Edit Rule area appears in the Manage Rules dashboard, allowing you to edit the newly-copied rule.
Working with vFoglight Rules and Registry Working with Rules 233 Simple rule Multiple-severity rule Note The appearance of the Edit Rule area depends on the severity levels of the newlycopied rule as indicated in the above illustration. For more information about rule severity levels, see “Adding severity-level variables” on page 256 3 If required, edit the newly-copied rule. For more information, see “Defining Rules” on page 248.
vFoglight Administration and Configuration Guide To delete a rule: Note This procedure continues from “Accessing the Manage Rules dashboard” on page 225. 1 In the Manage Rules dashboard, select the row containing the rule that you want to delete. 2 Click the Delete Selected button at the bottom. The Delete Rule Confirmation dialog box appears. 3 In the Delete Rule Confirmation dialog box, click OK. The Delete Rule Confirmation dialog box closes. 4 Observe the Manage Registry Variables dashboard.
Working with vFoglight Rules and Registry Working with Rules 235 1 In the Manage Rules dashboard, select the row containing the rule that you want to disable. Tip To select multiple rules, press the CTRL or SHIFT key while selecting the rows containing the rules that you want to disable. 2 Click the Disable Rules button at the bottom. The Delete Rule Confirmation dialog box appears. 3 In Delete Rule Confirmation dialog box, click OK.
vFoglight Administration and Configuration Guide 3 In Delete Rule Confirmation dialog box, click OK. The Delete Rule Confirmation dialog box closes and the Manage Rules dashboard refreshes, no longer showing the Rule is currently disabled icon ( the row containing the newly-enabled rule. ) in Suspending or resuming alarms You can configure a rule to stop generating alarms for a specified length of time (beginning immediately).
Working with vFoglight Rules and Registry Working with Rules 237 3 Specify the time period for which you want to suspend alarms. In the Temporarily Suspend Rule Alarms dialog box, click For and select the time period as required, then click Go. The Temporarily Suspend Rule Alarms dialog box closes and the Manage Rules dashboard refreshes, showing a warning icon in the row containing the rule with newly-suspended alarms. Note The warning icon indicates different types of states a rule may be in.
vFoglight Administration and Configuration Guide 3 Click OK. The Rule Confirmation dialog box closes and the Manage Rules dashboard refreshes. 4 In the Manage Rules dashboard, observe the row containing the rule whose alarms you resumed. The absence of the warning icon indicates that the alarms for the rule are no longer suspended. If a warning icon appears in the row containing the rule with newly-resumed alarms, place the mouse pointer over the icon.
Working with vFoglight Rules and Registry Working with Rules 239 A message appears, indicating the actions will be suspended for the selected amount of time. Click Save. The Temporarily Suspend Rule Actions dialog box closes and the Manage Rules dashboard refreshes, showing a warning icon in the row containing the rule with newly-suspended actions. Note The warning icon indicates different types of states a rule may be in.
vFoglight Administration and Configuration Guide The Rule Confirmation dialog box closes and the Manage Rules dashboard refreshes. 4 In the Manage Rules dashboard, observe the row containing the rule whose actions you resumed. The absence of the warning icon indicates that the actions for the rule are no longer suspended. If a warning icon appears in the row containing the rule with newly-resumed actions, place the mouse pointer over the icon.
Working with vFoglight Rules and Registry Working with Rules 241 2 If required, edit the rule schedules. For more information, see “Associating Rules with Schedules” on page 299. Viewing a rule summary The Edit Rule view includes a summary pane that allows you to quickly review a rule’s settings and drill down to the appropriate tab if required.
vFoglight Administration and Configuration Guide • Conditional expressions, alarm messages, and actions for each severity level Figure 3 To view a rule summary: Note This procedure continues from “Accessing the Manage Rules dashboard” on page 225. 1 In the Manage Rules dashboard, click the Rule Name column of the row containing the rule that you want to enable or disable The Edit Rule view appears in the display area.
Working with vFoglight Rules and Registry Working with Rules 243 Simple rule Multiple-severity rule Note The appearance of the Edit Rule view depends on the severity levels of the newlycopied rule as indicated in the above illustration. For more information about rule severity levels, see “Defining rule types” on page 250. 2 Open the Rule Summary pane by clicking the Roll Down button ( Rule Summary bar. The Rule Summary pane expands in the display area.
vFoglight Administration and Configuration Guide Note The appearance of the Rule Summary pane depends on the rule type, its severity levels, and other settings. In the above illustration, the rule whose settings appear in the Rule Summary pane is active. 3 Observe the rule summary. The Rule Summary pane includes links to other areas in the Edit Rule view and Manage Rules dashboard that allow you to quickly edit the rule settings if required. 4 Move the mouse pointer over the Rule Summary pane.
Working with vFoglight Rules and Registry Working with Rules 245 The Behavior tab opens in the Edit Rule view. Viewing and editing rule definitions To view or edit rule definitions: Note This procedure continues from “Accessing the Manage Rules dashboard” on page 225. 1 In the Manage Rules dashboard, click the Rule Name column of the row containing the rule whose definitions you want to view. The Edit Rule view appears in the display area.
vFoglight Administration and Configuration Guide Simple rule Multiple-severity rule Note The appearance of the Edit Rule area depends on the severity levels of the newlycopied rule as indicated in the above illustration. For more information about rule severity levels, see “Defining rule types” on page 250. 2 Observe the rule definitions. 3 Edit the rule definitions as required. For complete instructions, see “Defining Rules” on page 248.
Working with vFoglight Rules and Registry Working with Rules 247 To create a rule: Note This procedure continues from “Getting Started with the Administration Module” on page 32. 1 Ensure that the navigation panel is open. To open the navigation panel, click the right-facing arrow on the left. 2 Open the Create Rule dashboard by completing one of the following steps: • On the navigation panel, under Dashboards, choose Administration > Rules & Notifications > Manage Rules.
vFoglight Administration and Configuration Guide From here, you can proceed to “Defining Rules” on page 248. Defining Rules Rule definitions can consist of any if the following components: • Registry Variables. A registry variable can be used in rule conditions, expressions, and actions. Registry variables are stored in the vFoglight registry. A registry variable can have a global value that is available to all topology types and objects.
Working with vFoglight Rules and Registry Working with Rules 249 • “Defining rule types” on page 250 • “Triggering rules” on page 251 • “Defining the rule scope” on page 253 Getting started with rule definitions Once you create a rule, you can add comments to it and edit its settings as required. To get started with rule definitions: Note This procedure continues from “Copying rules” on page 231, “Viewing and editing rule definitions” on page 245, or “Creating Rules” on page 246.
vFoglight Administration and Configuration Guide Defining rule types There are two types of rules in vFoglight. Each rule type of is associated with a topology type and can be scoped to one or more specific topology objects. Those types are: • Simple rules. A simple rule has a single condition, and can be in one of three states: • Fire • Undefined • Normal If its condition is met, the state of the rule is set to Fire and any actions that are associated with this state are performed.
Working with vFoglight Rules and Registry Working with Rules 251 An alarm is generated each time a multiple-severity rule enters a new state. In addition, you can configure a multiple-severity rule to perform one or more actions upon entering and/or exiting each state. To define the rule type: Note This procedure continues from “Getting started with rule definitions” on page 249. • Select the rule type.
vFoglight Administration and Configuration Guide For details on how to write conditions for event-driven rules, see “Defining conditions for event-driven rules” on page 267. To assign a time-driven trigger: Note This procedure continues from “Defining rule types” on page 250. 1 In the Rule Definition tab, under Rule Triggering, select the Time Driven option. The Rule Definition tab refreshes, showing a set of Recurrence Interval boxes on the right.
Working with vFoglight Rules and Registry Working with Rules 253 The Rule Definition tab refreshes, showing the Event Name box on the right. 2 Specify the event that you want to use as the rule trigger. Click Event Name and select one of the following events: • AlarmSystemEvent • ReportGeneratedEvent Note For details on how to write conditions for event-driven rules, see “Defining conditions for event-driven rules” on page 267. From here, you can proceed to “Defining the rule scope” on page 253.
vFoglight Administration and Configuration Guide • In the Rule Definition tab, use the Rule Scope area to scope the rule to one or more topology objects. For detail instructions, see “Setting the Scope for a Rule or Derived Metric” on page 474. From here, you can proceed to “Defining Conditions, Alarms, and Actions” on page 254. Defining Conditions, Alarms, and Actions Simple rules have a single condition only, and can be in one of three states: Fire, Undefined, or Normal.
Working with vFoglight Rules and Registry Working with Rules 255 Figure 4 Simple rule Multiple-severity rule If you plan to make use of this feature, you need to add those variables before writing conditional expressions.
vFoglight Administration and Configuration Guide • “Copying severity-level variables and actions in multiple-severity rules” on page 297 Adding severity-level variables Each severity-level can have its own set of variables that you can use in alarm messages. Unlike registry variable that are global in nature, severity-level variables are only accessible to the severity level in which you define them. There are two types of severity-level variables: • Expressions.
Working with vFoglight Rules and Registry Working with Rules 257 In the above example, the Text and Subject variables make use of the expression-type variables, var1, var2, and var3. Furthermore, the Text and Subject variables can be used in an alarm message in an email action that sends that information to a specified recipient when the rule generates an alarm. If you are defining a simple severity rule, you can add one set of severity-level variables.
vFoglight Administration and Configuration Guide Note For more information about rule severity levels, see “Adding severity-level variables” on page 256. 2 Choose the alarm level for which you want to define the severity-level variables. If you are defining a simple rule, click Fire.
Working with vFoglight Rules and Registry Working with Rules 259 Simple rule Multiple-severity rule 3 Open the Severity Level Variables tab. The Severity Level Variables tab appears in the severity-level definition pane.
vFoglight Administration and Configuration Guide 4 Define the type of the severity variable by selecting one of the following Type options on the right: • Expression • Message 5 Name the severity-level variable. In the Name box, type the name of the variable. Important. The following names are reserved and should not be used: • foglight_severity_level • foglight_severity_level_name 6 Specify the variable value.
Working with vFoglight Rules and Registry Working with Rules 261 7 Click Add. The Severity Level Variables pane refreshes, showing the newly-added variable. To delete a severity-level variable from the list, select the row containing that variable in the Severity Level Variables pane, and click Delete Selected. From here, you can proceed to “Writing conditions” on page 261. Writing conditions A condition is the part of a rule that is evaluated against monitoring data.
vFoglight Administration and Configuration Guide Furthermore, event-driven rules can retrieve data generated by report- and alarmrelated events. Expressions can be simple—for example, an expression can consist only of a metric name—but they can also be defined using very complex syntax. See “Examples” on page 481 for examples of expressions. Conditional expressions make use of the query language.
Working with vFoglight Rules and Registry Working with Rules 263 to each severity level. System expressions are listed in the vFoglight Administration Module. Defining conditions for data-driven and time-driven rules When you write conditions for data-driven or time-driven rules, you can make use of variables, topology object metrics, and Groovy functions. To define a condition for a data-driven or time-driven rule: Note This procedure continues from “Adding severity-level variables” on page 256.
vFoglight Administration and Configuration Guide Simple rule Multiple-severity rule Important The appearance of the Condition tab depends on the rule type. In addition to the condition editor, multiple-severity rules also include an alarm editor that allows you to compose an alarm message associated with each severity state (Warning, Critical, and/or Fatal).
Working with vFoglight Rules and Registry Working with Rules 265 In the Condition tab, use the Condition area to write the conditional expression. You can type the condition directly into the Condition box, or use the operator controls and the Condition Editor to add logical operators, registry variables, metrics, or Groovy functions. For complete information about inserting operators or using the Condition editor, see “Specifying a Rule Condition or Derived Metric Expression” on page 481.
vFoglight Administration and Configuration Guide println @event.dump() Note Using a semicolon to end the line in a single-line expression is optional, therefore both expressions are valid. 3 Multiple-severity rules. Activate the condition by selecting the Activate check box. You must activate the condition for a severity level in a multiple-severity rule before you can save it.
Working with vFoglight Rules and Registry Working with Rules 267 • To add a rule-level variable, in the Alarm Message Editor dialog box, on the Rule Variables tab, select the rule-level variable and click Insert. • To add a system variable, on the System Variables tab, select the system variable and click Insert. The newly-added variable appears in the Alarm Message box. When you finish adding variables to the alarm message, close the Alarm Message box by clicking Close.
vFoglight Administration and Configuration Guide events and use the following properties in rule conditions in order to trigger event-driven rules: Property Data Type Description alarmID String Contains the ID of the alarm that generates the event. alarmLink String Contains the URL to the alarm. clearedTime Date Specifies the time at which the alarm is cleared. change AlarmChangeType Specifies the alarm change type: Fire, Clear, or Acknowledge.
Working with vFoglight Rules and Registry Working with Rules Property Data Type Description severityLevel Integer Contains a number that identifies the severity level: • 0: Undefined • 1: Normal • 2: Warning • 3: Critical • 4: Fatal severityName String Contains one of the following values that identify the severity level: Undefined, Normal, Warning, Critical, or Fatal. sourceID String Contains the ID of the source data object that generates the event.
vFoglight Administration and Configuration Guide Property Data Type Description createdTime Date Specifies the time at which the event is created. report Report Contains an object of the Report type. For complete information about creating and scheduling reports in vFoglight, see the vFoglight User Guide. In addition to the ReportGeneratedEvent object properties you can reference the Report object properties when writing rule conditions for a rule triggered by a report generation event.
Working with vFoglight Rules and Registry Working with Rules Property Data Type Description scheduleName String The name of the schedule that is associated with the report. size Integer The report size in bytes. templateId String The ID of the template used to create the report. templateName String The name of the template used to create the report. user String The name of the vFoglight user who created the report.
vFoglight Administration and Configuration Guide Simple rule Multiple-severity rule Important The appearance of the Condition tab depends on the rule type. In addition to the condition editor, multiple-severity rules also include an alarm editor that allows you to compose an alarm message associated with each severity state (Warning, Critical, and/or Fatal).
Working with vFoglight Rules and Registry Working with Rules 273 In the Condition tab, use the Condition area to write the conditional expression. using the following syntax: some_value.equals(@event.get("[report/]property"); Where • report indicates that you want to use the ReportGeneratedEvent in the conditional expression. • property is the name of the event property that you want to use in the comparison.
vFoglight Administration and Configuration Guide println @event.dump(); @event.get("report/name") == "MyReport"; Incorrect println @event.dump() @event.get("report/name”) == "MyReport"; Note The first line is missing a semicolon which causes the expression to result in an error. Single-line expressions Example B Correct println @event.dump(); Example C Correct println @event.dump() Note Using a semicolon to end the line in a single-line expression is optional, therefore both expressions are valid.
Working with vFoglight Rules and Registry Working with Rules 275 5 Multiple-severity rules (Optional). To reference a rule-level variable or a system variable in the alarm message, in the Alarm Message box, click the location to which you want to add the variable, and then click the Alarm Message Editor button ( ) above the Alarm Message box. The Alarm Message Editor dialog box appears.
vFoglight Administration and Configuration Guide Copying conditions in multiple-severity rules In some cases you may need to copy the conditions from an existing severity level of the same rule. A condition is comprised of a conditional expression and an alarm message, both of which are copied when required. For more information about conditional expressions and alarm messages, see “Writing conditions” on page 261.
Working with vFoglight Rules and Registry Working with Rules 277 a Click the Copy condition/alarm button above the Condition tab. A list appears, showing those severity levels for which the conditions have been defined. For example, if you are defining a condition for the Critical severity, and the conditions for the Fatal and Warning levels have already been defined, the list shows two options: Fatal and Warning, as illustrated below.
vFoglight Administration and Configuration Guide Defining actions An action is a particular operation that is performed when a rule enters or exits a state (for example, when a rule condition is met). Multiple actions can be associated with simple rules as well as with each severity level in a multiple-severity rule. Actions can be added to a rule after it is created.
Working with vFoglight Rules and Registry Working with Rules 279 • Command Actions. They cause an external action to be executed on the machine hosting the vFoglight Management Server. For example, a Command action may run the executable that starts a service. Various parameters can be set for this action. The mandatory parameter is COMMAND_LINE which is the executable command and one or more arguments. Optionally, you can also set OS environment variables (separated by an exclamation mark).
vFoglight Administration and Configuration Guide To view email settings in vFoglight: Note This procedure continues from “Accessing the vFoglight Configuration Dashboard” on page 67. • In the vFoglight Configuration dashboard, locate the Mail (Global Settings) view.
Working with vFoglight Rules and Registry Working with Rules 281 2 Set the global default values of the following mail. variables: • mail.from: The default email address used by the vFoglight Management Server from which emails are sent. • mail.host: The default email host used by the vFoglight Management Server from which emails are sent. • mail.password: The default password for logging into the email server. • mail.
vFoglight Administration and Configuration Guide In the Edit Registry Variable view, in the Global Default area, type the global default value that you want to assign to the variable. For example, to configure the mail.host variable, type the name of the default email host that you want the vFoglight Management Server to use for sending emails. b On the right of the Global Default area, click Save. A message appears in the upper-left corner, indicating success.
Working with vFoglight Rules and Registry Working with Rules 283 The Manage Registry Variables dashboard refreshes, and the row containing the newly-edited variable appears selected in the list. For complete information on how to edit a registry variable, see “Editing Registry Variables” on page 200. 3 Optional. Configure the mail connection and mail socket time-outs. The default values are 20 seconds for the connection and 10 seconds for the socket time-out.
vFoglight Administration and Configuration Guide b Specify the name and data type for the variable using the following boxes: Registry Variable Name: The name of the variable: mail.connection.timeout when specifying the connection time-out or mail.socket.timeout for the socket time-out. Registry Value Type: Click the box and select Integer from the list that appears. c Click Add. The Create Registry Variable dashboard refreshes, showing the Step 2: Registry Variable Added view.
Working with vFoglight Rules and Registry Working with Rules 285 d Edit the newly-created registry variable. In the Step 2: Registry Variable Added view, click Edit Registry Variable. The Create Registry Variable dashboard refreshes, showing the Edit Registry Variable view.
vFoglight Administration and Configuration Guide e Specify the length of the time-out. In the Edit Registry Variable view, in the Global Default area, ensure that the Static Value option is selected and type the number of seconds in the box. f Save your changes. On the right of the Global Default area, click Save. A message appears in the upper-left corner, indicating success.
Working with vFoglight Rules and Registry Working with Rules 287 To add an action to a rule: Note This procedure continues from “Defining conditions for data-driven and time-driven rules” on page 263. 1 In the Conditions and Actions tab (simple rules) or Conditions, Alarms & Actions tab (multiple-severity rules), open the Action tab. The Action tab appears in the display area.
vFoglight Administration and Configuration Guide From here, you can edit the action parameters as required. For details, see “About action parameters” on page 288. About action parameters Each rule action has a set of parameters associated with it. Some action parameters are mandatory while others are optional. When you add an action to a rule, you must configure the action’s mandatory parameters in order for it to be executed when the rule reaches the severity level for which the action is defined.
Working with vFoglight Rules and Registry Working with Rules 289 Parameter Required? Description COMMAND_LINE Yes The command that you want to run on the command line along with its options and arguments if applicable. Note If the command is not accessible from the directory, you need to specify its path. No A list of environment variables separated by exclamation marks ‘!’. mail.attachement No Email attachment. mail.attachement.file.
vFoglight Administration and Configuration Guide Parameter Required? Description mail.subject No Mail subject line COMMAND_LINE Yes The command that you want to run remotely along with its options and arguments if applicable. ENVIRONMENT_VARIABLES No A list of environment variables separated by exclamation marks ‘!’. HostName Yes The name of the host computer on which the command is to be executed.
Working with vFoglight Rules and Registry Working with Rules 291 Parameter Required? Description UseRegExp No Indicates whether the values specified by the HostName, PlatformInfo, and RemoteInstallationId parameters are regular expressions. Argument 1-10 No Parameters to pass to the script. Scoping object id No The ID of the scoping object. Script name Yes The name of the script. Script Actions Caution The rule runs the script from the /scripts directory.
vFoglight Administration and Configuration Guide Incorrect P:\hello.bat (where P: is a mapped drive) Only those commands that point to a specific batch file on a physical drive produce a command output in the Command Prompt window. That is because command actions invoked by a script do not read back from the stream nor print the command output to the console, waiting for the command to finish. In the above examples, only C:\hello.bat generates a command-line output.
Working with vFoglight Rules and Registry Working with Rules 293 Rules in vFoglight can be triggered by data, time, or events. Different trigger types, such as time, data, and event triggers, have different rule-level variables available to them. For example, in an event-driven rule you can reference the properties of the system alarm event that triggers the rule directly. The following table lists all of the rule-level variables and indicates their availability in different trigger types.
vFoglight Administration and Configuration Guide Variable Description Trigger Type Time Data Even t foglight_rule_name Rule name Yes Yes Yes foglight_scoping_id ID of the topology object Yes Yes Yes For more information on rule trigger types, see “Triggering rules” on page 251. Note vFoglight prevents you from creating a rule variable with the same name as a system variable. However, the variable name can change if you change the trigger type.
Working with vFoglight Rules and Registry Working with Rules Note 295 The above screen capture shows a list of parameters for a command action. Each action has a different set of parameters associated with it. For more information, see the table listing preceding this procedure. 2 Observe the Type column of the row containing the parameter that you want to edit. Caution The Type column shows the parameter’s data type.
vFoglight Administration and Configuration Guide 4 Specify the parameter value by completing one of the following steps in the Action Parameter Editor dialog box. Caution When specifying the parameter value, ensure that the value you specify matches the parameter’s data type. For more information, see step 2. • Set the parameter to a vFoglight registry variable.
Working with vFoglight Rules and Registry Working with Rules 297 In the Variable tab, in the Rule/System Variables table, select the row containing the rule system variable to which you want to set the parameter. The list of available variables depends on the rule trigger type. For complete information about rule system variables, see “About rule system variables” on page 292. For details on rule triggers, see “Triggering rules” on page 251. • Set the parameter to a custom value.
vFoglight Administration and Configuration Guide variables, see “Adding severity-level variables” on page 256 and “Defining actions” on page 278. While you are in the edit rule mode, any unsaved changes to the severity-level variables or actions that you want to copy will be carried over to the destination severity.
Working with vFoglight Rules and Registry Working with Rules 299 severity, and the conditions for the Fatal and Warning levels have already been defined, the list shows two options: Fatal and Warning, as illustrated below. Caution Attempting to copy a condition for a rule that has no conditions defined results in error. b Select the severity level whose condition you want to copy. The Condition tab refreshes.
vFoglight Administration and Configuration Guide rule, then it is automatically active at all times other than those specified by the blackout schedules. If you add both effective and blackout schedules to a rule, then it will be active only at the times specified by the effective schedules minus the times specified by the blackout schedules. This is because blackout schedules take precedence over effective schedules.
Working with vFoglight Rules and Registry Working with Rules 301 The Effective Schedules list on the right refreshes, showing the newly-added schedules. 3 Assign blackout schedules. a In the list that appears in the lower-left corner, select one or more schedules that you want to assign as blackout schedules. Note The list shows all schedules that exist in vFoglight. For information on how to add or remove schedules, see Chapter 8, “Using Schedules” on page 395. b Click Add on the right of the list.
vFoglight Administration and Configuration Guide From here, you can proceed to “Defining Alarm and Action Behavior” on page 302. Defining Alarm and Action Behavior vFoglight allows you to configure a rule so that its actions and alarms (multiple-severity rules only) do not fire repeatedly. Defining the behavior of rule alarms and actions can help you avoid being overwhelmed with alerts when a rule condition is met many times within a short period.
Working with vFoglight Rules and Registry Working with Rules 303 Defining Rule-Level Variables In addition to vFoglight registry variables and severity-level variables, you can define rule-level variables. If you are creating or editing a multiple-severity rule, you can define a rule level variable and reference it in expressions of different severities in the rule definition. There are two types of rule-level variables: • Expressions. An expression is used to retrieve data.
vFoglight Administration and Configuration Guide To define a rule-level variable: Note This procedure continues from “Defining Alarm and Action Behavior” on page 302. 1 Open the Rule Variables tab. The Rule Variables tab opens in the display area. 2 Define the type of the rule-level variable by selecting one of the following Type options on the right: • Expression • Message 3 Name the severity-level variable. In the Name box, type the name of the variable. Important.
Working with vFoglight Rules and Registry Working with Rules 305 For example: Severity-Level Variables Name Value Type var1 scope.get("agent/host/name") Expression Text @var1: CPU Utilization Message In the Expression/Message box, type the value of the variable. 5 Click Add. The Rule Variables pane refreshes, showing the newly-added variable. To delete a rule-level variable from the list, select the row containing that variable in the Rule Variables pane, and click Delete Selected.
vFoglight Administration and Configuration Guide different actions with a rule, configure a rule so that it does not fire repeatedly, and associate a rule with schedules to define when it should and should not be evaluated. Different types of data can be used in rules, including registry variables, raw metrics, derived metrics, and topology object properties. There are two types of rules in vFoglight: simple rules and multiple-severity rules.
Working with vFoglight Rules and Registry Working with Rules 307 • Remote Agent Manager State Rule • ServiceLevelEvaluation – FMSServiceSLP Rule Agent Health State Rule Purpose This rule monitors the health of all agents in the monitoring environment. Scope Agent : agentID != "0" Rule Definition Conditions State An agent is down Warning An agent’s health is in decline Critical BSM All Events Rule Purpose This rule sends all alarms from vFoglight to the Service Discovery and Dashboards product.
vFoglight Administration and Configuration Guide Rule Definition Conditions State The Data Service discards one or more observations within a 15 minute interval Warning Catalyst Database Space Checking Rule Purpose This rule monitors the size of the database. Scope CatalystDatabase Rule Definition Conditions State The size of the vFoglight database exceeds 75% of the maximum database size. Warning The size of the vFoglight database exceeds 90% of the maximum database size.
Working with vFoglight Rules and Registry Working with Rules 309 Scope CatalystTablespace Rule Definition Conditions State The size that is available to the Oracle database exceeds the threshold of set by the DBSMon.WarningFreeTablespaceSize registry variable. Warning The size that is available to the Oracle database exceeds the threshold of set by the DBSMon.CriticalFreeTablespaceSize registry variable.
vFoglight Administration and Configuration Guide Scope AgentTypeLicense vFoglight Memory Usage Check Rule Purpose This rule checks the memory that is available to vFoglight. Scope (CatalystServer).jvm vFoglight Topology Size Limit Reached Purpose Checks if any attempts to create topology objects are failing because the topology size limit has been reached. This number is defined by the foglight.limit.instances registry variable whose global default value is set to 10000.
Working with vFoglight Rules and Registry Working with Rules 311 ServiceLevelEvaluation – FMSServiceSLP Rule Purpose vFoglight monitors each service (either implicit or user-defined) for service level compliance. The ServiceLevelEvaluation – FMSServiceSLP rule checks the availability of each service and raises an alarm if the availability is lower than the a predefined threshold during a period of one hour.
vFoglight Administration and Configuration Guide Setting basic rule properties In the Rule Definition area of the Create Rule dashboard, you name the rule EJB_Instance1-Rollbacks and add comments about the purpose of this rule. You select Multiple-Severity Rule as the Rule Type. Since you want this rule to be evaluated every time that metrics associated with EJB_Instance1 are sent to the vFoglight Management Server, you leave the Trigger Type at its default setting, Data Driven.
Working with vFoglight Rules and Registry Working with Rules 313 You click the Validate Scope button ( ) to ensure that the topology type is valid and that you used the correct syntax in the Rule Scope box. The rule scope is successfully validated, so you click Next to navigate to the Condition, Alarms & Actions tab. Specifying conditions After scoping the rule to EJB_Instance1 in MyApplication, you specify the conditions for the rule on the Condition, Alarms & Actions tab.
vFoglight Administration and Configuration Guide An entering Email action is set for this rule. This action uses the ProblemSynopsis message as the text of the email that is sent when the rule enters the Fire state.
Working with vFoglight Rules and Registry Working with Rules 315 2 Open the rule for editing and navigate to the Action tab of the severity level for which you want to define the actions. 3 Add an entering ScriptAction and edit its parameters. a If your script has one or more arguments, use the Argument 1-10 parameters to specify the arguments’ value. b If you want the script to run against a particular topology object, use the Script object id parameter to specify the object’s ID.
vFoglight Administration and Configuration Guide The following diagram illustrates the scope of each of the rules that you are about to create from the topology model perspective.
Working with vFoglight Rules and Registry Working with Rules 317 c In the Create Rule dashboard, in the Rule Definition tab, in the Rule Name box, type the rule name. For example, Processor Load. d Under Rule Type, select the Simple Rule option. e Under Rule Triggering, select the Data Driven option. 2 Scope the rule to the Processor topology type. a In the Rule Definition tab, in the Rule Scope pane, ensure that the No Scoping Query check box is clear.
vFoglight Administration and Configuration Guide 3 Write a condition that triggers the rule each time the utilization of a Processor type reaches 90% using the Processor’s percentUserTime metric. a In the Create Rule dashboard, open the Conditions and Actions tab. b Expand the condition editing pane by clicking the Fire bar. c Click the Condition Editor button ( ). The Condition Editor dialog box appears.
Working with vFoglight Rules and Registry Working with Rules d In the Condition Editor dialog box, open the Metric/Property tab.
vFoglight Administration and Configuration Guide e On the Metric/Property tab, in the left pane, in the Scoping Topology area, click Processor. Tip f The Scoping Topology area shows the rule scope, Processor, that you defined in step 1. The pane on the right refreshes, showing the instances and metrics for the selected Processor type.
Working with vFoglight Rules and Registry Working with Rules 321 g In the Metrics area, select percentUserTime and click Insert. The Condition box in the display area refreshes, showing the newly-selected metric. h Edit the condition as follows: #percentUserTime# > 0.9 i Click the Validate button ( ) above the Condition box. A success message appears above the Condition box.
vFoglight Administration and Configuration Guide Edit the condition as follows: max(#percentUserTime for 24h#) > 0.9 5 Click Finish. To scope a rule to the Host type: Note The information in this procedure assumes that you have a good understanding of the rule creation workflow. For step-by-step instructions on how to scope a rule to a topology type or use the Condition Editor, see the above procedure, “To scope a rule to the Processor type:” on page 316. 1 Create a simple, data-driven rule.
Working with vFoglight Rules and Registry Working with Rules 323 2 In the Edit Rule view, open the severity level to which you want to add a command action. 3 In the severity level area, open the Severity Level Variables tab, and add severity-level variables that contain the information that you want to print to an output file. For example: The above example shows seven different severity-level variables: • Subject, Text: Define the text that appears in the alarm message.
vFoglight Administration and Configuration Guide For example, the expression f4registry("OraDBAWarning") retrieves the value of the OraDBAWarning registry variable. 4 Open the Action tab and add an entering command action. 5 Define the action parameters as follows: • COMMAND_LINE: Specify the absolute path and name of the shell script that you want the command action to call.
Working with vFoglight Rules and Registry Working with Rules 325 When the rule meets the condition that includes the newly-defined command action, it writes the information to the output file. Here is a sample of what that output may look like: jorcl:PUBLIC:19.0:root@localhost: melscv-w2k3-fdb.melsales.dev.mel.au.qsft For complete information on how to add actions to rules, see “Defining actions” on page 278.
vFoglight Administration and Configuration Guide
7 Working with Data This chapter introduces you to vFoglight data management entities on how to create and manage these entities. It contains the following sections: Note In order to complete each of the procedures in this chapter, your user account must belong to a group with the Administration role. For more information about users, groups, and roles, see “Managing Users and Security” on page 105. This chapter contains the following sections: About Data Management in vFoglight ..........................
vFoglight Administration and Configuration Guide About Data Management in vFoglight vFoglight models retain collected data and transform it into nodes, adding configuration data to each node as properties, and attaching metric data to appropriate nodes as metrics. Each metric is associated with a topology type or with a specific topology object. In some cases you will need to create custom topology types that suit your monitoring needs. For more information, see “Adding Topology Types” on page 329.
Working with Data Adding Topology Types 329 Adding Topology Types vFoglight transforms monitoring data into models. A model is a set of objects and relationships designed to represent a monitored resource and its parts. Topology describes the logical and physical relationships between data nodes in a model. At runtime, vFoglight dynamically builds topology models based on data about your system that is collected by vFoglight agents.
vFoglight Administration and Configuration Guide 3 To add one or more topology types that are defined in an XML file accessible by your local machine, complete one of the following steps in the Import From File area of the Add Topology Type dashboard. • Ensure that the File on Local Computer option is selected. Then click Browse, and navigate to the topology file in the file browser that appears.
Working with Data Adding Topology Types 331 b In the File Location on Server box, type the path and name of the topology file. Use either an absolute path or a path relative to the installation directory of the vFoglight Management Server. Note Use the back slash character ‘\’ as a directory separator. For example, both of the following lines point to the same topology file: C:\Vizioncore\vFoglight\topology\topology.xml topology\topology.
vFoglight Administration and Configuration Guide The Alert message box appears, this time indicating that the topology import was successful. Working with Derived Metrics vFoglight transforms collected data into nodes. It adds configuration and metric data to each node as properties and metrics, respectively. A metric is a specific value that is measured over time. Each metric is associated with a topology type or with a specific topology object.
Working with Data Working with Derived Metrics 333 • “Creating Derived Metrics” on page 342 • “Defining Derived Metrics” on page 344 Managing Derived Metrics The Manage Derived Metrics dashboard contains a list of all derived metrics showing their name and scope. The derived metrics that exist in your vFoglight environment appear on the Manage Derived Metrics dashboard. However, there is no distinction between raw and derived metrics in other locations on the Administration module.
vFoglight Administration and Configuration Guide 3 To sort the list of derived metrics by their name or scope, click the Derived Metric Name or Derived Metric Scope column headings as required. 4 Optional. Filter the list of derived metrics. • To show only the derived metrics whose name matches a particular text pattern, in the Derived Metric Name box at the top, type the text pattern.
Working with Data Working with Derived Metrics 335 The Manage Derived Metrics dashboard refreshes, showing the list of all variables. From here, you can proceed to any of the following procedures: • “Editing permissions of derived metrics” on page 335 • “Copying derived metrics” on page 339 • “Deleting derived metrics” on page 341 • “Viewing and editing derived metrics” on page 341 Editing permissions of derived metrics vFoglight allows you to control access to derived metrics.
vFoglight Administration and Configuration Guide • If one has a permission to the derived metric, others with undefined permission do not have any permission. • Final permission is based on a combination of the role, user, and derived metric defined on the server side. Use the Edit Permissions button ( ) on the Manage Derived Metrics dashboard to navigate to the Edit Permissions for Derived Metric area, that allows you to add or edit permissions to roles and users, as outlined below.
Working with Data Working with Derived Metrics 337 2 To add permissions to a derived metric, complete the following steps. a Click the role or user to which you want to assign permissions. Tip The Not Assigned icons in the Permissions columns indicate that the role has no permissions assigned to it. The Add Role Permission or Add User Permission dialog box appears.
vFoglight Administration and Configuration Guide b In the dialog box that appears, use the Read, Write, and Control check boxes to assign permissions as required, and click Save. The dialog box closes and the selected entry refreshes, showing three check marks in the Permission columns, one for each of the read, write, and control permissions. Permission granted Permission denied 3 To edit or delete permissions for a rule, complete the following steps.
Working with Data Working with Derived Metrics 339 b To edit the permissions, ensure that the Edit option is selected and use the Read, Write, and Control check boxes as required. c To delete the permissions, select the Delete option d Click Save. The dialog box closes and the selected entry refreshes, showing the newlyedited permissions. Copying derived metrics Use the Copy Derived Metric button on the Manage Derived Metrics dashboard to copy a derived metric, as outlined below.
vFoglight Administration and Configuration Guide 2 In the Copy Derivation dialog box, click OK. The Copy Derivation dialog box closes and the Create Derived Metric view appears in the display area. 3 Provide a unique name for the destination metric. In the Create Derived Metric view, in the Derived Metric Name box, type the name of the derived metric. 4 If required, edit the settings of the newly-copied derived metric. For more information, see “Defining Derived Metrics” on page 344.
Working with Data Working with Derived Metrics 341 Deleting derived metrics Use the Delete Selected button on the Manage Derived Metrics dashboard to delete a derived metric, as outlined below. To delete a derived metric: Note This procedure continues from “Accessing the Manage Derived Metrics dashboard” on page 333. 1 In the Manage Derived Metrics dashboard, select the row containing the derived metric that you want to delete. 2 Click the Delete Selected button at the bottom.
vFoglight Administration and Configuration Guide 1 In the Manage Derived Metrics dashboard, click the Derived Metric Name column of the row containing the derived metrics whose definitions you want to view. The Edit Derived Metric view appears in the Manage Derived Metrics dashboard. 2 Observe the metric definitions. 3 Edit the derived metric as required. For complete instructions, see “Adding calculations to derived metrics” on page 344.
Working with Data Working with Derived Metrics 343 When you create a derived metric, vFoglight changes the topology type to which the derived metric is scoped by associating a new metric property to that topology type. To create a derived metric: Note This procedure continues from “Getting Started with the Administration Module” on page 32. 1 Ensure that the navigation panel is open. To open the navigation panel, click the right-facing arrow on the left.
vFoglight Administration and Configuration Guide From here, you can proceed to “Defining Derived Metrics” on page 344. Defining Derived Metrics Derived metrics are calculated from one or more (raw or derived) metrics. They must be scoped to a topology type and can optionally be scoped to specific objects of that type. If a rule or derived metric is not scoped to specific objects, it applies to all objects of that type. Many derived metrics are included with vFoglight and its cartridges.
Working with Data Working with Derived Metrics 345 The vFoglight Management Server processes the derived metric calculation in the order they are listed, starting with the first one. Changing their order affects the behavior of the actions that are associated with the derived metric.
vFoglight Administration and Configuration Guide 2 Use the Derived Metric Scope and Expression areas to specify the scope of the derived metric. Caution If you change the topology type or object(s) to which the derived metric is scoped, you may need to reconfigure the derived metric expression: the metrics specified in the existing expression may not be available for the new topology type or object.
Working with Data Working with Derived Metrics 347 3 When you finish adding calculations to derived metrics, ensure that their order is valid. Caution The vFoglight Management Server evaluates derived metric calculations in the order that they are listed, starting with the first one. Changing their order affects the output of actions that are associated with those calculations.
vFoglight Administration and Configuration Guide • thousand • thousandth • trillion • trillionth • year For example, to set the unit of the derived metric to a number of days per month, click the left Unit box, and select day from the list that appears, then click the right Unit box and select month, as illustrated bellow. 5 Define the data type of the derived metric. A derived metric take over the form of a metric or an observation type.
Working with Data Working with Derived Metrics 349 • Schedule-Driven Derived Metric. A schedule-driven derived metric is evaluated based on a schedule created in the Administration Module. See Chapter 8, “Using Schedules” on page 395 for information about schedules. There are three trigger timing options for schedule-driven derived metrics: • Enter and Exit. Causes the derived metric to be evaluated when the period defined by the schedule begins and ends. • Enter only.
vFoglight Administration and Configuration Guide • Enter and Exit • Enter only • Exit only 4 To enable the trigger without data, select the Enable Trigger without Data check box. 5 Save your changes. To assign a time -driven trigger: Note This procedure continues from “Adding calculations to derived metrics” on page 344. 1 In the Expression area, under Trigger Type, select the Schedule Driven option. The Expression area refreshes, showing a set of controls on the right.
Working with Data Working with Derived Metrics 351 To set the value type for a derived metric: Note This procedure continues from “Triggering derived metrics” on page 348. 1 In the area immediately below the Derived Metric Calculations list, click Value Type and select Metric from the list that appears. 2 Select the units of measurement. Use one or both of the Unit boxes on the left of Unit Type as required. For example, percent or count / second.
vFoglight Administration and Configuration Guide creating rules simpler and more efficient by creating a derived metric scoped to the same topology type and using it in these rules’ conditions. See “Examples” on page 490 for an example. In addition, creating a derived metric could help you manage these rules.
Working with Data Working with Thresholds 353 Example: Optimizing Performance Derived metrics can also help you optimize performance by reducing the number of calculations that need to be performed at run-time.
vFoglight Administration and Configuration Guide To access the Manage Thresholds dashboard: Note This procedure continues from “Getting Started with the Administration Module” on page 32. 1 Ensure that the navigation panel is open. To open the navigation panel, click the right-facing arrow on the left. 2 On the navigation panel, under Dashboards, choose Administration > Data > Manage Thresholds. The Manage Thresholds dashboard appears in the display area.
Working with Data Working with Thresholds 355 From here, you can proceed to any of the following procedures: • “Editing threshold permissions” on page 355 • “Deleting thresholds” on page 359 • “Viewing and editing thresholds” on page 360 Editing threshold permissions vFoglight allows you to control access to thresholds. For each threshold you can grant or deny read, write, or control access to roles or users.
vFoglight Administration and Configuration Guide Figure 2 Permission granted Permission denied Permissions not assigned To add permissions for a threshold: Note This procedure continues from “Accessing the Manage Thresholds dashboard” on page 353. 1 In the Manage Thresholds dashboard, in the row containing the variable whose permissions you want to edit, click the Edit Permissions for Threshold button ( ). The Edit Permissions for Threshold area appears in the Manage Thresholds dashboard.
Working with Data Working with Thresholds 357 2 To add permissions to a threshold, complete the following steps. a Click the role or user to which you want to assign permissions. Tip The Not Assigned icons in the Permissions columns indicate that the role does not have permissions assigned to it. The Add Role Permission or Add User Permission dialog box appears.
vFoglight Administration and Configuration Guide b In the dialog box that appears, use the Read, Write, and Control check boxes to assign permissions as required, and click Save. The dialog box closes and the selected entry refreshes, showing three check marks in the Permission columns, one for each of the read, write, and control permissions. Permission granted Permission denied 3 To edit or delete permissions for a threshold, complete the following steps.
Working with Data Working with Thresholds 359 b To edit the permissions, ensure that the Edit option is selected and use the Read, Write, and Control check boxes as required. c To delete the permissions, select the Delete option d Click Save. The dialog box closes and the selected entry refreshes, showing the newlyedited permissions. Deleting thresholds Use the Delete Selected button on the Manage Thresholds dashboard to delete a threshold, as outlined below.
vFoglight Administration and Configuration Guide 3 In the Delete Threshold dialog box, click OK. The Delete Threshold dialog box closes. 4 Observe the Manage Thresholds dashboard. The newly-deleted threshold no longer appears in the list. Viewing and editing thresholds To view or edit a threshold: Note This procedure continues from “Accessing the Manage Thresholds dashboard” on page 353.
Working with Data Working with Thresholds 361 2 Observe the threshold definitions. 3 Edit the threshold as required. For complete instructions, see “Adding bounds to metric threshold levels” on page 364. Creating Thresholds You can add new thresholds to vFoglight using the Create Threshold dashboard. You can access this dashboard from the navigation panel, or through the Manage Thresholds dashboard.
vFoglight Administration and Configuration Guide In the Manage Thresholds dashboard that appears in the display area, click the Add Threshold button in the lower-left corner. or • On the navigation panel, under Dashboards, choose Administration > Data > Create Threshold. The Create Threshold dashboard appears in the display area. From here, you can proceed to “Defining Thresholds” on page 362. Defining Thresholds Defining thresholds involves several steps.
Working with Data Working with Thresholds 363 Selecting metrics and threshold levels To select a metric and its threshold level: Note This procedure continues from “Creating Thresholds” on page 361. 1 Choose the topology type of the metric whose thresholds you want to set. In the Create Threshold dashboard, in the Step 1: Create Threshold - Select Metric area, click Topology Type and select the topology type from the list that appears. 2 Choose the metric whose thresholds you want to set.
vFoglight Administration and Configuration Guide • ThresholdSeverity 4 Click Next. The Step 3: Create Threshold - Add Bounds area appears in the Create Threshold dashboard. From here, you can proceed to “Adding bounds to metric threshold levels” on page 364.
Working with Data Working with Thresholds Threshold Level Threshold Sub-Level AgentState Unknown Stopped Starting Stopping Running Collecting data Running but not collecting data AlarmChangeType Fire Clear Acknowledge AlarmSeverity Undefined Normal Fire Warning Critical Fatal 365
vFoglight Administration and Configuration Guide Threshold Level Threshold Sub-Level CatalystServiceState Stopped Stopping Starting Started Failed Destroyed Created Unregistered Registered ThresholdSeverity Normal Critical Fatal You can have one or more threshold bounds in a threshold level. There are three different types of threshold bounds: • Metric Threshold Bound. Severity level is bound to another metric. • Registry Variable Threshold Bound. Severity level is bound to a registry variable.
Working with Data Working with Thresholds 367 To bind a threshold level to a metric: Note This procedure continues from “Selecting metrics and threshold levels” on page 363 or “Viewing and editing thresholds” on page 360. 1 Select the severity type of the threshold level. Click Level and select a threshold level from the list that appears. 2 Select the Metric Threshold Bound option.
vFoglight Administration and Configuration Guide To bind a threshold level to a registry variable: Note This procedure continues from “Selecting metrics and threshold levels” on page 363 or “Viewing and editing thresholds” on page 360. 1 Select the severity type of the threshold level. Click Level and select a severity level from the list that appears. 2 Select the Registry Variable Threshold Bound option.
Working with Data Working with Thresholds 369 The newly-created registry variable threshold bound appears in the Threshold Bounds table. To bind a threshold level to a constant value: Note This procedure continues from “Selecting metrics and threshold levels” on page 363 or “Viewing and editing thresholds” on page 360. 1 Select the severity type of the threshold level. Click Level and select a severity level from the list that appears. 2 Select the Constant Threshold Bound option.
vFoglight Administration and Configuration Guide If you want vFoglight to acknowledge that the threshold is reached when the threshold level reaches the value of the binding registry variable, check the Inclusive check box. 5 Click the Add button on the right of the Bound Type options. The newly-created registry variable threshold bound appears in the Threshold Bounds table.
Working with Data Working with Thresholds or • New thresholds. Click Add. A list appears in the display area, showing the threshold bounds for the selected threshold level.
vFoglight Administration and Configuration Guide Observe the Manage Thresholds dashboard. The newly-added threshold appears in the list. Managing Retention Policies Topology is a representation of—and a way of understanding—the logical and physical relationship between items in your monitored environment. At run-time, vFoglight dynamically builds topology models using the monitoring data about your system that is collected by vFoglight agents.
Working with Data Managing Retention Policies 373 • “About Retention Policy Mechanisms” on page 373 • “Accessing the Manage Retention Policies Dashboard” on page 378 • “Deleting Retention Policies” on page 381 • “Viewing the Hierarchy of Topology Types in the Database Schema” on page 383 • “Editing Retention Policies” on page 386 • “Creating Retention Policies” on page 388 About Retention Policy Mechanisms While it is theoretically possible to create any retention policy that you desire in vFoglight, the
vFoglight Administration and Configuration Guide • Generation 3: Indefinite Because data is constrained to those buckets, retention policies must are also constrained to a set of rules. In general, you can create retention policies that: • Have 3 retention policies (including a purge), where: • The first retention policy sets the granularity of data stored for 3 days in generation 1.
Working with Data Managing Retention Policies 375 How retention policies interact with database generations Both mechanisms for populating the repository (from memory to the database, database roll-ups) use the retention policies defined in the Retention Policies Dashboard as the guidelines for how they store data. A retention policy is the set of definitions, for a given object, that indicate how data is stored.
vFoglight Administration and Configuration Guide Figure 3 Individual cartridges frequently have their own policies which must be examined on individual object level to understand that retention policy behavior. Developing a retention policy: Example While the browser interface does not prevent you from setting policies that are in conflict with the generations, setting policies that are outside of these boundaries does not yield the expected results.
Working with Data Managing Retention Policies 377 Acceptable age values Acceptable roll-up values Explanation Level 2 > 15 minutes and < 3 days Any roll-up greater than Level 1 The age date for the Level 2 policy must be less than or equal to three days. Data is persisted at the rollup interval defined in the Level 2 policy for 14 days. Level 3 > Level 2 setting and < 14 days Any roll-up greater than Level 2 The age date for the Level 3 policy must be less than or equal to 14 days.
vFoglight Administration and Configuration Guide Acceptable age values Acceptable roll-up values Explanation Level 2 <= 14 days Any roll-up greater than Level 1 The age date for the Level 2 policy must be less than or equal to 14 days. Data is persisted at this rollup interval indefinitely. A purge policy defines a minimum length of time that data must persist before it is truncated.
Working with Data Managing Retention Policies 379 In the Manage Retention Policies dashboard, the Age column specifies the amount of time allotted for data collection. The Roll-up Period defines the granularity of the collection period. For example, if Age is defined as one minute, and the Roll-up Period is defined as five minutes, any data older than one minute is eligible to be aggregated into the five-minute roll-up period.
vFoglight Administration and Configuration Guide 3 To sort the list of retention policies by the topology type to which they apply, click the Topology Type - Property Name column heading as required. 4 Optional. Filter the retention policies by the subset of topology types for any installed cartridges in your monitoring environment. Use this filter to search for, isolate, and apply policies on the basis of each individual case.
Working with Data Managing Retention Policies 381 From here, you can proceed to any of the following procedures: • “Deleting Retention Policies” on page 381 • “Viewing the Hierarchy of Topology Types in the Database Schema” on page 383 • “Editing Retention Policies” on page 386 • “Creating Retention Policies” on page 388 Deleting Retention Policies Use the Delete Selected button on the Manage Retention Policies dashboard to delete the retention policy associated with a particular topology object, as outl
vFoglight Administration and Configuration Guide To delete a retention policy: Note This procedure continues from “Accessing the Manage Retention Policies Dashboard” on page 378. 1 In the Manage Retention Policies dashboard, in the row containing the topology type whose retention policies you want to delete, select the check box on the left of the Topology Type - Property Name column. 2 Click the Delete Selected button at the bottom.
Working with Data Managing Retention Policies 383 Viewing the Hierarchy of Topology Types in the Database Schema Before you get started with editing retention policies, you need to identify the correct topology type whose retention policies you want to edit. When you set a retention policy for a topology type, the ancestors of that topology type inherit the newly-set retention policy. It is therefore important to identify the ancestors of the topology type before editing its retention policies.
vFoglight Administration and Configuration Guide Figure 5 Ancestors of a topology type in the Schema Browser To view the hierarchy of a topology type: 1 Ensure that the navigation panel is open. To open the navigation panel, click the right-facing arrow on the left. 2 On the navigation panel, under Dashboards, choose vFoglight > Schema > Schema Browser.
Working with Data Managing Retention Policies 385 3 Ensure that the Schema Browser shows the core topology types. On the navigation panel, under Schema Selector, verify if the vFoglight entry is selected. 4 Observe the list of topology types that appear in the Schema Browser dashboard. 5 Select a topology type in the upper pane of the Schema Browser and review its details in the lower pane.
vFoglight Administration and Configuration Guide To find out the ancestors of the selected topology type, at the top of the lower pane, on the right of View by, click Ancestors. The lower pane refreshes, showing the ancestors of the selected topology types. When you find out the hierarchy of the topology type whose retention policies you want to edit, you can proceed to “Editing Retention Policies” on page 386.
Working with Data Managing Retention Policies 387 To edit the default retention policy period: Note This procedure continues from “Accessing the Manage Retention Policies Dashboard” on page 378. 1 In the Manage Retention Policies dashboard, locate the TopologyObject type. 2 Review the default retention policies for the TopologyObject type. Expand the TopologyObject node to see the default policy periods. A set of policies appears under the TopologyObject node.
vFoglight Administration and Configuration Guide 5 Edit the existing roll-up period or configure the retention policy to purge the data. In the Roll-up to column, specify the duration and the measurement unit of the roll-up period. For example: 1 hour. If you want the data to purge after the retention period, click the box on the right and select purge from the list that appears. 6 Click Save.
Working with Data Managing Retention Policies 389 2 Add a data sampling period. In the Add Retention Policy dialog box, in the After column, specify the duration and the measurement unit of the data sampling period. For example: 20 min. 3 Add a roll-up period or configure the retention policy to purge the data. In the Roll-up to column, specify the duration and the measurement unit of the roll-up period. For example: 1 hour.
vFoglight Administration and Configuration Guide Specify the data sampling and roll-up or purging parameters periods for the newly-added retention period using the controls in the After and Roll-up to columns. To delete a retention period from the table, use the red Delete button ( ). 5 Click Save. The Edit Retention Policy Period dialog box closes and a message appears in the upper-left, indicating the success of the edit operation. 6 Observe the Manage Retention Policies dashboard.
Working with Data Managing Retention Policies 391 after 1 year - purge Note If the roll-up period is less than one day, the roll-up period must be a multiple of the previous roll-up period value. Note You cannot define two identical data sampling periods for the same topology type or property.
vFoglight Administration and Configuration Guide Enabling the Collection of Data with Older Timestamps By default, the vFoglight Management Server accepts only the data that is collected within one hour from the moment it is received. The one-hour window allows the server to accept the data that agents collect during such short-term disruptions.
Working with Data Enabling the Collection of Data with Older Timestamps 393 3 Find an unused VM option and set it to a desired length in milliseconds. a Remove the comment marker from the beginning of the line. b Insert the foglight.data_service.max_past_timestamp_delta option and the length of the store and forward period between the quotation marks. For example, to set the store and forward period to 8 hours, you should set the foglight.data_service.
vFoglight Administration and Configuration Guide
8 Using Schedules This chapter introduces you to vFoglight schedules and provides information on how to create and manage them. It contains the following sections: Note In order to complete each of the procedures in this chapter, your user account must belong to a group with the Administration role. For more information about users, groups, and roles, see “Managing Users and Security” on page 105. This chapter contains the following sections: About Schedules ...............................................
vFoglight Administration and Configuration Guide About Schedules A schedule is a calendar entry. A schedule consists of one or more schedule items. Each schedule item is effectively a sub-schedule: it includes a start date (and can include an end date), a time range during which it runs, a recurrence pattern (once, periodically, daily, weekly, monthly, or yearly), and range of recurrence. You use schedules to set effective periods and blackout periods for rules and agents.
Using Schedules Managing Schedules 397 Managing Schedules The Manage Schedules dashboard allows you to manage existing schedules, assign permissions to schedules, and other features.
vFoglight Administration and Configuration Guide 3 To sort the list of variables by their name or next scheduled time, click the Schedule Name or Next Scheduled Time column headings as required.
Using Schedules Managing Schedules 399 • “Viewing Schedule Definitions” on page 405 • “Viewing and Editing Schedules” on page 406 Editing Schedule Permissions vFoglight allows you to control access to a schedule. For each schedule you can grant or deny read, write, or control access to roles or users. For more information about security concepts in vFoglight, see Chapter 3, “Managing Users and Security” on page 105.
vFoglight Administration and Configuration Guide 2 To add permissions to a schedule, complete the following steps. a Click the role or user to which you want to assign permissions. Tip The Not Assigned icons in the Permissions columns indicate that the role has no permissions assigned to it. The Add Role Permission or Add User Permission dialog box appears.
Using Schedules Managing Schedules 401 b In the dialog box that appears, use the Read, Write, and Control check boxes to assign permissions as required, and click Save. The dialog box closes and the selected entry refreshes, showing three check marks in the Permission columns, one for each of the read, write, and control permissions. Permission granted Permission denied 3 To edit or delete permissions for a schedule, complete the following steps.
vFoglight Administration and Configuration Guide b To edit the permissions, ensure that the Edit option is selected and use the Read, Write, and Control check boxes as required. c To delete the permissions, select the Delete option. d Click Save. The dialog box closes and the selected entry refreshes, showing the newlyedited permissions. Copying Schedules Use the Copy Schedule button on the Manage Schedules dashboard to copy a schedule, as outlined below.
Using Schedules Managing Schedules The dialog box closes and the Edit Schedule view appears in the Manage Schedules dashboard. 2 If required, edit the newly-copied schedule. For more information, see “Viewing and Editing Schedules” on page 406.
vFoglight Administration and Configuration Guide Deleting Schedules Use the Delete Selected button on the Manage Schedules dashboard to delete a schedule, as outlined below. Note When a schedule is deleted, all references to that schedule are removed as well; any performance calendars that are based on that schedule are removed and the deleted schedule is removed from the list of effective and blackout schedules for rules.
Using Schedules Managing Schedules 405 Viewing Schedule Definitions To view schedule definitions: Note This procedure continues from “Accessing the Manage Schedules Dashboard” on page 397. 1 In the Manage Schedules dashboard, click the Schedule Name column of the row containing the schedule whose definitions you want to view. The Edit Schedule view appears in the Manage Schedules dashboard. 2 View the definitions of the selected schedule.
vFoglight Administration and Configuration Guide 3 Observe the schedule definitions for a selected date. In the Business Hours dialog box, use the calendar in the upper-left corner to select a date. On the right, the schedule for the selected date refreshes, showing the schedule’s effective hours in blue. When you finish observing schedule definitions, close the Business Hours dialog box.
Using Schedules Creating Schedules 407 to edit it to also run every Saturday from 11:00 am to 4:00 pm in May, add a schedule item for each of these time spans to the schedule. To view and edit a schedule: Note This procedure continues from “Accessing the Manage Schedules Dashboard” on page 397. 1 In the Manage Schedules dashboard, click the schedule that you want to edit. The Edit Schedule view appears in the Manage Schedules dashboard. 2 Observe the schedule definitions.
vFoglight Administration and Configuration Guide Creating a schedule involves several steps. Once you get started with schedule creation, you need to define the start date and recurrence pattern.
Using Schedules Creating Schedules 409 From here, you can proceed to “Getting Started with Schedule Definitions” on page 409. Getting Started with Schedule Definitions To get started with schedule definitions: Note This procedure continues from “Accessing the Create Schedule Dashboard” on page 408. 1 Specify the schedule name. In the Create Schedule dashboard, in the Schedule Name box, type the name that you want to assign to the schedule. 2 Optional. Add information that describes the schedule.
vFoglight Administration and Configuration Guide The Step 2: Create Schedule - Details of Schedule view appears in the Create Schedule dashboard. From here, you can proceed to “Adding or Removing Schedule Items” on page 410. Adding or Removing Schedule Items A schedule can contain one or more items, each describing a recurrence pattern.
Using Schedules Creating Schedules 411 When you create a schedule, you have to specify at least one schedule item and its recurrence pattern. You can edit the schedule at a later time by adding or removing schedule items as required. To add a schedule item to a newly-created schedule that has no other schedule items: Note This procedure continues from “Getting Started with Schedule Definitions” on page 409.
vFoglight Administration and Configuration Guide The Edit Schedule view appears. 2 In the Edit Schedule view, click Add Schedule Item in the lower-right corner. The Edit Schedule -> Add Schedule Item view appears, allowing you to define another schedule item.
Using Schedules Creating Schedules 413 For complete information on how to define a schedule item, see “Defining Schedule Items” on page 415. To add a schedule item to an existing schedule: Note This procedure continues from “Viewing and Editing Schedules” on page 406. 1 In the Edit Schedule view, click Add Schedule Item in the lower-right corner.
vFoglight Administration and Configuration Guide To delete a schedule item: Note This procedure continues from “Viewing and Editing Schedules” on page 406 or “Defining Schedule Items” on page 415. 1 In the Edit Schedule view, select the row containing the schedule item that you want to delete and click Delete Selected. The Schedule Confirmation dialog box appears, asking you to confirm the delete operation. 2 In the Schedule Confirmation dialog box, click OK.
Using Schedules Creating Schedules 415 Defining Schedule Items There are six types of patterns that you can define in a schedule item, as listed below.
vFoglight Administration and Configuration Guide Pattern Allows you to create pattern that For instructions, see Yearly Starts at a specified time and date, runs for a whole day or a fraction of a day, repeats at a regular interval of years on one or more days of the week each month, with or without a defined end date and time “To define a schedule item that occurs yearly:” on page 440 To define a schedule item that occurs once: Note This procedure continues from “Adding or Removing Schedule It
Using Schedules Creating Schedules 417 b Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted.
vFoglight Administration and Configuration Guide b Use the End Time [hh:mm] boxes to specify the hour and minute of the end time. Tip The Hour box accepts the values between 0 and 24. Any positive values outside that range are automatically adjusted to 24; negative values are not accepted. The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted. 4 Save the changes to the schedule item.
Using Schedules Creating Schedules 419 5 Add one or more schedule items if required. For details, see “Adding or Removing Schedule Items” on page 410. To define a schedule item that occurs periodically: Note This procedure continues from “Adding or Removing Schedule Items” on page 410. 1 In the Recurrence Pattern area, select the Periodical option. The view refreshes, showing a set of controls that allow you to define a schedule item that occurs periodically.
vFoglight Administration and Configuration Guide b Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted.
Using Schedules Creating Schedules 421 • To specify an end date, in the Range of Occurrence area, ensure that the End By Date option is selected, and specify the end date and time using the End Date and End Time [hh:mm] boxes as required. Tip Use the Calendar button on the right and use the calendar controls that appear to specify the start date. Tip The Day box accepts the values between 1 and 31.
vFoglight Administration and Configuration Guide 5 Save the changes to the schedule item. • New schedules. In the lower-right corner, click Add. • Existing schedules. In the lower-right corner, click Save. The Schedule Items table refreshes, showing the newly-added schedule item. 6 Add one or more schedule items if required. For details, see “Adding or Removing Schedule Items” on page 410.
Using Schedules Creating Schedules 423 2 Specify the start date of the recurrence pattern. Use the Start Date boxes to specify the day, month and year of the start date. Alternatively, click the Calendar button on the right and use the calendar controls that appear to specify the start date. Tip The Day box accepts the values between 1 and 31. Any positive values outside that range are automatically adjusted to 31; negative values are not accepted. 3 Specify the duration of the schedule item.
vFoglight Administration and Configuration Guide • Specify the start time and end time of the schedule item. • Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59.
Using Schedules Creating Schedules 425 • Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted.
vFoglight Administration and Configuration Guide 4 Specify the recurrence pattern. In the Recurrence Pattern area, use the Every box to specify the number of days at which the schedule recurs. Tip The Every box accepts any positive values. 5 Specify the date and time after which the schedule item ends using the controls in the Range of Occurrence area.
Using Schedules Creating Schedules 427 • To have the schedule item recurring at the recurrence pattern specified in step 4 without an end date, in the Range of Occurrence area, select the No End option. The Range of Occurrence area refreshes, no longer showing the controls for specifying the end date. 6 Save the changes to the schedule item. • New schedules. In the lower-right corner, click Add. • Existing schedules. In the lower-right corner, click Save.
vFoglight Administration and Configuration Guide 1 In the Recurrence Pattern area, select the Weekly option. The view refreshes, showing a set of controls that allow you to define a schedule item that occurs on a weekly basis. 2 Specify the start date of the recurrence pattern. Use the Start Date boxes to specify the day, month and year of the start date. Alternatively, click the Calendar button on the right and use the calendar controls that appear to specify the start date.
Using Schedules Creating Schedules 429 • If you want the schedule to occur for a part of the day, complete one of the following steps. • Specify the start time and end time of the schedule item. • Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59.
vFoglight Administration and Configuration Guide • Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted.
Using Schedules Creating Schedules 431 4 Specify the recurrence pattern. In the Recurrence Pattern area, use the Every box to specify the number of weeks at which the schedule occurs. Tip The Every box accepts any positive values. Select one or more check boxes that represent the days of the week on which the schedule occurs.
vFoglight Administration and Configuration Guide • To specify an end date, in the Range of Occurrence area, ensure that the End By Date option is selected, and specify the end date and time using the End Date and End Time [hh:mm] boxes as required. Tip Use the Calendar button on the right and use the calendar controls that appear to specify the start date. Tip The Day box accepts the values between 1 and 31.
Using Schedules Creating Schedules 433 The Schedule Items table refreshes, showing the newly-added schedule item. 7 Add one or more schedule items if required. For details, see “Adding or Removing Schedule Items” on page 410. To define a schedule item that occurs monthly: Note This procedure continues from “Adding or Removing Schedule Items” on page 410. 1 In the Recurrence Pattern area, select the Monthly option.
vFoglight Administration and Configuration Guide 2 Specify the start date of the recurrence pattern. Use the Start Date boxes to specify the day, month and year of the start date. Alternatively, click the Calendar button on the right and use the calendar controls that appear to specify the start date. Tip The Day box accepts the values between 1 and 31. Any positive values outside that range are automatically adjusted to 31; negative values are not accepted.
Using Schedules Creating Schedules 435 • If you want the schedule to occur for a part of the day, complete one of the following steps. • Specify the start time and end time of the schedule item. • Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59.
vFoglight Administration and Configuration Guide • Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted.
Using Schedules Creating Schedules 437 4 Specify the recurrence pattern. • To have the schedule occurring on a specified day of the month, at the rate of one or more months, in the Recurrence Pattern area, ensure that the By Date option is selected, and then specify the day of the month and the rate at which it occurs. Tip The Day box accepts the values between 1 and 31. Any positive values outside that range are automatically adjusted to 31; negative values are not accepted.
vFoglight Administration and Configuration Guide In the Recurrence Pattern area, use the Every box to specify the number of weeks at which the schedule occurs. Tip The Every box accepts any positive values. 5 Specify the date and time after which the schedule item ends using the controls in the Range of Occurrence area.
Using Schedules Creating Schedules 439 The Hour box accepts the values between 0 and 24. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted.
vFoglight Administration and Configuration Guide To define a schedule item that occurs yearly: Note This procedure continues from “Adding or Removing Schedule Items” on page 410. 1 In the Recurrence Pattern area, select the Yearly option. The view refreshes, showing a set of controls that allow you to define a schedule item that occurs on a yearly basis. 2 Specify the start date of the recurrence pattern. Use the Start Date boxes to specify the day, month and year of the start date.
Using Schedules Creating Schedules 3 Specify the duration of the schedule item.
vFoglight Administration and Configuration Guide • If you want the schedule to occur for a part of the day, complete one of the following steps. • Specify the start time and end time of the schedule item. • Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59.
Using Schedules Creating Schedules 443 • Use the Start Time [hh:mm] boxes to specify the hour and minute of the start time. Tip The Hour box accepts the values between 0 and 23. Any positive values outside that range are automatically adjusted to 23; negative values are not accepted. The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted.
vFoglight Administration and Configuration Guide 4 Specify the recurrence pattern. • To have the schedule occurring on a specified day of the month, at the rate of one or more months, in the Recurrence Pattern area, ensure that the By Date option is selected, and then specify the day of the month and the rate at which it occurs. Tip The Day box accepts the values between 1 and 31. Any positive values outside that range are automatically adjusted to 31; negative values are not accepted.
Using Schedules Creating Schedules 445 5 Specify the date and time after which the schedule item ends using the controls in the Range of Occurrence area. • To specify an end date, in the Range of Occurrence area, ensure that the End By Date option is selected, and specify the end date and time using the End Date and End Time [hh:mm] boxes as required. Tip Use the Calendar button on the right and use the calendar controls that appear to specify the start date.
vFoglight Administration and Configuration Guide The Minute box accepts the values between 0 and 59. Any positive values outside that range are automatically adjusted to 59; negative values are not accepted. • To have the schedule item recurring at the recurrence pattern specified in step 4 without an end date, in the Range of Occurrence area, select the No End option. The Range of Occurrence area refreshes, no longer showing the controls for specifying the end date.
9 Working with vFoglight Tooling This chapter introduces you to the Tooling dashboards and provides information on how to build script agents and use the query tool. It contains the following sections: Note In order to complete each of the procedures in this chapter, your user account must belong to a group with the Administration role. For more information about users, groups, and roles, see “Managing Users and Security” on page 105. This chapter contains the following sections: About vFoglight Tooling .
vFoglight Administration and Configuration Guide About vFoglight Tooling The vFoglight Management Server collects data from your monitored system and organizes that data into a topology model. Each topology model is comprised of nodes. The nodes and their relationship in the topology model represent the logical and physical structure of the entities in your monitored environment.
Working with vFoglight Tooling Building Script Agents 449 • Type 2 scripts. These scripts control their own collection frequency cycle. In Type 2 scripts, the vFoglight collector executes the script and remains open. The script controls the standby period instead of the agent properties. Type 2 scripts perform data calculations before the data enters the database and measure changes between collection periods. For a sample of a Type 2 script, see “Example: Type 2 Script” on page 466.
vFoglight Administration and Configuration Guide data immediately following the START_SAMPLE_PERIOD command, as shown in the above syntax block: START_SAMPLE_PERIOD field_name[.type[.{id|obs}]][:unit]=value The following table describes the script elements, some of which appears in the above block. Script Element Definition END_SAMPLE_PERIOD Sends the current collection sample to the database and completes the transaction. END_TABLE Closes the table.
Working with vFoglight Tooling Building Script Agents 451 Script Element Definition START_SAMPLE_PERIOD Starts the data collection for the specified table and inserts field data using the line of code that immediately follows this command. TABLE table_name Opens the table with table_name specifying the name of the table. If an identity field is declared, append it to the table name. type Specifies the topology type if it is not a metric.
vFoglight Administration and Configuration Guide From here, you can go to “Uploading Agent Scripts and Building Agent Packages” on page 452. Uploading Agent Scripts and Building Agent Packages Once you finish your script and get started with the Build Script Agent dashboard, you can upload your script to the vFoglight Management Server and build the agent package. To upload an agent script: Note This procedure continues from “Accessing the Build Script Agent Dashboard” on page 451.
Working with vFoglight Tooling Building Script Agents 453 3 Ensure that the version number of the script agent that you are about to upload is correct. To change the version number, use the Script Version boxes as required. 4 Upload the script and build the agent. Click Submit. The Build Script Agent dialog box appears, asking you to confirm the build operation.
vFoglight Administration and Configuration Guide 6 In the Build Script Agent dialog box, click Move to Agent Listing. The Agent Status area appears in the Build Script Agent dashboard. From here, you can proceed to “Deploying Script Agent Packages” on page 454. Deploying Script Agent Packages When you successfully upload the agent script and build the agent package, you can deploy that package to the vFoglight Agent Manager.
Working with vFoglight Tooling Building Script Agents 455 Use the Agent Status area in the Build Script Agent dashboard to deploy a script agent. Alternatively, you can deploy the package using the command line. To deploy a script agent package: Note This procedure continues from “Uploading Agent Scripts and Building Agent Packages” on page 452. 1 On the Build Script Agent dashboard, in the lower-left corner of the Agent Status area, click Deploy Agent Package.
vFoglight Administration and Configuration Guide For example: MyScriptAgent-1.2.0 4 Click Deploy. The Deploy Agent Package dialog box refreshes, showing the status of the deployment operation. After a few moments, in the Deploy Agent Package dialog box, in the Status column of the Progress table, a green check mark appears, indicating a success of the deployment operation.
Working with vFoglight Tooling Building Script Agents 457 5 Click OK to close the Deploy Agent Package dialog box. From here, you can proceed to “Creating and Activating Script Agent Instances” on page 457. Creating and Activating Script Agent Instances Once you have successfully deployed the package containing the script agent, you can create one or more instances of your custom script agent. Instance creation is identical to the process you use to create agent instances of any other type.
vFoglight Administration and Configuration Guide 1 In the Build Script Agent dashboard, in the Agent Status area, click the Create Agent button in the lower-left corner. The Create Agent dialog box appears. 2 Specify the host that you want to monitor with the script-based agent instance that you are about to create. Note In order to select the host, the vFoglight Agent Manager must be up and running on the monitored host.
Working with vFoglight Tooling Building Script Agents 459 The list reflects the cartridges that have been installed, enabled, and deployed to the monitored host. 3 Select the script agent to use as a type for the agent instance you are about to create. Note You can only create instances of those agents whose types have already been deployed to the monitored host. In the Agent Type box, click script agent type whose package you deployed in “Deploying Script Agent Packages” on page 454.
vFoglight Administration and Configuration Guide After a few moments, in the Create Agent Results dialog box, in the Status column of the Progress table, a green check mark appears, indicating a success of the operation.
Working with vFoglight Tooling Building Script Agents 461 The Agent Status dashboard, refreshes, showing the newly-created agent instance. 6 Activate the newly-added script agent instance. a In the Agent Status area, select the row containing the script agent instance and click Activate. The Agent Operation dialog box appears, showing the status of the activation process.
vFoglight Administration and Configuration Guide After a few moments, in the Agent Operation dialog box, in the Status column of the Progress table, a green check mark appears, indicating a success of the operation.
Working with vFoglight Tooling Building Script Agents 463 b In the Agent Operation dialog box, click OK. The Agent Operation dialog box closes and the Agent Status area refreshes, showing the Activated icon ( ) and Collecting Data icon ( ) in the row containing the script agent indicating that the agent is active and collecting data. Note It may take some time for the Activated ( ) and Collecting Data ( activation of the agent was successful.
vFoglight Administration and Configuration Guide Editing Script Agent Properties In some cases you might need to edit the properties of the newly-created script agent. For example, Type 1 script agents control their standby periods using agent properties. For more information, see “Building Script Agents” on page 448 and “Example: Type 1 Script” on page 466. Use the Agent Status area in the Build Script Agent dashboard to begin editing agent properties.
Working with vFoglight Tooling Building Script Agents Note 465 The type and range of script agent properties depends on the script that you used to build the agent. 3 Click Modify these properties for this agent only. The boxes in the agent properties area become enabled for editing. 4 In the agent properties area, edit the script agent properties as required.
vFoglight Administration and Configuration Guide 5 Save your changes. Click Save. The Build Script Agent dashboard refreshes, showing a list of all agent instances. Example: Type 1 Script The following is an example of a Type I script: @echo off if not "%ECHO%"=="" echo %ECHO% if not "%OS%"=="Windows_NT" goto EXIT if "%sample_freq%"=="" set sample_freq=60 echo LOG Start collecting data for NT at %sample_freq% seconds echo TABLE NT echo START_SAMPLE_PERIOD echo FooId.String.id = Bar echo stringProp.
Working with vFoglight Tooling Retrieving Data with Queries and Scripts 467 @echo off if not "%ECHO%"=="" echo %ECHO% if not "%OS%"=="Windows_NT" goto EXIT if "%sample_freq%"=="" set sample_freq=60 echo LOG Start collecting data for NT at %sample_freq% seconds :Loop echo LOG New sample is available echo TABLE NT echo START_SAMPLE_PERIOD echo FooId.String.id = Bar echo stringProp.String = This is a non-identity string property. echo intProp.
vFoglight Administration and Configuration Guide retrieve desired results. For more information about the query language and its syntax, see “Using the Query Language” on page 473. You may be required to run scripts at the request of Vizioncore Support or for other maintenance functions. You can also test sample scripts from this window. This tool has no restrictions, but is recommended for advanced users.
Working with vFoglight Tooling Retrieving Data with Queries and Scripts 469 From here, you can go to “Selecting Topology Objects” on page 469. Selecting Topology Objects Once you access the Script Editor dashboard, you can use it to select the objects of a particular topology type and view the data that they contain.
vFoglight Administration and Configuration Guide • Object type hierarchies • Object properties, including: • Unique ID • Object ID • ID • Version • Effective start date To select topology objects: Note This procedure continues from “Accessing the Script Editor Dashboard” on page 468. 1 Select a topology type whose objects you want to query. In the Script Editor dashboard, click Query, and select a topology type from the list that appears.
Working with vFoglight Tooling Retrieving Data with Queries and Scripts Topology object ID Topology type 471 Instance name 3 View information about one of the listed topology objects. In the Instances box, click a topology object ID. The Object ID, Object Type Hierarchy, and Object Properties boxes refresh, showing the information about the selected topology object instance. The Object Type Hierarchy area displays the hierarchical relationship between the selected topology type and its parent types.
vFoglight Administration and Configuration Guide Retrieving Data Once you retrieve information about one or more topology objects, you can run scripts against a selected topology object and retrieve the data that it contains as required. The Script Editor dashboard allows you to write and run scripts using the vFoglight query language and process scoping queries against one or more topology objects that exist in your monitoring system.
10 Using the Query Language A query language is used in vFoglight to set the scope for rules and derived metrics, to create rule conditions and expressions, to reference expressions in messages, and to create derived metric expressions. This appendix contains the following sections: Using the Query Language to Set the Rule or Derived Metric Scope .......................................474 Using the Query Language in Rule Conditions or Derived Metric Expressions ........................
vFoglight Administration and Configuration Guide Using the Query Language to Set the Rule or Derived Metric Scope The scope of a rule defines the set of topology objects against which it will run. The scope of a derived metric defines the set of topology objects to which it applies. A rule or derived metric must be scoped to a topology type and can optionally be scoped to specific instances of that type (topology objects).
Using the Query Language Using the Query Language to Set the Rule or Derived Metric Scope 475 • Scope down to a property of the selected topology type by proceeding to “Inserting topology type property names” on page 475. or • Validate the rule scope by clicking the Validate Scope button ( of the Property box. ) to the right If the scope is valid, a confirmation message appears above the Topology Type box while the name of the newly-selected topology type appears in the box at the bottom.
vFoglight Administration and Configuration Guide The name of the newly-selected property appears in the expression immediately below the Property box. 3 Specify the property value for which you want to query. In the above expression, select value and replace it with the property value. 4 Validate the scope by clicking the Validate Scope button ( ) on the right.
Using the Query Language Using the Query Language to Set the Rule or Derived Metric Scope 477 From here, you can proceed to any of the following procedures: • “Inserting topology object instances” on page 477 • “Filtering through topology type properties” on page 477 Inserting topology object instances When you specify a topology type, you can select an object instance of that type and insert it into the scoping query using the Scoping Query Editor dialog box.
vFoglight Administration and Configuration Guide To specify topology type properties: Note This procedure continues from “Restricting the scope to topology objects” on page 476. 1 In the Scoping Query Editor dialog box, click the Filter tab. The Filter tab opens in the Scoping Query Editor dialog box, allowing you to create a logical expression containing up to three comparison expressions that are connected with “AND” or “OR” logical operators.
Using the Query Language Using the Query Language to Set the Rule or Derived Metric Scope 479 The Scoping Query Editor dialog box closes and the scoping query (or scoping query segment) appears in the box immediately below the Topology Type and Property boxes. 6 Validate the scope by clicking the Validate Scope button ( ) on the right.
vFoglight Administration and Configuration Guide where TopologyType is the name of the topology type of which Object is an instance and Object is the specific instance to which you do not want the rule or derived metric to be scoped.
Using the Query Language Using the Query Language in Rule Conditions or Derived Metric Expressions 481 Expressions must be specified using the query language, and the syntax @expressionName must be used to reference expressions in messages. Tip If you want to include an email address in a message, simply use the @ symbol twice. For example: Send email to administrator@@example.com Note The expressions that you can reference in a message vary depending on the scope of the message.
vFoglight Administration and Configuration Guide expression that are either part of the query language or have been formatted to use the query language syntax. The process of writing expressions is described in the following sections: • “Inserting operators” on page 482 • “Editing conditions and expressions” on page 482 • “Validating conditions or expressions” on page 490 Inserting operators The available operators are listed along the top of the Condition and Expression boxes.
Using the Query Language Using the Query Language in Rule Conditions or Derived Metric Expressions 483 From here, you can proceed to any of the following procedures: • “Inserting registry variables” on page 483 • “Inserting metrics and topology object properties” on page 484 • “Inserting Groovy functions” on page 487 Inserting registry variables Caution Although you can insert a registry variable into a derived metric expression, it is not recommended that you do so.
vFoglight Administration and Configuration Guide derived metric scope. Each registry variable’s type and global default value also appear in this table. Note The list of registry variables displayed in this table is based on the list shown on the Manage Registry Variables dashboard (Administration > Rules & Notifications > Manage Registry Variables). This table is empty if no registry variables are available for the associated topology type.
Using the Query Language Using the Query Language in Rule Conditions or Derived Metric Expressions 485 • Parent types of the scoping topology type that descend from TopologyObject. To insert a metric or property into a rule condition or derived metric expression: Note This procedure continues from “Editing conditions and expressions” on page 482. 1 In the display area, place the cursor in the Condition box (rules) or Expression box (derived metrics) where you want to insert the metric.
vFoglight Administration and Configuration Guide The Metric/Property tab refreshes, showing the instances and metrics for the selected topology type. 4 Choose a metric or an instance. The Metric/Property tab displays only two columns at a time, causing the initial list of topology types to shift to the left. Use the arrow buttons in the upper-left to navigate through the window.
Using the Query Language Using the Query Language in Rule Conditions or Derived Metric Expressions 487 In the Properties pane, select the property that you want to add to the condition (rules) or expression (derived metrics). a Choose a property from the list. 5 Click the Insert button. The dialog box closes and the Condition (rules) or Expression (derived metrics) box refreshes, showing the newly-selected instance or metric.
vFoglight Administration and Configuration Guide To insert a Groovy function into a rule condition or derived metric expression: Note This procedure continues from “Editing conditions and expressions” on page 482. 1 In the display area, place the cursor in the Condition box (rules) or Expression box (derived metrics) where you want to insert the function. 2 In the Condition Editor (rules) or Expression Editor (derived metrics) dialog box, click the Function tab.
Using the Query Language Using the Query Language in Rule Conditions or Derived Metric Expressions 489 4 Specify the function arguments as required using one or more Arg boxes. The first argument represents the object on which the function will be performed, such as a metric (specified using the format #metric#) or a topology object within the rule or derived metric scope (specified as scope). See “Using Functions with Conditions and Expressions” on page 491 for more information.
vFoglight Administration and Configuration Guide Validating conditions or expressions When you have finished editing the rule condition or derived metric expression, you can validate its syntax. To validate a condition or expression: Note This procedure continues from “Editing conditions and expressions” on page 482. • Click the Validate button ( (derived metrics) box.
Using the Query Language Using the Query Language in Rule Conditions or Derived Metric Expressions 491 rules to perform the same function (rate) on the same metric (#passivationCount#). Instead of doing this manually for each rule, you decide to create a derived metric that you can use in all of these rules’ conditions. You use the fields and controls on the Create Derived Metric dashboard (Data > Create Derived Metric) to create a derived metric expression that calculates the passivation rate for EJBs.
vFoglight Administration and Configuration Guide • changeSummary: Returns the list of topology property changes for each topology object referenced by this function’s scope parameter over the specified time period (supplied in milliseconds). • checkObservationAlarms: Returns a list of all log entry objects with a particular severity. • checkUserPermission: Check the permissions assigned to a user. • compareStrings: Compares two text strings. • count: calculates the number of observations.
Using the Query Language Using the Query Language in Rule Conditions or Derived Metric Expressions 493 • getMonitoredComponentRuleInfoList: Returns a list of rules that are scoped to a monitored component. • getObservationTrend: Returns an observation trend. • getPropertyObject: Returns the value of property for the topology object with the given ID. • getPropertyValueAtGivenTimesOfGivenTopologyObjects: Returns the values of a given property for a list of TopologyObjects at a given list of times.
vFoglight Administration and Configuration Guide • period: calculates the total length of a period of time from a series of metrics and returns a value in seconds. • positive_delta: Returns the difference between the maximal values of the most recent two metric values for a scoping object. • positive_delta_rate: Returns the difference between the maximal values of the most recent two metric values for a scoping object divided by the time period in seconds of the more recent metric value.
Using the Query Language Using the Query Language FAQ 495 {return false;} Advanced scripting example In most cases, you use the scope variable as a parameter for the functions alarmCount, descendents, and getContainedObjects. However, there may be a situation in which you need to create a condition or expression that uses one of these functions but want the function to be performed on an object outside of the rule or derived metric scope.
vFoglight Administration and Configuration Guide If you want to reference the topology object from within a string or embedded query, you must prefix the scope variable with the dollar sign ‘$’. For example: "File system $scope is now full" or #Filesystem where name = $scope.get("filesystemName")# How do I export metrics from the command line? The fglcmd tool includes a command that allows you to export metric observations to a file using a metric query.
A Appendix: vFoglight Client Reference While the new versions of vFoglight use the vFoglight Agent Manager to communicate with vFoglight agents, previous versions used the vFoglight Client. The Administration module and vFoglight command-line interface support both technologies, however, some dashboards in the browser interface as well as vFoglight commands can provide slightly different type of data in monitoring environments that still use the vFoglight Client for agent communication.
vFoglight Administration and Configuration Guide Starting the vFoglight Client To start the vFoglight Client: • To start the vFoglight Client, you run the spid executable that is located in the vFoglight Client installation directory. Alternatively, to start the Client on Windows platforms, choose Start > Programs > Vizioncore > vFoglight SPID 5.2.4 > Start SPID. For more information, refer to the Installation and Setup Guide.
Appendix: vFoglight Client Reference Viewing the Content of a vFoglight Client Support Bundle 499 Each client support bundle consists of the following files and directories: config/ spid/ / / SPI/ SPI/ / SPI.xml SPID configuration file SPINetwork/ SPINetwork / Orb.xml JacORB configuration OrbInitRefs.
vFoglight Administration and Configuration Guide manifests/ _file_manifest.txt osfiles/ * Note OPTIONAL (may be present for specific platforms) A file manifest for every cartridge deployed to this SPID installation OPTIONAL (may be present for specific platforms) Various OS configuration files like “/etc/hosts”, depending on the OS platform. For information about the content of vFoglight Agent Manager support bundles, see “Viewing Audit Information” on page 82.
Appendix: vFoglight Client Reference Browser Interface 501 Browser Interface This section contains sample screen captures that appear in monitoring environments that use the vFoglight Client for agent communication with the vFoglight Management Server.
vFoglight Administration and Configuration Guide Agent Status dashboard The Agent Status dashboard shows an entry for the SPINetwork agent that comes with the vFoglight Client.
Appendix: vFoglight Client Reference Command-Line Interface 503 Command-Line Interface This section contains fglcmd examples and their command-line output that appears when the agent instances in your monitoring environment use the vFoglight Client for communication with the vFoglight Management Server.
vFoglight Administration and Configuration Guide myhost.mydomain:0#SpiInstaller/admin Agent Package ID: OSCartridge-Windows2003-5.2.4AgentPackage Agent Package Cartridge Name: OSCartridgeWindows2003 Agent Package Cartridge Version: 5.2.4 3 Review the above output and record the ID of the agent package that you want to deploy.
Appendix: vFoglight Client Reference Command-Line Interface 505 myhost.mydomain.corp:0 Client Name: SPI://myhost.mydomain.corp:0 Agent Types: NetMonitor Windows_System WebMonitor AppMonitor LogFilter SNMP ApacheSvr TerminalServer 3 Review the above output and record the type of the agent whose instance you want to create.
vFoglight Administration and Configuration Guide Host Name: tor013008.prod.quest.corp 50 log files found. OSCartridge\5.2.0\logs\AIX_Console_My_AIX_Console_Agent _2008-01-21_095227_001.log OSCartridge\5.2.0\logs\AIX_MPStat_My_AIX_MPStat_Agent_ 2008-01-21_094945_001.log OSCartridge\5.2.0\logs\AIX_System_My_AIX_System_Agent_ 2008-01-21_095149_001.log OSCartridge\5.2.0\logs\ApacheSvr_ApacheSvr_ 2008-01-16_102536_001.log OSCartridge\5.2.0\logs\ApacheSvr_My_ApacheSvr_Agent_ 2008-01-16_114450_001.
Appendix: vFoglight Client Reference Command-Line Interface 507 Agent Types: -----------------------------------Client ID: MyHost#SPI://MyHost:0 Client Name: SPI://MyHost:0 Agent Types: Windows_System WebMonitor AppMonitor LogFilter ------------------------------------ Installer IDs Installer IDs help deploy new agent packages to remote hosts. Installer IDs identify agent managers that are capable of installing agent packages on a remote machine.
vFoglight Administration and Configuration Guide Agent Package OS Version: /5\.1.*/ Agent Package OS Architecture: ia32,x86_64 -----------------------------------C:\Vizioncore\vFoglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:packages -clientid MyHost.#SPI://MyHost:0 Installer ID: MyHost#SPI://MyHost:0#SpiInstaller/admin Agent Package ID: C:\\dist\tmp\cartridge.
Index A about vFoglight 10 Action Parameter Editor dialog box 295, 296, 297 Add Retention Policy dialog box 388, 389 Add Role Permission dialog box 189, 229, 337, 357, 400 Add Topology Type dashboard 40, 42, 329, 330, 331 Add Topology Type node in navigation panel 329 Add User Permission dialog box 189, 229, 337, 357, 400 Administration dashboard 39, 43, 44, 45, 46, 47, 48, 49, 50 Audited Activities view 50 Current Statistics view 45, 46, 47 Currently Licensed Capabilities view 48 Federation view 49 Lice
vFoglight Administration and Configuration Guide managing schedules 397 managing thresholds 353 managing users 107 managing users and security 105 about 106 retrieving data 467 Rules & Notifications dashboards 183, 184, 223 about 184 managing registry variables 185 managing rules 225 Schedules dashboards 395 about 396 managing schedules 397 setting up vFoglight 53 about 54 managing licenses 69 managing support bundles 75 viewing audit information 82 viewing connection status 54 viewing vFoglight confi
Index cloning lists in secondary properties 173 editing lists in secondary properties 174 editing primary type-specific properties 172 editing type-specific properties 171 removing cloned lists from secondary properties 177 Agent Properties node in navigation panel 168 Agent Status dashboard 38, 45, 161, 461, 502 Agent Operation dialog box 461, 462, 463 Create Agent dialog box 459 Create Agent Results dialog box 459, 460 agents instances creating 457 managing blackouts 179 packages deploying 454 uploading
vFoglight Administration and Configuration Guide Cartridge Inventory node in navigation panel 150 cartridges agent components downloading 161, 163 components 148 disabling 158 downloading agent components 163 enabling 157 installing 149, 155 accessing Cartridge Inventory dashboard 150 managing 149 accessing Cartridge Inventory dashboard 150 uninstalling 159 Cartridges dashboards 147 about 148 Cartridge Inventory 39, 45, 46, 149, 150, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161 accessing 150 Cart
Index Expression Editor dialog box 482, 483, 484, 485, 487, 488, 491 getting started with defining derived metrics 344 Scoping Query Editor dialog box 475, 476, 477, 478, 479 setting derived metric value types 350 triggering derived metrics 348 Create Derived Metric node in navigation panel 343 Create Group dialog box 122 Create Registry Value—Step 1 view 206, 219, 220 Create Registry Value—Step 2 view 207, 220 Create Registry Variable dashboard 42, 195, 196, 283 creating derived metrics 342 creating reg
vFoglight Administration and Configuration Guide D dashboards Add Topology Type 40, 42, 329, 330, 331 Administration 39, 43, 44, 45, 46, 47, 48, 49, 50 Agent Adapters 502 Agent Blackouts 179, 180, 182 Selected Agents dialog box 181, 182 Agent Hosts 44 Agent Properties 44, 168, 169, 170, 171, 172, 173, 175, 177, 501 Agent Status 38, 45, 161, 461, 502 Agent Operation dialog box 461, 462, 463 Create Agent dialog box 459 Create Agent Results dialog box 459, 460 Build Script Agent 41, 449, 451, 452, 453,
Index Manage Registry Variables 40, 185, 186, 187, 188, 191, 193, 194, 195, 196, 200, 217, 218, 219, 220, 221, 234, 247, 280, 281, 282, 283, 286, 484 Add Role Permission dialog box 189 Add User Permission dialog box 189 Copy Registry Variable dialog box 191, 192 Create Registry Value—Step 1 view 206, 219, 220 Create Registry Value—Step 2 view 207, 220 Edit Registry Variable view 194, 200, 218, 219, 281, 282, 285, 286 Edit Role Permission dialog box 190 Edit User Permission dialog box 190 Registry Variable
vFoglight Administration and Configuration Guide Ports view 63, 65 Server view 57 WCF view 61 View Audit Information 40, 82, 83, 85, 87, 88 Show columns dialog box 84, 85, 86 Data dashboards 327, 332, 353 about 328 Add Topology Type 329, 330, 331 adding topology types 329 Create Derived Metric 42, 342, 343, 344 adding calculations to derived metrics 344 defining derived metrics 344 Expression Editor dialog box 482, 483, 484, 485, 487, 488, 491 getting started with defining derived metrics 344 Scoping
Index Data node in navigation panel 10, 33, 329, 333, 343, 354, 361, 362, 379 database changing database credentials 138 Database view 59, 68 Delete Derivation dialog box 341 Delete Rule Confirmation dialog box 234, 235, 236 Delete Threshold dialog box 359, 360 deleting internal users 117 Deploy Agent Package dialog box 455, 456, 457 Derived Metric Scope field editing 474 derived metrics creating 342 defining 344 adding calculations 344 getting started 344 setting value types 350 triggering 348 example op
vFoglight Administration and Configuration Guide assigning roles to groups 124 creating 122 deleting internal groups 126 editing role groups 132 editing users in groups 123 managing 118 accessing Manage Groups dashboard 119 directory settings editing 142 documentation cartridge 13 core 12 feedback 13 suite 12 download 162 H E Edit Derived Metric view 342 Edit Registry Variable view 194, 200, 218, 219, 281, 282, 285, 286 Edit Retention Policy Period dialog box 386, 387, 388, 390 Edit Role Permissio
Index schedule items to a newly-created schedule that has no other schedule items 411 schedule items to an existing schedule 413 schedules to performance calendars 205 severity-level variables to rules 257 topology object properties to a condition 484 topology object properties to a derived metric expression 484 topology types 329 users to groups 113, 123 assign data -driven triggers to derived metrics 350 data-driven triggers to rules 252 event-driven triggers to rules 252 roles to groups 124 schedule-dri
vFoglight Administration and Configuration Guide script agent packages 455 disable cartridges 158 rules 234 download agent components 162, 164 edit default retention policy periods 387 derived metrics 341 directory settings 144 lists in secondary properties 175 password settings 137 primary type-specific properties 172 role groups 132 rule definitions 245 schedules 407 script agent properties 464 thresholds 360 variable definitions 194 enable cartridges 157 rules 235 enable collection of data with old
Index passwords 116 upload agent scripts 452 view Administration dashboard 43 audit logs 88 client support bundle content 498 derived metrics 341 license capabilities 73 rule definitions 245 rule schedules 240 rule summary 242 schedule definitions 405 schedules 407 server support bundle content 80 thresholds 360 values of registry variables 209 variable definitions 194 521 Add Role Permission dialog box 337 Add User Permission dialog box 337 adding calculations to derived metrics 344 Copy Derivation dial
vFoglight Administration and Configuration Guide Manage Licenses node in navigation panel 69 Manage Registry Variables dashboard 40, 185, 186, 187, 188, 191, 193, 194, 195, 196, 200, 217, 218, 219, 220, 221, 234, 247, 280, 281, 282, 283, 286, 484 accessing 185 Add Role Permission dialog box 189 Add User Permission dialog box 189 Copy Registry Variable dialog box 191, 192 copying registry variables 191 Create Registry Value—Step 1 view 206, 219, 220 Create Registry Value—Step 2 view 207, 220 creating
Index Edit Role Permission dialog box 230 Edit Rule view 241, 242, 243, 244, 245, 323 Edit User Permission dialog box 230 editing rule definitions 245 editing rule permissions 228 enabling rules 234 getting started with defining rules 249 resuming rule actions 238 resuming rule alarms 236 Rule Confirmation dialog box 231, 232, 237, 238, 239, 240 Scoping Query Editor dialog box 475, 476, 477, 478, 479 setting expression scope in rule conditions 262 suspending rule actions 238 suspending rule alarms 236 Te
vFoglight Administration and Configuration Guide creating users 111 Edit Groups dialog box 113, 114 forcing password changes 115 unlocking passwords 115 Manage Users node in navigation panel 109 models about 30 modules in navigation panel Administration 10, 29, 31, 32, 33, 34, 37, 38, 39, 43, Manage Licenses 69 Manage Registry Variables 185, 196, 217, 484 Manage Retention Policies 379 Manage Roles 129 Manage Rules 226, 247 Manage Schedules 397, 408 Manage Support Bundles 76 Manage Thresholds 354, 361
Index using in scoping queries 474 R Registry Variable Confirmation dialog box 194 registry variables creating 195 editing 200 getting started with editing registry variables 200 scoping to topology 206 specifying values 201 using performance calendars 204 examples assigning multiple values to a registry variable 216 using performance calendars 216 managing 185 accessing Manage Registry Variables dashboard 185 copying registry variables 191 deleting registry variables 193 editing variable definitions 194
vFoglight Administration and Configuration Guide managing 225 accessing Manage Rules dashboard 225 copying rules 231 editing rule permissions 228 editing rules 245 resuming rule actions 238 resuming rule alarms 236 rules 233 suspending rule actions 238 suspending rule alarms 236 viewing rule definitions 245 viewing rule schedules 240 rule-level variables defining 303 viewing rule summary 241 Rules & Notifications dashboards 183, 184, 223 about 184 Check Registry Value 209 Show columns dialog box 212,
Index variables 204 viewing variable definitions 194 Manage Rules 40, 46, 47, 225, 226, 227, 228, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 242, 244, 245, 246, 247, 313, 490 accessing 225 Action Parameter Editor dialog box 295, 296, 297 action types 278 actions 278 Add Role Permission dialog box 229 Add User Permission dialog box 229 adding actions to rules 286 adding severity-level variables to rules 256 Alarm Message Editor dialog box 266, 267, 275 associating rules with schedules 299 Condition
vFoglight Administration and Configuration Guide about 396 Create Schedule 42, 407, 408, 409, 410, 411 accessing 408 adding schedule items 410 creating schedules 407 deleting schedule items 410 Edit Schedule - Add Schedule Item view 412 Edit Schedule view 412 getting started with schedule definitions 409 Schedule Confirmation dialog box 414 Step 1: Create Schedule - Schedule Name and Description view 408 Step 2: Create Schedule - Details of Schedule view 410, 411 Step 3: Create Schedule - Schedule Add
Index Manage Licenses 48, 69, 70, 73, 74 accessing 69 deleting licenses 74 installing licenses 70 License Confirmation dialog box 74, 75 viewing license capabilities 72 Manage Support Bundles 40, 42, 75, 76, 77, 79 accessing 76 creating server support bundles 77 retrieving server support bundles 79 Support Bundle Inventory view 78, 79 viewing server support bundle content 80 vFoglight Configuration 40, 47, 56, 57, 58, 59, 60, 61, 63, 65, 67, 68, 280 accessing 67 Database view 59, 68 Federation Configurati
vFoglight Administration and Configuration Guide Script Editor 41, 468, 469, 470, 472 accessing 468 retrieving data from topology objects 472 selecting topology objects 469 Tooling node in navigation panel 10, 11, 33, 447, 451, assigning roles to groups 124 Create Group dialog box 122 creating groups 122 deleting internal groups 126 Edit Roles dialog box 124, 125 Edit Users dialog box 123, 124 editing users in groups 123 Manage Roles 41, 124, 127, 128, 129, 131, 132, 468 topology retrieving data 467
Index vFoglight configuration viewing 56 vFoglight Configuration dashboard 40, 47, 56, 57, 58, 59, 60, 61, 63, 65, 67, 68, 280 accessing 67 Database view 59, 68 Federation Configuration view 58 Federation view 56, 57 JVM view 60 Mail (Global Settings) view 61, 62, 280 OS view 61 Ports view 63, 65 Server view 57 viewing accessing vFoglight Configuration dashboard 67 WCF view 61 vFoglight Configuration node in navigation panel 67 vFoglight module 384 vFoglight Server Topology view 57 View Audit Information
