Configuring in a BMC PATROL environment

This section provides information about configuring BMC PATROL for JBoss Application Server in PATROL environment.

You must provide configuration information that defines your JBoss Server environment to the PATROL monitoring environment. This information includes the host name, connection details, collection details, script details, and an administrator account name and password that PATROL can use to perform system management operations. This process is referred to as registering a server.

Registering JBoss environment 

BMC PATROL for JBoss Application Server now provides a single way for JBoss Application Server monitoring configuration. 

Before you begin

  • You must have installed and loaded PATROL for JBoss Application Server.
  • The operating system user account must have read and execute permissions for the JBoss home directory, execute permissions for the Java home directory, and full access to the ../Patrol3/PJB directory. BMC PATROL for JBoss Application Server supports RMI authentication for JBoss 5.1 and JSR-160 authentication for JBoss 6.

Follow these steps to configure a JBoss Application Server environment using PATROL console:

  1. Choose JBoss > KM Commands > Register...
    The Register JBoss environment dialog box is displayed, as shown in the following figure: 


    Register JBoss environment dialog box

    Registering_JBoss_Environement.png

  2. In Host/IP, enter the host name or IP address of a local or remote host.
    IP addresses can be in the IPv4 or IPv6 format.

    Example

    [2001:db8:28:3:f98a:5b31:67b7:67ef] is an IPv6 address.

  3. In JMX port, enter the JMX port number that the KM will use.

    Note

    The default value of the JMX port number depends on the version of JBoss.

    1. JBoss EAP 5.x – 1099 or 1090
    2. JBoss EAP 6.x/7.x – standalone 9990
    3. JBoss EAP 6.x/7.x – domain 9999
    4. Wildfly 8.x/9.x/10.x standalone – 9990
    5. Wildfly 8.x/9.x/10.x domain – 9999
    • For JBoss EAP 5.x, the JMX port number is defined by the jboss:service=Naming mbean at the Port attribute in the JBOSS_HOME/server/ServerName/conf/bindingservice.beans/META-INF/bindings-jboss-beans.xml file.
    • For JBoss EAP 6.x and 7.x, the JMX port number is defined by the management-http inside standalone.xml under the standalone directory or native interface inside host.xml under domain directory.
    • For JBoss Wildfly 8.x/9.x/10.x, the JMX port number is defined by the management-http inside the standalone.xml under the standalone directory or native interface inside host.xml under domain directory.
  4. (Optional) In User name, enter a valid JBoss Application Server account username.
  5. (Required only if you enter a JBoss username in the preceding step) In Password, enter the password for the JBoss Application Server account.

  6. In JBoss Home, enter the path of the directory in which JBoss Application Server is installed on the local host.

    Note

    • When a new user is added to the JBoss domain, the user will be added to the mgmt-users.properties, application-roles.properties, and application-users.properties files located in the <JBoss installation path>/domain/configuration.
    • When a JBoss environment is configured to use a different directory to the domain base by using an argument -Djboss.domain.base.dir=<NEW PATH>, the mgmt-users.properties, application-roles.properties, and application-users.properties files should be copied to the new directory that is configured to use.
    • The version of JBoss installed on the local host must be the same as on the monitored server.
  7. In JavaHome Directory, enter the path of the directory in which Java is installed on the local host. 
    BMC PATROL for JBoss Application Server supports only version 1.6 of Oracle JRE (Java Runtime Environment).

  8. In Local JBoss Administrator OS Account, enter a valid operating system username for the computer on which JBoss Application Server is installed.

    The operating system user account must have read and execute permissions for the JBoss Home directory, execution permissions for the Java Home directory, and full access to the ../Patrol3/pjb directory.

  9. In Local JBoss Administrator OS password, enter the password for the operating system user account.
  10. In the Collection Details pane, select one or more of the following options:
    • Server Availability
    • General Health
    • Full
    • Custom
  11. If you have selected the Custom option in the previous step, the Custom Groups dialog box is displayed as shown in the figure. In the Custom Groups dialog box, select one or more custom collection options.
    Custom Groups dialog box
    Custom_groups.png
  12. (Optional) In the PATROL Defined ID (optional)  text box, enter the PATROL defined ID.
  13. Click OK.

Unregistering a JBoss environment

  1. Right-click the registered JBoss environment you want to remove. 
  2. Select KM Commands > Unregister Environment command.
  3. At the confirmation prompt, click OK.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*