- API >
- Public API Resources >
- Server Pool >
- Server Pool Properties
Server Pool Properties¶
On this page
Note
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
The serverPool/properties
resource retrieves and updates the properties
and property values that define servers in the server pool.
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.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Endpoints¶
Get All Properties and Values Defined in the Server Pool¶
You must have the the Global Read Only role or higher.
Update a Property’s Settings¶
PROPERTY-ID
is the value of the id
field in the property entity.
You can send only the description
, multiSelect
, and statusName
fields. You can send a subset of those fields.
You must have the Global Owner role to use this endpoint.
Update a Property Value¶
Where:
PROPERTY-ID
is the value of theid
field in the property entity.PROPERTY-VALUE
is the value of avalues.value
field in the property entity.
You can send only the fields found in the values
array object. You can
send a subset of those fields.
You must have the Global Owner role to use this endpoint.
Delete a Property and all its Values¶
PROPERTY-ID
is the value of the id
field in the property entity.
You must have the Global Owner role to use this endpoint.
Delete a Property Value¶
Where:
PROPERTY-ID
is the value of theid
field in the property entity.PROPERTY-VALUE
is the value of avalues.value
field in the property entity.
You must have the Global Owner role to use this endpoint.
Sample Entity¶
Entity Fields¶
Name | Type | Description |
---|---|---|
id |
string | The property name. |
multiSelect |
boolean | If set to true , a user can specify multiple values for the property
when requesting servers. If a user specifies multiple values for the
property when requesting multiple servers, Ops Manager provisions servers
in a round-robin fashion; i.e. Ops Manager provisions a server for each
value before provisioning a second server for a given value. |
statusName |
string | Specifies whether the property can be used to provision a server. If
set to AVAILABLE , the property can be specified when a user
provisions a server. If set to UNAVAILABLE , the property cannot be
specified. |
values |
object array | The property’s values. |
values.description |
string | A description of the property value. |
values.statusName |
string | Specifies whether the property value can be used to provision a server.
If set to AVAILABLE , the value can be specified when a user
provisions a server. If set to UNAVAILABLE , the value cannot be
specified. |
values.value |
string | A value that exists for the property. |
Links¶
Relation | Description |
---|---|
self | Me |
http://mms.mongodb.com/serverPool |
The server pool. |