hicli Command

Description

kmipsrv set

Enables, disables, or changes the KMIP server settings.

  • --state=<ENABLED|DISABLED>—Whether the KMIP server is enabled or disabled.
  • --host=<ip address>—The IP address of the KMIP server.
  • --port=<port number>—The port number for the KMIP server.
  • --reconnect=<0|1>—Whether automatic reconnection is enabled (1) or disabled (0).
  • --protocol=<1.0|1.1|1.2|1.3|1.4|custom_hex>—The KMIP protocol to use for the server.
  • --nbio=<0|1>—Whether non-blocking I/O is required (1) or not required (0).
  • --timeout=<timeout>—The length of time, in seconds, after which a client request will time out. Specify 0 (zero) to indicate that the request should never time out.
  • --verify=<yes|no>—If set to yes, the KMIP client identity is verified before the server handles its request. We recommend that you set this option to yes.
  • --reset—Resets the KMIP server.
  • --loglevel=<ALL|CREATE-GET|OFF>—The log level to use for the KMIP server.
  • --cert_type=<DEFAULT|CUSTOM>—The certificate type being used by the KMIP server.
  • --SSL_cert=<path>—The path of the SSL certificate (in base64 PEM format) to be used. Required if --cert_type is CUSTOM.
  • --CA_cert=<path>—The path of the CA certificate (in base64 PEM format) to be used. Required if --cert_type is CUSTOM.
  • --private_key=<path>—The path of the private key (in base64 PEM format) to be installed. Required if --cert_type is CUSTOM and you did not use a CSR generated by Cryptographic Security Platform Vault.
  • --custom_cacert_use_to_verify_kmip_client_cert=<0|1>—If enabled, the user must upload a custom certificate while creating the KMIP client certificate. Required if --cert_type is CUSTOM.
  • --password=<password>—The password of the private key. Required only if the private key is encrypted.

kmipsrv_user

Creates, edits, or deletes a KMIP Client Certificate bundle:

  • --username=<user name>—The user name for the KMIP client certificate bundle.
  • --passwd=<password>—An optional password for the client certificate bundle. Note that not all KMIP clients can accept a password-protected client certificate.
  • --expire=<integer>—The number of days before the KMIP certificate expires.
  • --p12=<yes>
  • --operation=<create|update|remove|removeall|list>—The operation to preform on the client certificates.
  • --csr=<csrfile>—Optional. The name of the file containing the 3rd party certificate signing request (CSR) you want to use.
  • --download—If specified, the selected client certificate bundle is returned by this command.