Parameter values for the cachemanager component
Select the objects and properties that are associated with the global cache that you want to change.
You can set cache manager properties at the integration node level or at the integration server level. For examples of how to change parameters for the cachemanager component, see mqsichangeproperties command.
Integration node parameters
To change these
parameters, you must specify the integration node name and -o
CacheManager. You must restart the integration node for
all changes to be implemented.
- policy
- The cache policy to use for the cache manager. Set this parameter
to default, disabled, none,
or the fully qualified name of a policy file.
- If you specify default, the default cache policy is used. This policy defines the default single-integration node topology.
- If you specify disabled, the global cache components
in the integration node are disabled. By default, the cache
is disabled.
When the cache is enabled, the memory usage of integration servers that are hosting cache components is larger. If this memory usage is an issue, and you do not intend to use the cache, set the cache policy to disabled.
- If you specify none, the cache manager in each integration server uses the values that you set. The integration server properties that were set most recently by the broker-level policy are retained as a starting point for customization.
- If you specify the fully qualified name of a policy file, the integration nodes that are listed in the policy file are configured to share the data in the global cache. The path must be absolute, not relative.
- portRange
- The range of ports to be used by the cache manager. You can set
this parameter when you use the default topology. Set this parameter
to generate or to a specific range of ports.
- If you specify a range of ports, the value of this parameter must be in the format xxxx-yyyy, and the range must contain at least 20 ports.
- If you specify generate, the integration node generates a range of ports that are not being used by another integration node on that computer. The integration node chooses a range that starts from 2800. If, for example, another integration node is using ports 2800 - 2819, the integration node generates a range from 2820 to 2839.
- listenerHost
- A host name or IP address to which the integration node cache components listen. If your computer has more than one host name, set this parameter to ensure that the cache components use the correct host name. You can set this parameter when you use the default topology.
- objectGridCustomFile
- (Optional) The path to the objectgrid.xml file where you can define the locking strategies that you want to use with your embedded global cache. If this parameter is not set, then the system-wide configuration is used (workpath\common\wxs\objectgrid.xml), or if the system-wide configuration does not exist, the default configuration is used (installPath\server\cachesupport\config\objectgrid.xml). For more information about locking strategies, see Configuring locking strategies for the embedded global cache.
- deploymentPolicyCustomFile
- (Optional) The path to the deployment.xml file where you can define whether the embedded global cache can read data from a local replica of a cache map. If this parameter is not set, then the system-wide configuration is used (workpath\common\wxs\deployment.xml), or if the system-wide configuration does not exist, the default configuration is used (installPath\server\cachesupport\config\deployment.xml). For more information, see Configuring the embedded global cache to read data from replica shards of a cache map.
Integration server parameters
To change
these parameters, you must specify the integration server name and -o
ComIbmCacheManager. You must restart the integration server
for all changes to be implemented. If you stop the integration server
that contains the catalog server, the global cache becomes unavailable.
- enableCatalogService
- Determines whether the named integration server hosts a catalog server. Valid values are true or false.
- enableContainerService
- Determines whether the named integration server hosts a container server. Valid values are true or false.
- catalogClusterEndPoints
- This parameter is required if a catalog server is enabled in the
named integration server. The format of this value is a comma-separated
list of catalog server cluster endpoints. If you have more than one
integration server with a catalog server enabled for your embedded
grid (for failover), the list of endpoints must be identical for all
integration servers. Each endpoint has the format ServerName:listenerHost:CatalogPeerPort:haManagerPort.
The CatalogPeerPort must be unique. Do not specify
the same CatalogPeerPort for more than one integration
server. ServerName is a unique name for the catalog server in this integration server. The format of this value is integrationNodeName_listenerHost_listenerPort. The following example shows the catalogClusterEndPoints parameter when it is set dynamically by the integration server:
IBNODE_hostname.com_2809:hostname.com:2812:2810 - clientsDefaultToSSL
- Determines whether SSL is enabled for this integration server
when connecting to an external WebSphere® eXtreme
Scale grid.
Valid values are true or false.
If this property is set to true, all connections to external WebSphere eXtreme Scale grids are made with SSL supported. The connection to the external WebSphere eXtreme Scale grid is defined by the WXSServer configurable service. For an explanation of the combinations between this client connection and the external WebSphere eXtreme Scale server, see the topic Transport layer security and secure sockets layer in the WebSphere Extreme Scale product documentation online.
By default, this property is set to an empty string, which is equivalent to false. SSL connections can be made only from integration servers that are not hosting catalog or container servers. You can specify the SSL protocol by setting the sslProtocol property.
For more information, see Enabling SSL for external WebSphere eXtreme Scale grids.
- connectionEndPoints
- A string that comprises connection endpoints for container servers to connect to catalog servers, and for client connections to the embedded grid. You must set this parameter for all integration servers that participate in, or access, the embedded grid. The format of this value is a comma-separated list of endpoints. Each endpoint has the format listenerHost:listenerPort, and typically matches the integration server or groups where catalog servers are enabled.
- domainName
- The domain name that is used by WebSphere eXtreme
Scale clients
to identify and distinguish between embedded grids. Only WebSphere eXtreme
Scale servers with the same domain
name can participate in the same grid. Therefore, ensure that all
servers that participate in one embedded grid use the same domain
name. Also, ensure that each grid has a unique domain name.
If you do not specify a domain name, the integration node creates a name that is based on the server names of the catalog servers. (For more information about the format of this name, see catalogClusterEndPoints.)
- enableJMX
- Determines whether the named integration server can provide administration information about the grid. Valid values are true or false. To use the mqsicacheadmin command, you must set this parameter to true.
- haManagerPort
- This parameter is required if either the catalog server or container server is enabled. This value must be unique. Do not specify the same haManagerPort parameter for more than one integration server.
- jmxServicePort
- This parameter is required if the enableJMX parameter is set to true. This value must be unique. Do not specify the same jmxServicePort parameter for more than one integration server.
- listenerHost
- The host name of the local computer. If this parameter is not
set, the integration node uses as the default the first host name
that it identifies for this computer. Set this parameter if you have
more than one network card (for example, IPv4 and IPv6). If you are hosting containers servers in a multi-instance integration node, use this property to provide a comma-separated list of listener hosts for the multi-instance integration node. To specify a list of listener hosts on the mqsichangeproperties command, enclose the comma-separated list with a pair of backslash characters and quotation marks (\"):
mqsichangeproperties integrationNodeName -e integrationServerName -o ComIbmCacheManager -n listenerHost -v \"host1,host2\" - listenerPort
- The number of the listener port. This parameter is required if either the catalog server or container server is enabled. The value must be unique. Do not specify the same listenerPort parameter for more than one integration server.
- sslAlias
- The private key to use for a connection to an external WebSphere eXtreme
Scale grid.
This property is optional and is used only if the clientsDefaultToSSL property is set to true. If the external grid requires client authentication, and more than one trusted private key exists in the integration node keystore, use this property to specify which key to use. You can use only one key alias per integration server.
- sslProtocol
- The SSL protocol to use for a connection to an external WebSphere eXtreme
Scale grid.This property is optional and is used only if the clientsDefaultToSSL property is set to true. Valid values are determined by the IBMJSSE2 security provider. If you enter a value that is not recognized by the IBMJSSE2 provider, a BIP7146 warning is written to the local error log (syslog). If you try to connect to an external grid with the unrecognized value, exception message BIP7143 is issued. Examples of valid values are SSL, SSLv3, TLS, TLSv1, and SSL_TLS. If you do not set this property, a default value of TLS is used.Note: SSLv3 is disabled by default in IBM® Integration Bus Version 10.0, because SSLv3 is no longer considered secure; see Migrating a flow that uses SSLv3 for more information.
- objectGridCustomFile
- (Optional) The path to the objectgrid.xml file where you can define the locking strategies that you want to use with your embedded global cache. If this parameter is not set on either the integration node or the integration server, and no policy is set on the integration node, then the system-wide configuration is used (workpath\common\wxs\objectgrid.xml), or if the system-wide configuration does not exist, the default configuration is used (installPath\server\cachesupport\config\objectgrid.xml). For more information about locking strategies, see Configuring locking strategies for the embedded global cache.
- deploymentPolicyCustomFile
- (Optional) The path to the deployment.xml file where you can define whether the embedded global cache can read data from replica shards. If this parameter is not set on either the integration node or the integration server, and no policy is set on the integration node, then the system-wide configuration is used (workpath\common\wxs\deployment.xml), or if the system-wide configuration does not exist, the default configuration is used (installPath\server\cachesupport\config\deployment.xml). For more information, see Configuring the embedded global cache to read data from replica shards of a cache map.