API Doc
Search Docs...
⌘ K
OverviewDeploymentManagementOperationReferenceGlossary

Viewing all key management services

Procedure

Run the following command on any node in the cluster to view information about all key management services:

zbs-meta kms list

Output example

  • For external key management services:

    Type: kmip
    Provider Id:  1b8872b5-ffc4-4811-8671-b814efdf9c54
    Provider Name:  kmip-kms
    Vendor:  test-vendor
    Auth Id:  ka-1b8872-01
    Username:  test-username
    Is Rotating Key:  False
    Key Rotation Seconds:  31536000
    Last Key Rotation Time:  2026-01-06 13:46:04
    Last Key Backup Time:  2025-12-24 16:31:20.0
    Crypt Stats:
      CipherFamily: AES256_CTR, Encrypt Res Num:  60
    Status:  KMS_STATUS_RUNNING
    
    ID            Host              Port  Status
    ------------  --------------  ------  ------------------------
    ks-1b8872-01  192.168.2.2    5696  KMIP_SERVER_CONNECTED
    ks-1b8872-02  172.20.1.1     5696  KMIP_SERVER_DISCONNECTED
    ParameterDescription
    TypeThe key management service type. kmip indicates the external key management service communicates via the KMIP protocol.
    Provider IdThe ID of the key management service.
    Provider NameThe name of the key management service.
    VendorThe vendor of the key management service.
    Auth IdThe authentication information ID of the key management service.
    UsernameThe username field in the authentication information about the key management service.
    Is Rotating KeyWhether the cluster is rotating keys.
    Key Rotation SecondsThe interval for automatic key rotation in the cluster.
    Last Key Rotation TimeThe last key rotation time.
    Last Key Backup TimeThe last key backup time.
    CipherFamilyThe encryption algorithm enabled by the key management service.
    Encrypt Res NumThe number of encryption resources associated with this encryption algorithm in the cluster.
    StatusThe status of the key management service.
    IDThe ID of the key management server.
    HostThe IP address or domain name of the key management server.
    PortThe port of the key management service.
    StatusThe status of the key management server.
  • For native key management services:

    Type: native
    Provider Id:  1a1e76cf-ffa5-44da-a98b-3a13a2633702
    Provider Name:  NativeKMS
    Is Rotating Key:  False
    Key Rotation Seconds:  31536000
    Last Key Rotation Time:  2026-01-06 11:56:37.0
    Last Key Backup Time:  2025-12-24 16:31:20.0
    Crypt Stats:
       CipherFamily: AES256_CTR, Encrypt Res Num:  60
    Status:  KMS_STATUS_RUNNING
    ParameterDescription
    TypeThe key management service type. native represents the native key management service.
    Provider IdThe ID of the key management service.
    Provider NameThe name of the key management service.
    Is Rotating KeyWhether the cluster is rotating keys.
    Key Rotation SecondsThe interval for automatic key rotation in the cluster.
    Last Key Rotation TimeThe last key rotation time.
    Last Key Backup TimeThe last key backup time.
    CipherFamilyThe encryption algorithm enabled by the key management service.
    Encrypt Res NumThe number of encryption resources associated with this encryption algorithm in the cluster.
    StatusThe status of the key management service.