PowerCLI Reference

New-VIPermission

Synopsis

This cmdlet creates new permissions on the specified inventory objects for the provided users and groups in the role.

Syntax

New-VIPermission [-Entity] <VIObject> [-Principal] <VIAccount> [-Role] <Role> [-Propagate <Boolean>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

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

Detailed Description

This cmdlet creates new permissions on the specified inventory objects for the provided users and groups in the role. By default, new permissions are propagated down the hierarchy to sub-entities. You cannot create new permissions for the following objects:
- direct child folders of a datacenter
- root resource pools of clusters and standalone hosts.
These objects always inherit the permissions of their parent.

Parameters

Name	Type	Description	Required?	Pipeline Input
Principal	VIAccount	Specifies users and groups to which you want to apply the new permissions. If you specify principal names by using the "domain\name" syntax, wildcards are not supported. Passing multiple values to this parameter is obsolete.	true	false
Role	Role	Specifies the roles for which you want to create new permissions.	true	false
Entity	VIObject	Specifies the inventory objects for which you want to create new permissions. Passing multiple values to this parameter is obsolete.	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
Propagate	Boolean	Indicates that you want to propagate the new permissions to the child inventory objects.	false	false
Server	VIServer[]	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.	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

The one or more newly created Permission objects

Notes

You can specify permissions to a datastore only on vSphere 4.1 and later.

Examples

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

New-VIRole -Name Role -Server $server -Privilege (Get-VIPrivilege -PrivilegeGroup)

$permission = New-VIPermission -Role Role -Principal Administrator -Entity (Get-Datacenter)

Creates a permission on the provided server for a role with the specified privileges.