How Do I Use KooCLI in Non-configuration Mode?

When using KooCLI in non-configuration mode, you do not need to pass your authentication information through a profile. Instead, directly pass your authentication parameters in commands. This mode enables you to use the CLI conveniently without adding any profiles. For details, see Using KooCLI in Non-configuration Mode.

Note the following when using the KooCLI in this mode:

• Using an AK/SK in non-configuration mode
  • Access key (permanent AK/SK)
    • When cloud service APIs are called using a permanent AK/SK, pass both the access key ID (cli-access-key) and secret access key (cli-secret-key) in commands for authentication.
    • If a global service is to be accessed, the ID (cli-domain-id) of the account used to create the IAM user is also required for authentication. If the ID is not passed to the command, KooCLI automatically obtains it based on the user authentication information. However, if the cli-access-key or cli-secret-key parameter is missing or the cli-domain-id parameter fails to be automatically obtained, the following error message is displayed:
      • [USE_ERROR] Parameters cli-access-key,cli-secret-key must be specified at the same time.
      • [USE_ERROR] cli-domain-id is required for access to global services using AK/SK. Add this parameter or run `hcloud configure set` to configure it.
    • If both an AK/SK and a profile (cli-profile) are specified in a command, the AK/SK is preferentially used for authentication.
  • Temporary security credentials (temporary AK/SK and SecurityToken)
    • Using a temporary AK/SK and SecurityToken to call cloud service APIs through KooCLI is similar to using a permanent AK/SK. If both an AK/SK (cli-access-key/cli-secret-key) and SecurityToken (cli-security-token) are passed in the command, the AK/SK is considered temporary.
    • If a global service is to be accessed, the ID (cli-domain-id) of the account used to create the IAM user is also required for authentication. If the ID is not passed to the command, KooCLI automatically obtains it based on the user authentication information. However, if the cli-access-key or cli-secret-key parameter is missing or the cli-domain-id parameter fails to be automatically obtained, the following error message is displayed:
      • [USE_ERROR] Parameters cli-access-key,cli-secret-key must be specified at the same time.
      • [USE_ERROR] cli-domain-id is required for access to global services using AK/SK. Add this parameter or run `hcloud configure set` to configure it.
    • If a temporary AK/SK, SecurityToken, and profile (cli-profile) are specified in a command, the AK/SK and SecurityToken are preferentially used for authentication.

• Using an account in non-configuration mode
  • When cloud service APIs are called using a username and password, enter the username (cli-username), password (cli-password), and account name (cli-domain) of the IAM user in commands for authentication. Otherwise, the following error message is displayed:

    [USE_ERROR]Parameters cli-username,cli-password,cli-domain must be specified at the same time.

  • If both a username/password and a profile (cli-profile) are specified in a command, the username and password are preferentially used for authentication.
• Using a token in non-configuration mode
  • When you use a token to call a cloud service API with a command prompt tool (such as cmd.exe), the command line may be incomplete if the value of cli-x-auth-token is too long. Therefore, check whether the command line content is complete before executing the command.
  • If both cli-x-auth-token and cli-profile are specified in a command, cli-x-auth-token is preferentially used for authentication.
• Using an ECS agency in non-configuration mode
  • This authentication mode applies only when you use KooCLI on an ECS.
  • To use this mode, create a cloud service agency to delegate ECS to use the CLI on the IAM console, and add the agency in the Management Information > Agency area of the ECS details page. For details, see Cloud Service Delegation.
• Using an agency in non-configuration mode
  • In this authentication mode, the AK/SK, account, or token of the delegated party can be used for authentication.
  • To use this authentication mode, the delegating party must create an agency for the delegated party. If you are the delegating party, create an agency on the IAM console by referring to Account Delegation.

In addition to the preceding precautions, avoid using AK/SK, account, and token authentication parameters interchangeably in the same command. Otherwise, the following error message is displayed:

[USE_ERROR] Specify authentication parameters for only one of [AKSK|Account|Token] in the command.

In the preceding error message, AKSK indicates that the command contains cli-access-key, cli-secret-key, and cli-security-token; Account indicates that the command contains cli-username, cli-password, and cli-domain; Token indicates that the command contains cli-x-auth-token.