Power Inspectors

These Inspectors return information about the energy usage patterns of BigFix Clients and their attached monitors.

power level

The <power level> Inspectors provide exposure to the underlying batter and power information used by low-power modes. On Windows, this uses the GetSystemPowerStatus system call, and on OSX, it uses the IOPSCopyPowerSourcesList functionality.

Creation Methods

Declaration	Description	Available on platforms
power level	Returns a power level representing the underlying state of the battery or charging system. Example: power level - Returns the current power level, which might be something like "full battery power plugged in".	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Properties

Declaration	Return type	Description	Available on Platforms
<power level> as string	<string>	Converts a power level into a human-readable string.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
full of <power level>	<boolean> Plural: fulls	Returns TRUE if the battery is fully charged.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
low of <power level>	<boolean> Plural: lows	Returns TRUE if the battery is at a low charge level.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
normal of <power level>	<boolean> Plural: normals	Returns TRUE if the battery is at a normal charge level.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
plugged of <power level>	<boolean> Plural: pluggeds	Returns TRUE if the computer is currently plugged in to AC power.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ups of <power level>	<boolean> Plural: upss	Returns TRUE if the computer is currently being powered by a UPS.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

power state

The <power state> Inspectors return the state of a device, encapsulating the enumerated types used by the Client. There are two categories, system and monitor. System (computer) states include active, idle, logged off, standby, off and invalid. Monitor (display) states include on, off and invalid.

Creation Methods

Declaration	Description	Available on platforms
active state	Returns a power state constant signifying that the client system is active.	Win:8.0, Mac:8.1
idle state	Returns a power state constant signifying that the client system is idle.	Win:8.0, Mac:8.1
invalid state	Returns a power state constant signifying that the client system is invalid.	Win:8.0, Mac:8.1
logged off state	Returns a power state constant signifying that the client system is logged off.	Win:8.0, Mac:8.1
monitor invalid state	Returns a power state constant signifying that the attached computer monitor state is invalid.	Win:8.0, Mac:8.1
monitor off state	Returns a power state constant signifying that the attached computer monitor is off.	Win:8.0, Mac:8.1
monitor on state	Returns a power state constant signifying that the attached computer monitor is on.	Win:8.0, Mac:8.1
monitor standby state	Returns a power state constant signifying that the attached computer monitor is in a standby state.	Win:8.0, Mac:8.1
off state	Returns a power state constant signifying that the client system is off.	Win:8.0, Mac:8.1
standby state	Returns the power state corresponding to standby.	Win:8.0, Mac:8.1
state of <system power interval>	Returns the power state associated with the specified system power interval.	Win:8.0, Mac:8.1
state of <monitor power interval>	Returns the state of the specified 'monitor power' interval. This state is one of the following:onoffinvalid.	Win:8.0, Mac:8.1

Operators

Declaration	Return Type	Description	Available on Platforms
<power state> = <power state>	<boolean>	Returns TRUE if the two provided power states are equal.	Win:8.0, Mac:8.1

Properties

Declaration	Return type	Description	Available on Platforms
<power state> as string	<string>	Casts a power state as a string type.	Win:8.0, Mac:8.1

power history

The <power history> Inspectors retrieve information about your client computers and their displays within a tracking window (defaulting to 14 days). The information is in the form of a list of <interval, state> tuples for the system (computer) and <interval, state, monitor count> for monitors (attached displays). The first element of the list is the current state of the system. These Inspectors allow you to track computer usage for power management applications. The event lists are fetched from the client whenever 'power history' is referenced, and referencing 'system intervals of <power history>' simply iterates over the built list of intervals. Avoid referencing 'power history' multiple times in relevance as it rebuilds the list each time (increasing overhead) and may introduce inconsistency if the window slides between references.

Creation Methods

Declaration	Description	Available on platforms
power history	Returns the power history of the client computer. This points to historical information (the default is 14 days) about the power usage of the client computer and its attached monitor. Example: state of current system interval of power history - Returns the current machine state.	Win:8.0, Mac:8.1

Properties

