JMX Agent Configuration Properties

By default, the Agent properties file is named agent.properties. You can specify a different properties file on the command line when you launch the JMX Agent. See Starting the vFabric GemFire JMX Agent. Availble Agent properties include:
The Agent looks for the properties file in the following locations, in order:
  1. A directory that you explicitly specify with the -dir argument when starting the Agent
  2. The current directory
  3. Your home directory (the default)
  4. The CLASSPATH

You can modify the values in the properties file via the HttpAdaptor or any supported JMX interface.

Admin Distributed System Properties

Argument Comments Default Value

mcast-address

The multicast address of this distributed system. To use IP multicast, you must also define mcast-port, the IP port.

239.192.81.1

mcast-port

The multicast port, a value in the range 0..65535. To use IP multicast, you must also define mcast-address, the IP address.

10334

membership-port-range

The range of ports available for unicast UDP messaging and for TCP failure detection. This is specified as two integers separated by a minus sign. Different members can use different ranges. GemFire randomly chooses two unique integers from this range for the member, one for UDP unicast messaging and the other for TCP failure detection messaging. Additionally, the system uniquely identifies the member using the combined host IP address and UDP port number. You may want to restrict the range of ports that GemFire uses so the product can run in an environment where routers only allow traffic on certain ports.

1024-65535

locators

A comma-delimited list whose elements have the form host[port]. When you use the GemFire locator service, each locator is uniquely identified by the host on which it is running and the port on which it is listening.

""

remote-command

A default remote command prefix to use for command invocation on remote machines.

rsh -n {HOST} {CMD}

ssl-enabled

Indicates whether to use the Secure Sockets Layer (SSL) protocol for communication between members of this distributed system. Valid values are true and false. A true setting requires the use of locators. See SSL for more information on using SSL in GemFire.

false

ssl-protocols

A space-separated list of the valid SSL protocols for this connection. You can specify any to use any protocol that is enabled by default in the configured Java Secure Sockets Extension (JSSE) provider. See SSL for more information on using SSL in GemFire.

any

ssl-ciphers

A space-separated list of the valid SSL ciphers for this connection. You can specify any to use any ciphers that are enabled by default in the configured JSSE provider. See SSL for more information on using SSL in GemFire.

any

ssl-require-authentication

Indicates whether to require authentication for communication between members of the admin distributed system. Valid values are true and false.See SSL for more information on using SSL in GemFire.

true

tcp-port

The TCP port to listen on for cache communications. If set to zero, the operating system selects an available port. Each process on a machine must have its own TCP port. Note that some operating systems restrict the range of ports usable by non-privileged users, and using restricted port numbers can cause runtime errors in GemFire startup. Valid values are in the range 0..65535.

0

Logging and Statistics Refresh Properties

Argument Comments Default Value
log-level

A minimum level of log messages to be written.

config
log-disk-space-limit The maximum disk space to allocate for logging, in megabytes in the range 0..1000000. 0
log-file-size-limit The maximum size of the JMX Agent log file, in megabytes in the range 0..1000000. 0
refresh-interval The time interval in seconds after which the system statistics are refreshed. In GemFire 6.6.2 and earlier, the default is 5 seconds.

In GemFire 6.6.3, the default is 15 seconds.

HttpAdaptor Properties

Argument Comments Default Value

http-enabled

To enable the HttpAdaptor, this must be true.

true

http-bind-address

The machine name or IP address to which the HTTP listening socket should be bound. If this value is "localhost", then the socket is bound to the loopback address (127.0.0.1) and the adapter is only accessible via the URL http://localhost:8080. If null, all network addresses are used.

null

http-port

The value must be in the range 0..65535.

8080

http-authentication-enabled

If true, require a password.

false

http-authentication-user

User name.

admin

http-authentication-password User password. password

RMIConnectorServer Properties

Argument Comments Default Value

rmi-bind-address

IP address that the JMX Agent uses to communicate with the admin distributed system.

This is required on:
  • Multi-homed hosts (machines with multiple network cards)
  • Windows systems when using IPv6

The rmi-bind-address argument must be specified on the agent start command line if jconsole or jmanage are running on a different host.

If set to null - "" - all network addresses are used.

""

rmi-enabled

To enable the RMIConnectorServer, this must be true.

true

rmi-port

RMI registry port, a value in the range 0..65535.

1099

rmi-registry-enabled

If true, create an MX4J Naming MBean to serve as the RMI registry, and register the RMIConnector under the JNDI path /jmxconnector. More information is also available in the com.gemstone.gemfire.admin.jmx.Agent Javadocs.

true

rmi-server-port

Port to use for the RMIConnectorServer. If set to 0 (zero) the server socket uses a dynamically allocated port. You might want to specify the port to use when the JMX agent is behind the firewall, for example. Valid values are in the range 0..65535.

0

Email Notification Properties

Argument Comments Default Value

email-notification-enabled

Whether to send e-mail notifications.

false

email-notification-from

The from address to put into the e-mail notifications.

email-notification-host

The host where the mail server is running - used to send the notifications. This must be set for mails to be sent. The server’s default port is used for the notifications.

email-notification-to

A comma-separated list of e-mail addresses to which to send the notifications. This must be set for mails to be sent.

SSL Settings for JMX Agent (Communications Outside of GemFire)

Note: These settings can be the set to the same values as the GemFire peer SSL settings listed inAdmin Distributed System Properties.
Argument Comment Default Value

agent-ssl-enabled

Indicates whether the JMX Agent uses the Secure Sockets Layer (SSL) protocol for communication outside of GemFire.

false

agent-ssl-protocols

A space-separated list of the valid SSL protocols for this connection. You can specify any to use any protocol that is enabled by default in the configured Java Secure Sockets Extension (JSSE) provider.

any

agent-ssl-ciphers

A space-separated list of the valid SSL ciphers for this connection. You can specify any to use any of the ciphers that are enabled by default in the configured JSSE provider.

any

agent-ssl-require-authentication

If true, require client authentication for RMI and other non-HTTP connectors/adaptors.

true

http-ssl-require-authentication If true, require client authentication for HTTP adaptors. false