Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Интерфейс командной строки
  • Начало работы с CLI
  • Пошаговые инструкции
    • Все инструкции
    • Установка CLI
    • Аутентификация
      • Аутентификация от имени пользователя
      • Аутентификация от имени сервисного аккаунта
      • Аутентификация от имени федеративного пользователя
    • Управление профилем
      • Создание профиля
      • Управление параметрами профиля
      • Получение информации о профиле
      • Активация профиля
      • Удаление профиля
  • Концепции
    • Запуск команд
    • Конфигурация CLI
    • Синхронный и асинхронный режимы выполнения команд
  • Релизы CLI
  • Решение проблем
  • Справочник CLI (англ.)
    • Overview
    • CLI manage
      • init
      • version
      • help
      • config
        • Overview
        • profile
          • Overview
          • activate
          • delete
          • create
          • list
          • get
        • unset
        • set
        • get
        • list
      • components
        • Overview
        • restore
        • update
    • Operations manage
      • Overview
      • get
      • wait
    • Service manage
      • load-balancer
        • Overview
        • target-group
          • Overview
          • list-operations
          • remove-targets
          • add-targets
          • delete
          • update
          • create
          • list
          • get
        • network-load-balancer
          • Overview
          • target-states
          • detach-target-group
          • attach-target-group
          • stop
          • start
          • delete
          • update
          • create
          • list
          • get
          • add-listener
          • list-operations
          • remove-listener
      • managed-mongodb
        • Overview
        • database
          • Overview
          • delete
          • create
          • list
          • get
        • user
          • Overview
          • revoke-permission
          • grant-permission
          • delete
          • update
          • create
          • list
          • get
        • backup
          • Overview
          • list
          • get
        • resource-preset
          • Overview
          • list
          • get
        • shards
          • Overview
          • delete
          • add
          • list
          • get
        • cluster
          • Overview
          • enable-sharding
          • stop
          • move
          • list-operations
          • start
          • list-logs
          • list-backups
          • backup
          • delete
          • remove-labels
          • reschedule-maintenance
          • add-labels
          • update-config
          • update
          • restore
          • create
          • list
          • get
        • hosts
          • Overview
          • stepdown
          • restart
          • delete
          • add
          • list
          • resetup
      • managed-mysql
        • Overview
        • hosts
          • Overview
          • delete
          • update
          • add
          • list
        • database
          • Overview
          • delete
          • create
          • list
          • get
        • user
          • Overview
          • revoke-permission
          • grant-permission
          • delete
          • update
          • create
          • list
          • get
        • backup
          • Overview
          • list
          • get
        • resource-preset
          • Overview
          • list
          • get
        • cluster
          • Overview
          • restore
          • create
          • list
          • get
          • start-failover
          • list-operations
          • stop
          • start
          • list-logs
          • move
          • list-backups
          • backup
          • delete
          • update-config
          • remove-labels
          • add-labels
          • update
          • reschedule-maintenance
      • managed-sqlserver
        • Overview
        • host
          • Overview
          • list
        • database
          • Overview
          • delete
          • backup-import
          • backup-export
          • restore
          • create
          • list
          • get
        • user
          • Overview
          • revoke-permission
          • grant-permission
          • delete
          • update
          • create
          • list
          • get
        • backup
          • Overview
          • list
          • get
        • resource-preset
          • Overview
          • list
          • get
        • cluster
          • Overview
          • delete
          • remove-labels
          • add-labels
          • update-config
          • update
          • start-failover
          • restore
          • create
          • list
          • get
          • stop
          • start
          • list-operations
          • list-backups
          • backup
      • managed-redis
        • Overview
        • cluster
          • Overview
          • stop
          • start
          • move
          • list-operations
          • list-logs
          • list-backups
          • backup
          • rebalance
          • delete
          • remove-labels
          • add-labels
          • update-config
          • update
          • reschedule-maintenance
          • start-failover
          • restore
          • create
          • get
          • list
        • hosts
          • Overview
          • delete
          • add
          • list
        • backup
          • Overview
          • list
          • get
        • resource-preset
          • Overview
          • list
          • get
        • shards
          • Overview
          • delete
          • add
          • list
          • get
      • managed-postgresql
        • Overview
        • hosts
          • Overview
          • update-config
          • delete
          • update
          • add
          • list
        • database
          • Overview
          • delete
          • update
          • create
          • list
          • get
        • user
          • Overview
          • revoke-permission
          • grant-permission
          • delete
          • update
          • create
          • list
          • get
        • backup
          • Overview
          • list
          • get
        • resource-preset
          • Overview
          • list
          • get
        • cluster
          • Overview
          • move
          • list-operations
          • list-logs
          • list-backups
          • backup
          • delete
          • remove-labels
          • add-labels
          • update-config
          • update
          • reschedule-maintenance
          • start-failover
          • restore
          • create
          • list
          • get
          • start
          • stop
      • managed-kafka
        • Overview
        • cluster
          • Overview
          • update
          • reschedule-maintenance
          • move
          • create
          • stop
          • start
          • list-logs
          • list-hosts
          • list-operations
          • delete
          • list
          • get
        • topic
          • Overview
          • delete
          • update
          • create
          • list
          • get
        • user
          • Overview
          • delete
          • update
          • create
          • list
          • get
      • managed-elasticsearch
        • Overview
        • backup
          • Overview
          • list
          • get
        • extension
          • Overview
          • update
          • delete
          • create
          • list
          • get
        • resource-preset
          • Overview
          • list
          • get
        • cluster
          • Overview
          • reschedule-maintenance
          • remove-labels
          • add-labels
          • stop
          • update-config
          • update
          • start
          • list-operations
          • list-logs
          • list-backups
          • backup
          • delete
          • restore
          • create
          • list
          • get
        • hosts
          • Overview
          • add
          • list
          • delete
      • vpc
        • Overview
        • subnet
          • Overview
          • move
          • list-used-addresses
          • list-operations
          • delete
          • remove-labels
          • add-labels
          • remove-range
          • add-range
          • update
          • create
          • list
          • get
        • address
          • Overview
          • move
          • list-operations
          • delete
          • update
          • create
          • list
          • get
        • network
          • Overview
          • move
          • list-route-tables
          • list-operations
          • list-security-groups
          • list-subnets
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
        • route-table
          • Overview
          • move
          • list-operations
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
        • security-group
          • Overview
          • list
          • update-rule-meta
          • update-rules
          • move
          • list-operations
          • delete
          • remove-labels
          • add-labels
          • update
          • get
          • create
      • dns
        • Overview
        • bind-file
          • Overview
          • migrate-to-terraform
        • zone
          • Overview
          • add-labels
          • replace-records
          • delete-records
          • add-records
          • list-records
          • delete
          • update
          • get
          • create
          • list
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list-operations
          • remove-labels
      • kms
        • Overview
        • symmetric-key
          • Overview
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list-operations
          • rotate
          • cancel-version-destruction
          • schedule-version-destruction
          • set-primary-version
          • delete
          • update
          • create
          • list-versions
          • list
          • get
        • symmetric-crypto
          • Overview
          • re-encrypt
          • generate-data-key
          • decrypt
          • encrypt
      • ydb
        • Overview
        • storage-type
          • Overview
          • list
          • get
        • resource-preset
          • Overview
          • list
          • get
        • backup
          • Overview
          • set-access-bindings
          • remove-access-binding
          • add-access-binding
          • list-access-bindings
          • delete
          • list
          • get
        • database
          • Overview
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • remove-labels
          • add-labels
          • delete
          • start
          • stop
          • update
          • restore
          • backup
          • create
          • list
          • get
      • certificate-manager
        • Overview
        • certificate
          • Overview
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list-operations
          • delete
          • update
          • request
          • create
          • list
          • content
          • get
      • cdn
        • Overview
        • provider
          • Overview
          • activate
          • list-activated
        • cache
          • Overview
          • prefetch
          • purge
        • origin-group
          • Overview
          • update
          • create
          • list
          • get
          • delete
        • resource
          • Overview
          • delete
          • get-provider-cname
          • update
          • create
          • list
          • get
        • origin
          • Overview
          • delete
          • update
          • create
          • list
          • get
      • resource-manager
        • Overview
        • cloud
          • Overview
          • list-operations
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • update
          • list
          • get
        • folder
          • Overview
          • list-operations
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
      • managed-clickhouse
        • Overview
        • hosts
          • Overview
          • delete
          • update
          • add
          • list
        • cluster
          • Overview
          • reschedule-maintenance
          • restore
          • create
          • list
          • get
          • stop
          • start
          • move
          • remove-graphite-rollup
          • add-graphite-rollup
          • remove-external-dictionary
          • add-external-dictionary
          • set-compression
          • clear-compression
          • list-operations
          • list-logs
          • list-backups
          • backup
          • add-zookeeper
          • delete
          • remove-labels
          • add-labels
          • update-config
          • update
        • shards
          • Overview
          • delete
          • update-config
          • update
          • add
          • list
          • get
        • backup
          • Overview
          • list
          • get
        • resource-preset
          • Overview
          • list
          • get
        • ml-model
          • Overview
          • delete
          • update
          • create
          • list
          • get
        • format-schema
          • Overview
          • delete
          • update
          • create
          • list
          • get
        • version
          • Overview
          • list
        • database
          • Overview
          • delete
          • create
          • list
          • get
        • user
          • Overview
          • update
          • create
          • list
          • get
          • remove-quota
          • update-quota
          • add-quota
          • revoke-permission
          • grant-permission
          • delete
        • shard-groups
          • Overview
          • delete
          • list
          • get
          • update
          • create
      • dataproc
        • Overview
        • subcluster
          • Overview
          • delete
          • update
          • create
          • list
          • get
        • cluster
          • Overview
          • list-operations
          • list-ui-links
          • list-hosts
          • stop
          • start
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
        • job
          • Overview
          • cancel
          • create-hive
          • create-mapreduce
          • create-pyspark
          • create-spark
          • get
          • log
          • list
        • resource-preset
          • Overview
          • list
          • get
      • application-load-balancer
        • Overview
        • backend-group
          • Overview
          • delete-stream-backend
          • update-stream-backend
          • add-stream-backend
          • delete-grpc-backend
          • update-grpc-backend
          • add-grpc-backend
          • delete-http-backend
          • add-http-backend
          • update-http-backend
          • delete
          • update
          • create
          • list
          • get
        • http-router
          • Overview
          • delete
          • update
          • create
          • list
          • get
        • virtual-host
          • Overview
          • update-grpc-route
          • insert-grpc-route
          • remove-grpc-route
          • prepend-grpc-route
          • append-grpc-route
          • update-http-route
          • insert-http-route
          • remove-http-route
          • prepend-http-route
          • append-http-route
          • delete
          • update
          • create
          • list
          • get
        • target-group
          • Overview
          • get
          • remove-targets
          • add-targets
          • delete
          • update
          • create
          • list
        • load-balancer
          • Overview
          • create
          • list
          • get
          • target-states
          • remove-location
          • add-location
          • enable-traffic
          • disable-traffic
          • list-operations
          • update-stream-sni
          • update-sni
          • add-stream-sni
          • add-sni
          • remove-sni
          • remove-listener
          • update-stream-listener
          • update-listener
          • add-stream-listener
          • add-listener
          • delete
          • stop
          • start
          • update
      • cloud-desktop
        • Overview
        • desktop
          • Overview
          • reset-password
          • delete
          • create
          • list-operations
          • get-rdp-file
          • list
          • get
        • group
          • Overview
          • remove-access-bindings
          • add-access-bindings
          • set-access-bindings
          • list-access-bindings
          • delete
          • create
          • list-operations
          • list-desktops
          • list
          • get
      • lockbox
        • Overview
        • payload
          • Overview
          • get
        • secret
          • Overview
          • delete
          • add-version
          • update
          • create
          • list-versions
          • list
          • get
          • activate
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list-operations
          • cancel-version-destruction
          • schedule-version-destruction
          • deactivate
      • managed-kubernetes
        • Overview
        • cluster
          • Overview
          • list-nodes
          • list-operations
          • list-node-groups
          • start
          • stop
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
          • get-credentials
        • node-group
          • Overview
          • list-nodes
          • list-operations
          • delete
          • remove-node-labels
          • add-node-labels
          • remove-labels
          • add-labels
          • add-metadata
          • remove-metadata
          • update
          • create
          • list
          • get
        • list-versions
        • create-token
      • compute
        • Overview
        • placement-group
          • Overview
          • list-operations
          • list-instances
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
        • host-type
          • Overview
          • list
          • get
        • host-group
          • Overview
          • list-operations
          • remove-labels
          • list-instances
          • list-hosts
          • delete
          • add-labels
          • update
          • list
          • create
          • get
        • disk-placement-group
          • Overview
          • list-operations
          • list-disks
          • remove-labels
          • delete
          • add-labels
          • update
          • create
          • list
          • get
        • filesystem
          • Overview
          • update
          • delete
          • create
          • list-operations
          • list
          • get
          • resize
          • remove-labels
          • add-labels
        • disk
          • Overview
          • list-operations
          • move
          • delete
          • resize
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
        • disk-type
          • Overview
          • list
          • get
        • image
          • Overview
          • list-operations
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • get-latest-from-family
          • list
          • get
        • snapshot
          • Overview
          • list-operations
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
        • zone
          • Overview
          • list
          • get
        • instance-group
          • Overview
          • remove-labels
          • add-labels
          • remove-metadata
          • add-metadata
          • start
          • stop
          • update
          • create
          • list
          • get
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list-logs
          • list-operations
          • delete-instances
          • stop-instances
          • list-instances
          • delete
        • instance
          • Overview
          • list
          • get
          • list-operations
          • move
          • remove-one-to-one-nat
          • add-one-to-one-nat
          • update-network-interface
          • detach-filesystem
          • attach-filesystem
          • detach-disk
          • attach-new-disk
          • attach-disk
          • restart
          • start
          • stop
          • get-serial-port-output
          • delete
          • remove-labels
          • add-labels
          • remove-metadata
          • add-metadata
          • update-container
          • update
          • create-with-container
          • create
        • connect-to-serial-port
      • container
        • Overview
        • registry
          • Overview
          • configure-docker
          • remove-ip-permissions
          • add-ip-permissions
          • set-ip-permissions
          • list-ip-permissions
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
        • image
          • Overview
          • get
          • list-vulnerabilities
          • list-scan-results
          • get-last-scan-result
          • get-scan-result
          • scan
          • delete
          • list
        • cluster
          • Overview
          • list-nodes
          • list-operations
          • list-node-groups
          • remove-labels
          • start
          • stop
          • delete
          • add-labels
          • update
          • create
          • list
          • get
          • get-credentials
        • node-group
          • Overview
          • update
          • create
          • list
          • get
          • list-nodes
          • list-operations
          • delete
          • remove-node-labels
          • add-node-labels
          • remove-labels
          • add-labels
          • remove-metadata
          • add-metadata
        • repository
          • Overview
          • lifecycle-policy
            • Overview
            • list-dry-run-affected-images
            • get-dry-run-result
            • list-dry-run-results
            • dry-run
            • delete
            • update
            • create
            • list
            • get
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list
          • get
      • iam
        • Overview
        • federation
          • Overview
          • list-operations
          • list-user-accounts
          • add-user-accounts
          • delete
          • update
          • create
          • list
          • get
        • key
          • Overview
          • delete
          • create
          • list
          • get
        • access-key
          • Overview
          • delete
          • create
          • list
          • get
        • api-key
          • Overview
          • delete
          • list
          • create
          • get
        • user-account
          • Overview
          • get
        • role
          • Overview
          • list
          • get
        • service-account
          • Overview
          • list-operations
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • delete
          • update
          • create
          • list
          • get
        • certificate
          • Overview
          • update
          • create
          • list
          • get
          • list-operations
          • delete
        • create-token
      • logging
        • Overview
        • group
          • Overview
          • list-operations
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list-resources
          • stats
          • delete
          • update
          • create
          • list
          • get
        • read
        • write
      • datatransfer
        • Overview
        • transfer
          • Overview
          • deactivate
          • activate
          • list
          • get
          • delete
          • update
          • create
        • endpoint
          • Overview
          • create
            • Overview
            • clickhouse-target
            • clickhouse-source
            • mongo-target
            • mongo-source
            • mysql-target
            • mysql-source
            • postgres-target
            • postgres-source
          • update
            • Overview
            • postgres-target
            • postgres-source
            • mysql-target
            • mysql-source
            • clickhouse-target
            • clickhouse-source
            • mongo-target
            • mongo-source
          • list
          • delete
          • get
      • serverless
        • Overview
        • api-gateway
          • Overview
          • remove-domain
          • add-domain
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list-operations
          • delete
          • update
          • create
          • get-spec
          • list
          • get
        • container
          • Overview
          • revision
            • Overview
            • deploy
            • get
            • list
          • deny-unauthenticated-invoke
          • allow-unauthenticated-invoke
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • list-operations
          • delete
          • remove-labels
          • add-labels
          • rollback
          • update
          • create
          • list
          • get
        • mdbproxy
          • Overview
          • update
            • Overview
            • clickhouse
            • postgresql
          • create
            • Overview
            • clickhouse
            • postgresql
          • list-operations
          • delete
          • remove-labels
          • add-labels
          • list
          • get
        • function
          • Overview
          • version
            • Overview
            • logs
            • get-by-tag
            • remove-tag
            • set-tag
            • create
            • get
            • list
          • runtime
            • Overview
            • list
          • set-access-bindings
          • list-access-bindings
          • invoke
          • logs
          • list-operations
          • tag-history
          • delete
          • remove-labels
          • add-labels
          • update
          • create
          • list
          • get
          • remove-scaling-policy
          • set-scaling-policy
          • list-scaling-policies
          • deny-unauthenticated-invoke
          • allow-unauthenticated-invoke
          • remove-access-binding
          • add-access-binding
        • trigger
          • Overview
          • create
            • Overview
            • billing-budget
            • logging
            • cloud-logs
            • container-registry
            • object-storage
            • internet-of-things
            • message-queue
            • timer
            • yds
          • delete
          • remove-labels
          • add-labels
          • update
          • list
          • get
          • pause
          • list-operations
          • resume
      • iot
        • Overview
        • mqtt
          • Overview
          • subscribe
          • publish
        • device
          • Overview
          • password
            • Overview
            • add
            • delete
            • list
          • certificate
            • Overview
            • delete
            • add
            • list
          • delete
          • remove-topic-aliases
          • add-topic-aliases
          • logs
          • update
          • create
          • list
          • get
        • registry
          • Overview
          • password
            • Overview
            • delete
            • add
            • list
          • certificate
            • Overview
            • add
            • list
            • delete
          • get
          • remove-labels
          • delete
          • add-labels
          • logs
          • update
          • create
          • list
          • list-device-topic-aliases
      • organization-manager
        • Overview
        • user
          • Overview
          • remove
          • list
        • organization
          • Overview
          • leave
          • list-operations
          • remove-access-binding
          • add-access-binding
          • set-access-bindings
          • list-access-bindings
          • update
          • list
          • get
        • federation
          • Overview
          • saml
            • Overview
            • certificate
              • Overview
              • get
              • list
              • create
              • update
              • list-operations
              • delete
            • get
            • create
            • list
            • update
            • delete
            • add-user-accounts
            • list-user-accounts
            • list-operations
  1. Начало работы с CLI

