Rename-Net IPHttps Configuration

Module:
networktransition
Renames an IP-HTTPS profile.

Syntax 

Rename-NetIPHttpsConfiguration
      [-Profile <String[]>]
      [-ProfileActivated <Boolean[]>]
      [-PolicyStore <String>]
      -NewName <String>
      [-PassThru]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Rename-NetIPHttpsConfiguration
      [-Profile <String[]>]
      [-ProfileActivated <Boolean[]>]
      [-GPOSession <String>]
      -NewName <String>
      [-PassThru]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Rename-NetIPHttpsConfiguration
      -InputObject <CimInstance[]>
      -NewName <String>
      [-PassThru]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

Examples

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

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

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.

Example 2: Rename an IP-HTTPS profile 

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

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

Required Parameters

-InputObject

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

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-NewName

Specifies the new name for the IP-HTTPS profile.

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

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
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
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
Accept pipeline input: False
Accept wildcard characters: False
-GPOSession

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.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

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.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Profile

Specifies the name of the profile to rename.

Type: String[]
Aliases: IPHttpsProfile
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ProfileActivated

Specifies which profile to rename.

Type: Boolean[]
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
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
Accept pipeline input: False
Accept wildcard characters: False

Inputs

None

This cmdlet accepts no input objects.

Outputs

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

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign ( # ) provides the namespace and class name for the underlying WMI object.

When the Passthru parameter is specified, this cmdlet outputs a modified Windows Management Instrumentation (WMI) object.