Set-DAMultiSite
Set-DAMultiSite
Configures global settings for all entry points in a multi-site deployment.
Syntax
Parameter Set: Set3
Set-DAMultiSite [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-GslbFqdn <String> ] [-ManualEntryPointSelectionAllowed <String> ] [-Name <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-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
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 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
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
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#DAMultiSite
The
Microsoft.Management.Infrastructure.CimInstance
object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#
) provides the namespace and class name for the underlying WMI object.
The DAMultiSite object contains the following properties:
-- Multi-site deployment name.
-- Multi-site deployment entry points with a list of servers associated with each entry point.
-- Global load balancing FQDN, if required.
-- Support for remote clients to manually select the entry point to which the clients connect.
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
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
EXAMPLE 3
This example erases the previously defined FQDN of a third-party load balancer.
PS C:\> Set-DAMultiSite -ManualSiteSelection enabled -GslbFqdn "" -PassThru