< Back

Set-VIRole

Sun Jan 19, 2020 7:09 pm

NAME Set-VIRole



SYNOPSIS

This cmdlet modifies the privileges of the provided roles.





SYNTAX

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

[-WhatIf] [<CommonParameters>]



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

[-WhatIf] [<CommonParameters>]





DESCRIPTION

This cmdlet modifies the privileges of the provided roles.





PARAMETERS

-AddPrivilege <Privilege[]>

Specifies privileges and privilege groups you want to add to the provided roles.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Name <String>

Provides a new name for the provided role.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-RemovePrivilege <Privilege[]>

Specifies privileges or privilege groups you want to remove from the provided roles.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Role <Role[]>

Specifies the roles you want to modify.



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

Zero or more modified Role objects







NOTES









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



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



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



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... IRole.html

Get-VIRole

New-VIRole

Remove-VIRole

Get-VIPrivilege

Get-VIPermission

New-VIPermission

Remove-VIPermission

Set-VIPermission