Navigation
You were redirected from a different version of the documentation. Click here to go back.

Group Server Pool Properties

The groups/GROUP-ID/serverPool/properties resource retrieves the properties used to 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.

Endpoint

Get All Properties Defined in the Server Pool

GET /api/public/v1.0/groups/GROUP-ID/serverPool/properties

Sample Entity

{
  "id" : "region",
  "description" : "Location",
  "multiSelect" : false,
  "statusName" : "AVAILABLE",
  "values" : [ {
      "description" : "Eastern region",
      "statusName" : "AVAILABLE",
      "value" : "east"
  }, ... ],
  "links" : [ ... ],

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.

Example

Get All Properties Defined in the Server Pool

Request

curl -i -u "username:apiKey" --digest "https://<ops-manager-host>/api/public/v1.0/groups/GROUP-ID/serverPool/properties"

Response

HTTP/1.1 200 OK

{
  "links" : [ ... ],
  "results" : [ {
    "id" : "region",
    "description" : "Location",
    "links" : [ { ... } ],
    "multiSelect" : false,
    "statusName" : "AVAILABLE",
    "values" : [ {
      "description" : "Eastern region",
      "statusName" : "AVAILABLE",
      "value" : "east"
    }, {
      "description" : "Western region",
      "statusName" : "AVAILABLE",
      "value" : "west"
    } ]
  }, {
    "id" : "size",
    "description" : "CPU, RAM",
    "links" : [ ... ],
    "multiSelect" : false,
    "statusName" : "AVAILABLE",
    "values" : [ {
      "statusName" : "AVAILABLE",
      "value" : "large"
    }, {
      "statusName" : "AVAILABLE",
      "value" : "medium"
    } ]
  } ],
  "totalCount" : 2
}