Начало работы с интерфейсом командной строки

Статья создана
Yandex.Cloud
,
улучшена
+1
  • Установка
  • Создание профиля
  • Примеры команд

Интерфейс командной строки Yandex Cloud (CLI) — скачиваемое программное обеспечение для управления вашими облачными ресурсами через командную строку.

Установка

Linux
macOS
Windows
  1. Выполните команду:

    curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bash
    

    Скрипт установит CLI и добавит путь до исполняемого файла в переменную окружения PATH.

    Примечание

    Скрипт дополнит переменную PATH только если его запустить в командных оболочках bash или zsh.

    Если вы запустили скрипт в другой оболочке, добавьте путь до CLI в переменную PATH самостоятельно.

  2. После завершения установки перезапустите командную оболочку.

  1. Выполните команду:

    curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bash
    

    Скрипт установит CLI и добавит путь до исполняемого файла в переменную окружения PATH.

  2. Перезапустите командную оболочку, чтобы перезагрузить переменные окружения.

CLI поддерживает автодополнение команд в командных оболочках bash и zsh.

Важно

Если вы используете macOS версии 10.14 Mojave или ниже, то вместо zsh-completion используйте пакет bash-completion и конфигурационный файл ~/.bash_profile.

Чтобы автодополнение заработало:

  1. Установите менеджер пакетов Homebrew.

  2. Установите пакет zsh-completion:

    brew install zsh-completion
    

    Скрипт установки автоматически дополнит файл ~/.zshrc:

    # The next line updates PATH for Yandex Cloud CLI.
    if [ -f '/Users/<username>/yandex-cloud/path.bash.inc' ]; then source '/Users/<username>/yandex-cloud/path.bash.inc'; fi
    # The next line enables shell command completion for yc.
    if [ -f '/Users/<username>/yandex-cloud/completion.zsh.inc' ]; then source '/Users/<username>/yandex-cloud/completion.zsh.inc'; fi
    

    Если вы используете macOS 10.14 Mojave либо более раннюю версию, здесь и далее вместо 'zsh-completion' используйте пакет bash-completion и конфигурационный файл ~/.bash_profile

  3. После завершения установки добавьте в файл ~/.zshrc следующие строки. Расположите их выше строк, автоматически добавленных скриптом установки.

    if [ -f $(brew --prefix)/etc/zsh_completion ]; then
    . $(brew --prefix)/etc/zsh_completion
    fi
    
  4. Перезапустите командную оболочку.

