osmo credential#

usage: osmo credential [-h] [--format-type {json,text}] {set,list,delete} ...

Positional Arguments#

command#

Possible choices: set, list, delete

Named Arguments#

--format-type#

Possible choices: json, text

Specify the output format type (Default text).

Default: 'text'

Sub-commands#

set#

Create or update a credential

osmo credential set [-h] [--type {REGISTRY,DATA,GENERIC}]
                    (--payload PAYLOAD [PAYLOAD ...] | --payload-file PAYLOAD_FILE [PAYLOAD_FILE ...])
                    name

Positional Arguments#

name#

Name of the credential.

Named Arguments#

--type#

Possible choices: REGISTRY, DATA, GENERIC

Type of the credential.

Default: 'GENERIC'

--payload#

List of key-value pairs. The tabulated information illustrates the mandatory and optional keys for the payload corresponding to each type of credential:

Credential Type

Mandatory keys

Optional keys

REGISTRY

auth

registry, username

DATA

access_key_id, access_key

endpoint, region (default: us-east-1)

GENERIC

--payload-file#

List of key-value pairs, but the value provided needs to be a path to a file. Retrieves the value of the secret from a file.

Ex. osmo credential set registry_cred_name –type REGISTRY –payload registry=your_registry username=your_username auth=xxxxxx Ex. osmo credential set data_cred_name –type DATA –payload access_key_id=your_s3_username access_key=xxxxxx endpoint=s3://bucket Ex. osmo credential set generic_cred_name –type GENERIC –payload omni_user=your_omni_username omni_pass=xxxxxx Ex. osmo credential set generic_cred_name –type GENERIC –payload-file ssh_public_key=<path to file>

list#

List all credentials

osmo credential list [-h]

Ex. osmo credential list

delete#

Delete an existing credential

osmo credential delete [-h] name

Positional Arguments#

name#

Delete credential with name.

Ex. osmo credential delete omni_cred