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
 

Add-DAEntryPoint

Add-DAEntryPoint

ps_daentrypoint_v1.0.0.cdxml

Synopsis

Adds an entry point to a multi-site deployment.

Syntax

Add-DAEntryPoint [-Name] [-AsJob] [-CimSession] [-ClientIPv6Prefix] [-ComputerName] [-DeployNat] [-Force] [-GslbIP] [-InternalInterface] [-InternetInterface] [-NoPrerequisite] [-PassThru] [-ServerGpoName] [-ThrottleLimit] [-ConnectToAddress] [-RemoteAccessServer] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-DAEntrypoint cmdlet adds an entry point to a multi-site deployment. This cmdlet checks that the server complies with the prerequisites for DirectAccess deployment, and adds the server as an entry point.

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

-ClientIPv6Prefix <String>

Specifies the IPv6 address prefix assigned to remote clients connecting over IP-HTTPS. The prefix length must be 59 or 64 bits.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ComputerName <String>

Specifies the name or address, either IPv4 or IPv6, 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

-ConnectToAddress <String>

Specifies the public name, or IPv4 address, of the Remote Access server, or network address translation (NAT) server, to which remote clients connect.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-DeployNat <SwitchParameter>

Indicates that the server or server cluster is deployed behind a NAT device.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

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

-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

-InternalInterface <String>

Specifies the name of the internal network adapter of the first server in the entry point.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-InternetInterface <String>

Specifies the name of the external network adapter of the first server in the entry point.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name to be assigned to the entry point.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NoPrerequisite <SwitchParameter>

Indicates that a prerequisite check for DirectAccess deployment requirements should not be performed.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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

-RemoteAccessServer <String>

Specifies the name or IP address, IPv4 or IPv6, of the server that will be the first server in the entry point.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ServerGpoName <String>

Specifies the name of the GPO in which DirectAccess server configuration settings for the entry point are stored. The GPO is created in the domain that contains the server specified in RemoteAccessServer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

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#DAEntryPoint

Notes

None

Examples

Example 1

This example adds the edge server named da2.domain1.corp.contoso.com to the multi-site deployment, names the server Entry Point 2 and declares CorpNet1 as the network interface which is connected to the corporate internal network. Since the company uses IPv6 prefixes, IPHTTPS remote clients will connect via ep2.da.contoso.com using predefined prefix 3000:0:30:2000::/64.

PS C:\>Add-DAEntryPoint -Name "Entry Point 2" -InternalInterface CorpNet1 -RemoteAccessServer "da2.domain1.corp.contoso.com" -InternetInterface Internet -ClientIPv6Prefix 3000:0:30:2000::/64 -ConnectToAddress "ep2.da.contoso.com" -PassThru -Force

EntryPointName                 GslbIp                         Servers 
--------------                 ------                         ------- 
Entry Point 2                  0.0.0.0                        {DA2.domain1.corp.contoso.com} 


To validate the name of the GPO which was created by this cmdlet, the following script should be used.
PS C:\>$daServer = Get-DAServer -EntrypointName "Entry Point 2"



PS C:\>$daServer.ServerConfiguration.GpoName

domain1.corp.contoso.com\DirectAccess Server Settings - Entry Point 2


In addition, running the Get-DAMultiSite cmdlet displays the newly added entry point.
PS C:\>Get-DAMultiSite

EnterpriseName             : Company Enterprise 
GslbFqdn                   : 
ManualSiteSelectionAllowed : Enabled 
DAEntryPoints              : {Entry Point 1, Entry Point 2} 

Example 2

This example adds the edge server named da2.domain1.corp.contoso.com to the multi-site deployment, names the server Entry Point 2 and declares CorpNet1 as the network interface which is connected to the corporate internal network using a pre-created GPO domain2.corp.contoso.com\EP2ServerGpo.

PS C:\>Add-DAEntryPoint -Name "Entry Point 2" -InternalInterface CorpNet1 -RemoteAccessServer "da2.domain1.corp.contoso.com" -InternetInterface Internet -ClientIPv6Prefix 3000:0:30:2000::/64 -ConnectToAddress "ep2.da.contoso.com" -ServerGpoName "domain1.corp.contoso.com\EP2ServerGpo"  -PassThru –Force

EntryPointName                 GslbIp                         Servers 
--------------                 ------                         ------- 
Entry Point 2                  0.0.0.0                        {DA2.domain1.corp.contoso.com}


To validate, the following script should be used.
PS C:\>$daServer = Get-DAServer -EntrypointName "Entry Point 2"



PS C:\>$daServer.ServerConfiguration.GpoName

domain1.corp.contoso.com\ EP2ServerGpo

Example 3

This example adds the edge server named da2.domain1.corp.contoso.com to the multi-site deployment, names the server Entry Point 2 and declares CorpNet1 as the network interface which is connected to the corporate internal network behind the NAT named DeployNat , with a defined internet interface named DMZNet1 and directs clients to connect to the entry point through ep2dmz.da.contoso.com.

PS C:\>Add-DAEntryPoint -Name "Entry Point 2" -InternalInterface CorpNet1 -RemoteAccessServer "da2.domain1.corp.contoso.com" -InternetInterface Internet -ClientIPv6Prefix 3000:0:30:2000::/64 -ConnectToAddress "ep2dmz.da.contoso.com" -ServerGpoName "domain1.corp.contoso.com\EP2ServerGpo" -PassThru –Force

EntryPointName                 GslbIp                         Servers 
--------------                 ------                         ------- 
Entry Point 2                  0.0.0.0                        {da2.domain1.corp.contoso.com} 

Example 4

This example adds the edge server named da2.domain1.corp.contoso.com to the multi-site deployment, names the server Entry Point 2 and declares CorpNet1 as the network interface which is connected to the corporate internal network using GSLB and the IP address for Entry Point 2 is 137.5.0.50.

PS C:\>Add-DAEntryPoint -Name "Entry Point 2" -InternalInterface CorpNet1 -RemoteAccessServer "da2.domain1.corp.contoso.com" -InternetInterface Internet -ClientIPv6Prefix 3000:0:30:2000::/64 -ConnectToAddress "ep2.da.contoso.com" –GslbIP "137.5.0.50" -PassThru -Force

EntryPointName                 GslbIp                         Servers 
--------------                 ------                         ------- 
Entry Point 2                  137.5.0.50                     {da2.domain1.corp.contoso.com} 

Online Version
Get-DAEntryPoint
Remove-DAEntryPoint
Set-DAEntryPoint