Запуск команд
Команды CLI разделены на группы, каждая из которых соответствует сервису или компоненту Yandex Cloud.
Примечание
Чтобы вызвать справку для какой-либо команды, укажите глобальный флаг --help.
Команды выполняются после прохождения аутентификации. После этого токен сохраняется в файловой системе. Вы также можете получать токен из переменной среды окружения YC_IAM_TOKEN вне зависимости от того, есть ли у вас сохраненный токен.
Управление конфигурацией CLI
Задать или изменить значения конфигурационных параметров CLI перед выполнением команды можно с помощью:
-
Профилей — в них сохраняется значение параметра (или набора параметров) и используется при запуске каждой команды.
Вы можете создать несколько профилей и переключаться между ними по необходимости или единоразово вызвать команду с набором параметров из другого профиля, указав глобальный параметр
--profile.Подробнее об управлении профилями читайте в пошаговых инструкциях.
-
Глобальных параметров — они определяют свойства только на один раз при вызове команды.
Глобальные параметры доступны для любой команды на любом уровне вложенности, но не все команды их обрабатывают. Например, если ресурс определяется только идентификатором, то параметры облака и каталога игнорируются.
Полный список доступных конфигурационных параметров описан в разделе Конфигурация CLI.
Синхронность выполнения команд
Выполнение некоторых команд занимает длительное время. В таком случае можно управлять синхронностью вызова команд.
Пока выполняется команда, в синхронном режиме CLI выводит точки, а в асинхронном сразу выдает информацию об операции. Подробнее о синхронности читайте в разделе Синхронный и асинхронный режимы выполнения команд.
Подключение к прокси-серверу
CLI может отправлять запросы к Yandex Cloud через прокси-сервер. Для этого необходимо создать переменную окружения HTTPS_PROXY, из которой CLI возьмет параметры для подключения. В переменной укажите:
- логин и пароль, если для подключения требуется аутентификация;
- доменное имя или IP-адрес прокси-сервера;
- порт для установки соединения.
Примечание
Если в пароле содержатся спецсимволы, замените их на шестнадцатеричные коды ASCII. Например, если в пароле есть символ @, используйте %40.
Чтобы создать переменную окружения HTTPS_PROXY, выполните команду:
export HTTPS_PROXY="https://user:password@hostname:port"
Чтобы отключить передачу трафика через прокси-сервер, удалите содержимое переменной HTTPS_PROXY:
unset HTTPS_PROXY
Чтобы создать переменную окружения HTTPS_PROXY, выполните команду:
$Env:HTTPS_PROXY = "https://user:password@hostname:port"
Чтобы отключить передачу трафика через прокси-сервер, перезапустите оболочку или удалите содержимое переменной HTTPS_PROXY с помощью команды:
$Env:HTTPS_PROXY = ""
Чтобы создать переменную окружения HTTPS_PROXY, выполните команду:
set HTTPS_PROXY=https://user:password@hostname:port
Чтобы отключить передачу трафика через прокси-сервер, перезапустите оболочку или удалите содержимое переменной HTTPS_PROXY с помощью команды:
set HTTPS_PROXY=