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

FreeBSD Manual Pages

  
 
  

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

NAME
       mdata-get -- Fetch the value of a metadata key-value pair.

SYNOPSIS
       /usr/sbin/mdata-get keyname

DESCRIPTION
       The  mdata-get 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 the	requested keyname will be printed to stdout.   If  the
       metadata	 service  is unavailable at the	time of	the request, this com-
       mand will block waiting for  it	to  become  available.	 Non-transient
       failures,  such	as  the	 non-existence	of the requested keyname, will
       cause the program to exit with a	non-zero status.  Depending on the na-
       ture of the error, some diagnostic output may be	printed	to stderr.

EXIT STATUS
       The following exit values are returned:

       0
	    Successful completion.

	    The	requested keyname was available, and its value was emitted  to
	    stdout.

       1
	    Metadata value not found.

	    The	requested keyname was not found	in the metadata.

       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-list(1), mdata-put(1)

Joyent SmartDataCenter		 October 2013			  MDATA-GET(1)

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

home | help