Menu Close

Chapter 37. keypair

This chapter describes the commands under the keypair command.

37.1. keypair create

Create new public or private key for server ssh access

Usage:

openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                [--public-key <file> | --private-key <file>]
                                <name>

Table 37.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 37.2. Positional Arguments

ValueSummary

<name>

New public or private key name

Table 37.3. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 37.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 37.5. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--public-key <file>

Filename for public key to add. if not used, creates a private key.

--private-key <file>

Filename for private key to save. if not used, print private key in console.

Table 37.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

37.2. keypair delete

Delete public or private key(s)

Usage:

openstack keypair delete [-h] <key> [<key> ...]

Table 37.7. Positional Arguments

ValueSummary

<key>

Name of key(s) to delete (name only)

Table 37.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

37.3. keypair list

List key fingerprints

Usage:

openstack keypair list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]

Table 37.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 37.10. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 37.11. Output Formatters

ValueSummary

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 37.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 37.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

37.4. keypair show

Display key details

Usage:

openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--public-key]
                              <key>

Table 37.14. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

Table 37.15. Positional Arguments

ValueSummary

<key>

Public or private key to display (name only)

Table 37.16. Output Formatters

ValueSummary

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 37.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 37.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--public-key

Show only bare public key paired with the generated key

Table 37.19. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names