Set-DAClientExperienceConfiguration
Set-DAClientExperienceConfiguration
Modifies the configuration of the specified DirectAccess client user experience.
Syntax
Parameter Set: ByName
Set-DAClientExperienceConfiguration [[-CorporateResources] <String[]> ] [[-IPsecTunnelEndpoints] <String[]> ] [[-PreferLocalNamesAllowed] <Boolean> ] [[-UserInterface] <Boolean> ] [[-SupportEmail] <String> ] [[-FriendlyName] <String> ] [[-ManualEntryPointSelectionAllowed] <Boolean> ] [[-GslbFqdn] <String> ] [[-ForceTunneling] <ForceTunneling> ] [[-CustomCommands] <String[]> ] [[-PassiveMode] <Boolean> ] [-AsJob] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: __cmdletization_InputObject
Set-DAClientExperienceConfiguration [[-CorporateResources] <String[]> ] [[-IPsecTunnelEndpoints] <String[]> ] [[-PreferLocalNamesAllowed] <Boolean> ] [[-UserInterface] <Boolean> ] [[-SupportEmail] <String> ] [[-FriendlyName] <String> ] [[-ManualEntryPointSelectionAllowed] <Boolean> ] [[-GslbFqdn] <String> ] [[-ForceTunneling] <ForceTunneling> ] [[-CustomCommands] <String[]> ] [[-PassiveMode] <Boolean> ] -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
Set-DAClientExperienceConfiguration modifies the specified configuration properties of the DirectAccess client user experience. The DirectAccess client configuration controls the user interface behavior, as well as what configuration options are available to the user.
This cmdlet can be used to change configuration properties stored in Group Policy Objects.
Parameters
-AsJob
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 |
-CorporateResources<String[]>
Configures the connectivity tests that DirectAccess client computers use to determine connectivity. Enter the values for this parameter in the form of a string array, with each entry surrounded by double quotes (“ “) and separated by commas. Use the following formats for each test type:
HTTP test: "HTTP:http://computername"
File test: "FILE:\\fileserver\"
Ping test: "PING:testURL”
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CustomCommands<String[]>
Configures any custom commands required by the administrator. The custom commands are incorporated into the logs that are generated when there are problems. Commands run in an elevated Windows PowerShell console sequentially.
Each item in the string array must be an individual command.
Aliases |
none |
Required? |
false |
Position? |
11 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ForceTunneling<ForceTunneling>
Configures the force tunneling setting on a DirectAccess client computer. Valid values for ForceTunneling are “Enabled” or “Disabled”. By default, force tunneling is disabled.
Aliases |
none |
Required? |
false |
Position? |
10 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FriendlyName<String>
Specifies the name of the DirectAccess deployment to be shown in the client computer user interface. It is recommended that the name be 15 characters or less.
Aliases |
none |
Required? |
false |
Position? |
7 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GPOSession<String>
Specifies the Group Policy session to send configuration information. You can use GPOSession with the NetGPO cmdlets to aggregate multiple operations performed on a Group Policy Object.
GPOSession cannot be used in conjunction with PolicyStore.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GslbFqdn<String>
Specifies the fully-qualified domain name (FQDN) used for DirectAccess multisite client computers. The client computer resolves the FQDN to an IP address, and compares the IP address to the list of entry points. Client computers use the matching entry point for connectivity.
Specify the value for GslbFqdn in double quotes (“ “).
Aliases |
none |
Required? |
false |
Position? |
9 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IPsecTunnelEndpoints<String[]>
Configures the IPsec tunnel endpoints to use for DirectAccess. Client computers use this information to verify the availability of the DirectAccess servers and present that information to the user.
Specify the values for IPsecTunnelEndpoints in double quotes (“ “), separated by commas, in the following format:
"Ping: ipaddress"
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance[]>
Specifies the name of the object which contains the client experience configuration information to modify.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-ManualEntryPointSelectionAllowed<Boolean>
Specifies if the user of a client computer can change the site used for DirectAccess connectivity. If ManualEntryPointSelectionAllowed is set to True, then users can change the entry point configuration in the user interface. If ManualEntryPointSelectionAllowed is set to False, then users cannot change the entry point configuration in the user interface. By default, ManualEntryPointSelectionAllowed is set to True.
Aliases |
none |
Required? |
false |
Position? |
8 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassThru
Sends items from an interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output. However, to send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassiveMode<Boolean>
Controls the passive mode setting on DirectAccess client computers. In order to report DirectAccess status to the user, DirectAccess performs a set of tests frequently. When PassiveMode is set to True, those tests happen much less frequently. However, enabling passive mode makes the client experience less responsive.
Valid values for PassiveMode are “True” or “False”. By default, PassiveMode is set to False, which is the recommended setting.
Aliases |
none |
Required? |
false |
Position? |
12 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PolicyStore<String>
Specifies the policy store into which the cmdlet stores the configuration information.
To store the configuration information in a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName"
To store the configuration information in a computer’s local GPO, specify the computer’s local GPO name in the following format: "GPO:<computername>"
PolicyStore cannot be used in conjunction with GPOSession.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PreferLocalNamesAllowed<Boolean>
Controls if users can disconnect DirectAccess. Disconnecting DirectAccess temporarily deactivates the name resolution policy table.
Valid values for PreferLocalNamesAllowed are “True” or “False”. If set to True, users can disconnect DirectAccess. The default value is False.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SupportEmail<String>
Configures the email address displayed in the user interface for users to send logs and requests for assistance. SupportEmail must be configured for logging to work.
Specify SupportEmail in the format of a valid email address.
Aliases |
none |
Required? |
false |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-UserInterface<Boolean>
Enables or disables the user interface for DirectAccess on the client computers that receive the policy.
Valid values for UserInterface are “True” or “False”. Setting UserInterface to False, removes the user interface. By default, UserInterface is set to True.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DAClientExperienceConfiguration
This cmdlet accepts as input a CIM object that contains a DA client experience configuration.
Outputs
The output type is the type of the objects that the cmdlet emits.
- This cmdlet produces no output.
Examples
Example: Disable the DirectAccess user interface
This cmdlet disables the DirectAccess user interface.
PS C:\> Set-DAClientExperienceConfiguration –PolicyStore “Contoso\GPO1” –UserInterface “False”