Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ECLAT-LSSNAP(1)		     Eclat User	Reference	       ECLAT-LSSNAP(1)

NAME
       eclat-lssnap, eclat-describe-snapshots -	describes available Amazon EBS
       snapshots

SYNOPSIS
       eclat lssnap [-r	ID] [-u	ID] [--restorable-by ID] [--owner NAME]
       [SNAPSHOT-ID...]	[FILTER...]

       eclat lssnap --help

DESCRIPTION
       This  command  lists  the Amazon	EBS snapshots available	to you.	 These
       include public snapshots	available to any  AWS  account,	 your  private
       snapshots  and  private	snapshots  owned  by  others for which you are
       granted permissions.

       The list	of returned snapshots can be abridged using command  line  op-
       tions, filters and arguments.

       Filters are any arguments that have the key=value structure.  When fil-
       ters are	supplied, only those snapshots that match them	are  returned.
       Multiple	 filters are joined using logical AND.	 Multiple values sepa-
       rated by	commas can be specified	for a given key, in which case a logi-
       cal  OR	is  implied.  See the section FILTERS below for	a detailed de-
       scription of available filters.

       Any command line	argument that is not an	option or filter is treated as
       snapshot	 ID  (or  snapshot  name, if ID	mapping	is enabled) to return.
       Any number of IDs can be	specified.  If ID mapping is enabled (see  the
       section	MAPS  in  eclat(1)),  this  command uses the SnapshotId	map to
       translate snapshot names	to the corresponding identifiers.

       Snapshot	IDs, filters and options can be	used in	conjunction.

OPTIONS
       -u, --owner ID
	      Returns the snapshots owned by the specified owner.   The	 argu-
	      ment  is	the  ID	of the owner, or one of	the following reserved
	      words:

	      self   Returns the snapshots you own.

	      amazon Returns the public	AWS snapshots.

       -r, --restorable-by D
	      Returns snapshots	from which the specified account ID can	create
	      volumes.

FILTERS
       description=string
	      A	description of the snapshot.

       owner-alias=string
	      The alias	of the AWS account that	owns the snapshot.

       owner-id=string
	      The ID of	the AWS	account	that owns the snapshot.

       progress=string
	      The  progress  of	 the snapshot, in percent.  Note that you must
	      specify the percent sign.

       snapshot-id=string
	      The ID of	the snapshot

       start-time=date
	      The time stamp when the snapshot was initiated, in the ISO  8601
	      format, i.e. YYYY-MM-DDThh:mm:ssZ.

       status=pending |	completed | error
	      The snapshot status.

       tag-key=string
	      The  key	of  a  tag assigned to the resource, regardless	of its
	      value.  Note,  that  this	 filter	 works	independently  of  the
	      tag-value	 filter,  i.e.	 tag-key=foo tag-value=bar will	return
	      all snapshots that have the tag foo defined  and	all  snapshots
	      that  have  bar  as  a value of any of their tags.  To request a
	      snapshot that has	the tag	foo set	 to  the  value	 bar  see  the
	      tag:KEY filter below.

       tag-value=string
	      The  value  of a tag assigned to the resource, regardless	of the
	      tag's key.  See the comment above.

       tag:KEY=VAL
	      Selects the snapshots having the specified tag KEY  set  to  the
	      value VAL.  For example:

	      tag:Name="root snapshot"

       volume-id=string
	      The ID of	the volume the snapshot	is for.

       volume-size=N
	      The size of the volume, as a decimal number, in GiB.

OUTPUT
       Each line of output describes a single snapshots.  The following	infor-
       mation is included, separated by	horizontal tab characters:  the	 snap-
       shot ID,	the corresponding volume ID and	size in	GiB, the status	of the
       snapshot	(completed, pending or error), progress	percentage, the	 start
       time, and the snapshot description, if not empty.

       If  the snapshot	has associated tags, these are listed below that line,
       each tag	on a separate line, prefixed by	a single TAB character.

       For example (long lines split for readability):

       snap-78a54011 vol-4d826724 10 pending   80%  2012-05-07T12:51:50.000Z	       "Daily Backup"
       snap-12345678 vol-4d826724 10 completed 100% 2012-04-07T00:00:00.000Z
	       comment="Taken before switching to new kernel"
	       rand=E34AF890

SEE ALSO
       eclat(1), eclat-rmsnap(1), eclat-mksnap(1).

AUTHORS
       Sergey Poznyakoff

BUG REPORTS
       Report bugs to <bug-eclat@gnu.org.ua>.

COPYRIGHT
       Copyright (C) 2012-2015 Sergey Poznyakoff
       License GPLv3+: GNU GPL version 3 or later <http://gnu.org/li-
       censes/gpl.html>
       This  is	 free  software:  you  are free	to change and redistribute it.
       There is	NO WARRANTY, to	the extent permitted by	law.

ECLAT			       January 26, 2015		       ECLAT-LSSNAP(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | FILTERS | OUTPUT | SEE ALSO | AUTHORS | BUG REPORTS | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=eclat-lssnap&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help