service

The <service> inspectors provide access to all services configured on supported operating systems. Using an inspector for which there is no service results in an error referring to a nonexistent object.

Q: relay service
E: Singular expression refers to nonexistent object.

To avoid errors, check if the service exists before trying to use its inspector.

Q: exists relay service
A: False

Creation
Properties
Casts

Version	Platforms
8.0.584.0	AIX, HP-UX, Red Hat, SUSE, Solaris, Windows
8.1.535.0	Debian, Ubuntu
9.5.13.130	Raspbian

Creation

all running service : service

Returns a list of all running Windows 32 services, such as ATAPI and BESRelay.

Plural: all running services

Version	Platforms
8.1.535.0	Windows

permalink source

all service : service

Returns a list of all Windows 32 services, including the BESRelay.

Plural: all services

Version	Platforms
8.1.535.0	Windows

permalink source

driver running service : service

Returns a list of all running Windows 32 system drivers.

Plural: driver running services

Version	Platforms
8.1.535.0	Windows

permalink source

driver service : service

Returns a list of all Windows 32 system drivers.

Plural: driver services

Version	Platforms
8.1.535.0	Windows

permalink source

explorer service : service

Returns a service object for the 'BESExplorer' service, if available on the local system.

Plural: explorer services

Version	Platforms
11.0.2.0	AIX, Debian, Raspbian, Red Hat, SUSE, Solaris, Ubuntu, Windows

permalink source

main gather service : service

Returns a service object for the main gathering service, typically located on the main server.Note: On a Macintosh, returns <nothing>. Included for compatibility.

Plural: main gather services

Version	Platforms
8.0.584.0	AIX, HP-UX, Red Hat, SUSE, Solaris, Windows
8.1.535.0	Debian, Ubuntu
9.5.13.130	Raspbian

permalink source

plugin portal service : service

Returns a service object for the 'BESPluginPortal' service, if available on the local system.

Plural: plugin portal services

Version	Platforms
10.0.0.133	AIX, Debian, Raspbian, Red Hat, SUSE, Solaris, Ubuntu, Windows

permalink source

proxy agent service : service

Returns a service object of the BESProxyAgent if one is present.

Plural: proxy agent services

Version	Platforms
9.0.586.0	AIX, Debian, HP-UX, Red Hat, SUSE, Solaris, Ubuntu, Windows
9.5.13.130	Raspbian

permalink source

relay service : service

Returns a service object for the relay component of BES. Note: On a Macintosh, this returns <nothing>.

Plural: relay services

Version	Platforms
8.0.584.0	AIX, HP-UX, Red Hat, SUSE, Solaris, Windows
8.1.535.0	Debian, Ubuntu
9.5.13.130	Raspbian

permalink source

running service : service

Returns all the running service objects.

Plural: running services

Version	Platforms
8.0.584.0	Windows

permalink source

running service <string> : service

Returns the running service object matching the name provided. The service name must be passed between double quotes (e.g. "BESClient"). On Debian, Raspbian, Ubuntu, AIX, HP-UX and Solaris, the inspector only works for BigFix services. The BigFix service names are: BESClient, BESExplorer, BESFillDB, BESGatherDB, BESPluginPortal, BESRelay, BESRootServer, BESWebReportsServer and BESWebUI.

Plural: running services

Version	Platforms
8.0.584.0	AIX, HP-UX, Red Hat, SUSE, Solaris, Windows
8.1.535.0	Debian, Ubuntu
9.5.13.130	Raspbian

permalink source

service : service

Returns all the service objects.

Plural: services

Version	Platforms
8.0.584.0	Windows
9.2.0.363	Red Hat, SUSE

permalink source

service <string> : service

Returns the service object matching the name provided, regardless of its running state.On a Macintosh, returns a <dummy> type. The service name must be passed between double quotes (e.g. "BESClient"). On Debian, Raspbian, Ubuntu, AIX, HP-UX and Solaris, the inspector only works for BigFix services. The BigFix service names are: BESClient, BESExplorer, BESFillDB, BESGatherDB, BESPluginPortal, BESRelay, BESRootServer, BESWebReportsServer and BESWebUI.

Plural: services

Version	Platforms
8.0.584.0	AIX, HP-UX, Red Hat, SUSE, Solaris, Windows
8.1.535.0	Debian, Ubuntu
9.5.13.130	Raspbian

permalink source

webui service : service

Returns a service object for the 'BESWebUI' service, if available on the local system.

Plural: webui services

Version	Platforms
9.5.3.211	AIX, Debian, Red Hat, SUSE, Solaris, Ubuntu, Windows
9.5.13.130	Raspbian

permalink source

win32 running service : service

A synonym for 'running service'. This can be any running service from atapi to the BESRelay.

Plural: win32 running services

Version	Platforms
8.1.535.0	Windows

permalink source

win32 service : service

A synonym for 'service'. This can be anything from atapi to the BESRelay.

Plural: win32 services

Version	Platforms
8.1.535.0	Windows

permalink source

Properties

can interact with desktop of <service> : boolean

Indicates the system is configured to allow the service to interact with the desktop.

Plural: can interact with desktops

Version	Platforms
8.0.584.0	Windows

permalink source

checkpoint of <service> : integer

Service specific value indicating its checkpoint state.

Plural: checkpoints

Version	Platforms
8.0.584.0	Windows

permalink source

display name of <service> : string

Returns the display name of the service.

Plural: display names

Version	Platforms
8.0.584.0	Windows

permalink source

driver type of <service> : boolean

Returns True if the specified service is a driver type.

Plural: driver types

Version	Platforms
8.1.535.0	Windows

permalink source

file of <service> : file

Returns the file object that corresponds to the executable of the specified <service>.

Note: On Debian, Raspbian, Ubuntu, AIX and Solaris, this inspector only works for BigFix services.

