Part II. API Reference

Table of Contents

I. Application Programmer Interfaces (APIs)

pme.api.pmdctl — Primary interface for the Power Manager Engine.

II. Build

build.version — Engine's release version.

build.revision — Engine's revision number.

build.restart — Restart the engine and associated processes.

III. Client

client.computername — Computer's name.

client.localhostname — Computer's local host name.

client.ethernetaddress — Primary ethernet address.

client.ethernetaddresses — All ethernet addresses.

client.machinemodel — Machine's model type.

IV. Event Store

eventstore.events — Available events that can be triggered or performed.

eventstore.store — Store zero or more events.

eventstore.remove — Remove an event.

eventstore.history — Event history.

V. Legal

legal.licence — Engine's licence details.

legal.license — Set the licence details.

legal.revoke — Remove all licence information.

VI. Listen

listen.sockets — Sockets the engine accepts incoming connections on.

listen.applysocket — Set a socket to listen for incoming connections on.

listen.removesocket — Remove a socket.

VII. Log

log.recent — Audit log tail.

log.filterlevel — Filtering out log messages with levels lower than this.

log.setfilterlevel — Set the filter level for new log messages.

VIII. Notifications

notifications.current — Notifying date and time based triggers with events.

notifications.warning — Warnings of host affecting actions.

notifications.warningperiod — Seconds to display warnings.

notifications.notifyperiod — Seconds to display notifications.

notifications.setwarningperiod — Set the seconds to display warnings.

notifications.setnotifyperiod — Sets seconds before an Event the user is notified.

IX. On Demand

ondemand.available — Available on demand events.

ondemand.perform — Perform an event's actions.

X. Power

power.sources — Known sources of power.

XI. Scheduler

scheduler.enabled — Can events be triggered.

scheduler.pending — Date and time based triggers with events.

scheduler.active — Active events.

scheduler.assistants — Local assistant signatures.

scheduler.setenabled — Set the Scheduler's enabled state.

scheduler.cancel — Cancel a pending queued trigger.

scheduler.adjust — Adjust a pending trigger date.

scheduler.reset — Reset a pending trigger.

XII. Time Zone

timezone.name — name

timezone.utcoffset — UTC offset in seconds

XIII. Structures

SSL — A description of a SSL configuration.

action — Task to perform.

action sleep — Put the computer to sleep.

action shut down — Shut down the computer.

action restart — Restart the computer.

action log out — Log out all users.

action fast user switch — Switch to the Login Window.

action notification — Post a notification.

action await notification — Wait for a notification.

action await relative date — Wait for a period of time.

action execute external — Execute an external process.

action launch application — Launch an application.

action warn — Warn users of imminent host affecting action.

action await power on — Wait for the computer to power on.

action await sample — Wait for a sample to conclude.

active event — Active event instance.

application description — Description for launching an external process.

assistant — Assistant details.

condition — Description of a testable condition that resolves to a boolean.

condition boolean — A constant condition.

condition delayed boolean — A delayed constant condition.

condition days — Conditional on the day of the week.

condition date range — Conditional on the date falling within a specific period.

condition time range — Conditional on the time now falling within a specific period.

condition execute external — Conditional on the external executable's exit status.

condition sample — Conditional on a sample's successful conclusion.

condition running processes — Conditional on whether specific processes are running.

condition power assertions — Conditional on whether other processes have power assertions set.

condition power state — Conditional on the computer's power source state.

condition battery health — Conditional on the battery health.

condition power remaining — Conditional on the power remaining.

criteria — Group of conditions to test.

event — Event containing triggers to observe, conditions to test, and actions to perform.

event history — Event history.

external — Description for executing an external process.

external executable — Execute the external executable.

external inline — Execute the inline content.

external criterion — Criterion for judging an external executable sample.

external criterion interpret — Interpret the output as a number.

external criterion contains — Output contains a value.

licence — Licence details for this Power Manager Engine.

log message

power source — A power source.

power source serial — Power source connected via a serial cable.

power source USB — Power source connected via a USB cable.

power source network — Power source connected via a network connection.

power source internal — Internal power source such as a fitted or removable battery.

power source unknown — Unknown power source.

power source filter — A profile for filtering power source changes.

process signature — Process signature provides a robust means of identifying a running process.

process signature bundle identifier — Match a process's bundle identifier.

process signature name — Match a process's bundle or executable name.

process signature localised name — Match a process's localised name.

queued trigger — Queued trigger instance.

queued warning — Host wide warning.

resource limits — Constraints for external processes.

sample — Description for sampling.

sample execute external — Sample from an external executable.

sample criterion — Criterion for concluding a sample.

sample criterion equal — Judge the samples looking for a positive match.

sample criterion not equal — Judge the samples looking for a negative match.

socket — A description of a TCP/IP socket.

trigger — Description of an external event or potential change in state to watch.

trigger once — Trigger once on a given time and date.

trigger daily — Trigger at a given time on given days of the week.

trigger after inactivity — Trigger after a given period of user inactivity.

trigger notification — Trigger on receiving a notification.

trigger power on — Trigger when the computer powers on.

trigger start up — Trigger when the computer starts up.

trigger log in — Trigger when a user logs in.

trigger log out — Trigger when a user logs out.

trigger sample — Trigger when a sample successfully concludes.

trigger power state — Trigger when the source of power changes.

trigger power remaining — Trigger when the power remaining changes.

trigger battery health — Trigger when a power source's battery health changes.

XIV. Elements

SSL allowances — SSL allow.

SSL level — SSL level.

action type — Types of action.

application behaviour — Application launch behaviours.

application visibility — Application visibility.

behaviour — Event wide behaviours.

comparison — Value comparison methods.

comparison option — Comparison options.

condition type — Types of condition.

day — Days of the week.

days — Days of the week. Any combination of unique days.

delay by seconds — Seconds to delay by.

drift — Acceptable date and time drift.

encoding — Encoding formats.

event activity — Active event state.

external continues — When to continue performing remaining actions.

external criterion type — Types of external criterion.

external files — Special case external files.

external type — Types of externals.

external user types — Types of special case users.

image — Built-in image identifiers.

licence state — Available licence states.

message level — Levels of log messages.

notification — Notification.

numeric comparison — Numeric value comparison methods.

port — TCP/IP port.

power — Power event.

power confidence — The power source confidence.

power health — The power source health.

power source capacity — Power source capacity.

power source type — The power source type.

power state — The power source state.

process signature type — Types of process signature.

protocol family — Supported network protocols.

quiet — Minimise notifications.

requires — How many must resolve to true.

sample criterion type — Types of sample criterion.

scatter — Seconds, plus and minus, to scatter a date and time by.

scope — Scope of notification.

socket options — Socket options.

socket state — Socket states.

source type — Types of sample sources.

time out — Duration after which a silent connection is disconnected.

trigger type — Types of trigger.

unique ID — Unique identifier (ID).

value — Value to compare against.