PowerCLI Reference

New-CIAccessControlRule

Synopsis

This cmdlet creates a new access control rule.

Syntax

New-CIAccessControlRule [-AccessLevel] <AccessLevel> -Entity <AccessControlledEntity> -EveryoneInOrg [-Force] [-Server <CIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

New-CIAccessControlRule [-AccessLevel] <AccessLevel> [-User] <CIObject> -Entity <AccessControlledEntity> [-Force] [-Server <CIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-CIAccessControlRule
Set-CIAccessControlRule
Remove-CIAccessControlRule

Detailed Description

This cmdlet creates a new access control rule.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
AccessLevelAccessLevelSpecifies the access level for the access control rule that you want to create. This parameter accepts Read, ReadWrite, and FullControl values.trueFalse
UserCIObjectSpecifies the cloud users for whom the access control rule applies. This parameter accepts CIUser and Org objects. When you pass an Org object to this parameter, the access control rule applies for everyone in the organization.trueFalse
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
EntityAccessControlledEntitySpecifies the entity for which you want to create the access control rule. This parameter accepts vApp and Catalog objects.trueTrue (ByValue)
EveryoneInOrgSwitchParameterIndicates that the access control rule applies for everyone in the organization of the entity.trueFalse
ForceSwitchParameterIndicates that you want to overwrite any existing access control rules for the specified entity and cloud user. This parameter is only applicable when the User parameter is specified.falseFalse
ServerCIServer[]Specifies the cloud servers 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 the Connect-CIServer cmdlet.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 CIAccessControlRule object

Notes

Examples

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

New-CIAccessControlRule -Entity 'MyVApp' -User 'MyUser' -AccessLevel "FullControl"

Creates a new access control rule for the specified vApp. The access control rule provides the specified user with full control access privileges for the vApp.

-------------------------- Example 2 --------------------------

New-CIAccessControlRule -Entity 'MyCatalog' -EveryoneInOrg -AccessLevel "Read"

Creates a new access control rule for the specified catalog. The access control rule provides all users in the organization with read only privileges for the catalog.


Copyright © VMware, Inc. All rights reserved.