CreateStoreFrontServerGroupModel

Details of a StoreFront server group to create.

Properties

NameDescription Additional information
Name

Name of the StoreFront cluster.

Type: String

DataCenterId

ID of the datacenter containing all of the StoreFront servers in the cluster.

Type: String

DomainId

ID of the domain to which all of the StoreFront servers in the cluster are joined.

Type: String

Servers

A list of servers on which to deploy StoreFront, to create the StoreFront server group. At least 2 servers are required.

Any servers which were not in the StoreFront server group prior to the update will be provisioned and added as StoreFront servers. Any servers which were in the StoreFront server group prior to the update, but are not specified, will be deprovisioned and removed from the StoreFront server group.

Type: Array of String

NetworkName

The management network which the StoreFront servers in the StoreFront server group are connected to.

If network isolation is disabled, this is not used.

If not specified, 'Shared Controller Management Network' is assumed.

Type: String

CertificateFriendlyName

Friendly name for the SSL certificate which should be used to configure the StoreFront servers' SSL endpoints. The certificate must be a valid Web Server certificate, with a CN that matches the StoreFront servers' FQDNs.

If specified, the SSL certificate must already be installed on all servers that will become part of the StoreFront server group.

If not specified, WildCardCertificateFile is required.

Type: String

WildCardCertificateFile

Path to file containing the SSL certificate which should be used to configure the StoreFront servers' SSL endpoints. The certificate must be a valid Web Server certificate, with a CN that matches the StoreFront servers' FQDNs.

If the path is to a local file, that file must be located at the same local file path on all of the StoreFront servers. It is not recommended to use a network share path for security reasons.

If specified, WildCardCertificatePasswordBase64 is required.

If not specified, CertificateFriendlyName is required.

Type: String

WildCardCertificatePasswordBase64

Password to the SSL certificate file. Required if WildCardCertificateFile is specified.

Type: String

LoadBalancerUrl

Load balancer URL in the format of https:///xyz.abc.com/. The load balancer should be configured to direct web traffic between all of the servers in the StoreFront server group.

Type: String

Description

Description.

Type: String

Tags

See Tags and Custom Properties.

Type: Array of String

CustomProperties

See Tags and Custom Properties.

Type: Array of CustomPropertyModel

Sample

application/json

Sample:
{
  "Name": "servergroup1",
  "DataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a",
  "DomainId": "241b45cc-261d-47d0-81d7-a0a41c54c760",
  "Servers": [
    "sf1",
    "sf2"
  ],
  "NetworkName": "Shared Controller Management Network",
  "CertificateFriendlyName": "cluster certificate",
  "WildCardCertificateFile": "C:\\Certificates\\cluster.cer",
  "WildCardCertificatePasswordBase64": "cGFzc3dvcmQ=",
  "LoadBalancerUrl": "https://lb.sf.datacenter1.csp.com",
  "Description": "my StoreFront server group",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}