Example running the QnA on a Windows computer.

Q: file of service "BESRootServer"
A: "BESRootServer.exe" "99.99.5.878" "Server component of BigFix" "99.99.5.878" "HCL Technologies Limited"

Example running the QnA on a Linux computer.

Q: file of service "BESClient"
A: /opt/BESClient/bin/BESClient

Plural: files

Version	Platforms
8.0.584.0	Windows
11.0.5.0	Red Hat, SUSE

permalink source

image path of <service> : string

Returns the full file system path to the executable image associated with the specified <service>.

Note: On Debian, Raspbian, Ubuntu, AIX and Solaris, this inspector only works for BigFix services.

Example running the QnA on a Windows computer.

Q: image path of service "BESRootServer"
A: "C:\Program Files (x86)\BigFix Enterprise\BES Server\BESRootServer.exe"

Example running the QnA on a Linux computer.

Q: image path of service "BESClient"
A: /opt/BESClient/bin/BESClient

Plural: image paths

Version	Platforms
8.0.584.0	Windows
11.0.5.0	Red Hat, SUSE

permalink source

Returns the login account under which the service is configured to run.

Plural: login accounts

Version	Platforms
8.0.584.0	Windows

permalink source

pid of <service> : integer

Returns the process ID(s) of the active service.

Note: On Red Hat and SUSE, this property applies to services managed by systemd.

Q: pid of service "sshd"
A: 1104

Q: pid of service "EventLog"
A: 1208

Plural: pids

Version	Platforms
9.1.1065.0	Windows
11.0.5.0	Red Hat, SUSE

permalink source

runlevel of <service> : string

Returns the list of runlevels for which the service is active.

Note: For Systemd services, use the target property.

Q: runlevels of service "network"
A: 2
A: 3
A: 4
A: 5

Plural: runlevels

Version	Platforms
9.2.0.363	Red Hat, SUSE

permalink source

running of <service> : boolean

The service name must be passed between double quotes (e.g. "BESClient"). On Debian, Raspbian, Ubuntu, AIX, HP-UX and Solaris, the inspector only works for BigFix services. The BigFix service names are: BESClient, BESExplorer, BESFillDB, BESGatherDB, BESPluginPortal, BESRelay, BESRootServer, BESWebReportsServer and BESWebUI.

Plural: runnings

Version	Platforms
8.2.1078.0	AIX, Debian, HP-UX, Red Hat, SUSE, Solaris, Ubuntu, Windows
9.5.13.130	Raspbian

permalink source

security descriptor of <service> : security descriptor

This Windows-specific inspector returns a security descriptor for the specified service.

Plural: security descriptors

Version	Platforms
8.0.584.0	Windows

permalink source

service name of <service> : string

Returns the name of the service.

Plural: service names

Version	Platforms
8.0.584.0	Windows

permalink source

service specific exit code of <service> : integer

Service specific exit code.

Plural: service specific exit codes

Version	Platforms
8.0.584.0	Windows

permalink source

start type of <service> : string

Returns a string that represents the service startup configuration. It describes when the driver is loaded, which can be one of:boot: started by OS loader (usually these are needed to launch the OS).system: started during OS initialization (used by PnP drivers that do device detection after the loader is finished).auto: started by the Service Control Manager (SCM).demand: started on demand, either by PnP manager when a device is enumerated or by the SCM in response to user demand.disabled: can't be started (used to temporarily disable driver services).

Plural: start types

Version	Platforms
8.0.584.0	Windows

permalink source

state of <service> : string

Returns one of Continuing, Pausing, Paused, Running, Starting, Stopping, Stopped, Unknown. The service name must be passed between double quotes (e.g. "BESClient"). On Debian, Raspbian, Ubuntu, AIX, HP-UX and Solaris, the inspector only works for BigFix services. The BigFix service names are: BESClient, BESExplorer, BESFillDB, BESGatherDB, BESPluginPortal, BESRelay, BESRootServer, BESWebReportsServer and BESWebUI.

Plural: states

Version	Platforms
8.0.584.0	AIX, HP-UX, Red Hat, SUSE, Solaris, Windows
8.1.535.0	Debian, Ubuntu
9.5.13.130	Raspbian

permalink source

target of <service> : string

Returns all the targets list of systemd services. Note: For SystemV services, use the runlevel property.

Q: target of service "postfix"
A: multi-user.target

Plural: targets

Version	Platforms
11.0.4.0	Red Hat, SUSE

permalink source

version of <service> : version

This inspector takes the specified service property and retrieves its version (file version). The service name must be passed between double quotes (e.g. "BESClient"). On Debian, Raspbian, Ubuntu, AIX, HP-UX and Solaris, the inspector only works for BigFix services. The BigFix service names are: BESClient, BESExplorer, BESFillDB, BESGatherDB, BESPluginPortal, BESRelay, BESRootServer, BESWebReportsServer and BESWebUI.

Plural: versions

Version	Platforms
8.0.584.0	AIX, HP-UX, Red Hat, SUSE, Solaris, Windows
8.1.535.0	Debian, Ubuntu
9.5.13.130	Raspbian

permalink source

win32 exit code of <service> : integer

Service specific Win32 exit code.

Plural: win32 exit codes

Version	Platforms
8.0.584.0	Windows

permalink source

win32 type of <service> : boolean

Returns True if the specified service is a Win32 type.

Plural: win32 types

Version	Platforms
8.1.535.0	Windows

permalink source

Casts

<service> as string : string

Returns a string containing the Service name, Display name, and State of the service.

Version	Platforms
8.0.584.0	Windows
8.2.1078.0	AIX, Debian, HP-UX, Red Hat, SUSE, Solaris, Ubuntu
9.5.13.130	Raspbian

permalink source