open-consul/website/content/docs/enterprise/backups.mdx

40 lines
1.7 KiB
Plaintext
Raw Normal View History

---
2020-04-07 18:55:19 +00:00
layout: docs
page_title: Consul Enterprise Automated Backups
sidebar_title: Automated Backups
2020-04-07 18:55:19 +00:00
description: >-
Consul Enterprise provides a highly available service that manages taking
snapshots, rotation and sending backup files offsite to Amazon S3 (or
S3-compatible endpoints), Google Cloud Storage, or Azure Blob Storage.
---
updating enterprise documentation with additional clarity Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> updating capitalization of namespaces
2020-03-24 20:06:20 +00:00
# Automated Backups
<EnterpriseAlert>
2020-07-08 23:09:00 +00:00
This feature is available in all versions of{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>.
</EnterpriseAlert>
Consul Enterprise enables you to run
updating enterprise documentation with additional clarity Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> updating capitalization of namespaces
2020-03-24 20:06:20 +00:00
the snapshot agent within your environment as a service (Systemd as an example)
2020-04-06 20:27:35 +00:00
or scheduled through other means. Once running, the snapshot agent service operates as a highly
available process that integrates with the snapshot API to automatically manage
taking snapshots, backup rotation, and sending backup files offsite to Amazon S3
updating enterprise documentation with additional clarity Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> updating capitalization of namespaces
2020-03-24 20:06:20 +00:00
(or another S3-compatible endpoint), Google Cloud Storage, or Azure Blob Storage.
2020-04-06 20:27:35 +00:00
This capability provides an enterprise solution for backup and restoring the state of Consul servers
within an environment in an automated manner. These snapshots are atomic and point-in-time. Consul
datacenter backups include (but are not limited to):
updating enterprise documentation with additional clarity Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> updating capitalization of namespaces
2020-03-24 20:06:20 +00:00
- Key/Value Store Entries
2020-04-06 20:27:35 +00:00
- Service Catalog Registrations
- Prepared Queries
updating enterprise documentation with additional clarity Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/backups/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/namespaces/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/upgrades/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/network-segments/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/read-scale/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> Update website/source/docs/enterprise/redundancy/index.html.md Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com> updating capitalization of namespaces
2020-03-24 20:06:20 +00:00
- Sessions
- Access Control Lists (ACLs)
- Namespaces
2020-04-06 20:27:35 +00:00
For more experience leveraging Consul's snapshot functionality, we suggest you look through our HashiCorp
Learn tutorial for [Datacenter Backups in Consul](https://learn.hashicorp.com/tutorials/consul/backup-and-restore).
2020-04-06 20:27:35 +00:00
For detailed configuration information on configuring the Consul Enterprise's snapshot agent, review the
[Consul Snapshot Agent documentation](/commands/snapshot/agent).