Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Cloud Backup
  • Getting started
    • All guides
    • Activating the service
    • Viewing service resource operations
    • Limiting RAM usage by the Cloud Backup agent
    • Viewing backup statistics
  • Access management
  • Pricing policy
    • Overview
      • Overview
      • debug-info
      • install
      • reinstall
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • Troubleshooting
  1. CLI reference
  2. agent
  3. install

yc backup agent install

Written by
Yandex Cloud
Updated at December 2, 2024

Installs backup agent on instance. Attention! This command could be executed only on instances with oslogin support. Supported os families are: ubuntu, centos, debian, redos. This command will execute ssh connection on given instance, install needed packages, download agent installer script and launch downloaded agent installer script.

Command UsageCommand Usage

Syntax:

yc backup agent install [Flags...] [Global Flags...]

FlagsFlags

Flag Description
--id string
Target instance id
--name string
Target instance name
--login string
Specifies the user to log in as on the remote machine. If not specified the certificate is issued to a default OS Login profile.
--internal-address Connect to instance via internal address.
--public-address Connect to instance via public address.
-i,--identity-file string
Selects a file from which the identity (private key) for public key authentication is read. If not specified a new ssh certificate is issued.
--policy-ids value[,value]
Policy ids to attach to specified instance after agent installation. Note: policy attachment on new instance is async operation and it may take few minutes.

Global FlagsGlobal Flags

Flag Description
--profile string
Set the custom configuration file.
--debug Debug logging.
--debug-grpc Debug gRPC logging. Very verbose, used for debugging connection problems.
--no-user-output Disable printing user intended output to stderr.
--retry int
Enable gRPC retries. By default, retries are enabled with maximum 5 attempts.
Pass 0 to disable retries. Pass any negative value for infinite retries.
Even infinite retries are capped with 2 minutes timeout.
--cloud-id string
Set the ID of the cloud to use.
--folder-id string
Set the ID of the folder to use.
--folder-name string
Set the name of the folder to use (will be resolved to id).
--endpoint string
Set the Cloud API endpoint (host:port).
--token string
Set the OAuth token to use.
--impersonate-service-account-id string
Set the ID of the service account to impersonate.
--no-browser Disable opening browser for authentication.
--format string
Set the output format: text (default), yaml, json, json-rest.
--jq string
Query to select values from the response using jq syntax
-h,--help Display help for the command.

Was the article helpful?

Previous
debug-info
Next
reinstall
Yandex project
© 2025 Yandex.Cloud LLC