EMS Server Group Options

These options apply to each group in the ems.server_groups[] array.

ems.server_groups[].name

Name of this server group. Server group names must be unique within a proxy configuration. Group names are user-defined and can be any string; however it is recommended to follow the Server Group and Server Role Name Guidelines for server group names.

This field is required for each server group.

Default value: none

Example usage:

Command Line

Note: Server group names cannot be specified explicitly on the command-line; instead, they are set automatically when other command-line options reference them. For example, setting the tags server group option on the command-line:
--ems.server_groups.foo.tags tag1,tag2

will implicitly and automatically create a server group named "foo" if it does not already exist. Server group names cannot be set by setting the "name" option directly; the following example will not work:

--ems.server_groups.foo.name=bar

Config File

ems:
  server_groups:
    - name: foo

Environment Variable

Note: Server group names cannot be specified explicitly via an environment variable; instead, they are set automatically when other environment variable options reference them. For example, setting the tags server group option via an environment variable:
EMSRESTD_EMS_SERVER_GROUPS_FOO_TAGS='tag1,tag2'

will implicitly and automatically create a server group named "foo" if it does not already exist. Server group names cannot be set by setting the "name" option directly; the following example will not work:

EMSRESTD_EMS_SERVER_GROUPS_FOO_NAME=bar

ems.server_groups[].servers[]

Array of the EMS server instances that comprise this EMS server group. Each entry in this array has the options described in EMS Server Options.

ems.server_groups[].tags[]

List of user-defined tags to apply to this server group. REST API calls that support a server_group_tags query parameter to target a list of server groups use the tags in this list to generate the list of server groups to target.

Default value: none

Example usage:

Command Line

--ems.server_groups.{group name}.tags red,blue

Config File

ems:
  server_groups:
    - name example
      tags:
        - red
        - blue

Environment Variable

EMSRESTD_EMS_SERVER_GROUPS_{GROUP NAME}_TAGS='red,blue'