## PowerCLI Reference

# Set-VIRole

## Synopsis

This cmdlet modifies the privileges of the provided roles.

Syntax

Set-VIRole [-Role] <Role[]> [-Name <String>] [-AddPrivilege <Privilege[]>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-VIRole [-Role] <Role[]> [-Name <String>] [-RemovePrivilege <Privilege[]>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VIRole
New-VIRole
Remove-VIRole
Get-VIPrivilege
Get-VIPermission
New-VIPermission
Remove-VIPermission
Set-VIPermission

Detailed Description

This cmdlet modifies the privileges of the provided roles.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
Role | Role[] | Specifies the roles you want to modify. | true | true (ByValue)
AddPrivilege | Privilege[] | Specifies privileges and privilege groups you want to add to the provided roles. | false | false
Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | false
Name | String | Provides a new name for the provided role. | false | false
RemovePrivilege | Privilege[] | Specifies privileges or privilege groups you want to remove from the provided roles. | false | false
Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | false
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false

Return Type

Zero or more modified Role objects

Notes

Examples

-------------- Example 1 --------------

    Set-VIRole -Role Role -AddPrivilege (Get-VIPrivilege -Name 'Create Datacenter')

Adds the "Create Datacenter" privilege to the Role role.

Copyright © VMware, Inc. All rights reserved.