Edit

Rename-DAEntryPointTableItem

  • Reference
Module:
DirectAccessClientComponents

Renames a DirectAccess entry point.

Syntax

Rename-DAEntryPointTableItem
      [-EntryPointName <String[]>]
      -PolicyStore <String>
      -NewName <String>
      [-PassThru]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Rename-DAEntryPointTableItem
      [-EntryPointName <String[]>]
      -GPOSession <String>
      -NewName <String>
      [-PassThru]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Rename-DAEntryPointTableItem
      -InputObject <CimInstance[]>
      -NewName <String>
      [-PassThru]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Rename-DAEntryPointTableItem cmdlet renames a DirectAccess entry point.

Examples

Example 1: Rename an entry point

PS C:\> Rename-DAEntryPointTableItem -EntryPointName "Redmond" -NewName "Bellevue" -PolicyStore "Contoso\GPO1"

This cmdlet renames a DirectAccess entry point from Redmond to Bellevue.

Parameters

-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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EntryPointName

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 (" ").

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-GPOSession

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.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NewName

Specifies the new name for the entry point.

Type:String
Position:Named
Default value:None
Required:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PolicyStore

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 format "Domain\GPOName".

To retrieve the entry point information from a computer's local GPO, specify the computer's local GPO name in the format "GPO:<computername>".

PolicyStore cannot be used in conjunction with GPOSession.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

This cmdlet accepts as input a CIM object that contains a DA site table entry.

Outputs

None