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

FreeBSD Manual Pages

  
 
  

home | help
MDATA-LIST(1)		       Metadata	Commands		 MDATA-LIST(1)

NAME
       mdata-list -- Fetch the list of available metadata key-value pairs.

SYNOPSIS
       /usr/sbin/mdata-list

DESCRIPTION
       The mdata-list command allows the user (or a script) to query the meta-
       data  for  a  guest  instance running in	a SmartDataCenter (SDC)	cloud.
       Metadata	values are generally set  programmatically  via	 CloudAPI,  or
       during interactive provisioning via a Web Portal.  They may also	be set
       from  within  the  instance with	the mdata-put command.	The value of a
       key-value pair may be obtained by passing its  name  to	the  mdata-get
       command.

       The  list  of  all  customer-provided  metadata key-value pairs will be
       printed to stdout.  If the metadata service is unavailable at the  time
       of the request, this command will block waiting for it to become	avail-
       able.   Non-transient  failures	will  cause the	program	to exit	with a
       non-zero	status.	 Depending on the nature of the	error, some diagnostic
       output may be printed to	stderr.

EXIT STATUS
       The following exit values are returned:

       0
	    Successful completion.

	    The	list of	key-value pairs	was emitted to stdout.

       2
	    An error occurred.

	    An unexpected error	condition occurred, which is believed to be  a
	    non-transient  condition.  Retrying	the request is not expected to
	    resolve the	error condition; either	a software bug or  misconfigu-
	    ration exists.

       3
	    A usage error occurred.

	    Malformed  arguments  were passed to the program.  Check the usage
	    instructions to ensure valid arguments are supplied.

SEE ALSO
       mdata-delete(1),	mdata-get(1), mdata-put(1)

Joyent SmartDataCenter		 October 2013			 MDATA-LIST(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mdata-list&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help