Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Add-RemoteAccessRadius

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Add-RemoteAccessRadius

Adds a new external RADIUS server for VPN authentication, accounting for DirectAccess (DA) and VPN, or one-time password (OTP) authentication for DA.

Syntax

Parameter Set: Add0
Add-RemoteAccessRadius [-ServerName] <String> [-Purpose] <String> [-SharedSecret] <String> [-AccountingOnOffMsg <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-EntrypointName <String> ] [-MsgAuthenticator <String> ] [-PassThru] [-Port <UInt16> ] [-Score <Byte> ] [-ThrottleLimit <Int32> ] [-Timeout <UInt32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Add-RemoteAccessRadius cmdlet adds a new external RADIUS server for one of the following purposes:
-- Accounting Radius configuration applies to both DirectAccess (DA) and VPN.
-- One-time password (OTP) RADIUS configuration applies only to DA.
-- Authentication Radius configuration applies only to VPN.

Radius server configuration for Accounting and OTP are global in nature, such as the configurations apply to the entire Remote Access deployment. RADIUS server configuration for VPN applies only to a specific VPN server, and all servers in a load balancing cluster, or if multi-site is deployed, to all VPN servers at a site.

Following describes aspects of this cmdlet behavior.
-- If a RADIUS server is currently being used for a specific purpose, then it can be added for additional purpose using this cmdlet.
-- The RADIUS server properties for authentication and accounting are the same except for the AccountingOnOffMsg parameter which is applicable only to accounting RADIUS and the MsgAuthenticator parameter which is applicable only to authentication RADIUS. These properties are not relevant for DA OTP authentication.
-- If a user tries to add a RADIUS server for a particular purpose but specifies a parameter that is not applicable to that purpose, then this cmdlet will still run but the parameter will be ignored and a warning message will be issued. When adding a RADIUS server for OTP authentication both the above described parameters are ignored if specified.
-- If the accounting configuration is Windows Server® 2012 accounting, then a user can switch to external RADIUS accounting by adding an external RADIUS server for the purpose of accounting.
-- Following are some pre-requisites for adding a RADIUS server.
---- A RADIUS server cannot be added for authentication when VPN is not even installed.
---- A RADIUS server cannot be added for authentication when the authentication type is Windows or when local NPS is installed.
---- A RADIUS server cannot be added for the purpose of accounting when external RADIUS accounting is not enabled.
---- A RADIUS server cannot be added for purpose of OTP authentication if OTP authentication is not enabled.

Parameters

-AccountingOnOffMsg<String>

Indicates the enabled state for sending of accounting on or off messages. The acceptable values for this parameter are: 
-- Enabled.
-- Disabled. This is the default value.
This parameter is applicable only when the RADIUS server is being added for Remote Access accounting.


Aliases

none

Required?

false

Position?

named

Default Value

Disabled

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-AsJob

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

-ComputerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the computer on which the remote access server computer-specific tasks should be executed. If this parameter is specified when adding a RADIUS server for authentication, then it is added for the VPN server represented by this parameter value.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EntrypointName<String>

Specifies the identity of a site in a multi-site deployment. This parameter is applicable only to RADIUS server configuration for VPN authentication. It is not applicable to RADIUS accounting and OTP and hence is ignored when a user tries to add a radius server for these purposes.
When this parameter is specified it indicates that the RADIUS server for VPN authentication should be added for that site.
If this parameter is not specified in a multi-site deployment, then this parameter value for the server on which the cmdlet is run is used. The server could also be represented by using the ComputerName parameter.
If this parameter and ComputerName parameter are specified and the ComputerName parameter value does not belong to the site represented by this parameter value, then this parameter takes precedence and the RADIUS server is added to it.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-MsgAuthenticator<String>

Specifies the enabled state for the usage of message authenticator. The acceptable values for this parameter are: 
-- Enabled.
-- Disabled. This is the default value.
This parameter is applicable only when the RADIUS server is being added for VPN authentication.


Aliases

none

Required?

false

Position?

named

Default Value

Disable

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

-Port<UInt16>

Specifies the port number on which the RADIUS server is accepting authentication requests. The default value is 1813.


Aliases

none

Required?

false

Position?

named

Default Value

1813

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Purpose<String>

Specifies the purpose for which the external RADIUS server is being added. The acceptable values for this parameter are: 
-- Authentication.
-- Accounting.
-- Otp.


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Score<Byte>

Specifies the initial score. The default value is 30.


Aliases

none

Required?

false

Position?

named

Default Value

30

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ServerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the external RADIUS server.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SharedSecret<String>

Specifies the shared secret between the VPN server and the specified external RADIUS server. Note: The secret is specified in clear text.


Aliases

none

Required?

true

Position?

4

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

-Timeout<UInt32>

Specifies the timeout value in seconds. The default value is 5 (seconds).


Aliases

none

Required?

false

Position?

named

Default Value

5

Accept Pipeline Input?

true (ByPropertyName)

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.

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#RemoteAccessRadiusServer[]

    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 RemoteAccessRadiusServer object array consists of the following properties:
    -- IPv4 or IPv6 address, or host name, of the RADIUS server that was added.
    -- The Purpose for which the server was added property: the RADIUS server can be added for VPN authentication, accounting or OTP.
    -- Radius initial score.
    -- Radius timeout in seconds.
    -- Radius port number.
    -- For added security, the Radius shared secret property is never populated; it will always show as blank.
    -- The Status of accounting on and off messages property is always blank if the RADIUS server was added for authentication or OTP.
    -- The Status of message authenticator property is always blank if the RADIUS server was added for accounting or OTP.


Examples

EXAMPLE 1

This example adds the RADIUS server named 10.1.2.1 for the purpose of VPN authentication.


PS C:\> Add-RemoteAccessRadius –ServerName 10.1.2.1 Authentication "s3cr3t2" -PassThru
ServerName   Purpose         Score  Timeout(s)  Port   AccountingOnOffMsg MsgAuthenticator 
----------   -------         -----  ----------  ----   ------------------ ---------------- 
10.1.2.1     Authentication  30     5           1812                      Disabled 

EXAMPLE 2

This example adds the RADIUS server named 10.1.3.1 for the purpose of accounting for DA and VPN.


PS C:\> Add-RemoteAccessRadius –ServerName 10.1.3.1 Accounting "s3cr3t5" -PassThru
ServerName   Purpose         Score  Timeout(s)  Port   AccountingOnOffMsg MsgAuthenticator 
----------   -------         -----  ----------  ----   ------------------ ---------------- 
10.1.3.1     Accounting      30     5           1813   Disabled 

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.