InstallByMultiTenant method of the PS_RemoteAccess class

  • Article

Installs DirectAccess and multi-tenant site-to-site (S2S) VPN.

Syntax

uint32 InstallByMultiTenant(
  [in]  string             ComputerName,
  [in]  boolean            MultiTenancy,
  [in]  string             VpnType,
  [in]  string             MsgAuthenticator,
  [in]  boolean            PassThru,
  [in]  uint16             RadiusPort,
  [in]  uint8              RadiusScore,
  [in]  string             RadiusServer,
  [in]  uint32             RadiusTimeout,
  [in]  string             SharedSecret,
  [in]  uint64             CapacityKbps,
  [out] RemoteAccessCommon cmdletOutput
);

Parameters

ComputerName [in]

The IP address or hostname of the computer that is to run the Remote Access server tasks.

MultiTenancy [in]

Indicates whether to install the VPN as a multi-tenant service. True to install the the VPN as a multi-tenant service; otherwise false.

VpnType [in]

Windows Server 2012 R2: This parameter is not available before Windows Server 2016.

The type of VPN to configure.

MsgAuthenticator [in]

Indicates whether to enable the message authenticator for a Remote Authentication Dial In User Service (RADIUS) server. You can set this parameter to one of the following values. By default, this parameter is set to disabled.

Enabled

Enables the message authenticator.

Disabled

Disables the message authenticator.

PassThru [in]

Indicates whether the cmdletOutput parameter returns an object. True to return an object; otherwise false. By default, cmdletOutput does not return an object.

RadiusPort [in]

The port number on which the RADIUS server accepts authentication requests. The default port is 1812.

RadiusScore [in]

Indicates the initial score of the RADIUS server. The default score is 30.

RadiusServer [in]

The IP address or hostname of the RADIUS server.

RadiusTimeout [in]

The timeout value for the RADIUS server, in seconds. The default value is 5.

SharedSecret [in]

The shared secret between the Remote Access server and the RADIUS server.

CapacityKbps [in]

The bandwidth capacity of the remote access configuration.

cmdletOutput [out]

The RemoteAccessCommon object that receives the information for the installed Remote Access features.

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

See also

PS_RemoteAccess