Для Windows CLI можно установить с помощью PowerShell и cmd:

  • Для установки с помощью PowerShell:

    1. Выполните команду:

      iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-yc/install.ps1')
      
    2. Скрипт установки спросит, нужно ли добавить путь до yc в переменную PATH:

      Add yc installation dir to your PATH? [Y/n]
      
    3. Введите Y. После этого CLI Yandex Cloud можно пользоваться, командную оболочку перезапускать не нужно.

  • Для установки с помощью cmd:

    1. Выполните команду:

      @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-yc/install.ps1'))" && SET "PATH=%PATH%;%USERPROFILE%\yandex-cloud\bin"
      
    2. Скрипт установки спросит, нужно ли добавить путь до yc в переменную PATH:

      Add yc installation dir to your PATH? [Y/n]
      
    3. Введите Y.

    4. Перезапустите командную оболочку, чтобы перезагрузить переменные окружения.

Создание профиля

Если вы еще не подключены к консоли управления, войдите в консоль и примите пользовательское соглашение (нажмите Войти).

От имени пользователя
От имени сервисного аккаунта
От имени федеративного пользователя

Чтобы аутентифицироваться от имени пользователя:

  1. Получите OAuth-токен в сервисе Яндекс.OAuth. Для этого перейдите по ссылке и нажмите Разрешить.

  2. Запустите команду yc init, чтобы выполнить настройку вашего профиля CLI.

  3. По запросу команды введите свой OAuth токен.

    Please go to https://oauth.yandex.ru/authorize?response_type=token&client_id=1a6990aa636648e9b2ef855fa7bec2fb
     in order to obtain OAuth token.
    
    Please enter OAuth token: AaAaBbBbCcCcDdDdEeEeFfFfGgGg
    
  4. Выберите одно из предложенных облаков, в которых у вас есть права доступа:

    Please select cloud to use:
     [1] cloud1 (id = aoe2bmdcvatao4frg22b)
     [2] cloud2 (id = dcvatao4faoe2bmrg22b)
    Please enter your numeric choice: 2
    

    Если вам доступно только одно облако, оно будет выбрано автоматически.

  5. Выберите каталог по умолчанию:

    Please choose a folder to use:
     [1] folder1 (id = cvatao4faoe2bmdrg22b)
     [2] folder2 (id = tao4faoe2cvabmdrg22b)
     [3] Create a new folder
    Please enter your numeric choice: 1
    
  6. Выберите зону доступности по умолчанию для сервиса Yandex Compute Cloud:

    Do you want to configure a default Yandex Compute Cloud availability zone? [Y/n] Y
    Which zone do you want to use as a profile default?
     [1] ru-central1-a
     [2] ru-central1-b
     [3] ru-central1-c
     [4] Don't set default zone
    Please enter your numeric choice: 2
    
  7. Проверьте настройки вашего профиля CLI:

    yc config list
    

