key-pair
key-pair create
Usage
usage: symp key-pair create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--public-key PUBLIC_KEY]
name
Description
Create or import a key pair. Creates a 2048-bit SSH-2 RSA key. You may import SSH-2 RSA keys of length 1024, 2048, and 4096 bits.
Returns
Returns dict: Key pair information
Mandatory
positional arguments:
name The name of the key pair. The key pair name must be unique. It may consist of only letters, numbers, spaces, underscores, periods and dashes.
It must begin and end with a letter, number or an underscore
Optional
optional arguments:
-h, --help show this help message and exit
--public-key PUBLIC_KEY
The public key (base64-encoded)
key-pair delete
Usage
usage: symp key-pair delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
key_name
Description
Delete the specified key pair.
Mandatory
positional arguments:
key_name Name of key pair
Optional
optional arguments:
-h, --help show this help message and exit
key-pair get
Usage
usage: symp key-pair get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--include-public-key]
key_name
Description
Get the details of the specified key pair.
Returns
Returns dict: Key pair information
Mandatory
positional arguments:
key_name Name of key pair
Optional
optional arguments:
-h, --help show this help message and exit
--include-public-key (Optional) Whether to return public key
key-pair list
Usage
usage: symp key-pair list
[-h] [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--names [NAMES [NAMES ...]]]
[--fingerprints [FINGERPRINTS [FINGERPRINTS ...]]]
Description
Returns all key pairs.
Returns
Returns list: Key pairs
Optional
optional arguments:
-h, --help show this help message and exit
--names [NAMES [NAMES ...]]
Key names to filter by
--fingerprints [FINGERPRINTS [FINGERPRINTS ...]]
Fingerprints to filter by