Chapter 39. keypair
Chapter 39. keypair This chapter describes the commands under the keypair command. 39.1. keypair create Create new public or private key for server ssh access Usage: Table 39.1. Positional arguments Value Summary <name> New public or private key name Table 39.2. Command arguments Value Summary -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. --type <type> Keypair type. can be ssh or x509. (supported by api versions 2.2 - 2.latest ) --user <user> The owner of the keypair. (admin only) (name or id). Requires ``--os-compute-api-version`` 2.10 or greater. --user-domain <user-domain> Domain the user belongs to (name or id). this can be used in case collisions between user names exist. Table 39.3. Output formatter options Value Summary -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 to show multiple columns Table 39.4. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 39.5. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 39.6. Table formatter options Value Summary --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 --print-empty Print empty table if there is no data to show. 39.2. keypair delete Delete public or private key(s) Usage: Table 39.7. Positional arguments Value Summary <key> Name of key(s) to delete (name only) Table 39.8. Command arguments Value Summary -h, --help Show this help message and exit --user <user> The owner of the keypair. (admin only) (name or id). Requires ``--os-compute-api-version`` 2.10 or greater. --user-domain <user-domain> Domain the user belongs to (name or id). this can be used in case collisions between user names exist. 39.3. keypair list List key fingerprints Usage: Table 39.9. Command arguments Value Summary -h, --help Show this help message and exit --user <user> Show keypairs for another user (admin only) (name or ID). Requires ``--os-compute-api-version`` 2.10 or greater. --user-domain <user-domain> Domain the user belongs to (name or id). this can be used in case collisions between user names exist. --project <project> Show keypairs for all users associated with project (admin only) (name or ID). Requires ``--os-compute- api-version`` 2.10 or greater. --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. --marker MARKER The last keypair id of the page --limit LIMIT Maximum number of keypairs to display Table 39.10. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 39.11. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 39.12. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 39.13. Table formatter options Value Summary --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 --print-empty Print empty table if there is no data to show. 39.4. keypair show Display key details Usage: Table 39.14. Positional arguments Value Summary <key> Public or private key to display (name only) Table 39.15. Command arguments Value Summary -h, --help Show this help message and exit --public-key Show only bare public key paired with the generated key --user <user> The owner of the keypair. (admin only) (name or id). Requires ``--os-compute-api-version`` 2.10 or greater. --user-domain <user-domain> Domain the user belongs to (name or id). this can be used in case collisions between user names exist. Table 39.16. Output formatter options Value Summary -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 to show multiple columns Table 39.17. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 39.18. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 39.19. Table formatter options Value Summary --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 --print-empty Print empty table if there is no data to show.
openstack keypair create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--public-key <file> | --private-key <file>] [--type <type>] [--user <user>] [--user-domain <user-domain>] <name> openstack keypair delete [-h] [--user <user>] [--user-domain <user-domain>] <key> [<key> ...] openstack keypair list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--user <user>] [--user-domain <user-domain>] [--project <project>] [--project-domain <project-domain>] [--marker MARKER] [--limit LIMIT] openstack keypair show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--public-key] [--user <user>] [--user-domain <user-domain>] <key>