vSphere PowerCLI Cmdlets Reference

Set-VIRole

Synopsis

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

Modifies the privileges of the provided roles.

Parameters

NameDescriptionRequired?Pipeline InputDefault Value
RoleSpecify the roles you want to modify.truetrue (ByValue)
NameProvide a new name for the provided role.falsefalse
AddPrivilegeSpecify privileges and privilege groups you want to add to the provided roles.falsefalse
ServerSpecify the vSphere servers 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.falsefalse
WhatIfIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse
ConfirmIf 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.falsefalse$true
RemovePrivilegeSpecify privileges or privilege groups you want to remove from the provided roles.falsefalse

Return Type

Role

Notes

Examples

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

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

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


Copyright © 1998 - 2010 VMware, Inc. All rights reserved.