Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Rename-NetIPHttpsConfiguration

Rename-NetIPHttpsConfiguration

msft_netiphttpsconfiguration.cdxml

Synopsis

Renames an IP-HTTPS profile.

Syntax

Rename-NetIPHttpsConfiguration [-AsJob] [-CimSession] [-PassThru] [-PolicyStore] [-Profile] [-ProfileActivated] [-ThrottleLimit] [-NewName] [-Confirm] [-WhatIf] [<CommonParameters>]

Rename-NetIPHttpsConfiguration [-AsJob] [-CimSession] [-GPOSession] [-PassThru] [-Profile] [-ProfileActivated] [-ThrottleLimit] [-NewName] [-Confirm] [-WhatIf] [<CommonParameters>]

Rename-NetIPHttpsConfiguration [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-InputObject] [-NewName] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Rename-NetIPHttpsConfiguration cmdlet renames an IP-HTTPS profile, either on a computer or in a Group Policy Object (GPO).

Parameters

-AsJob <SwitchParameter>

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

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-GPOSession <String>

Specifies the Group Policy session which contains the IP-HTTPS configuration to rename. You can use this parameter with the NetGPO cmdlets to aggregate multiple operations performed on a GPO. You cannot use this parameter with the PolicyStore parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the object which contains an IP-HTTPS profile 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 IP-HTTPS profile.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-PolicyStore <String>

Specifies the policy store that contains the configuration profile to rename. The acceptable values for this parameter are:  -- GPO To rename the configuration profile of a GPO, specify the GPO name using the following format: Domain\GPOName You cannot use this parameter with the GPOSession parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Profile <String[]>

Specifies the name of the profile to rename.

Aliases

IPHttpsProfile

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ProfileActivated <Boolean[]>

Specifies which profile to rename.

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

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPHttpsConfiguration

Notes

None

Examples

Example 1: Rename an IP-HTTPS profile using a configuration object

This set of commands uses the Get-NetIPHttpsConfiguration cmdlet to get an IP-HTTPS configuration object and stores it in a variable named $config. The contents of the variable are then passed to this cmdlet.

PS C:\>$config = Get-NetIPHttpsConfiguration –PolicyStore "testdomain\GPOName"



PS C:\>Rename-NetIPHttpsConfiguration –InputObject $config

Example 2: Rename an IP-HTTPS profile

This command renames the IP-HTTPS profile named Redmond to Fareast.

PS C:\>Rename-NetIPHttpsConfiguration –Profile Redmond –NewName Fareast

Online Version
Get-NetIPHttpsConfiguration
New-NetIPHttpsConfiguration
Remove-NetIPHttpsConfiguration
Reset-NetIPHttpsConfiguration
Set-NetIPHttpsConfiguration