FarmRoleSummary object

Example JSON representation

{
  "alias": "string", 
  "cloudLocation": "string", 
  "cloudPlatform": "ec2", 
  "farm": {
    "id": 1
  }, 
  "id": 1, 
  "instanceType": {
    "id": "string"
  }, 
  "launchIndex": 1, 
  "role": {
    "deprecated": {
      "deprecated": "2013-01-01T12:34:56.789Z", 
      "replacement": {
        "id": 1
      }
    }, 
    "id": 1
  }
}

Properties

property attributes valid values description filter option
alias
string
required
filterable

The Alias for this Farm Role.

?alias=...
cloudLocation
string
required
create-only
filterable

The Cloud Location.

?cloudLocation=...
cloudPlatform
string
required
create-only
filterable
"ec2"
"gce"
"azure"
"cloudstack"
"idcf"
"openstack"
"ocs"
"rackspacenguk"
"rackspacengus"
"hpcloud"
"mirantis"
"vio"
"cisco"
"vmware"

The Cloud Platform this Farm Role runs on.

?cloudPlatform=...
instanceType
InstanceTypeForeignKey object
required

The instance type that should be used for all instances related to this Farm Role.

role
RoleIdentity object
required
filterable

Identifier of the Role.

Pass the id of the object you are referencing in:
?role=...
farm
FarmForeignKey object
read-only
filterable

Farm this Farm Role should be added to.

Pass the id of the object you are referencing in:
?farm=...
id
integer
read-only
filterable

Unique identifier for this Farm Role.

?id=...
launchIndex
integer
optional

Launch index for this Farm Role.