Creating an S3 Vault

You can add an S3 Vault either by using the Commvault API or from the Command Center.

Before You Begin

Using Command Center

You can add an S3 Vault from the Command Center.

Create an S3 Vault

  1. From the Command Center navigation pane, go to Manage > Infrastructure.

    The Infrastructure page appears.

  2. Click the S3 Vault tile.

    The S3 Vault page appears.

  3. Click Add S3 Vault.

    The Add S3 Vault wizard appears.

  4. On the S3 Vault Name page, in the S3 Vault name box, enter a name for the S3 Vault, and then click NEXT.

    The S3 Vault name is unique across the entire CommCell.

  5. On the Plan page, from the Plan list, select an existing plan or create a new plan by clicking the +, and then click Next.

    When creating a plan, configure storage for your vault:

    • Bundled Storage: Standard managed storage included with your subscription
    • AGP Storage: Air Gap Protect for immutable, air-gapped backups

    For more information about creating plans and configuring AGP storage, see Creating a Server Plan.

    The S3 Vault package is automatically installed on any MediaAgents in the plan that do not already have it.

  6. On the S3 User Permission page, in the Enter users, users groups box, enter the user or the user group to search for a user or user group, and then click Add.

    Users added here are given S3 User Role.

  7. Click Add to create S3 Vault.

    Note

    Rotate keys whenever a new user is added to the S3 Vault.

View S3 Vault Details

  1. From the Command Center navigation pane, go to Manage > Infrastructure.

    The Infrastructure page appears.

  2. Click the S3 Vault tile.

    The S3 Vault page appears.

  3. Click the S3 Vault you want to view.

    The S3 Vault overview page appears, displaying details such as the vault name, backup summary, and associated endpoint.

Using API

The S3 bucket creation process involves creating an instance of the S3 Vault, which is managed through the CreateCVS3Store API. This API allows you to create an S3 Vault by specifying the necessary details such as the bucket entity, plan entity, endpoints, and owners. The response includes the details of the newly created S3 Vault and any associated jobs for installing the S3 endpoint package on selected clients.

S3 Vault Creation

  • API Endpoint: POST /V4/CVS3Store
  • Description: Create an instance of the S3 Vault.
  • Request Body:
    • bucket: Specifies the name for the S3 Vault.
    • plan: Specifies the plan name to be used.
    • cvs3Endpoints: List of clients to be configured as S3 endpoints.
    • owners: List of users to add S3 Plan role and associate with the new S3 Vault.
    • userGroups: List of groups to add S3 Plan role and associate with the new S3 Vault.
    • rotateKeys: Flag to rotate user keys.
  • Responses:
    • 200: Success, returns the details of the newly created S3 Vault.
    • 400: Bad or incomplete request.
    • 403: Forbidden.
    • 404: Requested details not found.
    • 409: Entity with the same name already exists.
    • 500: Internal processing error.
×

Loading...