Rename-DAEntryPointTableItem
Rename-DAEntryPointTableItem
Renames a DirectAccess entry point.
Syntax
Parameter Set: ByPolicyStore
Rename-DAEntryPointTableItem -NewName <String> -PolicyStore <String> [-AsJob] [-CimSession <CimSession[]> ] [-EntryPointName <String[]> ] [-PassThru] [-State <State[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: __cmdletization_InputObject
Rename-DAEntryPointTableItem -InputObject <CimInstance[]> -NewName <String> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByGpoSession
Rename-DAEntryPointTableItem -GPOSession <String> -NewName <String> [-AsJob] [-CimSession <CimSession[]> ] [-EntryPointName <String[]> ] [-PassThru] [-State <State[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
Rename-DAEntryPointTableItem renames a DirectAccess entry point.
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 |
-EntryPointName<String[]>
Specifies the name of the entry point to rename. The entry point name is usually the friendly name of the location, such as "Redmond" or "Paris".
Specify the name of the entry point by using double quotes ( “ ”).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GPOSession<String>
Specifies the Group Policy session to retrieve 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? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance[]>
Specifies the object to rename.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies the new name for the entry point.
Aliases |
none |
Required? |
true |
Position? |
named |
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 |
-PolicyStore<String>
Specifies the policy store from which the cmdlet reads the entry point information.
To retrieve the entry point from a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName"
To retrieve the entry point information from 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? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-State<State[]>
This parameter is deprecated.
Aliases |
none |
Required? |
false |
Position? |
named |
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 |
-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_DASiteTableEntry
This cmdlet accepts as input a CIM object that contains a DA site table entry.
Outputs
The output type is the type of the objects that the cmdlet emits.
- This cmdlet produces no output.
Examples
Example: Rename an entry point
This cmdlet renames a DirectAccess entry point from Redmond to Bellevue.
PS C:\> Rename-DAEntryPointTableItem -EntryPointName "Redmond" -NewName "Bellevue" –PolicyStore Contoso\GPO1