xenial (1) mdata-list.1.gz

Provided by: joyent-mdata-client_0.0.1-0ubuntu2_amd64 bug

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 metadata 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
       available.   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
            misconfiguration 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)