Syntax
Remove-VIRole [-Role] <Role[]> [-Force] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet removes the specified roles. To remove a role that is associated with a permission, you need to set the Force parameter to $true.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Role | Role[] | Specifies the roles you want to remove. | true | true (ByValue) | |
| 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 | |
| Force | SwitchParameter | Indicates that you want to remove the role even if it is associated with a permission. | 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
NoneNotes
Examples
-------------- Example 1 --------------
Get-VIRole -Server $server -Name "Customer*" | Remove-VIRole
Removes the roles with names that start with "Customer".