vSphere PowerCLI Reference

New-VIRole

Synopsis

Creates a new role on the specified servers and applies the provided privileges.

Syntax

New-VIRole [-Name] <String> [[-Privilege] <Privilege[]>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

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

Detailed Description

Creates a new role on the specified servers and applies the provided privileges.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecify a name for the new role.truefalse
PrivilegePrivilege[]Specify the privileges you want to apply to the new role.falsefalse
ConfirmSwitchParameterIf 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
ServerVIServer[]Specify the vSphere server 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
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

Role

Notes

Examples

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

New-VIRole -Name Role -Privilege (Get-VIPrivilege -PrivilegeGroup)

Creates a new role with the provided group privileges.


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