PowerCLI Reference

New-VIRole

Synopsis

This cmdlet 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

This cmdlet creates a new role on the specified servers and applies the provided privileges.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecifies a name for the new role.truefalse
PrivilegePrivilege[]Specifies 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
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

The newly created Role object

Notes

Examples

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

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

Creates a new role with the provided group privileges.


Copyright © VMware, Inc. All rights reserved.