CLI Configuration
To help developers, the Ping CLI has options for configuration to be able to manage Ping Identity platform services.
Connecting Ping Identity products and services
Multiple supported Ping Identity products and services can be connected to the CLI, which allows developers to use common interfaces and command structure to manage connected products.
For more information about supported products, refer to Product Compatibility for a list of available products and Connecting Ping Identity Services for details of how to connect your deployment to Ping CLI.
Configuration profiles
Ping CLI supports the concept of Configuration Profiles. Configuration Profiles allow developers to quickly switch between different CLI configurations when working with multiple product environments.
For example, a developer is working with two development environments. Using Configuration Profiles, the developer can configure one profile per environment in the CLI and switch between them easily without having to continually reconfigure the Ping CLI.
Learn more in Managing Configuration Profiles.
Defining runtime configuration
Ping CLI has multiple ways to pass option values for run-time configuration. The options are:
-
In-line Parameters: Parameters may be passed in-line as part of invoking the command in the command line console.
Refer to the Command Reference for a full list of in-line parameters per command.
-
Configuration File: Parameters could be persisted in the Ping CLI configuration file, attached to a named configuration profile.
Refer to Using the Configuration File for details on how to set, unset and modify parameter values in Ping CLI’s configuration file
-
Environment Variables: Parameters could be set in the environment’s shell as environment variables before running the Ping CLI command. This option is most useful when running Ping CLI in a CI/CD environment.
Using the configuration file
Parameters could be persisted in the Ping CLI configuration file, attached to a named configuration profile. When configuring the Ping CLI’s configuration file, the following commands can be used:
-
pingcli config set: Persist a value for a specified configuration key.
-
pingcli config get: Retrieve a previously persisted value for a specified configuration key.
-
pingcli config unset: Remove a previously persisted value for a specified configuration key.
-
pingcli config list-keys: List all the configuration keys available to persist values for.
You can find a full reference of available configuration keys in Configuration Settings Reference.