Edit

Rename-CMCategory

  • Reference
Module:
ConfigurationManager

Renames a category.

Syntax

Rename-CMCategory
      -InputObject <IResultObject>
      -NewName <String>
      [-PassThru]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Rename-CMCategory
      -CategoryType <CategoryType>
      -Name <String>
      -NewName <String>
      [-PassThru]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Rename-CMCategory cmdlet renames a category instance.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Rename a category by getting a category object

PS ABC:\> $Category = Get-CMCategory -Name "Category01" -CategoryType BaselineCategories
PS ABC:\> Rename-CMCategory -InputObject $Category -NewName "NewCategory01"

The first command gets the category object named Category01 of the type BaselineCategories and stores the object in the $Category variable.

The second command renames the category stored in $Category to NewCategory01.

Example 2: Rename a category by its name and type

PS ABC:\> Rename-CMCategory -Name "Category02" -NewName "NewCategory02" -CategoryType BaselineCategories

This command renames the category named Category02 of the type BaseineCategories to NewCategory02.

Example 3: Rename a category by passing a category object through the pipeline

PS ABC:\> Get-CMCategory -Name "Category03" -CategoryType BaselineCategories | Rename-CMCategory -NewName "NewCategory03"

This command gets the category object named Category03 of the type BaselineCategories and uses the pipeline operator to pass the object to Rename-CMCategory, which renames the category to NewCategory03.

Parameters

-CategoryType

Specifies a category type. Valid values are:

  • AppCategories
  • BaselineCategories
  • CatalogCategories
  • DriverCategories
  • UserCategories
Type:CategoryType
Accepted values:AppCategories, BaselineCategories, CatalogCategories, DriverCategories, UserCategories
Position:Named
Default value:None
Required:True
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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-InputObject

Specifies a category instance object. To obtain a category instance object, use the Get-CMCategory cmdlet.

Type:IResultObject
Aliases:Category
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of a category instance.

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

-NewName

Specifies a new name for the category instance.

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

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

Type:SwitchParameter
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 doesn't run.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object