certificate modify

Prev Next

This command updates a certificate added to the VMS.

Usage

certificate modify --id ID
                   [--name NAME]
                   [--cert-type WEBHOOK|KAFKA|KAFKA_MTLS|SMTP]
                   [--certificate TEXT]
                   [--private-key TEXT]
                   [--ca-certificate TEXT]

Required Parameters

--id ID

The ID of the certificate you want to modify.

Options

--name NAME

Sets a name for the certificate.

--cert-type WEBHOOK|KAFKA|

KAFKA_MTLS|SMTP

Determines the capability to be authenticated with the certificate. Valid values:

  • WEBHOOK for webhook connections.

  • KAFKA for Kafka connections.

  • KAFKA_MTLS for Kafka mTLS authentication.

  • SMTP for securing SMTP connection used to send event notification emails.
    NOTE: This option is available with VAST Cluster 5.4.6 and later.

--certificate TEXT

Supply the certificate as plain text.

--private-key TEXT

Supply the private key for the certificate.

--ca-certificate TEXT

Supply the CA certificate as plain text.

Example

To change the name for the certificate with certificate ID 4:

vcli: admin> certificate modify --id 4 --name smpt-prod