Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-DAMultiSite

Set-DAMultiSite

ps_damultisite_v1.0.0.cdxml

Synopsis

Configures global settings for all entry points in a multi-site deployment.

Syntax

Set-DAMultiSite [-AsJob] [-CimSession] [-ComputerName] [-GslbFqdn] [-ManualEntryPointSelectionAllowed] [-Name] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-DAMultiSite cmdlet configures global multi-site settings that are applied to all entry points, including: -- The name of an entry point server included in the multi-site deployment. -- The global load balancing fully qualified domain name (FQDN), if required. -- Support for remote clients to manually select the entry point to which the clients connect. -- The name of the multi-site deployment.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ComputerName <String>

Specifies the IPv4 orIPv6 address, or host name, of one of the entry point servers included in the multi-site deployment for which parameters should be set.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-GslbFqdn <String>

Specifies the FQDN of a third-party global load balancer, if deployed. A global load balancer is used to direct clients to the closest entry point.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ManualEntryPointSelectionAllowed <String>

Sets the enabled state that allows clients running Windows® 7 or Windows Server® 2012 to manually select the entry point to which each client connects.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name used to identify the multi-site deployment.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#DAMultiSite

Notes

None

Examples

EXAMPLE 1

This example enables users to manually select entry points when using the Windows Server 2012 Network connectivity assistant.

PS C:\>Set-DAMultiSite -ManualEntryPointSelection enabled –PassTrue

EnterpriseName                   : Company Enterprise 
GslbFqdn                         : 
ManualEntryPointSelectionAllowed : Enabled 
DAEntryPoints                    : Entry Point 1 

EXAMPLE 2

This example sets the FQDN of a third-party load balancer named directaccessglobalsite.contoso.com.

PS C:\>Set-DAMultiSite -GslbFqdn "directaccessGlobalSite.contoso.com" -PassTrue

EnterpriseName                   : Company Enterprise 
GslbFqdn                         : directaccessglobalsite.contoso.com 
ManualEntryPointSelectionAllowed : Enabled 
DAEntryPoints                    : Entry Point 1 

EXAMPLE 3

This example erases the previously defined FQDN of a third-party load balancer.

PS C:\>Set-DAMultiSite -ManualSiteSelection enabled -GslbFqdn "" -PassThru

EnterpriseName                   : Company Enterprise 
GslbFqdn                         : 
ManualEntryPointSelectionAllowed : Enabled 
DAEntryPoints                    : Entry Point 1 

Online Version
Disable-DAMultiSite
Enable-DAMultiSite
Get-DAMultiSite