New-OfficeWebAppsMachine

  • Reference
Module:
OfficeOnlineServerPowerShell

Adds the current server to an existing Office Online Server farm.

Syntax

New-OfficeWebAppsMachine
   [-Force]
   [-MachineToJoin] <String>
   [-Roles <String[]>]
   [-WhatIf]
   [-Confirm]

Description

The New-OfficeWebAppsMachine cmdlet adds the current server to an existing Office Online Server farm and optionally sets one or more roles on the new server.

Examples

------------------EXAMPLE 1---------------------

New-OfficeWebAppsMachine -MachineToJoin server1.contoso.com

This example adds the current server to the Office Online Server farm that is running on the server named server1.contoso.com.

Parameters

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Assumes the answer to any user prompt is Yes.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MachineToJoin

Specifies the name of any server that is already a member of the Office Online Server farm.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Roles

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.

The role types are as follows:

FrontEnd

WordBackEnd

ExcelBackEnd

PowerPointBackEnd

As a best practice, we recommend that all servers in an Office Online Server farm run all roles. Assigning roles is not useful until the Office Online Server farm contains approximately 50 servers.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False