Edit

Share via


Rename-NetIPHttpsConfiguration

Renames an IP-HTTPS profile.

Syntax

ByPolicyStore (Default)

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

ByGpoSession

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

InputObject (cdxml)

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.

Parameters

-AsJob

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByGpoSession
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject (cdxml)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-NewName

Specifies the new name for the IP-HTTPS profile.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByPolicyStore
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Profile

Specifies the name of the profile to rename.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPHttpsProfile

Parameter sets

ByPolicyStore
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByGpoSession
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ProfileActivated

Specifies which profile to rename.

Parameter properties

Type:

Boolean[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByPolicyStore
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByGpoSession
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

This cmdlet accepts no input objects.

Outputs

CimInstance

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.