Skip to main content
Command reference

security key-manager external barbican check

Suggest changes
PDFs

Show detailed status of the enabled Barbican KMS configurations

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

This command displays the Barbican Key Management Service (KMS) status.

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-node {<nodename>|local}] - Node

If this parameter is specified then the command displays only the Barbican status for the given node.

[-vserver <Vserver Name>] - Vserver Name

If this parameter is specified then the command displays only the Barbican status for the given Vserver.

[-category <Categories for KMS using SVM KEK KM status check>] - Component

If this parameter is specified then the command displays only the Barbican status for the given category.

            Category                    Description
            --------                    -----------
            Status                      Status of the Barbican Key Management Service
            Details                     Detailed description of the status
[-status <Status Check>] - Status

If this parameter is specified then the command displays only the Barbican status entries matching the given status.

            OK
            FAILED
            UNKNOWN
[-detail <text>] - Status Details

This field displays the detailed status message, if available.

Examples

The example below displays the status of all components of all Barbican configurations enabled on the node.

cluster-1::> security key-manager external barbican check
            Vserver: vsSample1
            Node: nodeSample
            Category: service_reachability
                        Status: OK
                        Details: OK
Category: kms_wrapped_key_status
                        Status: OK
                        Details: OK
Vserver: vsSample2
            Node: nodeSample
Category: service_reachability
                        Status: OK
                        Details: OK
Category: kms_wrapped_key_status
                        Status: OK
                        Details: OK
            4 entries were displayed.