get¶
Description¶
Get a configuration value from the config file.
The cdp configure get command can be used to print a configuration value in
the CDP config file. The get command supports two types of configuration
values, unqualified and qualified config values.
Note that cdp configure get only looks at values in the CDP configuration
file. It does not resolve configuration variables specified anywhere else,
including environment variables, command line arguments, etc.
Unqualified Names¶
Every value in the CDP configuration file must be placed in a section (denoted
by [section-name] in the config file). To retrieve a value from the
config file, the section name and the config name must be known.
An unqualified configuration name refers to a name that is not scoped to a
specific section in the configuration file. Sections are specified by
separating parts with the "." character (section.config-name). An
unqualified name will be scoped to the current profile. For example,
cdp configure get cdp_access_key_id will retrieve the cdp_access_key_id
from the current profile, or the default profile if no profile is
specified. You can still provide a --profile argument to the cdp
configure get command. For example, cdp configure get cdp_region --profile
testing will print the region value for the testing profile.
Qualified Names¶
A qualified name is a name that has at least one "." character in the name.
This name provides a way to specify the config section from which to retrieve
the config variable. When a qualified name is provided to cdp configure
get, the currently specified profile is ignored. Section names that have
the format [profile profile-name] can be specified by using the
profile.profile-name.config-name syntax, and the default profile can be
specified using the default.config-name syntax.
Synopsis¶
cdp configure get varname [--profile profile-name]
Examples¶
Suppose you had the following config file:
[default]
cdp_access_key_id=default_access_key
cdp_private_key=default_private_key
[foobar]
farboo=true
[profile testing]
cdp_access_key_id=testing_access_key
cdp_private_key=testing_private_key
The following commands would have the corresponding output:
$ cdp configure get cdp_access_key_id
default_access_key
$ cdp configure get default.cdp_access_key_id
default_access_key
$ cdp configure get cdp_access_key_id --profile testing
testing_access_key
$ cdp configure get profile.testing.cdp_access_key_id
testing_access_key
$ cdp configure get foobar.farboo
true
$ cdp configure get preview.does-not-exist
$
$ echo $?
1