Citrix Daas SDK

Rename-BrokerApplication

Renames an application.

Syntax

Rename-BrokerApplication
      [-InputObject] <Application[]>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Rename-BrokerApplication
      [-Name] <String>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Rename-BrokerApplication cmdlet changes the administrative name of an application. An application cannot have the same name as another application.

Renaming an application does not alter its published name. To change the name with which this application appears to end-users, set a new value for the PublishedName property using the Set-BrokerApplication cmdlet.

Renaming an application does not alter its BrowserName. If the BrowserName property also needs to be changed, use the Set-BrokerApplication cmdlet to modify it.

Examples

EXAMPLE 1

Renames the application with name “Old Name” to “New Name”.

Rename-BrokerApplication -Name "Old Name" -NewName "New Name"
<!--NeedCopy-->

EXAMPLE 2

Renames application with the Uid 1 to “New Name”, showing the result.

Get-BrokerApplication -Uid 1 | Rename-BrokerApplication -NewName "New Name" -PassThru
<!--NeedCopy-->

Parameters

-InputObject

Specifies the application to rename.

Type: Application[]
Position: 2
Default value: Null
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the application to rename.

Type: String
Position: 2
Default value: Null
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-NewName

Specifies the new name for the application.

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

-PassThru

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.

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

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

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

Inputs

Citrix.Broker.Admin.SDK.Application

You can pipe applications to Rename-BrokerApplication.

Outputs

None or Citrix.Broker.Admin.SDK.Application

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.Application object.

Rename-BrokerApplication