Set-VBRS3CompatibleRepositorySecurityOptions

Short Description

Modifies settings that Veeam Agent uses to access S3 compatible repositories.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRS3CompatibleRepositorySecurityOptions -Repository <VBRAmazonS3CompatibleRepository> [-AccessControlPolicy <VBRS3CompatibleAccessControlPolicyType>] [-IAMEndpoint <String>] [-STSEndpoint <String>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings that Veeam Agent uses to access S3 compatible repositories.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Repository

Specifies an S3 compatible repository. The cmdlet will modify settings that Veeam Agent uses to access this repository.

Accepts the VBRAmazonS3CompatibleRepository object. To get this object, run the Get-VBRObjectStorageRepository cmdlet.

True

Named

True (ByValue, ByPropertyName)

AccessControlPolicy

Specifies how Veeam Agent accesses S3 compatible repositories:

  • AllowAll — use this option if you want Veeam Agent to access S3 compatible directly using credentials for the S3 compatible bucket.
  • S3CompatibleManaged — use this option if you want Veeam Agent to access S3 compatible repositories directly using secure credentials with a service token.
    Note: use the IAMEndpoint and STSEndpoint parameters to specify these credentials.
  • VBRManaged — use this option if you want Veeam Agent to access S3 compatible repositories through gateway servers.

VBRS3CompatibleAccessControlPolicyType

False

Named

False

IAMEndpoint

For the direct secure connection with a service token.

Specifies an endpoint of your S3 compatible repository. The cmdlet will use this host to connect to this repository.

String

False

Named

False

STSEndpoint

For the direct secure connection with a service token.

Specifies the security token of your S3 compatible repository. The cmdlet will use this security token to connect to this repository.

String

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRS3CompatibleRepositorySecurityOptions

Examples

Set-VBRS3CompatibleRepositorySecurityOptionsExample 1. Setting Direct Access to S3 Compatible Repositories [Using Bucket Credentials]

Set-VBRS3CompatibleRepositorySecurityOptionsExample 2. Setting Direct Access to S3 Compatible Repositories [Using Service Token]

Set-VBRS3CompatibleRepositorySecurityOptionsExample 3. Setting Access Through Gateway Server to S3 Compatible Repositories

Related Commands

Get-VBRObjectStorageRepository

Page updated 7/25/2024

Page content applies to build 12.3.1.1139