FireScope Quick Start

Select Product

FireScope Attributes

 

Supported Attributes for the FireScope ALL Agent version


Attribute Operation Description Method Return Value
Agent Attribute Timeouts agent_attribute_timeoutsNumber of attribute process timeouts in the last 1 minute.AgentInteger
Agent Average Processing Time agent_avg_processing_timeAverage time spent processing attributes in the last 1 minute.  Useful for performance modeling agent configuration. AgentFloat
Agent Buffer Queue agent_stored_bufferNumber of attributes stored in the buffer, waiting to be sent to the FireScope ApplianceAgentInteger
Agent Check agent_checkQuick check of the availability of the agentAgentInteger
Agent Failed Attributes agent_failed_attributesNumber of agent-based attributes that are in a failed state.AgentInteger
Agent Invalid Attributes agent_invalid_attributesNumber of invalid attribute operations in the last 1 minute.  This means attributes that are either not supported by the host (such as checking for a non-existent drive letter) or the return value was outside of expected parameters.AgentInteger
Agent Memory Utilization agent_memory_utilMemory consumed by the FireScope agentAgentInteger
Agent Store and Forward Setting agent_store_and_fwdIdentifies if Agent Batch Mode enabled.  The batch mode feature enables the FireScope agent to store collected data and send to the parent FireScope appliance at pre-scheduled times in large batches.  Very useful for slow networks or WAN links.AgentInteger
Agent Successful Attributes agent_successful_attributesNumber of attributes currently successfully returning data.AgentInteger
Agent TCP Sessions agent_tcp_sessions(type)TCP Session information AgentInteger
Agent Thread Count agent_thread_countNumber of threads spawned by the FireScope AgentAgentInteger
Agent Version agent_current_versionReturns the version of the currently installed agentAgentString
Boot Time host_boottimeTime, in seconds, that the system was last started.AgentInteger
Check Web Page Contents webpage_regexpressionReturns the first match with a regular expression within the contents of a web pageFireScope ServerString
Checksum Check filesystem_checksumCalculates a specified file's checksumAgentInteger
Connected Users host_connected_usersNumber of users connected to a systemAgentInteger
CPU Interrupts cpu_interruptsNumber of Device interrupts. AgentInteger
CPU Load cpu_loadProcessor load averaged over 1 minute, or 15 minutes. Can be aggregate of all processors (default) or a specified processor.AgentFloat
CPU Switches cpu_switchesContext switchesAgentInteger
CPU Utilization agent_cpu_utilCPU utilization of running processes in percentage format, filtered by processor, time frame or process characteristicsAgentInteger
Disk Read Statistics filesystem_device_readReturns read statistics around a specified disk.AgentInteger
Disk Space filesystem_sizeDisk space measured in kilobytes. In case of a mounted volume, disk space for local file system is returned.AgentInteger
Disk Write Statistics filesystem_device_writeReturns statistics around write performance of a specified diskAgentInteger
DNS Name host_nameReturns the DNS name of the system.AgentString
File Checksum filesystem_checksum(file)Performs a checksum of a specified file.AgentInteger
File Existence Check filesystem_file_existsChecks to see if a specified file existsAgentInteger
File Size filesystem_filesizeReturn size of specified file. Value returned in bytes. File must have read permissions for user FireScope.AgentInteger
File Time filesystem_timeReturns the time, in seconds of a files last modified date, when it was last accessed or last time it was changed.AgentInteger
FireScope Stats firescope_dbReturns statistics about the configuration of this FireScope BSM instanceFireScope ServerInteger
Group Average grouped_averageCalculated average of an attribute across multiple Configuration ItemsFireScope ServerFloat
Group Average grouped_averageCalculated average of an attribute across multiple Configuration ItemsFireScope ServerFloat
Group Maximum grouped_maximumCalculated maximum value of an attribute across multiple Configuration ItemsFireScope ServerFloat
Group Minimum grouped_minimumCalculated Minimum within a group of CI's for a given AttributeFireScope ServerFloat
Group Sum grouped_sumCalculated Sum within a group of CI's for a given AttributeFireScope ServerFloat
Host Run host_runExecute a specified command on the Configuration Item and capture the output as an attribute.AgentString
Inode Count filesystem_inodeNumber of inodesAgentInteger
Local Time host_local_timeReturns the local time as determined by the operating system of the system running the agent. Returned in number of seconds.AgentInteger
Log Reader filesystem_logreaderWill read (or tail) a system logfile and return each line from the file as type log.AgentLog
MD5 Sum of File filesystem_file_md5sumMD5 hash of the file. Can be used only for files less than 64MB, unsupported otherwise.AgentString
Memory Size memory_sizeCan be used to evaluate multiple aspects of memory size, such as total, shared, cached, etc.AgentInteger
Network DNS Availability network_dns_availabilityChecks the availability of a DNS serviceFireScope ServerInteger
Network Interface Collisions network_interface_collisionReturns the total number of network collisions that have occurred.AgentInteger
Network Interface Incoming Statistics network_interface_incomingThis attribute provides access to a variety of statistics around incoming network traffic.AgentInteger
Network Interface Outgoing Statistics network_interface_outgoingMulti-purpose attribute for collecting specific statistics around outgoing traffic on a network interface.AgentInteger
Network Port Listen Status network_listenVerifies that the selected port is in a Listening stateFireScope ServerInteger
Network Response Time response_timeLatency between FireScope Appliance and host, measured in milliseconds.FireScope ServerInteger
Ping pingSimple ping check of status of Configuration ItemFireScope ServerInteger
Process Memory Consumption process_memoryTotal memory used by each process running under a given authenticated account.AgentInteger
Regex File Check filesystem_regexpressionChecks a specified file for a search string.AgentInteger
SNMP Trap snmptrapCollects messages forwarded to FireScope from SNMP devicesFireScope ServerLog
Swap Incoming Statistics swap_inStatistics around incoming data to a swap device.AgentInteger
Swap Outgoing Statistics swap_outStatistics around outgoing swap data for a specified swap device.AgentInteger
Swap Size swap_sizeSwap space of a specified swap deviceAgentInteger
Syslog syslogCollects messages being sent from syslog enabled devicesFireScope ServerLog
System Information host_informationReturns detailed information about the system running the agent.AgentString
TCP Port Check network_tcp_port_checkTests ability to open a TCP connection to a specified port on a remote machine. FireScope ServerInteger
TCP Service Check network_tcp_service_checkThis attribute will test if a network service is running and accepting connections.AgentInteger
TCP Service Performance network_performance_tcp_serviceEvaluates the number of seconds it takes to establish a TCP connection on a specified service.FireScope ServerInteger
Uptime host_uptimeTime in seconds that the system has been running.AgentInteger
VM Allocated Memory vm_guest_info_mem_overheadAmount of additional host memory allocated to the VMVirtual Center APIInteger
VM Datastore Metrics vm_host_fs(datastore, mode)Current storage metrics for a VM host.Virtual Center APIInteger
VM Guest Allocated Memory vm_guest_info_mem_overheadAmount of additional host memory allocated to the VMVirtual Center APIInteger
VM Guest Allocated Processors vm_guest_info_numprocsNumber of processors allocated to a Guest VM.Virtual Center APIInteger
VM Guest CPU Performance Counter vm_guest_cpu_perf (object, counter)Generic CPU performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the CPU Real-time Chart Options to see the list of available Objects and Counters. If omitted, the object id will default to the listed host or guest.Virtual Center APIString
VM Guest CPU Utilization vm_guest_cpu_utilCPU utilization for a guest:Virtual Center APIFloat
VM Guest Disk Aborts vm_guest_disk_aborts (File system device)Number of disk commands aborted in the last 20s periodVirtual Center APIInteger
VM Guest Disk Performance Counter vm_guest_disk_perf (object, counter)Generic Disk performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the Disk Real-time Chart Options to see the list of available Objects and Counters. If omitted, the object id will default to the listed host or guest:Virtual Center APIInteger
VM Guest Disk Resets vm_guest_disk_resets (File system device)Number of bus resets in the last 20s periodVirtual Center APIInteger
VM Guest Memory Balloon vm_guest_mem_balloonAmount of memory used by memory control:Virtual Center APIInteger
VM Guest Memory Information vm_guest_mem(mode)Current guest memory information:Virtual Center APIInteger
VM Guest Memory Performance Counter vm_guest_mem_perf (counter)Generic Memory performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the Memory Real-time Chart Options to see the list of available Counters.Virtual Center APIString
VM Guest Memory Used by Swap vm_guest_mem_swappedAmount of memory that is used by swap for a system component:Virtual Center APIInteger
VM Guest Network Performance Counter vm_guest_net_perf(object, counter)Generic Network performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the Network Real-time Chart Options to see the list of available Objects and Counters. If omitted, the object id will default to the listed host or guest.Virtual Center APIString
VM Guest Notes vm_guest_info_notesAnnotation notes entered in VMWare.Virtual Center APIString
VM Guest Operating System vm_guest_info_osOperating System running on a Guest VM.Virtual Center APIString
VM Guest State vm_guest_stateOperational status of VM. States can be powerOn, powerOff, reset, or suspended:Virtual Center APIString
VM Guest System Performance Counter vm_guest_sys_perf(object, counter)Generic System performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the System Real-time Chart Options to see the list of available Objects and Counters. If omitted, the object id will default to the listed host or guest.Virtual Center APIString
VM Guest VM Tools Status vm_guest_info_vmtoolsQueries status of VMWare Tools installed on a Guest VM.Virtual Center APIString
VM Host Available Memory vm_host_mem_availAvailable memory on a VM Host.Virtual Center APIInteger
VM Host Configured Guests vm_host_guests_configuredNumber of VMs configured on a host.Virtual Center APIInteger
VM Host CPU Performance Counter vm_host_cpu_perf (object, counter)Generic CPU performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the CPU Real-time Chart Options to see the list of available Objects and Counters. If omitted, the object id will default to the listed host or guest.Virtual Center APIString
VM Host CPU Utilization vm_host_cpu_util([cpu id])CPU utilization for entire host (no argument) or for a specific host CPU id.Virtual Center APIFloat
VM Host DataStore Percentage vm_host_fs_percent (datastore, mode)Current storage metrics for a VM Host, as a percentage of total.Virtual Center APIFloat
VM Host Disk Aborts vm_host_disk_aborts(file system device)Number of disk commands aborted in the period (20s)Virtual Center APIInteger
VM Host Disk Performance Counter vm_host_disk_perf (object, counter)Generic Disk performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the Disk Real-time Chart Options to see the list of available Objects and Counters. If omitted, the object id will default to the listed host or guest:Virtual Center APIString
VM Host Disk Resets vm_host_disk_resets(file system device)Number of bus resets in the period (20s)Virtual Center APIInteger
VM Host Guest CPU Usage vm_host_guests_cpu_usageCPU percent utilized by the all guests of the host.Virtual Center APIFloat
VM Host Information vm_guest_info_hostName of the host that the guest belongs toVirtual Center APIString
VM Host Management Agent Performance Counter vm_host_mgt_agent_perf (counter)Generic Management Agent performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the Management Agent Real-time Chart Options to see the list of available Counters. Virtual Center APIString
VM Host Memory Control Utilization vm_host_mem_balloonAmount of memory used by memory control:Virtual Center APIInteger
VM Host Memory Performance Counter vm_host_mem_perf (counter)Generic Memory performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the Memory Real-time Chart Options to see the list of available Counters.Virtual Center APIString
VM Host Memory Statistics vm_host_mem(mode)Memory statistics for a VM Host.Virtual Center APIInteger
VM Host Network Performance Counter vm_host_net_perf(object, counter)Generic Network performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the Network Real-time Chart Options to see the list of available Objects and Counters. If omitted, the object id will default to the listed host or guest.Virtual Center APIString
VM Host Running Guests vm_host_guests_runningNumber of VMs currently running on a host.Virtual Center APIInteger
VM Host State vm_host_stateConnection state of a VM Host, or whether or not FireScope can connect with this host.Virtual Center APIString
VM Host System Performance Counter vm_host_sys_perf(object, counter)Generic System performance key. Refer to the “Customize Performance Chart” window of the VMware Infrastructure Client and select the System Real-time Chart Options to see the list of available Objects and Counters. If omitted, the object id will default to the listed host or guest.Virtual Center APIString
VM Host VMWare Version vm_host_versionReturns version of VMWare software installed on VM Host.Virtual Center APIString
VM Virtual Center Configured Guests vm_vc_guests_configuredNumber of Guest VM's configured on a Virtual Center.Virtual Center APIInteger
VM Virtual Center Connection Status vm_vc_pingCan FireScope connect to this Virtual Center.Virtual Center APIInteger
VM Virtual Center Disk Percentage vm_vc_host_fs_percent(mode, aggregate function)Aggregates the percentage of disk space stats (compared to total disk space) across all hosts.Virtual Center APIFloat
VM Virtual Center Disk Space Statistics vm_vc_host_fs(mode, aggregate function)Aggregates the disk space stats across all hostsVirtual Center APIFloat
VM Virtual Center Host Aggregate Performance Counter vm_vc_host_perf(group, counter, group function, history function, history period, history table, object function)Aggregates the current value of a specific performance counter across all hosts in a Virtual Center.Virtual Center APIString
VM Virtual Center Memory Statistics vm_vc_host_mem(mode, aggregate function)Aggregates the memory stats across all hosts.Virtual Center APIFloat
VM Virtual Center Running Guests vm_vc_guests_runningNumber of Guest VMs currently running on a Virtual Center.Virtual Center APIInteger
VM Virtual Center Version vm_vc_versionVersion of VMWare Virtual Center running on this Configuration Item.Virtual Center APIString
Web Page Contents webpage_getStores the contents of a web page. This is automatically generated by the User Experience Checker feature.FireScope ServerString
Web Page Download Speed webcheck_speedDownload speed, in bps, of a specified web page. Automatically generated by User Experience Checker feature.FireScope ServerInteger
Web Page Performance webpage_performanceCalculates the time in seconds it takes to download a web pageFireScope ServerInteger
Windows Event Viewer windows_eventvwrCaptures events from Windows Event Logs.AgentLog
Windows Perfmon windows_perfmonReturns the value of a perfmon metric. Recommend using Typeperf command on system to get the path of the metric.AgentFloat
Windows Process Statistics windows_processStatistics about a specified running process on a windows machine.AgentInteger
Windows Service Status windows_service_statusReturns the status of a Windows Service.AgentInteger