New-CIAccessControlRule

This cmdlet creates a new access control rule.

Syntax

[-User]  <CIObject>
-AccessLevel  <AccessLevel>
-Entity  <AccessControlledEntity>
[-Force]
[-Server  <CIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
User
CIObject 1 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.
required
AccessLevel
AccessLevel named Specifies the access level for the access control rule that you want to create. This parameter accepts Read, ReadWrite, and FullControl values.
required
Entity
AccessControlledEntity named
  • pipeline
  • Specifies the entity for which you want to create the access control rule. This parameter accepts vApp and Catalog objects.
    optional
    Force
    SwitchParameter named 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.
    optional
    Server
    CIServer[] named 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.

    -AccessLevel  <AccessLevel>
    -Entity  <AccessControlledEntity>
    -EveryoneInOrg
    [-Force]
    [-Server  <CIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    AccessLevel
    AccessLevel named Specifies the access level for the access control rule that you want to create. This parameter accepts Read, ReadWrite, and FullControl values.
    required
    Entity
    AccessControlledEntity named
  • pipeline
  • Specifies the entity for which you want to create the access control rule. This parameter accepts vApp and Catalog objects.
    required
    EveryoneInOrg
    SwitchParameter named Indicates that the access control rule applies for everyone in the organization of the entity.
    optional
    Force
    SwitchParameter named 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.
    optional
    Server
    CIServer[] named 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.

    Output

    VMware.VimAutomation.Cloud.Types.V1.CIAccessControlRule

    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.

    Related Commands

    Feedback

    Was this page helpful?