productInsights - Cloud Product Insights (productInsights)

Registers the software with IBM Cloud Product Insights for usage reporting.

NameTypeDefaultDescription
urlstringThe url name of the IBM Cloud Product Insights service, which includes the host and port.
apiKeystringThe API key for accessing the IBM Cloud Product Insights service.
sslRefA reference to top level ssl element (string).Specifies the SSL configuration that is needed to establish a secure connection.
groupsstringA comma-separated list of groups that this server belongs to.
proxyUrlstringThe url name of the proxy server to use, which includes the host and port.
proxyUserstringThe user name to use if the proxy needs authentication.
proxyPasswordReversably encoded password (string)The password to use if the proxy needs authentication.

ssl

Specifies the SSL configuration that is needed to establish a secure connection.

NameTypeDefaultDescription
keyStoreRefA reference to top level keyStore element (string).A keystore containing key entries for the SSL repertoire. This attribute is required.
trustStoreRefA reference to top level keyStore element (string).${keyStoreRef}A keystore containing trusted certificate entries used by the SSL repertoire for signing verification. This attribute is optional. If unspecified, the same keystore is used for both key and trusted certificate entries.
sslProtocolstringThe SSL handshake protocol. Protocol values can be found in the documentation for the underlying JRE's Java Secure Socket Extension (JSSE) provider. When using the IBM JRE the default value is SSL_TLS and when using the Oracle JRE the default value is SSL.
clientAuthenticationbooleanfalseSpecifies whether client authentication is enabled. If set to true then client authentication is required and the client must provide a certificate for the server trusts.
clientAuthenticationSupportedbooleanfalseSpecifies whether a client authentication is supported. If set to true then the client authentication support means the server will check trust from a client if the client presents a certificate.
securityLevel
  • HIGH
  • MEDIUM
  • LOW
  • CUSTOM
HIGHSpecifies the cipher suite group used by the SSL handshake. HIGH are 3DES and 128 bit and higher ciphers, MEDIUM are DES and 40 bit ciphers, LOW are ciphers without encryption. If the enabledCiphers attribute is used the securityLevel list is ignored.
HIGH
Cipher suites 3DES and 128 bit and higher
MEDIUM
%repertoire.MEDIUM
LOW
%repertoire.LOW
CUSTOM
%repertoire.CUSTOM
clientKeyAliasstringSpecifies the alias of the certificate in the keystore that is used as the key to send to a server that has client authentication enabled. This attribute is only needed if the keystore has more than one key entry.
serverKeyAliasstringSpecifies the alias of the certificate in the keystore used as the server's key. This attribute is only needed if the keystore has more then one key entry.
enabledCiphersstringSpecifies a custom list of ciphers. Separate each cipher in the list with a space. The supported cipher will depend on the underlying JRE used. Please check the JRE for valid ciphers.

ssl > outboundConnection

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
hoststringThe server uses this SSL configuration when it accesses the specified host name.
portintThe server uses this SSL configuration when it accesses the remote host name at the specified port.
clientCertificatestringThe client uses this certificate alias if you make a connection to a server that supports or requires client authentication.