Citrix Virtual Apps and Desktops SDK

Set-AdminRole

Set the properties of a role.

Syntax

Set-AdminRole
   [-InputObject] <Role[]>
   [-CanLaunchManage <Boolean>]
   [-CanLaunchMonitor <Boolean>]
   [-Description <String>]
   [-PassThru]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-AdminRole
   [-Id] <Guid[]>
   [-CanLaunchManage <Boolean>]
   [-CanLaunchMonitor <Boolean>]
   [-Description <String>]
   [-PassThru]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-AdminRole
   [-Name] <String[]>
   [-CanLaunchManage <Boolean>]
   [-CanLaunchMonitor <Boolean>]
   [-Description <String>]
   [-PassThru]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

Change the description of the ‘Supervisor’ role.

Set-AdminRole -Name Supervisor -Description "Helpdesk supervisor role"
<!--NeedCopy-->

Parameters

-InputObject

Specifies the roles to update (by object).

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

-Id

Specifies the roles to update (by id).

Type: Guid[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies the roles to update (by name).

Type: String[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CanLaunchManage

Supplies the new CanLaunchManage value.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2109

-CanLaunchMonitor

Supplies the new CanLaunchMonitor value.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2109

-Description

Supplies the new description value.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Length range: 0 to 256

-PassThru

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

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 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.

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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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.DelegatedAdmin.Sdk.Role

You can pipe the roles to be updated into this command.

Outputs

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.

Set-AdminRole