FarmRole object

Example JSON representation

{
  "advancedConfiguration": {
    "abortInitializationOnOrchestrationFailure": true, 
    "disableAgentHostnameManagement": true, 
    "disableAgentIptablesManagement": true, 
    "disableAgentNtpManagement": true, 
    "instanceName": "string", 
    "rebootAfterHostInit": true
  }, 
  "alias": "string", 
  "availabilityZones": [
    "string"
  ], 
  "bootstrapping": {
    "enabled": true, 
    "type": "BootstrapConfiguration"
  }, 
  "cloudFeatures": {
    "type": "CloudFeatures"
  }, 
  "cloudLocation": "string", 
  "cloudPlatform": "ec2", 
  "farm": {
    "id": 1
  }, 
  "id": 1, 
  "instanceType": {
    "id": "string"
  }, 
  "launchIndex": 1, 
  "networking": {
    "hostname": {
      "domainName": "string", 
      "type": "HostnameConfiguration"
    }, 
    "networks": [
      {
        "associatePublicIpAddress": true, 
        "cloudFeatures": {
          "type": "NetworkCloudFeatures"
        }, 
        "id": "string", 
        "ipPool": {
          "id": "string"
        }, 
        "primary": true, 
        "staticIpMap": [
          {
            "ipAddress": "string", 
            "serverIndex": 1, 
            "type": "GenericStaticIp"
          }
        ], 
        "subnets": [
          {
            "id": "string"
          }
        ]
      }
    ], 
    "subnets": [
      {
        "id": "string", 
        "networkId": "string"
      }
    ]
  }, 
  "role": {
    "deprecated": {
      "deprecated": "2013-01-01T12:34:56.789Z", 
      "replacement": {
        "id": 1
      }
    }, 
    "id": 1
  }, 
  "scaling": {
    "considerSuspendedServers": "running", 
    "enabled": true, 
    "maxInstances": 1, 
    "minInstances": 1, 
    "rules": [
      "string"
    ], 
    "scalingBehavior": "suspend-resume"
  }, 
  "security": {
    "securityGroups": [
      {
        "id": "string", 
        "name": "string"
      }
    ]
  }
}

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=...
advancedConfiguration
FarmRoleAdvancedConfiguration object
optional

Advanced Farm Role configuration.

availabilityZones
Array of string
optional

The list of availability zones. This property is available only for GCE, Openstack, Azure and AWS based Farm Roles. Please note, that the value is required for GCE Farm Roles, but for Openstack and AWS the availability zone will be chosen by the cloud engine if property is empty or not specified.

bootstrapping
BootstrapConfiguration object
optional

Farm Role bootstrap configuration. Please note this property is available only for Farm Roles configured with enabled Chef built-in automation.

cloudFeatures
CloudFeatures object
optional

Cloud specifics Farm Role configuration. This property is available only for Azure and AWS based Farm Roles. Please note, that the value is required for AzureConfiguration.

launchIndex
integer
optional

Launch index for this Farm Role.

networking
NetworkConfiguration object
optional

Farm Role network configuration. Please note that this property is not available for AWS Farm Roles that weren't launched inside Amazon VPC.

scaling
ScalingConfiguration object
optional

Farm Role scaling configuration.

security
SecurityConfiguration object
optional

Endpoints using this object