COMMAND EVERYTHING.
Performs prerequisite checks for DirectAccess (DA) to ensure that it can be installed, installs DA for remote access (RA) (includes management of remote clients) or for management of remote clients only, installs VPN (both Remote Access VPN and site-to-site VPN), and installs Border Gateway Protocol Routing..
Microsoft RemoteAccess reference: Performs prerequisite checks for DirectAccess (DA) to ensure that it can be installed, installs DA for remote access (RA) (includes management of remote clients) or for management of remote clients only, installs VPN (both Remote Access VPN and site-to-site VPN), and installs Border Gateway Protocol Routing.. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Install-RemoteAccess. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Windows / RemoteAccess · Windows Server 2025 documentation; feature/module prerequisites apply
-AsJob- Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-CapacityKbps- Specifies thebandwidth processing capacity of the gateway in Kbps.
-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.
-ClientGpoName- Specifies the names of the client GPO. The GPO name is specified in DOMAIN\GPO_NAME format. A 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 domain of the DA server: - DirectAccess Client Settings.
-ComputerName- Specifies the IPv4 or IPv6 address, or host name, of the computer on which the remote access server computer specific tasks should be run.
-Confirm- Prompts you for confirmation before running the cmdlet.
-ConnectToAddress (required)- Specifies the DA server or NAT public address to which the clients connect. Specified as a host name or an IPv4 address. If the address is specified, then is must to be public.
-DAInstallType (required)- Specifies the configuration in which DA should be installed. The acceptable values for this parameter are: - FullInstall: DA is installed for both remote access and for the management of remote clients. - ManageOut: DA is installed only for the management of remote clients.
-DeployNat- Specifies that DA should be deployed behind a NAT. In a single network adapter configuration scenario the DA server is always deployed behind a NAT and there is no need to specify this parameter.
-EntrypointName- Specifies the identity of a site in a multi-site deployment where VPN needs to be installed. This is required in a scenario where DA with multi-site is already deployed and a user wants to additionally deploy VPN. If this parameter is not specified, then the entry point name to which the server on which the cmdlet is run is used. The server could also be represented using the ComputerName parameter. If both this parameter and ComputerName parameter are specified and the computer name does not belong to the site represented by the entry point name then this parameter takes precedence and VPN is deployed at the site indicated by it. Note: A multi-site deployment case VPN can only be installed one site at a time. Note: In a S2S case, the cmdlet will install it on any one available node in that entry point.
-Force- Forces the command to run without asking for user confirmation. When suppressed, the cmdlet assumes user confirmation for the following conditions. - If an appropriate certificate for NLS is not found, then a self-signed certificate is created. - If an appropriate SSL certificate is not found, then a self-signed certificate is created. Note: If the addresses are not static (such as DHCP), then ShouldContinue can be used.
-IPAddressRange- Specifies that static pool IPv4 addressing should be enabled. This parameter contains an IP address range, and consisting of a start IP and an end IP, from which IP addresses are allocated to VPN clients. In a load balancing scenario only static pool IPv4 addressing is supported for a VPN (DHCP address assignment is not supported). This parameter must be specified and an IPv4 address range should be provided for every node in the cluster. This parameter is specified in the following format: StartIPRange1, EndIPRange1, StartIPRange2, EndIPRange2, StartIPRange3, EndIPRange3, and so on. The start and end IPs of each of the ranges must be specified one after the other and separated by commas.
-IPv6Prefix- Enables IPv6 address assignment for a VPN and specifies the prefix to use for the addressing.
-InternalInterface- Specifies the name of the corporate network facing interface. In a single network adapter configuration the same name is specified for both internal and internet interfaces. If a name is not specified, then the cmdlet attempts to detect the internal interface automatically.
-InternetInterface- Specifies the name of the internet facing interface. In a single network adapter configuration the same name is specified for both internal and internet interfaces. If name is not specified, then this cmdlet attempts to detect the internet interface automatically.
-MsgAuthenticator- Specifies that the usage of message authenticator should be enabled or disabled. The acceptable values for this parameter are: - Enabled. - Disabled. The default value is Disabled. This parameter is applicable only when a RADIUS server is being configured for authentication.
-MultiTenancy (required)- Indicates that multitenancy is enabled for the service.
-NlsCertificate- Specifies that the Network Location Server (NLS) should be configured on the DA server itself and represents the certificate to be used. The subject name of the certificate should resolve to an address on the internal interface of the DA server.
-NlsUrl- Specifies that the NLS is present on a different server and represents the URL on the server that will be used to provide clients with location information.
-NoPrerequisite- Specifies that a prerequisite check should not be performed for DA.
-PassThru- Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-Prerequisite (required)- Specifies that prerequisite checks should be performed. This parameter is part of a separate parameter set used to only run the prerequisite checks for DA.
-RadiusPort- Specifies the port number on which the RADIUS server is accepting authentication requests. The default value is 1813. This parameter is applicable only when a RADIUS server is being configured for authentication.
-RadiusScore- Specifies the initial score for the RADIUS server. The default value is 30. This parameter is applicable only when a RADIUS server is being configured for authentication.
-RadiusServer- Specifies the IPv4 or IPv6 address, or host name, of the RADIUS server that is to be used for authentication. Specifying this parameter indicates that RADIUS authentication should be used for VPN.
-RadiusTimeout- Specifies the timeout value for the RADIUS server, in seconds. The default value is 5 seconds. This parameter is applicable only when a RADIUS server is being configured for authentication.
-ServerGpoName- Specifies the name of the GPO for the DA 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 domain of a DA server: -- DirectAccess Client Settings.
-SharedSecret- Specifies the shared secret between the RA server and the specified external RADIUS server, which is required for successful communication between the two servers. Note: The secret is specified in plain text. It is mandatory to specify this parameter if a RADIUS server is being configured for authentication.
-ThrottleLimit- 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.
-VpnType (required)- Specifies the type of VPN installation. The acceptable values for this parameter are: - Vpn - VpnS2S - SstpProxy - RoutingOnly
-WhatIf- Shows what would happen if the cmdlet runs. The cmdlet is not run.
Windows with the RemoteAccess module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.