vSphere PowerCLI Cmdlets Reference

Remove-VIRole

Synopsis

Removes the specified roles.

Syntax

Remove-VIRole [-Role] <Role[]> [-Force] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

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

Detailed Description

Removes the specified roles. To remove a role that is associated with a permission, you need to set the Force parameter to $true.

Parameters

NameDescriptionRequired?Pipeline InputDefault Value
RoleSpecify the roles you want to remove.truetrue (ByValue)
ForceIndicate that you want to remove the role even if it is associated with a permission.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

Return Type

none

Notes

Examples

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

Get-VIRole -Server $server -Name "Customer*" | Remove-VIRole

Removes the roles with names that start with "Customer".


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