- Function Overview
- What's New
- Service Overview
- Getting Started
-
User Guide
- Configuration Management
- HTTP Proxy
- Commonly Used Commands
-
Options
- Option Overview
- Printing Help Information
- Printing Debugging Information
- Generating API Input Parameter Skeleton in JSON Format
- Checking Command
- Specifying Region
- Calling APIs with AK/SK in Non-configuration Mode
- Specifying Account ID
- Specifying Profile
- Specifying Authentication Mode
- Specifying Output Format
- Passing API Parameters with JSON File
- Specifying Request Timeouts
- Specifying Retry Count
- Skipping HTTPS Request Certificate Verification
- Specifying a Domain Name
- Polling Results
- Obtaining CLI Examples on API Explorer
- Using KooCLI in Non-configuration Mode
- Online Experience
- Obtaining Authentication Information
-
FAQs
- Overview
- Authentication
- Profiles
- Metadata Cache
- Logs
- Network Connections
- Cloud Services
- Cloud Service APIs
- Regions
-
Parameters
- What Are KooCLI System Parameters?
- Why Am I Seeing a Message Indicating an Invalid Parameter?
- Why Are Old and New KooCLI System Parameters (Such as region and cli-region) Available? Which Parameters Are Recommended?
- Why Am I Seeing a Message Indicating a Duplicate Parameter?
- How Do I Use cli-jsonInput?
- When Can I Use cli-jsonInput?
- Why Am I Seeing a Message Indicating an Unsupported Parameter Position or Type?
- How Do I Leave a Body Parameter Empty for Cloud Service APIs?
- Interactive Mode and Autocomplete
-
Output Formats
- What Output Formats Are Supported by KooCLI?
- How Do I Define a JMESPath Expression?
- Which KooCLI System Parameters Are Related to Data Output? Which Ones Are Recommended?
- How Do I Use cli-output, cli-query, and cli-output-num?
- How Do I Use cli-output-rows, cli-output-cols, and cli-output-num? What Are the Precautions?
- How Do I Use cli-json-filter? What Are the Precautions?
- Other
- Videos
- General Reference
Show all
Copied.
Setting Custom Parameters in a Profile
KooCLI allows you to set custom parameters in a profile. This helps you manage parameters that are frequently used in commands, have long values, or have values to be encrypted. Run the following command to enter the interactive mode and add or modify custom parameters in a profile:
hcloud configure set [--cli-profile=${profileName}] --cli-custom=true
hcloud configure set --cli-profile=test --cli-custom=true 1. Enter the custom parameter name: projectId 2. Encrypt the custom parameter for storage? (y/N): n 3. Enter the parameter value: 06810000000000000000000000f89d2e Custom parameter saved. To stop setting more custom parameters, press `Ctrl+C`. 1. Enter the custom parameter name: password 2. Encrypt the custom parameter for storage? (y/N): y 3. Enter the parameter value: **** Custom parameter saved. To stop setting more custom parameters, press `Ctrl+C`.
A custom parameter cannot exceed 128 characters. During interactive setting, determine whether to encrypt the custom parameter for storage according to your requirements. To ensure the security of your custom parameters that need to be encrypted for storage, the system anonymizes the parameter values you enter. The entered characters are displayed as asterisks (****) after you press Enter.
To use a custom parameter, replace the original value in the command with custom.${Name of the custom parameter}. For example:
hcloud ECS NovaListServers --cli-profile=test --project_id="custom.projectId"
When you use an encrypted custom parameter, KooCLI anonymizes the parameter value in places where the value may be displayed, for example, in the printed request URL of debugging information or in printed body parameters in dryrun mode.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot