FarmRoleNetwork object

Example JSON representation

{
  "associatePublicIpAddress": true, 
  "cloudFeatures": {
    "type": "NetworkCloudFeatures"
  }, 
  "id": "string", 
  "ipPool": {
    "id": "string"
  }, 
  "primary": true, 
  "staticIpMap": [
    {
      "ipAddress": "string", 
      "serverIndex": 1, 
      "type": "GenericStaticIp"
    }
  ], 
  "subnets": [
    {
      "id": "string"
    }
  ]
}

Properties

property attributes valid values description filter option
id
string
required
associatePublicIpAddress
boolean
optional

Whether we need to associate a public IP address to the instance of the current Farm Role.

cloudFeatures
NetworkCloudFeatures object
optional

Cloud specifics Farm Role Network configuration.

ipPool
IpPoolForeignKey object
optional

Identifier of the IpPool configuration.

primary
boolean
optional

Whether this network is primary. Only one network from the list can be primary. If primary flag is omitted in all networks first network will be marked as primary.

staticIpMap
Array of IpAddressConfiguration objects
optional

The configuration of IP addresses for Servers in the current Farm Role. Currently is being supported by EC2 and Openstack platform.

subnets
Array of CloudSubnetForeignKey objects
optional

The subnet identifiers.