Skip to main content

List or describe keypair profiles

Requirements

  • Using keypair profiles is an account-level control.

  • Your account admin can permit or prohibit other users from working with keypair profiles.

  • You can only use this flow if you have enabled keypair profiles as a requirement for keypair generation.

  • You must specify the alias and algorithm at the time of generation if keypair profiles are not enabled.

Command

Keypair profile commands begin with:

smctl keypair profile

or

smctl kp profile

or

smctl keypair profiles

or

smctl keypair keypairprofile

or

smctl keypair keyprofiles

Subcommands

Keypair profile commands support these subcommands:

Table 1. Subcommands for listing or describing keypair profiles

Shortcut

Subcommand

Description

desc

describe

Get details for a keypair profile ID.

ls

list

List keypair profiles.


Describe keypair profile

Describe keypair profile commands begin with:

smctl keypair profile describe

or

smctl kp profile desc

Flags

Describe keypair profile commands support these flags:

Table 2. Flags for listing and describing keypair profiles

Shortcut

Flag

Description

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for keypair profiles.


Example

Description: Describe the keypair profile with the provided keypair profile ID.

Command:

smctl keypair profiles describe <keypair profile id> <account id string>

Command sample:

smctl keypair profiles describe a609c6e6-fc89-48ff-a071-1d7001580452

List keypair profile

List keypair profile commands begin with:

smctl keypair profile list

or

smctl kp profile ls

Flags

List keypair profile commands support these flags:

Table 3. Flags for listing and describing keypair profiles

Shortcut

Flag

Description

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for keypair profiles.


Example

Description: List the keypair profile with the specified keypair profile alias.

Command:

smctl keypair profiles list -–filter name=<keypair profile alias>

Command sample:

smctl keypair profiles list -–filter name=keypair-profile-name