Veeam Backup for Microsoft Office 365 4.0
PowerShell Reference
Related documents

Add-VBOAmazonS3CompatibleAccount

Short Description

Creates S3 Compatible storage account credentials.

Syntax

Add-VBOAmazonS3CompatibleAccount -AccessKey <string> -SecurityKey <securestring> [-Description <string>][<CommonParameters>]

Detailed Description

This cmdlet creates the VBOAmazonS3CompatibleAccount object. This object contains storage account credentials for the following types of object storage:

  • S3 Compatible object storage.
  • IBM Cloud object storage.

Veeam Backup for Microsoft Office 365 will use these storage account credentials to access these object storage.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

AccessKey

Specifies an access key. The cmdlet will use this key to add S3 Compatible storage account credentials to Veeam Backup for Microsoft Office 365.

String

True

Named

False

 

SecurityKey

Specifies a secret key. The cmdlet will use this key to add S3 Compatible storage account credentials to Veeam Backup for Microsoft Office 365.

SecureString

True

Named

False

 

Description

Specifies a description for S3 Compatible storage account credentials.

String

False

Named

False

 

<CommonParameters>

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

Output Object

The cmdlet returns the VBOAmazonS3CompatibleAccount object that contains S3 Compatible storage account credentials.

Examples

Add-VBOAmazonS3CompatibleAccountExample 1. Adding S3 Compatible Credentials Record

This example shows how to add S3 Compatible storage account credentials to Veeam Backup for Microsoft Office 365.

$securepassword = Read-Host "Enter your password" -AsSecureString

Enter your password: **********

Add-VBOAmazonS3CompatibleAccount -AccessKey "867F16FDE95B12DF" -SecurityKey $securepassword

Perform the following steps:

  1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
  2. Enter the password.
  3. Run theAdd-VBOAmazonS3CompatibleAccount cmdlet. Specify the AccessKey parameter value. Set $securepassword as the SecurityKey parameter value.

Add-VBOAmazonS3CompatibleAccountExample 2. Adding S3 Compatible Record with Description

This example shows how to add S3 Compatible storage account credentials with a description.

$securepassword = Read-Host "Enter your password" -AsSecureString

Enter your password: **********

Add-VBOAmazonS3CompatibleAccount -AccessKey "eu7^vuKvvhcrtbP" -SecurityKey $securepassword -Description "S3 Compatible Credential Records"

Perform the following steps:

  1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
  2. Enter the password.
  3. Run the Add-VBOAmazonS3CompatibleAccount cmdlet. Specify the following settings:
  • Set $securepassword as the SecurityKey parameter value.
  • Specify the AccessKey parameter value.
  • Specify the Description parameter value.

Related Commands

Read-Host

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.