Monitor workload
- Overview of the agent
- Roadmap for using the Monitoring Agent for Workloads
- Workspaces reference
- Predefined workspaces
- Workspace descriptions
- Attributes reference
- Attribute groups for the monitoring agent
- Attributes in each attribute group
- Situations reference
- Predefined situations
- Situation descriptions
Monitor Agent for Workloads
The Monitoring Agent for Workloads provides you with the capability to monitor tasks that are specific to the workloads that you deploy.
Overview of the agent
The Monitoring Agent for Workloads (Workload Agent) provides you with the capability to monitor the performance of your workloads. This chapter contains a description of the features, components, and interface options for the Monitoring Agent for Workloads.
System Monitoring service
The System Monitoring service provides a monitoring infrastructure featuring the following services and which enables the Monitoring Agent for Workloads to gather and display data :
- Providing a hub monitoring server, remote monitoring server, IBM PureApplication System Monitoring Portal and connectivity information that enable automatic configuration of monitoring agents.
- Performing automated load balancing to avoid overloading a remote monitoring server. When an agent is started as a result of a newly deployed workload, the agent connects to the remote monitoring server that has the fewest agents connected. Agents are assigned an instance of remote monitoring server during startup and are not stopped and restarted for load balancing purposes.
- Determining when scaling out operations take place to provision a new instance of remote monitoring server. When you deploy the System Monitoring service, you specify the maximum number of active monitoring agents that can connect to a remote monitoring server. If more agents are deployed, a new instance of remote monitoring server is created and those agents connect to the new remote monitoring server.
- Determining when scaling in operations take place to deprovision an instance of remote monitoring server. When you deploy the System Monitoring service, you specify the minimum number of active monitoring agents that can connect to a remote monitoring server. If the number of active monitoring agents connecting to every remote monitoring server is less than the value that you specify, one remote monitoring server is deprovisioned to release resources, the monitoring agents that connected to that remote monitoring server then connect to another active remote monitoring server, and their functions are not impacted.
- Providing troubleshooting operations that are compliant with the Troubleshooting Framework Guidelines.
All of the preceding operations are automated and so require no manual intervention if the Workload agents are deployed after the System Monitoring service has been deployed. Preexisting agents must be manually connected to the System Monitoring service.
The IBM PureApplication System Monitoring Portal is the interface for the agent. The data that is collected by the Monitoring Agent for Workloads is presented in the IBM PureApplication System Monitoring Portal. You can use the consolidated view of your environment as seen in the IBM PureApplication System Monitoring Portal to monitor and resolve performance issues throughout the enterprise.
Functions of the monitoring agent
The Monitoring Agent for Workloads offers a central point of management for your application deployments or workloads. It provides a comprehensive means for gathering exactly the information you need to detect problems early and to prevent them. Information is standardized across the system. You can monitor multiple workloads from a single IBM PureApplication System Monitoring Portal, each workload is monitored by an instance of the agent. Using the agent, you can easily collect and analyze specific information, including:
- Deployment metrics for every virtual application instance, such as the availability and running state of each virtual machine used by the deployment.
- Role Type specific virtual machine deployment metrics.
- A topological view of the configuration of any application deployment.
- The ability to link to Operating System agents such as the UNIX OS agent and the Linux OS agent to view operating system metrics.
- The ability to link to the Monitoring Agent for IBM PureApplication System to view hardware specific system metrics.
- The ability to link to other IBM Tivoli Monitoring agents such as the WebSphere MQ Monitoring Agent and the Monitoring Agent for mySAP.
Roadmap for using the Monitoring Agent for Workloads
This topic provides a list of tasks that you must complete before you can use the Monitoring Agent for Workloads to monitor the workloads in your cloud environment.
The Monitoring Agent for Workloads is automatically installed when you deploy a workload to your cloud environment, however, you must complete the following steps before you can view the data that is collected by the Monitoring Agent for Workloads:
- Enable the agent to use System Monitoring to monitor workloads.
- Manually connect preexisting agent instances of deployed workloads to the monitoring service.
Connections to the monitoring service are automated and so require no manual intervention if the Workload agents are deployed after the System Monitoring service has been deployed.
After you complete these tasks, you can log on to the IBM PureApplication System Monitoring Portal to view the data that is collected by the Monitoring Agent for Workloads.
Workspaces reference
A workspace is the working area of the IBM PureApplication System Monitoring Portal application window. The Navigator tree that is displayed at the left of the workspace contains a list of the workspaces provided by the agent.
About workspaces
Use the Navigator tree that is displayed at the left of the workspace to select the workspace you want to see. As part of the application window, the right side of the status bar shows the Tivoli Enterprise Portal Server name and port number to which the displayed information applies and the ID of the current user.
When you select an item in the Navigator tree, a default workspace is displayed. When you right-click a Navigator item, a menu that includes a Workspace item is displayed. The Workspace item contains a list of workspaces for that Navigator item. Each workspace has at least one view. Some views have links to other workspaces.
The workspaces in the Navigator are displayed in a Physical view that shows your enterprise as a physical mapping or a dynamically populated logical view that is agent-specific. You can also create a Logical view. The Logical view is the default view.
This monitoring agent provides predefined workspaces. You cannot modify or delete the predefined workspaces, but you can create new workspaces by editing them and saving the changes with a different name.
The Monitoring Agent for Workloads provides various default workspaces. These workspaces are displayed in the Navigator tree under the following nodes and subnodes for this monitoring agent:
- Workload Agent (navigator item)
- Contains a single workspace summarizing general information about the deployment.
- Deployment (Q9 node)
- Corresponds to a Workload Agent instance and contains agent instance-level workspaces.
When multiple instances of the monitoring agent are defined on a system, the top-level node becomes Workload Agent. The Workload Agent workspace is undefined at this node. A subnode for each instance is created called Instance::Q9. A workspace that is called Instance: :Q9 is associated with the instance node. This workspace is comparable to the Workload Agent workspace.
Workspace views can be any combination of query-based views, event views, and special purpose views.
Some attribute groups for this monitoring agent might not be represented in the predefined workspaces or views for this agent.
3.1. Predefined workspaces
The Monitoring Agent for Workloads provides predefined workspaces, which are organized by Navigator item.
Agent-level navigator items
- Workload Agent navigator item
- Deployment Summary workspace.
- Deployment node
- Role Type Perspective Deployment Overview workspace
- Role Type Specific Virtual Machine Overview workspace
- Virtual Machine Perspective Deployment Overview workspace
- Virtual Machine Specific Role Overview workspace
- Virtual Machine Overview workspace
- Deployment Performance workspace (Superseded)
- Role Specific Virtual Machine Performance (Superseded)
- Virtual Machine Performance workspace (Superseded)
3.2. Workspace descriptions
Each workspace description provides information about the workspace such as the purpose and a list of views in the workspace.
Workspaces are listed under Navigator items. When the agent has sub-nodes, the Navigator items are listed under the subnode.
Workload Agent Navigator item
The Workload Agent Navigator item features one workspace.
- Deployment Summary workspace
- The Deployment Summary workspace displays configuration information about the deployment being monitored. This workspace has no links.
- Predefined views:
- Agent Event: The Agent Event view contains a table that provides you with information about events that occur in the monitored deployments. When appropriate, suggestions are provided to help you handle the events.
- Deployment Summary: The Deployment Summary view contains a table that provides you with configuration information, including the unique ID of the associated application, its environment profile and the ID of the associated virtual system for the deployment.
- Situation Event Console: The Situation Event Console view lists all situations that have been triggered and require your attention. To help you decide on an appropriate action, information such as the severity, impact and time since the situation was triggered is provided.
Deployment Node
The Deployment node features the following workspaces.
- Role Type Perspective Deployment Overview workspace
- The Role Type Perspective Deployment Overview workspace displays information about the deployment with emphasis how the Roles in the deployment are related to the Role Types. The workspace features 2 views providing information that can help you to troubleshoot and re-configure the deployment.
- Predefined views:
- Role Type Perspective Deployment Topology: The Role Type Perspective Deployment Topology view displays a hierarchical representation of the deployment. The associated application, Role Types and Roles of the deployment are shown in a parent to child tree structure. If any of the components are in an error state, or are unavailable, this is denoted by a red fault icon. This view also links you to the Role Type Specific Virtual Machine Overview workspace.
- Virtual Machine Role Status: The Virtual Machine Role Status view features a table displaying information about virtual machines and the roles that they are assigned. Specific information about the Roles such as Role name, status and availability can be accessed through this table. This information can help you to make decisions regarding the operational viability of the deployment.
- Predefined links
- Role Type Specific Virtual Machine Overview workspace
You can right-click a Role Type icon in the Role Type Perspective Deployment Topology view to link to this workspace.
- Link to the operating system monitoring agent: If an operating system monitoring agent is detected on a virtual machine, a link to this agent can be accessed by right-clicking a virtual machine in the Virtual Machine Role Status view. The following operating system monitoring agents are supported by this function:
- IBM Tivoli Monitoring: Linux OS Agent
- IBM Tivoli Monitoring: UNIX OS Agent
- IBM Tivoli Monitoring: Windows OS Agent
- IBM Tivoli Monitoring: AIX Premium Agent
- Link to the Monitoring Agent for IBM PureApplication System: To access this link right click a virtual machine in the Virtual Machine Role Status view.
- Link to Domain agents: If domain agents are detected on a virtual machine links to these agents can be accessed by right clicking the virtual machine in the Virtual Machine Role Status view. The following domain agents are supported by this function:
- IBM Tivoli Composite Application Manager Agent for DB2
- IBM Tivoli Composite Application Manager Agent for WebSphere Message Broker
- IBM Tivoli Composite Application Manager Agent for WebSphere MQ
- IBM Tivoli Composite Application Manager Agent for WebSphere Application Server
- IBM Tivoli Composite Application Manager Agent for mySAP
- IBM Tivoli Composite Application Manager Extended Agent for Oracle Database
- Role Type Specific Virtual Machine Overview workspace
- The Role Type Specific Virtual Machine Overview workspace displays information about all the virtual machines that are associated with the Role Type used to link to this workspace. The workspace features three views and is only available if linked to from the Role Type Perspective Deployment Overview workspace. The information available in this workspace can be used to make virtual machine specific configuration changes and to troubleshoot faulty virtual machines.
- Predefined views:
- Virtual Machine Availability per Role Type: The Virtual Machine Availability per Role Type view displays a bar chart showing all the virtual machines that are associated with the Role Type used to link to this workspace. Each bar shows the number of virtual machines in each availability state. The different availability states are as below:
- Critical
- Warning
- Unknown
- Normal
- Virtual Machine Status per Role Type: The Virtual Machine Status per Role Type view displays a bar chart showing all the virtual machines in the deployment that are associated with the Role Type used to link to this workspace. Each bar shows the number of virtual machines in each running state. The different running states are as below:
- Error
- Failed
- Stopped
- Terminated
- Terminating
- Launching
- Run
- Virtual Machine Summary per Role Type: The Virtual Machine Summary per Role Type view displays configuration information about all the virtual machines that are associated with the Role Type used to link to this workspace. This includes information such as the public IP address of the virtual machine, its hostname and the hostname of the associated hypervisor.
- Predefined links
- Role Type Specific Virtual Machine Overview workspace
You can right-click a Role icon in the Role Type Perspective Deployment Topology view to link to this workspace.
- Link to the operating system monitoring agent: If an operating system monitoring agent is detected on a virtual machine, a link to this agent can be accessed by right-clicking the virtual machine in the Topology view. The following operating system monitoring agents are supported by this function:
- IBM Tivoli Monitoring: Linux OS Agent
- IBM Tivoli Monitoring: UNIX OS Agent
- IBM Tivoli Monitoring: Windows OS Agent
- IBM Tivoli Monitoring: AIX Premium Agent
- Virtual Machine Perspective Deployment Overview workspace
- The Virtual Machine Perspective Deployment Overview workspace displays information about the deployment with emphasis how the Virtual Machines in the deployment are related to the Roles in the deployment. The workspace features 3 views providing information that can help you to troubleshoot and re-configure the deployment.
- Predefined views:
- Virtual Machine Perspective Deployment Topology: The Virtual Machine Perspective Deployment Topology view displays a hierarchical representation of the deployment. The associated application, virtual machines and Roles of the deployment are shown in a parent to child tree structure. If any of the components are in an error state, or are unavailable, this is denoted by a red fault icon. This view also links you to the Virtual Machine Specific Role Overview workspace.
- Virtual Machine Availability per Role Type in the Last hour: The Virtual Machine Availability per Role Type in the Last hour view displays a bar chart showing the number of virtual machines that have been in each availability state per Role Type, over the last hour. The different availability states are as below:
- Critical
- Warning
- Unknown
- Normal
You must enable historical data collection for the Virtual Machine Availability attribute group for information to be displayed in this view.
- Virtual Machine Status per Role Type in the Last Hour: The Virtual Machine Status per Role Type in the Last hour view displays a bar chart showing the number of virtual machines that have been in each running state per Role Type, over the last hour. The different running states are as below:
- Error
- Failed
- Stopped
- Terminated
- Terminating
- Launching
- Run
You must enable historical data collection for the Virtual Machine Status attribute group for information to be displayed in this view.
- Predefined links
- Virtual Machine Specific Role Overview workspace
You can right-click a virtual machine icon in the Virtual Machine Perspective Deployment Topology view to link to this workspace.
- Link to the operating system monitoring agent: If an operating system monitoring agent is detected on a virtual machine, a link to this agent can be accessed by right-clicking the virtual machine in the Topology view. The following operating system monitoring agents are supported by this function:
- IBM Tivoli Monitoring: Linux OS Agent
- IBM Tivoli Monitoring: UNIX OS Agent
- IBM Tivoli Monitoring: Windows OS Agent
- IBM Tivoli Monitoring: AIX Premium Agent
- Virtual Machine Specific Role Overview workspace
- The Virtual Machine Specific Role Overview workspace displays information about all the Roles that are assigned to the virtual machine used to link to this workspace. The workspace features two views and is only available if linked to from the Virtual Machine Perspective Deployment Overview workspace. The information available in this workspace can be used to make virtual machine specific configuration changes and to troubleshoot faulty virtual machines.
- Predefined views:
- Virtual Machine Specific Role Availability Summary: The Virtual Machine Specific Role Availability Summary view displays a bar chart showing the number of Roles assigned to the virtual machine used to link to this workspace in each availability state. The different availability states are as below:
- Critical
- Warning
- Unknown
- Normal
- Virtual Machine Specific Role Overview: The Virtual Machine Specific Role Overview displays information about all the Roles assigned to the virtual machine used to link to this workspace. This includes information such as the public IP address of the virtual machine, its hostname and the hostname of the associated hypervisor.
- Virtual Machine Overview workspace
- The Virtual Machine Overview workspace displays information about all the virtual machines in a deployment. The workspace features three views providing information that can help you to troubleshoot the virtual machines. This workspace has no links.
- Predefined views:
- Virtual Machine Availability per Role Type: The Virtual Machine Availability per Role Type view displays a bar chart showing the number of virtual machines associated with each Role type, in each Availability state. The different availability states are as below:
- Critical
- Warning
- Unknown
- Normal
- Virtual Machine Status per Role Type: The Virtual Machine Status per Role Type view displays a bar chart showing the number of virtual machines associated with each Role type, in each running state. The different running states are as below:
- Error
- Failed
- Stopped
- Terminated
- Terminating
- Launching
- Run
- Virtual Machine Summary: The Virtual Machine Summary view displays configuration information about all the virtual machines in the deployment. This includes information such as the public IP address of the virtual machine, its host name, and the ID of the associated deployment.
- Predefined links
- Virtual Machine Specific Role Overview workspace
You can right-click a virtual machine in the Virtual Machine Summary view to link to this workspace.
- Deployment Performance workspace (Superseded)
- The Deployment Performance workspace displays performance information about the deployment. The workspace features 3 views providing information that can help you to troubleshoot and re-configure the deployment.
- Predefined views:
- Deployment Topology: The Deployment Topology view displays a hierarchical representation of the deployment. The deployment's associated application, roles and virtual machines are shown in a parent to child tree structure. If any of the components are in an error state or are unavailable this is denoted by a red fault icon.
- Virtual Machine Availability per Role: The Virtual Machine Availability per Role view displays a bar chart showing all the virtual machines in the deployment grouped by assigned role. Each bar shows the number of virtual machines in a particular availability state. The different availability states are:
- Critical
- Warning
- Unknown
- Normal
- Virtual Machine Status per Role: The Virtual Machine Status per Role view displays a bar chart showing all the virtual machines in the deployment grouped by assigned role. Each bar shows the number of virtual machines in a particular running state. The different running states are:
- Error
- Failed
- Stopped
- Terminated
- Terminating
- Launching
- Run
- Predefined links
- Role Specific Virtual Machine Performance workspace
You can right-click a role icon in the Topology view or a bar representing a role in either the Virtual Machine Status per Role or the Virtual Machine Availability per Role views to link to this workspace.
- Link to domain agent: If domain agents are detected on a virtual machine links to these agents can be accessed by right clicking the virtual machine in the Topology view. The following domain agents are supported by this function:
- IBM Tivoli Composite Application Manager Agent for DB2
- IBM Tivoli Composite Application Manager Agent for WebSphere Message Broker
- IBM Tivoli Composite Application Manager Agent for WebSphere MQ
- IBM Tivoli Composite Application Manager Agent for WebSphere Application Server
- IBM Tivoli Composite Application Manager Agent for mySAP
- IBM Tivoli Composite Application Manager Extended Agent for Oracle Database
- Link to the operating system monitoring agent: If an operating system agent is detected on a virtual machine a link to this agent can be accessed by right clicking the virtual machine in the Topology view. The following operating system monitoring agents are supported by this function:
- IBM Tivoli Monitoring: Linux OS Agent
- IBM Tivoli Monitoring: UNIX OS Agent
- IBM Tivoli Monitoring: Windows OS Agent
- IBM Tivoli Monitoring: AIX Premium Agent
- Role Specific Virtual Machine Performance workspace (Superseded)
- The Role Specific Virtual Machine Performance workspace displays performance information about all the virtual machines assigned to a particular role in a deployment. The workspace features 3 workspaces and is only available if linked to from the Deployment performance workspace. The information available in this workspace can be used to make virtual machine specific configuration changes and to troubleshoot faulty virtual machines.
- Predefined views:
- Virtual Machine Availability: The Virtual Machine Availability view displays a bar chart showing all the virtual machines that are assigned to a particular role. Each bar shows the number of virtual machines in a particular availability state. The different availability states are:
- Critical
- Warning
- Unknown
- Normal
- Virtual Machine Status: The Virtual Machine Status view displays a bar chart showing all the virtual machines in the deployment that are assigned a particular role. Each bar shows the number of virtual machines in a particular running state. The different running states are:
- Error
- Failed
- Stopped
- Terminated
- Terminating
- Launching
- Run
- Virtual Machine Summary view: The Virtual Machine summary view displays configuration information about all the virtual machines assigned to a particular role. This includes information such as the virtual machine's public IP address, host name and associated deployment's ID.
- Virtual Machine Performance workspace (Superseded)
- The Virtual Machine Performance workspace displays performance information about all the virtual machines in a deployment (not filtered by role). The workspace features three views providing information that can help you to troubleshoot the virtual machines. This workspace has no links.
- Predefined views:
- Virtual Machine Availability per Role: The Virtual Machine Availability per Role view displays a bar chart showing all the virtual machines in the deployment grouped by assigned role. Each bar shows the number of virtual machines in a particular availability state. The different availability states are as below:
- Critical
- Warning
- Unknown
- Normal
- Virtual Machine Status per Role: The Virtual Machine Status per Role view displays a bar chart showing all the virtual machines in the deployment grouped by assigned role. Each bar shows the number of virtual machines in a particular running state. The different running states are as below:
- Error
- Failed
- Stopped
- Terminated
- Terminating
- Launching
- Run
- Virtual Machine Summary: The Virtual Machine Summary view displays configuration information about all the virtual machines in the deployment. This includes information such as the public IP address of the virtual machine, its host name, and the ID of the associated deployment.
Attributes reference
Attributes are the application properties that are being measured and reported by the Monitoring Agent for Workloads.
About attributes
Attributes are organized into attribute groups. Attributes in an attribute group relate to a single object such as an application, or to a single kind of data such as status information.
Attributes in a group can be used in queries, query-based views, situations, policy workflows, take action definitions, and launch application definitions. Chart or table views and situations are two examples of how attributes in a group can be used:
- Chart or table views
Attributes are displayed in chart and table views. The chart and table views use queries to specify which attribute values to request from a monitoring agent. You use the Properties editor to apply filters and set styles to define the content and appearance of a view based on an existing query.
- Situations
You use attributes to create situations that monitor the state of your operating system, database, or application. A situation describes a condition you want to test. When you start a situation, the values you have assigned to the situation attributes are compared with the values collected by the Workload Agent and registers an event if the condition is met. You are alerted to events by indicator icons that are displayed in the Navigator.
4.1. Attribute groups for the monitoring agent
The Monitoring Agent for Workloads contains the following attribute groups. The table name depends on the maximum table name limits of the target database being used for the Tivoli Data Warehouse. If the maximum name is 30 characters, any warehouse table name longer than 30 characters is shortened to 30 characters.
- Attribute group name: Agent Event
- Table name: KQ9AGTEVT
- Warehouse table name: KQ9_AGENT_EVENT or KQ9AGTEVT
- Attribute group name: Deployment Summary
- Table name: KQ9DEPLOY
- Warehouse table name: KQ9_DEPLOYMENT or KQ9DEPLOY
- Attribute group name: Performance Object Status
- Table name: KQ9POBJST
- Warehouse table name: KQ9_PERFORMANCE_OBJECT_STATUS or KQ9POBJST
- Attribute group name: Role Availability Summary
- Table name: KQ9RAVSUM
- Warehouse table name: KQ9_ROLE_AVAILABILITY_SUMMARY or KQ9RAVSUM
- Attribute group name: Topology
- Table name: KQ9TOPOLG
- Warehouse table name: KQ9_TOPOLOGY or KQ9TOPOLG
- Attribute group name: Virtual Machine Availability
- Table name: KQ9AVSUM
- Warehouse table name: KQ9_VIRTUAL_MACHINE_AVAILABILITY or KQ9AVSUM
- Attribute group name: Virtual Machine Roles Summary
- Table name: KQ9ROLEVM
- Warehouse table name: KQ9_VIRTUAL_MACHINE_ROLES_SUMMARY or KQ9ROLEVM
- Attribute group name: Virtual Machine Status
- Table name: KQ9STATSUM
- Warehouse table name: KQ9_VIRTUAL_MACHINE_STATUS or KQ9STATSUM
- Attribute group name: Virtual Machine Summary
- Table name: KQ9VMROLE
- Warehouse table name: KQ9_VIRTUALMACHINEROLE or KQ9VMROLE
- Attribute group name: Virtual Machine Topology
- Table name: KQ9VMTPLG
- Warehouse table name: KQ9_VIRTUAL_MACHINE_TOPOLOGY or KQ9VMTPLG
4.2. Attributes in each attribute group
Attributes in each Monitoring Agent for Workloads attribute group collect data that the agent uses for monitoring.
The descriptions of the attribute groups contain the following information:
- Historical group
- Whether the attribute group is a historical type that you can roll off to a data warehouse.
- Attribute descriptions
- Description, type, and Warehouse name (if applicable) for each attribute in the attribute group.
Some attributes are designated as key attributes. A key attribute is an attribute used in warehouse aggregation to identify rows of data that represent the same object.
Agent Event attribute group
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Agent Event attribute group:
- Node attribute: This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Formula
- The value for this attribute is calculated as .
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Formula
- The value for this attribute is calculated as .
- Warehouse name
- TIMESTAMP
- Category attribute
- Description
- Category of the event.
- Type
- String
- Formula
- The value for this attribute is calculated as .
- Warehouse name
- CATEGORY
- Error Code attribute
- Description
- Error code of the event.
- Type
- Integer (32-bit numeric property) with enumerated values. The strings are displayed in the Tivoli Enterprise Portal. The warehouse and queries return the values that are shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other value is the value that is returned by the agent in the Tivoli Enterprise Portal.
- Formula
- The value for this attribute is calculated as .
- Warehouse name
- ERRORCODE or ECODE
- Error Message attribute
- Description
- Message of the event.
- Type
- String
- Formula
- The value for this attribute is calculated as .
- Warehouse name
- ERRORMESSAGE or EMSG
- Event Level attribute
- Description
- Level of the event.
- Type
- Integer (32-bit numeric property) with enumerated values. The strings are displayed in the Tivoli Enterprise Portal. The warehouse and queries return the values that are shown in parentheses. The following values are defined:
- Error (1)
- Warning (2)
- Information (3)
Any other value is the value that is returned by the agent in the Tivoli Enterprise Portal.
- Formula
- The value for this attribute is calculated as .
- Warehouse name
- EVENTLEVEL or LEVEL
- Suggestion attribute
- Description
- Suggestion for the error.
- Type
- String
- Formula
- The value for this attribute is calculated as .
- Warehouse name
- SUGGESTION or SUGGST
Deployment Summary attribute group
The Deployment Summary attribute group provides configuration information about application deployments.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Deployment summary attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Appliance Group attribute
- Description
- The appliance group of the deployment.
- Type
- String
- Warehouse name
- APPLIANCE_GROUP or ALCNGRP
- Appliance Hostname attribute
- Description
- The hostname of the appliance which is associated with the deployment.
- Type
- String
- Warehouse name
- APPLIANCE_HOST_NAME or ALCNHST
- Appliance ID attribute
- Description
- The unique ID of the appliance which is associated with the deployment.
- Type
- String
- Warehouse name
- APPLIANCE_ID or ALCNID
- Appliance Type attribute
- Description
- The type of the appliance which is associated with the deployment.
- Type
- String
- Warehouse name
- APPLIANCE_TYPE or ALCNTPE
- Application ID attribute
- Description
- The unique ID of the application of which the deployment is an instance.
- Type
- String
- Warehouse name
- APPLICATION_ID or APPID
- Application Name attribute
- Description
- The name of the application of which the deployment is an instance.
- Type
- String
- Warehouse name
- APPLICATION_NAME or APPNAME
- Availability attribute
- Description
- The availability of the deployment.
- Type
- String
- Warehouse name
- AVAILABILITY or AVAIL
- Cloud Group ID attribute
- Description
- The unique ID of the cloud group which is associated with the deployment.
- Type
- String
- Warehouse name
- CLOUDGROUP or CLOUDGRP
- Environment Profile ID attribute
- Description
- The unique ID of the environment profile associated with the deployment.
- Type
- String
- Warehouse name
- ENVPROFILE or ENVPROF
- Deployment Name attribute
- Description
- The name of the deployment.
- Type
- String
- Warehouse name
- NAME
- Deployment Status attribute
- Description
- The status of the deployment.
- Type
- String
- Warehouse name
- STATUS
- Unique ID attribute - This attribute is a key attribute.
- Description
- The unique ID of the deployment.
- Type
- String
- Warehouse name
- UID
- Virtual System ID attribute
- Description
- The ID of the virtual system of the deployment.
- Type
- String
- Warehouse name
- VSID
- Cloud Group Name attribute
- Description
- The name of the cloud group which is associated with the deployment.
- Type
- String
- Warehouse name
- CLOUDGROUPNAME or CLDGRPN
- Environment Profile Name
- Description
- The name of the environment profile which is associated with the deployment.
- Type
- String
- Warehouse name
- ENVPROFILENAME or ENVPRFN
Performance Object Status attribute group
The Performance Object Status attribute group contains information that reflects the status of other attribute groups so you can see the status of all of the performance objects that make up this application all at once. Each of these other performance attribute groups is represented by a row in this table (or other type of view). The status for an attribute group reflects the result of the last attempt to collect data for that attribute group, which allows you to see whether the agent is performing correctly. Unlike other attribute groups, the Performance Object Status attribute group does not reflect the state of the monitored application. This attribute group is most often used to determine why data is not available for one of the performance attribute groups.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Performance Object Status attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Query Name attribute - This attribute is a key attribute.
- Description
- The name of the attribute group.
- Type
- String
- Warehouse name
- QUERY_NAME or ATTRGRP
- Object Name attribute
- Description
- The name of the performance object.
- Type
- String
- Warehouse name
- OBJECT_NAME or OBJNAME
- Object Type attribute
- Description
- The type of the performance object.
- Type
- Integer with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- WMI (0)
- PERFMON (1)
- WMI ASSOCIATION GROUP (2)
- JMX (3)
- SNMP (4)
- SHELL COMMAND (5)
- JOINED GROUPS (6)
- CIMOM (7)
- CUSTOM (8)
- ROLLUP DATA (9)
- WMI REMOTE DATA (10)
- LOG FILE (11)
- JDBC (12)
- CONFIG DISCOVERY (13)
- NT EVENT LOG (14)
- FILTER (15)
- SNMP EVENT (16)
- PING (17)
- DIRECTOR DATA (18)
- DIRECTOR EVENT (19)
- SSH REMOTE SHELL COMMAND (20)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- OBJECT_TYPE or OBJTYPE
- Object Status attribute
- Description
- The status of the performance object.
- Type
- Integer with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- ACTIVE (0)
- INACTIVE (1)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- OBJECT_STATUS or OBJSTTS
- Error Code attribute
- Description
- The error code associated with the query.
- Type
- Integer with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- NO ERROR (0)
- GENERAL ERROR (1)
- OBJECT NOT FOUND (2)
- COUNTER NOT FOUND (3)
- NAMESPACE ERROR (4)
- OBJECT CURRENTLY UNAVAILABLE (5)
- COM LIBRARY INIT FAILURE (6)
- SECURITY INIT FAILURE (7)
- PROXY SECURITY FAILURE (9)
- NO INSTANCES RETURNED (10)
- ASSOCIATOR QUERY FAILED (11)
- REFERENCE QUERY FAILED (12)
- NO RESPONSE RECEIVED (13)
- CANNOT FIND JOINED QUERY (14)
- CANNOT FIND JOIN ATTRIBUTE IN QUERY 1 RESULTS (15)
- CANNOT FIND JOIN ATTRIBUTE IN QUERY 2 RESULTS (16)
- QUERY 1 NOT A SINGLETON (17)
- QUERY 2 NOT A SINGLETON (18)
- NO INSTANCES RETURNED IN QUERY 1 (19)
- NO INSTANCES RETURNED IN QUERY 2 (20)
- CANNOT FIND ROLLUP QUERY (21)
- CANNOT FIND ROLLUP ATTRIBUTE (22)
- FILE OFFLINE (23)
- NO HOSTNAME (24)
- MISSING LIBRARY (25)
- ATTRIBUTE COUNT MISMATCH (26)
- ATTRIBUTE NAME MISMATCH (27)
- COMMON DATA PROVIDER NOT STARTED (28)
- CALLBACK REGISTRATION ERROR (29)
- MDL LOAD ERROR (30)
- AUTHENTICATION FAILED (31)
- CANNOT RESOLVE HOSTNAME (32)
- SUBNODE UNAVAILABLE (33)
- SUBNODE NOT FOUND IN CONFIG (34)
- ATTRIBUTE ERROR (35)
- CLASSPATH ERROR (36)
- CONNECTION FAILURE (37)
- FILTER SYNTAX ERROR (38)
- FILE NAME MISSING (39)
- SQL QUERY ERROR (40)
- SQL FILTER QUERY ERROR (41)
- SQL DB QUERY ERROR (42)
- SQL DB FILTER QUERY ERROR (43)
- PORT OPEN FAILED (44)
- ACCESS DENIED (45)
- TIMEOUT (46)
- NOT IMPLEMENTED (47)
- REQUESTED A BAD VALUE (48)
- RESPONSE TOO BIG (49)
- GENERAL RESPONSE ERROR (50)
- SCRIPT NONZERO RETURN (51)
- SCRIPT NOT FOUND (52)
- SCRIPT LAUNCH ERROR (53)
- CONF FILE DOES NOT EXIST (54)
- CONF FILE ACCESS DENIED (55)
- INVALID CONF FILE (56)
- EIF INITIALIZATION FAILED (57)
- CANNOT OPEN FORMAT FILE (58)
- FORMAT FILE SYNTAX ERROR (59)
- REMOTE HOST UNAVAILABLE (60)
- EVENT LOG DOES NOT EXIST (61)
- PING FILE DOES NOT EXIST (62)
- NO PING DEVICE FILES (63)
- PING DEVICE LIST FILE MISSING (64)
- SNMP MISSING PASSWORD (65)
- DISABLED (66)
- URLS FILE NOT FOUND (67)
- XML PARSE ERROR (68)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- ERROR_CODE or ERRCODE
Role Availability Summary attribute group
The Role Availability Summary attribute group provides information about the number of role instances that are in each availability state.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Role Availability Summary attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Critical Count attribute
- Description
- The number of role instances that are in a critical availability state.
- Type
- Integer (32-bit gauge) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- CRITICALCOUNT or CRITCNT
- Warning Count attribute
- Description
- The number of role instances that are in a warning availability state.
- Type
- Integer (32-bit gauge) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- WARNINGCOUNT or WARNCNT
- Unknown Count attribute
- Description
- The number of role instances that are in an unknown availability state.
- Type
- Integer (32-bit gauge) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- UNKNOWNCOUNT or UNKNCNT
- Normal Count attribute
- Description
- The number of role instances that are in a normal availability state.
- Type
- Integer (32-bit gauge) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- NORMALCOUNT or NORMCNT
- Virtual Machine Name attribute - This attribute is a key attribute.
- Description
- The name of the virtual machine assigned to the roles.
- Type
- String
- Warehouse name
- VIRTUALMACHINENAME or VMNAME
Topology attribute group
The Topology attribute group provides information about the connections between deployment components from a role perspective.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Topology attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Availability attribute
- Description
- The availability of the component.
- Type
- String
- Warehouse name
- AVAILABILITY or AVAIL
- ID attribute - This attribute is a key attribute.
- Description
- The unique ID of the component.
- Type
- String
- Warehouse name
- CHILD_ID or CHILDID
- IP Address attribute
- Description
- The IP address of the virtual machine.
- Type
- String
- Warehouse name
- IPADDRESS or IP
- Name attribute
- Description
- The name of the component.
- Type
- String
- Warehouse name
- NAME
- Parent ID attribute - This attribute is a key attribute.
- Description
- The unique ID of the parent of the component.
- Type
- String
- Warehouse name
- PARENT_ID or PARENTID
- State attribute
- Description
- The state of the component.
- Type
- String
- Warehouse name
- STATE
- Type attribute
- Description
- The component type.
- Type
- String
- Warehouse name
- TYPE
Virtual Machine Availability attribute group
The Virtual Machine Availability attribute group provides information about the number of virtual machines per availability state, grouped by the roles that the machines are assigned.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Virtual Machine Availability attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Critical Count attribute
- Description
- The number of virtual machines in a critical availability state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- CRITICAL or CRITCNT
- Normal Count attribute
- Description
- The number of virtual machines in a normal availability state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- NORMAL or NORMCNT
- Role Name attribute
- Description
- The role assigned to the virtual machines.
- Type
- String
- Warehouse name
- ROLE_NAME or ROLENAM
- Unknown Count attribute
- Description
- The number of virtual machines in an unknown availability state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- UNKNOWN or UNKNCNT
- Warning Count attribute
- Description
- The number of virtual machines in a warning availability state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- WARNING or WARNCNT
Virtual Machine Roles Summary attribute group
The Virtual Machine Roles Summary attribute group provides information about a virtual machine and the roles currently assigned to that virtual machine.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Virtual Machine Roles Summary attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Availability attribute
- Description
- The availability of the virtual machine.
- Type
- String
- Warehouse name
- AVAILABILITY or AVAIL
- Count attribute
- Description
- The number of roles currently assigned to the virtual machine.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- COUNT or CNT
- Deployment ID attribute
- Description
- The unique ID of the deployment currently deployed on the virtual machine.
- Type
- String
- Warehouse name
- DEPLOYID
- Hostname attribute
- Description
- The hostname of the virtual machine.
- Type
- String
- Warehouse name
- HOSTNAME
- Hypervisor Hostname attribute
- Description
- The hostname of the hypervisor on which the virtual machine is hosted.
- Type
- String
- Warehouse name
- HYPERVISORHOSTNAME or HYPHST
- Hypervisor ID attribute
- Description
- The unique ID of the hypervisor on which the virtual machine is hosted.
- Type
- String
- Warehouse name
- HYPERVISORID or HYPERID
- Node ID attribute
- Description
- The unique ID of the node.
- Type
- String
- Warehouse name
- NODEID
- Public IP Address attribute - This attribute is a key attribute.
- Description
- The public IP address of the virtual machine.
- Type
- String
- Warehouse name
- PUBLIC_IP or PRIVAIP
- State attribute
- Description
- The running state of the virtual machine.
- Type
- String
- Warehouse name
- STATUS
- Virtual Machine Name attribute
- Description
- The name of the virtual machine.
- Type
- String
- Warehouse name
- VMNAME
- Virtual Machine ID attribute - This attribute is a key attribute.
- Description
- The unique ID of the virtual machine.
- Type
- String
- Warehouse name
- VMUID
- Role List attribute - This attribute is a key attribute.
- Description
- A list of all the roles currently assigned to the virtual machine.
- Type
- String
- Warehouse name
- ROLELIST or ROLELST
- Private IP address attribute
- Description
- The private IP address of the virtual machine.
- Type
- String
- Warehouse name
- PRIVATE_IP or PRIVATIP
Virtual Machine Status attribute group
The Virtual Machine Status attribute group provides information about the number of virtual machines per running status, grouped by the roles that the machines are assigned.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Virtual machine status attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Error Count attribute
- Description
- The number of virtual machines that are in an error state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- ERROR or ERRCNT
- Failed Count attribute
- Description
- The number of virtual machines that are in a failed state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- FAILED or FAILCNT
- Launching Count attribute
- Description
- The number of virtual machines that are in a launching state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- LAUNCHING or LAUNCNT
- Role Name attribute
- Description
- The role that the virtual machines are assigned.
- Type
- String
- Warehouse name
- ROLE_NAME or ROLENAME
- Run Count attribute
- Description
- The number of virtual machines in a running state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- RUNNING or RUNCNT
- Stopped Count attribute
- Description
- the number of virtual machines that are in a stopped state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- STOPPED or STOPCNT
- Terminated Count attribute
- Description
- The number of virtual machines that are in a terminated state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- TERMINATED or TERDCNT
- Terminating attribute
- Description
- the number of virtual machines that are in a terminating state.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- TERMINATINGCOUNT or TMIGCNT
Virtual Machine Summary attribute group
The Virtual Machine Summary attribute group provides configuration and availability information about a virtual machine.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Virtual Machine Summary attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Availability attribute
- Description
- The availability of the virtual machine.
- Type
- String
- Warehouse name
- AVAILABILITY or AVAIL
- Count attribute
- Description
- Reserved column.
- Type
- Integer (32-bit counter) with enumerated values. The strings are displayed in the IBM PureApplication System Monitoring Portal. The warehouse and queries return the values shown in parentheses. The following values are defined:
- Value Exceeds Maximum (2147483647)
- Value Exceeds Minimum (-2147483648)
Any other values will display the actual value returned by the agent in the IBM PureApplication System Monitoring Portal.
- Warehouse name
- COUNT or CNT
- Deployment ID attribute
- Description
- The unique ID of the deployment currently deployed on the virtual machine.
- Type
- String
- Warehouse name
- DEPLOYID
- Hostname attribute
- Description
- The hostname of the virtual machine.
- Type
- String
- Warehouse name
- HOST_NAME or HOSTNAME
- Hypervisor Hostname attribute
- Description
- The hostname of the hypervisor on which the virtual machine is hosted.
- Type
- String
- Warehouse name
- HYPERVISOR_HOST_NAME or HYPHST
- Hypervisor ID attribute
- Description
- The unique ID of the hypervisor on which the virtual machine is hosted.
- Type
- String
- Warehouse name
- HYPERVISOR_ID or HYPERID
- Node ID attribute
- Description
- The unique ID of the node.
- Type
- String
- Warehouse name
- NODE_ID or NOTEID
- Public IP address attribute
- Description
- The public IP address of the virtual machine.
- Type
- String
- Warehouse name
- PUBLIC_IP or PRIVAIP
- Role Availability attribute
- Description
- The Availability of the role currently assigned to the virtual machine.
- Type
- String
- Warehouse name
- ROLEAVAILABILITY or ROLEAVA
- Role ID attribute
- Description
- The unique ID of the role that the virtual machine is currently assigned.
- Type
- String
- Warehouse name
- ROLE_ID or ROLEID
- Role Name attribute
- Description
- The name of the role that the virtual machine is currently assigned.
- Type
- String
- Warehouse name
- ROLE_NAME or ROLENA
- Role State attribute
- Description
- The running state of the role currently assigned to the virtual machine.
- Type
- String
- Warehouse name
- ROLESTATUS or ROLESTA
- Status attribute
- Description
- The current running state of the virtual machine.
- Type
- String
- Warehouse name
- STATUS
- Virtual Machine Name attribute
- Description
- The name of the virtual machine.
- Type
- String
- Warehouse name
- VM_NAME or VMNAME
- Virtual Machine ID attribute - This attribute is a key attribute.
- Description
- The unique ID of the virtual machine.
- Type
- String
- Warehouse name
- VM_UID or VMUID
- Application ID attribute
- Description
- The unique ID of the application currently running on the virtual machine.
- Type
- String
- Warehouse name
- APPLICATIONID or APPID
- Application Name attribute
- Description
- The name of the application currently running on the virtual machine.
- Type
- String
- Warehouse name
- APPLICATIONNAME or APPNAME
- Cloud Group Name attribute
- Description
- The name of the cloud group associated with the virtual machine.
- Type
- String
- Warehouse name
- CLOUDGROUPNAME or CLDGRPN
- Deployment Name attribute
- Description
- The name of the deployment currently deployed on the virtual machine.
- Type
- String
- Warehouse name
- DEPLOYMENTNAME or DEPLOYN
- Environment Profile Name attribute
- Description
- The name of the environment profile associated with the virtual machine.
- Type
- String
- Warehouse name
- ENVPROFILENAME or ENVPRFN
- Private IP address attribute
- Description
- The private IP address of the virtual machine.
- Type
- String
- Warehouse name
- PRIVATE_IP or PRIVATIP
Virtual Machine Topology attribute group
The Virtual Machine Topology attribute group provides information about the connections between deployment components from a virtual machine perspective.
- Historical group
- This attribute group is eligible for use with Tivoli Data Warehouse.
- Attribute descriptions
- The following list contains information about each attribute in the Virtual Machine Topology attribute group:
- Node attribute - This attribute is a key attribute.
- Description
- The managed system name of the agent.
- Type
- String
- Warehouse name
- NODE
- Timestamp attribute
- Description
- The local time at the agent when the data was collected.
- Type
- String
- Warehouse name
- TIMESTAMP
- Availability attribute
- Description
- The availability of the component.
- Type
- String
- Warehouse name
- AVAILABILITY or AVAIL
- ID attribute
- Description
- The unique ID of the component.
- Type
- String
- Warehouse name
- CHILDID
- IP Address attribute
- Description
- The IP address of the virtual machine.
- Type
- String
- Warehouse name
- IPADDRESS or IP
- Name attribute
- Description
- The name of the component.
- Type
- String
- Warehouse name
- NAME
- Parent ID attribute
- Description
- The unique ID of the parent of the component.
- Type
- String
- Warehouse name
- PARENTID
- State attribute
- Description
- The running state of the deployment component.
- Type
- String
- Warehouse name
- STATE
- Type attribute
- Description
- The component type.
- Type
- String
- Warehouse name
- TYPE
- Private IP address attribute
- Description
- The private IP address of the virtual machine.
- Type
- String
- Warehouse name
- PRIVATE_IP or IPADDPRV
- Private IP address attribute
- Description
- The private IP address of the virtual machine.
- Type
- String
- Warehouse name
- PRIVATE_IP or IPPRV
Situations reference
A situation is a logical expression involving one or more system conditions. Situations are used to monitor the condition of systems in your network. You can manage situations from the IBM PureApplication System Monitoring Portal by using the Situation Editor or from the command-line interface using the tacmds for situations. You can manage private situations in the private configuration XML file.
About situations
The monitoring agents that you use to monitor your system environment include a set of predefined situations that you can use as-is. You can also create new situations to meet your requirements.
Predefined situations contain attributes that check for system conditions common to many enterprises. Using predefined situations can improve the speed with which you can begin using the Monitoring Agent for Workloads. You can change the conditions or values being monitored by a predefined situation to the conditions or values best suited to your enterprise.
You can display predefined situations and create your own situations using the Situation editor. The left panel of the Situation editor initially lists the situations associated with the Navigator item that you selected. When you click a situation name or create a situation, the right panel opens with the following tabs:
- Formula
- Formula describing the condition being tested.
- Distribution
- List of managed systems (operating systems, subsystems, or applications) to which the situation can be distributed. All the Workload Agent managed systems are assigned by default.
- Expert advice
- Comments and instructions to be read in the event workspace.
- Action
- Command to be sent to the system.
- EIF
- Customize forwarding of the event to an Event Integration Facility receiver. (Available when the Tivoli Enterprise Monitoring Server has been configured to forward events.)
- Until
- Options to close the event after a period of time, or when another situation becomes true.
Additional information about situations
information about predefined and custom situations and how to use them to respond to alerts.
5.1. Predefined situations
The monitoring agent contains predefined situations, which are organized by Navigator item.
Agent level Navigator items
- Workload Agent
- KQ9_Deployment_Fail_Sit
- KQ9_Deployment_Avail_Critical
- KQ9_Availability_Fail_Sit
- KQ9_Availability_Fail_Warn
- KQ9_Status_Fail_Sit
- KQ9_Status_Fail_Warn
A situation named KQ9_Deployment_Change_Sit is available for internal use. You are advised not to modify this situation as this would lead to the IWDEventHandler application not being able to keep the IBM PureApplication System Monitoring Portal logical navigator views synchronized with the PureSystems environment when the deployment virtual machines scale in or out. In the event that you do accidentally modify the situation the IWDEventHandler application recreates the situation when the IBM PureApplication System Monitoring Portal Server or IWDEventHandler application is restarted. You must however first delete the situation for it to be restored after the restart.
5.2. Situation descriptions
Each situation description provides information about the situation that you can use to monitor the condition of systems in your network.
The situation descriptions provide the following information:
- Description
- Information about the conditions that the situation tests.
- Formula
- Syntax that contains one or more logical expressions describing the conditions for the situation to monitor.
- Distribution
- Whether the situation is automatically distributed to instances of the agent or is available for manual distribution.
- Run at startup
- Whether the situation starts monitoring when the agent starts.
- Sampling interval
- Number of seconds that elapse between one sample of data that the monitoring agent collects for the server and the next sample.
- Situation persistence
- Whether the conditions specified in the situation evaluate to "true" for the defined number of occurrences in a row before the situation is raised. The default of one means that no persistence-checking takes place.
- Severity
- Severity of the predefined events: Warning, Informational, or Critical.
- Clearing conditions
- Controls when a true situation closes: after a period of time, when another situation is true, or whichever occurs first if both are selected.
Workload Agent Navigator item
- KQ9_Deployment_Fail_Sit situation
- Description
- This situation executes when the deployment has failed. Check the status of all role types for more information.
- Formula
- *IF *VALUE KQ9_DEPLOYMENT.STATUS *EQ 'FAILED'
- Distribution
- This situation is available for distribution.
- Run at startup
- Yes
- Sampling interval
- 5 minutes
- Situation persistence
- The number of times the conditions of the situation must occur for the situation to be true is 1.
- Error conditions
- Critical
- Clearing conditions
- The situation clears when the condition becomes false.
- KQ9_Deployment_Avail_Critical
- Description
- This situation executes when the deployment is in a critical availability state. Check the status of all role types for more information.
- Formula
- *IF *VALUE KQ9_DEPLOYMENT.AVAILABILITY *EQ 'CRITICAL'
- Distribution
- This situation is available for distribution.
- Run at startup
- Yes
- Sampling interval
- 5 minutes
- Situation persistence
- The number of times the conditions of the situation must occur for the situation to be true is 1.
- Error conditions
- Critical
- Clearing conditions
- The situation clears when the condition becomes false.
- KQ9_Availability_Fail_Sit situation
- Description
- This situation monitors the availability of the virtual machines that play a specific role in the deployment and issues an alert when all of the virtual machines of that role have failed.
- Formula
- *IF *VALUE KQ9_VIRTUAL_MACHINE_AVAILABILITY.NormalCount *EQ 0 *AND *VALUE KQ9_VIRTUAL_MACHINE_AVAILABILITY.WarningCount *EQ 0 *AND *VALUE KQ9_VIRTUAL_MACHINE_AVAILABILITY.UnknownCount *EQ 0 *AND *VALUE KQ9_VIRTUAL_MACHINE_AVAILABILITY.RoleName *NE 'UNKNOWN'
- Distribution
- This situation is available for distribution.
- Run at startup
- Yes
- Sampling interval
- 5 minutes
- Situation persistence
- The number of times the conditions of the situation must occur for the situation to be true is 1.
- Error conditions
- Critical
- Clearing conditions
- The situation clears when the condition becomes false.
- KQ9_Availability_Fail_Warn situation
- Description
- This situation monitors the availability of the virtual machines that play a specific role in the deployment and issues an alert when the virtual machines of that role might fail.
- Formula
- *IF *VALUE KQ9_AVAILABILITYSUMMARY.NormalCount *EQ 0 *AND *VALUE KQ9_AVAILABILITYSUMMARY.WarningCount *GT 0
- Distribution
- This situation is available for distribution.
- Run at startup
- No
- Sampling interval
- 5 minutes
- Situation persistence
- The number of times the conditions of the situation must occur for the situation to be true is 1.
- Error conditions
- Warn
- Clearing conditions
- The situation clears when the condition becomes false.
- KQ9_Status_Fail_Sit situation
- Description
- This situation monitors the status of the virtual machines that play a specific role in the deployment and issues an alert when none of the virtual machines of that role are running or launching.
- Formula
- *IF *VALUE KQ9_STATUSSUMMARY.RunningCount *EQ 0 *AND *VALUE KQ9_STATUSSUMMARY.LaunchingCount *EQ 0
- Distribution
- This situation is available for distribution.
- Run at startup
- Yes
- Sampling interval
- 5 minutes
- Situation persistence
- The number of times the conditions of the situation must occur for the situation to be true is 1.
- Error conditions
- Critical
- Clearing conditions
- The situation clears when the condition becomes false.
- KQ9_Status_Fail_Warn situation
- Description
- This situation monitors the status of the virtual machines that play a specific role in the deployment and issues an alert when none of the virtual machines of that role are running.
- Formula
- *IF *VALUE KQ9_VIRTUAL_MACHINE_STATUS.RunningCount *EQ 0 *AND *VALUE KQ9_VIRTUAL_MACHINE_STATUS.LaunchingCount *GT 0
- Distribution
- This situation is available for distribution.
- Run at startup
- No
- Sampling interval
- 5 minutes
- Situation persistence
- The number of times the conditions of the situation must occur for the situation to be true is 1.
- Error conditions
- Warn
- Clearing conditions
- The situation clears when the condition becomes false.