.TH gettokens 1 "January 2017" Moray "Moray Client Tools"
.SH NAME
.PP
gettokens \- fetch the list of shards from electric\-moray
.SH SYNOPSIS
.PP
\fB\fCgettokens [COMMON_OPTIONS]\fR
.SH DESCRIPTION
.PP
Reports the list of physical shards behind an electric\-moray instance.
.PP
Electric\-moray is a component typically deployed in front of several separate
Moray shards.  Electric\-moray instances speak the Moray protocol to their
clients, but they use consistent hashing on some field of each object to select
the appropriate backend to handle each request.  (This functions similar to a
layer\-7 load balancer.)  A full discussion of electric\-moray is beyond the scope
of this documentation.
.PP
For this command, the service specified with the \fB\fCCOMMON_OPTIONS\fR should be an
electric\-moray instance, not a moray instance.
.SH OPTIONS
.PP
See \fB\fCmoray(1)\fR for information about the \fB\fCCOMMON_OPTIONS\fR, which control
the log verbosity and how to locate the remote server.
.SH ENVIRONMENT
.PP
See \fB\fCmoray(1)\fR for information about the \fB\fCLOG_LEVEL\fR, \fB\fCMORAY_SERVICE\fR, and
\fB\fCMORAY_URL\fR environment variables.
.SH EXAMPLES
.PP
Using an electric\-moray service, this operation reports a list of URLs:
.PP
.RS
.nf
$ gettokens \-h electric\-moray.emy\-10.joyent.us
{
  "tokens": [
    "tcp://1.moray.emy\-10.joyent.us:2020",
    "tcp://2.moray.emy\-10.joyent.us:2020"
  ]
}
.fi
.RE
.PP
Using most Moray servers, this operation is not supported:
.PP
.RS
.nf
$ gettokens
gettokens: moray client ("172.27.10.72:52387" to "172.27.10.76:2020"): request failed: server error: Operation not supported
.fi
.RE
.SH SEE ALSO
.PP
\fB\fCmoray(1)\fR
.SH BUGS
.PP
It's not clear why backend shards are called "tokens".
.PP
This command likely belongs with an electric\-moray tool suite, rather than the
Moray tool suite.