Syntax
New-CIAccessControlRule [-AccessLevel] <AccessLevel> -Entity <AccessControlledEntity> [-User] <CIObject> [-Server <CIServer[]>] [-Force] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet creates a new access control rule.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| AccessLevel | AccessLevel | Specifies the access level for the access control rule that you want to create. This parameter accepts Read, ReadWrite, and FullControl values. | true | false | |
| User | CIObject | Specifies 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. | true | false | |
| 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 | |
| Entity | AccessControlledEntity | Specifies the entity for which you want to create the access control rule. This parameter accepts vApp and Catalog objects. | true | true (ByValue) | |
| EveryoneInOrg | SwitchParameter | Indicates that the access control rule applies for everyone in the organization of the entity. | true | false | |
| Force | SwitchParameter | Indicates 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. | false | false | |
| InformationAction | ActionPreference | false | false | ||
| InformationVariable | String | false | false | ||
| PipelineVariable | String | false | false | ||
| Server | CIServer[] | 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 Connect-CIServer. | 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 newly created CIAccessControlRule objectNotes
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.