Product Documentation

Set-AdminRole

Nov 06, 2015

Set the properties of a role.

Syntax

Set-AdminRole [-InputObject] <Role[]> [-Description <String>] [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-AdminRole [-Id] <Guid[]> [-Description <String>] [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-AdminRole [-Name] <String[]> [-Description <String>] [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Set-AdminRole command allows the description of custom roles to be updated. You cannot modify built-in roles.

To modify the permissions of a role, use the Add-AdminPermission and Remove-AdminPermission cmdlets.

To update the metadata associated with a role, use the Set-AdminRoleMetadata and Remove-AdminRoleMetadata cmdlets.

Parameters

-InputObject<Role[]>

Specifies the roles to update (by object).

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-Id<Guid[]>

Specifies the roles to update (by id).

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-Name<String[]>

Specifies the roles to update (by name).

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-Description<String>

Supplies the new description value.

Required? false
Default Value  
Accept Pipeline Input? false

-PassThru<SwitchParameter>

Returns the affected record. By default, this cmdlet does not generate any output.

Required? false
Default Value False
Accept Pipeline Input? false

-LoggingId<Guid>

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in connects to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Input Type

Citrix.DelegatedAdmin.Sdk.Role You can pipe the roles to be updated into this command.

Return Values

None or Citrix.DelegatedAdmin.Sdk.Role

When you use the PassThru parameter, Set-AdminRole generates a Citrix.DelegatedAdmin.Sdk.Role object. Otherwise, this cmdlet does not generate any output.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Set-AdminRole -Name Supervisor -Description "Helpdesk supervisor role"

Change the description of the 'Supervisor' role.