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

FreeBSD Manual Pages

  
 
  

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

NAME
     mdata-put -- Set the value of a metadata key-value pair.

SYNOPSIS
     /usr/sbin/mdata-put keyname [ value ]

DESCRIPTION
     The  mdata-put command allows the user (or a script) to modify the metadata
     for a guest instance running in a SmartDataCenter	(SDC)  cloud.	Metadata
     values  are generally set programmatically via CloudAPI, or during interac-
     tive provisioning via a Web Portal.  The value of a key-value pair  may  be
     obtained by passing its name to the mdata-get command.

     The  key-value pair named keyname will be updated in the metadata store for
     this instance.  If a value argument is provided on the  command-line,  then
     that  value will be used.	Otherwise, if stdin is not a tty, the value will
     be read from stdin.

     If the metadata service is unavailable at the time  of  the  request,  this
     command will block waiting for it to become available.  Non-transient fail-
     ures,  such  as  the non-existence of the requested keyname, will cause the
     program to exit with a non-zero status.  Depending on the nature of the er-
     ror, some diagnostic output may be printed to stderr.

EXIT STATUS
     The following exit values are returned:

     0
	  Successful completion.

	  The requested keyname was valid, and its value was updated.

     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 misconfiguration exists.

     3
	  A usage error occurred.

	  Malformed  arguments	were passed to the program.  Check the usage in-
	  structions to ensure valid arguments are supplied.

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

Joyent SmartDataCenter		  October 2013			    MDATA-PUT(1)

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

home | help