Edit

Share via


New-OfficeWebAppsMachine

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

Syntax

Default (Default)

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Assumes the answer to any user prompt is Yes.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MachineToJoin

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Displays a message that describes the effect of the command instead of executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False