Перед началом работы подготовьте сервисный аккаунт:

  1. Аутентифицируйтесь в CLI как пользователь.
  2. Если у вас еще нет сервисного аккаунта, создайте его и настройте права доступа для него.

Чтобы аутентифицироваться от имени сервисного аккаунта:

  1. Получите список сервисных аккаунтов, которые существуют в вашем облаке:

    yc iam service-account --folder-id <ID каталога> list
    +----------------------+------------+
    |          ID          |    NAME    |
    +----------------------+------------+
    | aje3932acd0c5ur7dagp | default-sa |
    +----------------------+------------+
    
  2. Создайте авторизованный ключ для сервисного аккаунта и сохраните его в файл key.json:

    yc iam key create --service-account-name default-sa --output key.json
    id: aje83v701b1un777sh40
    service_account_id: aje3932acd0c5ur7dagp
    created_at: "2019-08-26T12:31:25Z"
    key_algorithm: RSA_2048
    
  3. Добавьте авторизованный ключ сервисного аккаунта в профиль CLI.

    1. Создайте новый профиль CLI:

      yc config profile create sa-profile
      
    2. Добавьте авторизованный ключ:

      yc config set service-account-key key.json
      
  4. Проверьте, что параметры для сервисного аккаунта добавлены верно:

    yc config list
    service-account-key:
      id: aje83v701b1un777sh40
      service_account_id: aje3932acd0c5ur7dagp
      created_at: "2019-08-26T12:31:25Z"
      key_algorithm: RSA_2048
      public_key: |
        -----BEGIN PUBLIC KEY-----
        MIIBIjANBg...
        -----END PUBLIC KEY-----
      private_key: |
        -----BEGIN PRIVATE KEY-----
        MIIEvwIBAD...
        -----END PRIVATE KEY-----
    
  5. Настройте профиль для запуска команд.

    Для некоторых команд требуется указание уникального идентификатора облака и каталога. Вы можете указать информацию о них в профиле или запускать такие команды с соответствующим флагом.

    1. Укажите облако в профиле:

      yc config set cloud-id <ID облака>
      

      Или запускайте команды с параметром --cloud-id.

    2. Укажите каталог в профиле:

      yc config set folder-id <ID каталога>
      

      Или запускайте команды с параметром --folder-id.

    Все операции в этом профиле будут выполняться от имени привязанного сервисного аккаунта. Вы можете изменить параметры профиля или сменить его.

