InstallByDirectAccess method of the PS_RemoteAccess class

This cmdlet does the following 1. Performs pre-requisite checks for DirectAccess to ensure that it can be installed2. Installs DirectAccess for remote access (includes management of remote clients) or for management of remote clients only3. Installs VPN (both Remote Access VPN and site-to-site VPN).

Syntax

uint32 InstallByDirectAccess(
  [in]  string             ComputerName,
  [in]  string             DAInstallType,
  [in]  string             ClientGpoName,
  [in]  string             InternalInterface,
  [in]  string             InternetInterface,
  [in]  uint8              NlsCertificate[],
  [in]  string             NlsUrl,
  [in]  boolean            NoPrerequisite,
  [in]  string             ServerGpoName,
  [in]  string             ConnectToAddress,
  [in]  boolean            DeployNat,
  [in]  boolean            PassThru,
  [in]  boolean            Force,
  [out] RemoteAccessCommon cmdletOutput
);

Parameters

ComputerName [in]

IPv4/IPv6 address or hostname of the machine on which the remote access server machine specific tasks should be executed.

DAInstallType [in]

Indicates the configuration in which DirectAccess should be installed. Can take one of the following values. 1. FullInstall - DirectAccess is installed for both remote access and for the management of remote clients. 2. ManageOut - DirectAccess is installed only for the management of remote clients.

ClientGpoName [in]

Names of the client GPO. The GPO name is specified in DOMAIN\GPO_NAME format. Domain can be one of the domains deployed in the corporate network. If a GPO name is not specified then by default a GPO with following name is created in the DA server's domain: [domain] client policy for DirectAccess connection to workplace.

InternalInterface [in]

Name of the corpnet facing interface. In a single-NIC configuration the same name is specified for both internal and Internet interfaces. If name is not specified then cmdlet tries to detect the internal interface automatically.

InternetInterface [in]

Name of the Internet facing interface. In a single-NIC configuration the same name is specified for both internal and Internet interfaces. If name is not specified then cmdlet tries to detect the Internet interface automatically.

NlsCertificate [in]

Indicates that the Network Location Server should be configured on the DirectAccess server itself and represents the certificate to be used. The subject name of the cert should match the internal interface of the DA server.

NlsUrl [in]

Specifying this parameter indicates that the NLS is present on a different and represents the URL on the server that will be used to provide clients with location information.

NoPrerequisite [in]

This parameter when specified indicates that a prerequisite check should not be performed for DirectAccess.

ServerGpoName [in]

Name of the GPO for the DirectAccess server. Specified in the format DOMAIN\GPO_NAME. If a name is not specified then a GPO with the following name is created in the DA server's domain: [domain] server policy for DirectAccess connection to workplace.

ConnectToAddress [in]

Indicates the DA server or NAT public address that clients connect to. Specified as hostname or IPv4 address.

DeployNat [in]

Specifying this switch parameter indicates that DA should be deployed behind a NAT. In a single-NIC configuration scenario the DA server is always deployed behind a NAT and hence there is no need to specify this switch parameter.

PassThru [in]

Specifying PassThru returns the Remote Access object which contains the entire Remote Access (DA and VPN) configuration. This cmdlet doesn't generate an object by default.

Force [in]

Switch parameter used to suppress user confirmation prompts for the following conditions. When suppressed the cmdlet assumes user confirmation for the below mentioned changes. 1. If an appropriate cert for NLS is not found then a self-signed cert is created. 2. If an appropriate SSL cert is not found then a self-signed cert is created.

cmdletOutput [out]

1. When only DirectAccess is installed output will be the DA status, DA deployment mode and DA configuration portions and common configuration portions. 2. When only VPN is installed output will be the VPN status and VPN configuration and common configuration portions.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\Microsoft\Windows\RemoteAccess
MOF	RAMgmtPSProvider.mof
DLL	RAMgmtPSProvider.dll

See also

PS_RemoteAccess