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

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.

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.

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 a file object corresponding to the specified <service>.

Plural: files

Version	Platforms
8.0.584.0	Windows

permalink source

image path of <service> : string

Returns the full path to the service executable.

Plural: image paths

Version	Platforms
8.0.584.0	Windows

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

No documentation exists.

Plural: pids

Version	Platforms
9.1.1065.0	Windows

permalink source

runlevel of <service> : string

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

Note: On RedHat 7, this also lists the targets of systemd services.

Q: (it as string, runlevels of it) of services whose (it as string contains "ssh")
A: "sshd.service" "sshd" "Stopped", multi-user.target

Plural: runlevels

Version	Platforms
9.2.0.363	Red Hat, SUSE

permalink source

running of <service> : boolean

No documentation exists.

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.

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

version of <service> : version

This inspector takes the specified service property and retrieves its version (file version).

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