Internal Name:

JBossAS7 Host Controller

Description:

Domain controller (delegate) for this host

Singleton:

no

Plugin:

JBossAS7

HostController

process|basename|match=^java.*,arg|org.jboss.as.host-controller|match=.*

Start Script Path

The path to the script that the Start and Restart operations should use to start the server. If the path is
not absolute, it is resolved relative to the server home directory
(e.g. "bin/standalone.sh", "bin/domain.sh").

no

startScript

Start Script Prefix

A prefix command line that should be prepended to the start script command line by the Start and Restart
operations; the prefix command must be an absolute path (e.g. "/usr/bin/sudo"). This property is
most commonly used to run the AS7 process as a different user than the RHQ Agent (e.g. "sudo -u jboss
-g jboss" could be used to run AS7 as user "jboss" and group "jboss". It is also
possible to chain prefix commands (e.g. "nohup sudo -u jboss" could be used to make AS7 ignore HUP
signals and to run as user "jboss").

no

startScriptPrefix

Start Script Environment Variables

The variables that the Start and Restart operations will add to the environment of the server start script.
Each name=value pair should be on a new line. Variable values should *not* be enclosed in quotes (e.g.
"JAVA_HOME=/usr/java/jdk1.6.0_30"). On UNIX systems, the typical minimum set of environment variables is:
PATH=/usr/bin:/bin . And on Windows the typical minimum set is: PATH=C:\Windows\System32;C:\Windows ,
OS=Windows_NT , SYSTEMROOT=C:\Windows . In addition, it is good practice to set JAVA_HOME to the absolute
path of the install directory of the JRE or JDK you wish to use to run the AS7 instance. However, if
JAVA_HOME is not specified, the start script will attempt to find java in the PATH.

no

startScriptEnv

Start Script Arguments

The arguments that the Start and Restart operations will pass to the server
start script. Each argument should be on a new line - for example: --server-config=standalone-ha-full.xml.
As an exception, the value of a space-delimited option can optionally be on the same line as the option -
for example: -c standalone-ha-full.xml.

no

startScriptArgs

Log Event Sources

yes

logEventSources

Hostname

Host name of the domain API

yes

hostname

Port

Port of the domain API

yes

port

User

Management user for a secured Host controller

no

user

Password

Password for the management user

no

password

Home Directory

Root directory of the server installation

no

homeDir

Base Directory

Base directory for server content

no

baseDir

Configuration Directory

Base configuration directory

no

configDir

Log Directory

the directory where log files will be written for this host controller

no

logDir

Domain Host

Host name within the AS7 domain

no

domainHost

Product Type

Server product type (e.g. AS or EAP)

no

productType

Number of management requests

measurement

Number of requests sent to the controller

_internal:mgmtRequests

Number of management requests per Minute

measurement

Number of requests sent to the controller

_internal:mgmtRequests

Time used for management requests

measurement

Total time for requests

_internal:requestTime

Time used for management requests per Minute

measurement

Total time for requests

_internal:requestTime

Maximum request time

measurement

Max time for a request since last metric get

_internal:maxTime

Server Code Name

trait

Server Code Name

_skm:release-codename

Server Version

trait

Server Version

_skm:release-version

Product Name

trait

Product Name

_skm:product-name

Product Version

trait

Product Version

_skm:product-version

Start time of the server

trait

Start time of the server

startTime

Domain Config File

trait

The name of the domain configuration file this host controller is using

domain-config-file

Host Config File

trait

The name of the host configuration file this host controller is using

host-config-file

Properties

no

*2

Path

The standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances

no

*3

Installed extensions

no

*

Start this host controller

Start this Host/Domain Controller with all its enabled managed servers

Shut down this host controller

Stop this Host/Domain Controller with all its managed servers

Restart this host controller

Restart this Host/Domain Controller with all its running managed servers

Install a management user

Installs a user in the server for management