Declaration	Return type	Description	Available on Platforms
current monitor interval of <power history>	<monitor power interval> Plural: current monitor intervals	Returns a monitor power interval reflecting how long the monitor has been turned on for the specified power history.	Win:8.0, Mac:8.1
current system interval of <power history>	<system power interval> Plural: current system intervals	Returns the most recent interval of the system intervals list.	Win:8.0, Mac:8.1
last monitor interval in <power state> of <power history>	<monitor power interval> Plural: last monitor intervals in	Returns the last time interval for the display monitor as logged in the power history. You must specify the power state you are interested in (either monitor on or monitor off).	Win:8.1, Mac:8.1
last monitor interval in monitor off state of <power history>	<monitor power interval> Plural: last monitor intervals in monitor off state	Returns the last time interval during which the display monitor was OFF from the specified power history.	Win:8.1, Mac:8.1
last monitor interval in monitor on state of <power history>	<monitor power interval> Plural: last monitor intervals in monitor on state	Returns the last time interval during which the display monitor was ON from the specified power history.	Win:8.1, Mac:8.1
last system interval in <power state> of <power history>	<system power interval> Plural: last system intervals in	Returns the power interval corresponding to the last time the computer system was in the specified power state (active, idle, logged off, off, standby) as logged in the power history.	Win:8.1, Mac:8.1
last system interval in active state of <power history>	<system power interval> Plural: last system intervals in active state	Returns the interval corresponding to the last active state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
last system interval in idle state of <power history>	<system power interval> Plural: last system intervals in idle state	Returns the interval corresponding to the last idle state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
last system interval in logged off state of <power history>	<system power interval> Plural: last system intervals in logged off state	Returns the interval corresponding to the last logged off state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
last system interval in off state of <power history>	<system power interval> Plural: last system intervals in off state	Returns the interval corresponding to the last off state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
last system interval in standby state of <power history>	<system power interval> Plural: last system intervals in standby state	Returns the interval corresponding to the last standby state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
monitor interval of <power history>	<monitor power interval> Plural: monitor intervals	Returns the interval corresponding to the 'monitor power' entry in the specified power history.	Win:8.0, Mac:8.1
system interval of <power history>	<system power interval> Plural: system intervals	Returns a list of computer states and their start and end times ( for example the computer was idle from Wed, 15 Sep 2010 12:30:00 -0700 to Wed, 15 Sep 2010 18:22:00 -0700, which is an interval of 5:52:00 ).	Win:8.0, Mac:8.1

system power interval

The <system power interval> Inspectors return an interval or a list of intervals that contain information about the client computer. Each system interval is composed of a time range and a power state, which can include on, off, standby or hibernate.

Creation Methods

Declaration	Description	Available on platforms
user interval of <activity history>	Returns a power interval (containing a time range and a power state, such as standby or idle) corresponding to the specified user activity history.	Win:8.0
current system interval of <power history>	Returns the most recent interval of the system intervals list.	Win:8.0, Mac:8.1
last system interval in <power state> of <power history>	Returns the power interval corresponding to the last time the computer system was in the specified power state (active, idle, logged off, off, standby) as logged in the power history.	Win:8.1, Mac:8.1
last system interval in active state of <power history>	Returns the interval corresponding to the last active state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
last system interval in idle state of <power history>	Returns the interval corresponding to the last idle state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
last system interval in logged off state of <power history>	Returns the interval corresponding to the last logged off state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
last system interval in off state of <power history>	Returns the interval corresponding to the last off state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
last system interval in standby state of <power history>	Returns the interval corresponding to the last standby state of the computer system, as logged in the given power history.	Win:8.1, Mac:8.1
system interval of <power history>	Returns a list of computer states and their start and end times ( for example the computer was idle from Wed, 15 Sep 2010 12:30:00 -0700 to Wed, 15 Sep 2010 18:22:00 -0700, which is an interval of 5:52:00 ). Example: (state of it, start of range of it, end of range of it, length of range of it) of system intervals of power history - Returns a list of computer states as well as their start times, end times and elapsed times.	Win:8.0, Mac:8.1

Properties

Declaration	Return type	Description	Available on Platforms
range of <system power interval>	<time range> Plural: ranges	Returns the time range associated with the specified 'system power' interval. This will provide you with the start and stop time for any particular state of the BES Client system.	Win:8.0, Mac:8.1
state of <system power interval>	<power state> Plural: states	Returns the power state associated with the specified system power interval.	Win:8.0, Mac:8.1

monitor power interval

The <monitor power interval> Inspectors return information about the monitors (displays) attached to a given computer. Each computer can have multiple monitors, and they can be either on or off. This information can be used in a power-usage study. Monitor intervals are retrieved as tuples in the form of <interval, state, monitor count>, where the interval contains the start and end time, the state (on or off) and the number of monitors that are attached to the computer.

Creation Methods

Declaration	Description	Available on platforms
current monitor interval of <power history>	Returns a monitor power interval reflecting how long the monitor has been turned on for the specified power history.	Win:8.0, Mac:8.1
last monitor interval in <power state> of <power history>	Returns the last time interval for the display monitor as logged in the power history. You must specify the power state you are interested in (either monitor on or monitor off).	Win:8.1, Mac:8.1
last monitor interval in monitor off state of <power history>	Returns the last time interval during which the display monitor was OFF from the specified power history.	Win:8.1, Mac:8.1
last monitor interval in monitor on state of <power history>	Returns the last time interval during which the display monitor was ON from the specified power history.	Win:8.1, Mac:8.1
monitor interval of <power history>	Returns the interval corresponding to the 'monitor power' entry in the specified power history.	Win:8.0, Mac:8.1

Properties

Declaration	Return type	Description	Available on Platforms
count of <monitor power interval>	<integer> Plural: counts	Returns the number of 'monitor power' intervals currently logged.	Win:8.0, Mac:8.1
range of <monitor power interval>	<time range> Plural: ranges	Returns the time range associated with the specified 'monitor power' interval. This will provide you with the start and stop time for any particular monitor (display) state.	Win:8.0, Mac:8.1
state of <monitor power interval>	<power state> Plural: states	Returns the state of the specified 'monitor power' interval. This state is one of the following:onoffinvalid.	Win:8.0, Mac:8.1

Platform

Contents