Чтобы аутентифицироваться с помощью SAML-совместимой федерации удостоверений:

  1. Узнайте идентификатор федерации у вашего администратора.

  2. Запустите интерактивное создание профиля:

    yc init --federation-id=<ID федерации>
    
  3. Выберите профиль, для которого вы хотите настроить аутентификацию, или создайте новый.

    Welcome! This command will take you through the configuration process.
    Pick desired action:
    [1] Re-initialize this profile 'default' with new settings
    [2] Create a new profile
    
  4. CLI выведет сообщение о продолжении аутентификации в браузере. Для продолжения нажмите клавишу Enter.

    You are going to be authenticated via federation-id 'aje1f0hsgds3aas2f6ai2'.
    Your federation authentication web site will be opened.
    After your successful authentication, you will be redirected to 'https://console.cloud.yandex.ru'.
    
    Press 'enter' to continue...
    

    После успешной аутентификации на сервере федерации в профиле сохранится IAM-токен. При каждой операции аутентификация будет происходить с помощью этого токена, пока не истечет время жизни токена. После этого CLI снова выведет сообщение о необходимости пройти аутентификацию в браузере.

  5. Вернитесь в интерфейс командной строки, чтобы завершить создание профиля.

  6. Выберите одно из предложенных облаков, в которых у вас есть права доступа:

    Please select cloud to use:
     [1] cloud1 (id = aoe2bmdcvatao4frg22b)
     [2] cloud2 (id = dcvatao4faoe2bmrg22b)
    Please enter your numeric choice: 2
    

    Если вам доступно только одно облако, оно будет выбрано автоматически.

  7. Выберите каталог по умолчанию:

    Please choose a folder to use:
     [1] folder1 (id = cvatao4faoe2bmdrg22b)
     [2] folder2 (id = tao4faoe2cvabmdrg22b)
     [3] Create a new folder
    Please enter your numeric choice: 1
    
  8. Выберите зону доступности по умолчанию для сервиса Yandex Compute Cloud:

    Do you want to configure a default Yandex Compute Cloud availability zone? [Y/n] Y
    Which zone do you want to use as a profile default?
     [1] ru-central1-a
     [2] ru-central1-b
     [3] ru-central1-c
     [4] Don't set default zone
    Please enter your numeric choice: 2
    
  9. Проверьте настройки вашего профиля CLI:

    yc config list
    federation-id: aje1f0hs6ojais2f6ai2
    ...
    

