Miscellaneous Cluster Properties
The following cluster properties control various aspects of behavior.
gateway91
The following cluster properties control various aspects of
API Gateway
behavior.Refer to "Time Units" under Cluster Properties for a list of the valid time units that you can use for time-related properties.
Property | Description |
---|---|
admin. certificateDiscoveryEnabled | Allows the Policy Manager to securely discover this API Gateway 's SSL certificate without user intervention. Value is a Boolean.
Default: true See also services.certificateDiscoveryEnabled . |
attachment.diskThreshold | Threshold of attachments in a single request to keep in RAM. Default: 1048576 bytes |
builtinService.snmpQuery.enabled | Controls the availability of the SNMP query service check box in the Listen Port Properties [Basic Settings] tab.
Default: true |
CA WSDM Gateway Observer | |
contentType.otherTextualTypes | Textual Content-Types. By default, the gateway recognizes these Content-Types: text, xml, json and form encoded. Each Content-Type should be on a separate line and may include a charset—for example: application/custom; charset="UTF-8" |
customerMapping. addToGatewayAuditEvents | Controls whether the API Gateway saves the mapping information with the audits:
Default: true |
customerMapping. addToServiceMetrics | Determines whether the API Gateway saves the mapping information with the service metrics:
Default: true |
dataGrid.protocol | The protocol Hazelcast uses to discover cluster members. Restart all nodes in the cluster for changes to take effect. Default: tcpip (1) The Hazelcast cache is used for message replay protection and is a key component of assertions such as the Protect Against Message Replay Assertion (XML Security) . (2) This is a hidden cluster property that is edited by typing its name in the Key field in Manage Cluster-Wide Properties. Modify this only under the direction of CA Support. |
dataGrid.tcpip.connectionTimeout | Maximum time Hazelcast will try to connect to a well known member before timing out. Value is a time unit. Default: 5s The "Notes" under dataGrid.protocol above also apply here. |
datetime.autoFormats | Values for built-in set of supported date formats. This property determines the values that the Set Context Variable assertion can parse by default when "< auto >" is selected and what values the Compare Expression assertion can automatically convert when "Date/Time" is selected as the data type.This is a hidden cluster property that is edited by typing in its name in the Key field in Manage Cluster-Wide Properties. By default, these formats are supported: Example : 1997-07-16T 19:20:30.45-1:00
Observe these guidelines when configuring this property:
The default value for the cluster property is as follows (line breaks added here for readability and to minimize horizontal scrolling when viewing this page):
|
datetime.customFormats | Customizes the values displayed in the "Format" drop-down list in the Set Context Variable assertion. User can modify datetime.customFormats by adding new formats or by removing the existing formats. To add additional formats, enter them here, separating each format with a semicolon. Changing datetime.customFormats does not affect values in datetime.autoFormats. |
db.replicationDelayThreshold | The threshold for auditing a warning due to slow or failed replication. Enter "0" (zero) to disable audits. Value is a time unit. Default: 60s |
db.replicationErrorAuditInterval | Minimum interval between successive database replication failure audits. This allows the number of audits to be restricted, so auditing will occur only once per hour (or whatever is configured) when replication is failing. Value is a time unit. Default: 60m |
ekeycache.maxEntries | Maximum number of cached ephemeral key thumbprints (per-node). Default: 1000 |
help.url | Location of the online help system. By default, the Policy Manager uses the API Gateway documentation wiki as the online help. Change this setting only if your organization has installed an offline version of the document due to internet restrictions (see Install Offline Help).Default: blank (which indicates the factory default help location is in use) (1) The new help file location will take effect the next time you log in to the Policy Manager. (2) New value must point to a web server that supports http or https . |
icap.channelIdleTimeout | Maximum idle time for a connected channel in the connection pool to an ICAP server. Any channels exceeding this timeout value will be disconnected and removed from the pool. Value is a time unit; the allowable range is between 1 second and 1 hour. Default: 1m |
keyStore.searchForAlias | Determines how the API Gateway searches for key aliases:
Default: true For more information about private keys, see Manage Private Keys. For more information on how to select a private key to use, see Selecting a Custom Private Key |
keyStore.signWithSha1 | Sets the default signature hash to use for the message digest when signing certificates. Value is a Boolean.
Default: false |
krb5.kdc | Sets the "kdc" value in the krb5.conf (Kerberos configuration) file. The default value is determined by parsing the user's domain in the kerberos.keytab file, then performing a host/IP lookup to determine the KDC value. |
krb5.realm | Sets the "default_realm" value in the krb5.conf (Kerberos configuration) file. The default value is determined by parsing the user's domain in the kerberos.keytab file, then performing a host/IP lookup to determine the realm. |
license.expiryWarningPeriod | Time in the future to display impending expiration of the API Gateway license or SSL certificate. Value is a time unit.Default: 30d |
metrics.fineInterval | Time interval for Service Metrics fine resolution bins. Default: 5000 milliseconds For more information about service metrics bins, see Dashboard - Service Metrics. Restart the cluster if you change this value. |
mtom.decodeSecuredMessages | Controls whether secured MTOM-encoded message are automatically decoded. Value is a Boolean.
Default: true This cluster property only acts on messages containing a WS-Security destined for the API Gateway . All other message are unaffected by this property and MTOM decoding occurs only when a Decode MTOM Message assertion is present in the policy. |
pingServlet.mode | Determines how the API Gateway responds to PING commands. Values are:
Default: REQUIRE_CREDS See Ping URI Test for a more detailed description of each setting. |
policyValidation. maxConcurrency | Maximum number of server-side policy validation jobs that may be active simultaneously. Default: 15 Requires a API Gateway restart for changes to take effect. |
policyValidation.maxPaths | Maximum number of possible paths through a policy before the policy is considered to be too complex to attempt server-side validation. Default: 500000 |
policyVersioning.maxRevisions | Maximum number of policy revisions to retain. Only revisions that are not active and which do not have a comment count toward the maximum. If set to zero, only the active version and commented versions are retained. Revisions with comments are always retained, regardless of the setting of this cluster property. Default: 20 |
Progress Actional for SOA Operations | |
request.compress.gzip.allow | Determines whether GZIP compressed requests are accepted:
Default: true |
response.compress.gzip.allow | Determines whether GZIP compressed responses can be returned to the client:
Default: true |
restman.request.message.maxSize | Configures the maximum request message size going to the REST Management Service to support large migrations. The io.xmlPartMaxBytes cluster property has no affect on the REST Management Service. Default = 50MB. |
rbac.autoRole.managePolicy. autoAssign | Determines if a non-admin user should be added to the auto-created Manage Policy role, when a new Policy is successfully created.
Default: true |
rbac.autoRole.manageProvider. autoAssign | Determines if a non-admin user should be added to the auto-created Manage Provider role, when a new Policy is successfully created.
Default: true |
rbac.autoRole.manageService. autoAssign | Determines if a non-admin user should be added to the auto-created Manage Service role, when a new Published Service is successfully created.
Default: true |
rsasigcache.maxEntries | Number of verified signatures to cache. The property sets the size of the RSA signature cache, which keeps track of recently-verified XML snippets. Only the SHA1 hash is cached, not the entire XML snippet. Caching is disabled by default, which enhances overall security with a slight performance penalty. When caching is enabled, the RSA decrypt operation is skipped and the signature is assumed verified if the exact same signed XML is presented, verified with exactly the same public key and signature value. The cached signature is not used if there are changes to the XML, public key, or signature value. Enable this property when:
A setting of zero disables the cache. Default: 0 (caching disabled) Requires a API Gateway restart for changes to take effect. |
scheduledTask.maxThreads | The maximum number of threads for the task scheduler. Must be greater than or equal to 1. Default: 10 Requires a API Gateway restart for changes to take effect. |
security.fips.enabled | Enable FIPS-compliant cryptographic algorithms. Value is a Boolean.
When the security.fips.enabled property is set to "true", non-FIPS ciphers are not accepted. There is no assurance that the built-in TLS implementation can correctly process all non-FIPS algorithms.
Default: false |
serverModuleFile.upload.enable | Enable or disable the Manage Server Module Files task in the Policy Manager. Default: true |
serverModuleFile.upload.maxSize | The maximum server module file size permitted to be uploaded. The default is 20MB. A value of "0" (zero) indicates unlimited size. Default: 20971520 (bytes).(1) This value should be less than the DB packet size limit. For example for MySQL, this is the max_allowed_packet value within my.cnf or my.ini. (2) Increasing the default value may cause database replication issues in a clustered environment. |
siteminder12.agent. configuration | Configure the agent for the Authenticate with SiteMinder R12 Protected Resource custom assertion . |
soap.actors soap.roles | The SOAP actors or roles in the security header that are processed by the API Gateway . Each actor or role should be separated with a space or placed on a separate line.Default: secure_span http://www.layer7tech.com/ws/policy
Unless otherwise configured in the policy, response messages use the actor/role value from the request message (if the request message uses one of the configured additional values). |
soap.rejectMustUnderstand | Controls how messages with unrecognized SOAP headers addressed to the API Gateway are handled:
Default: true |
swagger.maxDownloadSize | Maximum size (in bytes) of a Swagger specification document download. A value of "0" (zero) indicates unlimited size. Default: 10485760 bytes (uses the value from the General Context Variables context variable) |
template. defaultMultivalueDelimiter | Delimiter between values when a multi-valued context variable is interpolated. Default: , (comma space) |
template.partBodyMaxSize | Maximum size of message part bodies to interpolate in memory. Default: 5242880 bytes |
template.strictMode | Determines what happens when a context variable cannot be resolved for whatever reason. Value is a Boolean.
Default: false |
wsdlDownload.maxSize | Maximum size of a WSDL document download. A value zero indicates unlimited size. Default: 10485760 bytes (uses the value from the General Context Variables context variable) |
wsdm.notification.enabled | Enables notifications when subscribing to a WSDM resource. Value is a Boolean. Default: true |
wsdm.notification.interval | Time between WSDM subscription notifications attempts. This applies only to metrics notifications; status changes are sent as they occur. Default: 60000 milliseconds |
xslDownload.maxSize | Maximum size in bytes of a XSL document download. A value of "0" (zero) indicates unlimited size. Default: 10485760 bytes (uses the value from the context variable) |
xacml.pdp.maxDownloadSize | Maximum size of a XACML policy document download. A value of zero indicates unlimited size. Default: 10485760 bytes (uses the value from the context variable) |
xacml.pdp.policyCache. maxAge | Time to cache a XACML policy in memory. When the Evaluate XACML Policy assertion is processed within the policy, the policy is re-downloaded if the cached policy is older than the value of this cluster property. Default: 300000 milliseconds Requires a API Gateway restart for changes to take effect. |
xacml.pdp.policyCache. maxEntries | Maximum number of cached XACML policies loaded from URLs across all Evaluate XACML Policy assertions on a single API Gateway node. Enter zero to disable caching.Default: 100 Requires a API Gateway restart for changes to take effect. |
xacml.pdp.policyCache. maxStaleAge | Maximum expiration of cached policies loaded from URLs. A setting of "-1" indicates no expiry. Default: -1 Requires a API Gateway restart for changes to take effect. |
xslt.engine.force20 | Determines when the XSLT 2.0 engine (currently Saxon) is used to process XSLT/XPath stylesheets. Value is a Boolean.
Requires a API Gateway restart for changes to take effect. |