< Back
Remove-VIRole
Post
NAME Remove-VIRole
SYNOPSIS
This cmdlet removes the specified roles.
SYNTAX
Remove-VIRole [-Role] <Role[]> [-Force] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
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
-Force [<SwitchParameter>]
Indicates that you want to remove the role even if it is associated with a permission.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Role <Role[]>
Specifies the roles you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
NOTES
-------------------------- Example 1 --------------------------
Get-VIRole -Server $server -Name "Customer*" | Remove-VIRole
Removes the roles with names that start with "Customer".
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... IRole.html
Get-VIRole
New-VIRole
Set-VIRole
Get-VIPrivilege
Get-VIPermission
New-VIPermission
Remove-VIPermission
Set-VIPermission
SYNOPSIS
This cmdlet removes the specified roles.
SYNTAX
Remove-VIRole [-Role] <Role[]> [-Force] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
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
-Force [<SwitchParameter>]
Indicates that you want to remove the role even if it is associated with a permission.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Role <Role[]>
Specifies the roles you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
NOTES
-------------------------- Example 1 --------------------------
Get-VIRole -Server $server -Name "Customer*" | Remove-VIRole
Removes the roles with names that start with "Customer".
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... IRole.html
Get-VIRole
New-VIRole
Set-VIRole
Get-VIPrivilege
Get-VIPermission
New-VIPermission
Remove-VIPermission
Set-VIPermission