Примеры команд

Ниже описана последовательность действий для создания облачной сети, подсети и виртуальной машины, подключенной к этой подсети.

  1. Посмотрите описание команд CLI для работы с облачными сетями:
    yc vpc network --help
    
  2. Создайте облачную сеть в каталоге, указанном в вашем профиле CLI:
    yc vpc network create \
        --name my-yc-network \
        --labels my-label=my-value \
        --description "my first network via yc"
    
  3. Создайте подсеть в облачной сети my-yc-network:
    yc vpc subnet create \
        --name my-yc-subnet-b \
        --zone ru-central1-b \
        --range 10.1.2.0/24 \
        --network-name my-yc-network \
        --description "my first subnet via yc"
    
  4. Получите список всех облачных сетей в каталоге, указанном в вашем профиле CLI:
    yc vpc network list
    
    +----------------------+------------------+-------------------------+
    |          ID          |       NAME       |       DESCRIPTION       |
    +----------------------+------------------+-------------------------+
    | skesdqhkc6449hbqqar1 | my-ui-network    | my first network via ui |
    | c6449hbqqar1skesdqhk | my-yc-network    | my first network via yc |
    +----------------------+------------------+-------------------------+
    
    Получите тот же список c большим количеством деталей в формате YAML:
    yc vpc network list --format yaml
    
    - id: skesdqhkc6449hbqqar1
      folder_id: ijkl9012
      created_at: "2018-09-05T09:51:16Z"
      name: my-ui-network
      description: "my first network via ui"
      labels: {}
    - id: c6449hbqqar1skesdqhk
      folder_id: ijkl9012
      created_at: "2018-09-05T09:55:36Z"
      name: my-yc-network
      description: "my first network via yc"
      labels:
        my-label: my-value
    
  5. Создайте виртуальную машину и подключите к подсети my-yc-subnet-b:
    1. Подготовьте пару ключей (открытый и закрытый) для SSH-доступа на виртуальную машину.
    2. Создайте виртуальную машину Linux:
      yc compute instance create \
          --name my-yc-instance \
          --network-interface subnet-name=my-yc-subnet-b,nat-ip-version=ipv4 \
          --zone ru-central1-b \
          --ssh-key ~/.ssh/id_rsa.pub
      
      В параметре ssh-key передайте путь к открытому ключу для SSH-доступа. В ОС виртуальной машины будет автоматически создан пользователь yc-user с указанным открытым ключом.
  6. Подключитесь к виртуальной машине по SSH:
    1. Узнайте публичный IP-адрес виртуальной машины. Для этого посмотрите подробную информацию о вашей виртуальной машине:
      yc compute instance get my-yc-instance
      
      В выводе команды найдите адрес виртуальной машины в блоке one_to_one_nat:
      one_to_one_nat:
          address: 130.193.32.90
          ip_version: IPV4
      
    2. Подключитесь к виртуальной машине по SSH от имени пользователя yc-user, используя закрытый ключ:
      ssh yc-user@130.193.32.90
      
  7. Удалите виртуальную машину my-yc-instance, подсеть my-yc-subnet-b и сеть my-yc-network:
    yc compute instance delete my-yc-instance
    yc vpc subnet delete my-yc-subnet-b
    yc vpc network delete my-yc-network
    

Была ли статья полезна?

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • Установка
  • Создание профиля
  • Примеры команд