rancher v2.15.1

ETCDSnapshot.snapshotFile

SnapshotFile holds metadata about the snapshot file produced by this snapshot operation.

9 fields
ETCDSnapshot.snapshotFile fields and descriptions
Field / TypeDescription
createdAt
string

CreatedAt is the timestamp when the snapshot was created.

  • format: date-time
location
string

Location is the absolute file:// or s3:// URI address of the snapshot.

message
string

Message is a string detailing the encountered error during snapshot creation if specified.

metadata
string

Metadata contains a base64-encoded, gzipped snapshot of the cluster spec at the time the snapshot was taken.

name
string

Name is the full snapshot name. It consists of the cluster name prefix, followed by the base snapshot identifier and ends with an optional storage suffix (e.g. "s3"). The typical format is: <cluster>-etcd-snapshot-<cluster>-<nodepool>-<uniqueid>-<timestamp>[-<storage-type>] The base snapshot identifier follows: etcd-snapshot-<cluster>-<nodepool>-<uniqueid>-<timestamp>

nodeName
string

NodeName is the name of the downstream node where the snapshot was created.

object

S3 holds metadata about the S3 destination if the snapshot is stored remotely. If nil, the snapshot is assumed to be stored locally and associated with the owning CAPI machine.

size
integer

Size is the size of the snapshot file in bytes.

  • format: int64
status
string

Status represents the current state of the snapshot, such as "successful" or "failed".