Skip to content

OfficeOnlineServerMachine

dscbot edited this page Nov 5, 2023 · 2 revisions

OfficeOnlineServerMachine

Parameters

Parameter Attribute DataType Description Allowed Values
Ensure Write String Ensure Present or Absent Present, Absent
Roles Write StringArray[] Specifies one or more server roles, separated by commas, to assign to the new server. If no roles are specified, then the server is assigned all roles.
MachineToJoin Key String Specifies the name of any server that is already a member of the Office Web Apps Server farm.

Description

The OfficeOnlineServerMachine resource is used to instruct the server to join an existing Office Web Apps 2013 or Office Online Server 2016 farm. Specify the name of the first server (which would have run the OfficeOnlineServerFarm resource) and it will join on that server when this resource is run.

Examples

Example 1

This example shows how to join a machine to an Office Web Apps farm. This shows that the new server will use all roles (it is not recommended to split roles out to dedicated servers for Office Online Server farms of less than 50 servers).

Configuration Example
{
    Param()

    Import-DscResource -ModuleName OfficeOnlineServerDsc

    OfficeOnlineServerMachine JoinFarm
    {
        MachineToJoin = "office1.contoso.com"
        Roles         = "All"
    }
}