Enable-DAMultiSite
Enable-DAMultiSite
Enables and configures a multi-site deployment, and adds the first entry point.
Syntax
Parameter Set: Enable1
Enable-DAMultiSite [-EntryPointName] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-GslbFqdn <String> ] [-GslbIP <IPAddress> ] [-ManualEntryPointSelectionAllowed <String> ] [-Name <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Enable-DAMultiSite cmdlet enables and configures a multi-site deployment. This cmdlet configures both global multi-site settings and entry point-specific settings.
Global settings include:
-- Multi-site deployment name.
-- A fully qualified domain name (FQDN) for global load balancing. This setting is optional.
-- Support for remote clients to manually select the entry point to which they connect.
Entry point-specific settings include:
-- Entry point name.
-- A global load balancing IP address for the entry point. This setting is optional.
A prerequisite check is performed for multi-site deployment requirements.
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 or IPv6 address, or host name, of a server or server cluster in the multi-site deployment.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EntryPointName<String>
Specifies the name of the first entry point in the multi-site deployment.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
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. Global load balancing is used to direct Remote Access clients to the nearest entry point.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GslbIP<IPAddress>
Specifies the IPv4 or IPv6 dedicated IP address (DIP) of the server, or the virtual IP address (VIP) of the server cluster, to be used for global load balancing.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ManualEntryPointSelectionAllowed<String>
Allow clients running or Windows® 8 to manually select the entry point to which they connect.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
'Enabled' |
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 |
"Enterprise" |
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 entire multi-site deployment configuration as follows:
-- Multi-site deployment name.
-- Multi-site entry points, where each entry point has a list of associated servers.
-- Global load balancing FQDN, if defined.
-- Support for remote clients to manually select the entry point to which they connect.
Examples
EXAMPLE 1
This example enables Direct Access (DA) Multi-site on the local DA server while using default parameters and naming the first entry point Entry Point 1. As can be seen from the output, the cmdlet chose a default EnterpriseName Enterprise and enabled the Manual Entry Point Selection by the Windows Server® 2012 user.
PS C:\> Enable-DAMultiSite -EntryPointName "Entry Point 1" -PassThru -Force
EXAMPLE 2
This example enables DA Multi-site on the remote DA server ‘DA1’ while using default parameters and naming the first entry point Entry Point 1. As can be seen from the output, the cmdlet chose a default EnterpriseName Enterprise and enabled Manual Entry Point Selection by the Windows Server 2012 user.
PS C:\> Enable-DAMultiSite -EntryPointName "Entry Point 1" -ComputerName "da1" –PassThru
EXAMPLE 3
This example enables DA Multi-site on the local computer while naming the Multi-site deployment Company Enterprise and determining the FQDN of a third-party load balancer directaccessGlobalSite.contoso.com. Using load balancer will also require entering the GslbIP for the first entry point 137.2.0.1.
As can be seen from the output, the cmdlet enabled Manual Entry Point Selection by the Windows Server 2012 user.
PS C:\> Enable-DAMultiSite "Entry Point 1" -GslbFqdn "directaccessGlobalSite.contoso.com" –EnterpriseName "Company Enterprise" -GslbIP "137.2.0.1" -PassThru -Force
EXAMPLE 4
This example enables DA Multi-site on the local computer while naming the Multi-site deployment Company Enterprise and disabled the user from manually select entry points when using the Windows Server 2012 network connectivity assistant.
PS C:\> Enable-DAMultiSite -EntryPointName "Entry Point 1" -ManualSiteSelectionAllowed Disabled -Name "Company Enterprise" -PassThru -Force