- API >
- Public API Resources >
- Server Pool >
- Server Pool Servers
Server Pool Servers¶
On this page
The serverPool/servers
resource provides access to the server
pool’s servers. The pool provides Ops Manager users with
pre-provisioned servers for deploying MongoDB.
For a list of all server pool API resources, see Server Pool. For information on the server pool, see Provision Servers for the Server Pool.
Endpoints¶
Get All Servers in the Server Pool¶
To filter by server status, use the status
query parameter:
STATUS
can be one of the following values: AVAILABLE
or TRASH
.
STATUS
cannot be RESERVED
, BOUND
, NEEDS_CLEAN
, or
DELETED
.
You must have the Global Read Only role to use this endpoint.
Get a Server by ID¶
SERVER-ID
is the string specified in the id
field in the
serverPool/servers
entity.
You must have the Global Read Only role to use this endpoint.
Get a Server by Hostname¶
HOSTNAME
is the string specified in the hostname
field in the
serverPool/servers
entity.
You must have the Global Read Only role to use this endpoint.
Remove a Server from the Server Pool¶
SERVER-ID
is the string specified in the id
field in the
serverPool/servers
entity.
You must have the Global Owner role to use this endpoint.
Note
If the Automation Agent is still running on the server, the server will appear again in the server pool the next time the Automation Agent pings Ops Manager.
Sample Entity¶
Entity Fields¶
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
string | A unique identifier for the server. | ||||||||||||
hostname |
string | The hostname that identifies the server. | ||||||||||||
properties |
object of key/value pairs | The custom properties assigned to the server. Administrators control which properties to expose to end users. If properties are exposed, users must select property values when requesting servers. For more information, see Servers Request Options. | ||||||||||||
created |
date | The date the server was added to the server pool. | ||||||||||||
recycled |
date | The date the server was returned to the pool. | ||||||||||||
statusName |
string | The server’s availability. Possible values are:
|
||||||||||||
boundGroupId |
string | The ID of the group where this server is in use. |
Links¶
Relation | Description |
---|---|
self |
Me |
http://mms.mongodb.com/serverPoolServers |
The servers in the pool. |
http://mms.mongodb.com/serverPoolProperties |
The options used to select a server. |