Share via


Set method of the PS_VpnAuthProtocol class

Updates the authentication method of an incoming S2S VPN interface of a RRAS server.

Syntax

uint32 Set(
  [in]  string          UserAuthProtocolAccepted[],
  [in]  string          TunnelAuthProtocolsAdvertised,
  [in]  uint8           RootCertificateNameToAccept[],
  [in]  uint8           CertificateAdvertised[],
  [in]  string          SharedSecret,
  [in]  boolean         PassThru,
  [in]  string          CertificateEKUsToAccept[],
  [out] VpnAuthProtocol cmdletOutput
);

Parameters

UserAuthProtocolAccepted [in]

Specifies Local Authentication protocols that are allowed.

TunnelAuthProtocolsAdvertised [in]

Specifies the remote AuthenticationMethod used by the RRAS server. If PreSharedKey is specified, SharedSecret parameter becomes mandatory. If Certificates is specified, UserMachineCert parameter becomes mandatory. Only one of them can be specified.

RootCertificateNameToAccept [in]

Root certificates to be allowed. Applicable only if UserAuthProtocolAccepted contains certificates.

CertificateAdvertised [in]

Certificate to be sent to peer. Applicable only if TunnelAuthProtocolsAdvertised contains "Certificate".

SharedSecret [in]

Text of the Shared Secret to be used in dialing the connection. Applicable only if AuthenticationMethod is set to "PSK".

PassThru [in]

Indicates whether the cmdletOutput parameter returns an object. True to return an object; otherwise false.

CertificateEKUsToAccept [in]

Windows Server 2012: This parameter is unavailable prior to Windows Server 2012 R2.

An array that contains the names of the allowed Enhanced Key Usage (EKU) certificates.

cmdletOutput [out]

Receives the VpnAuthProtocol object that contains the updated authentication method.

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_VpnAuthProtocol