Get-VBOAmazonSecurityGroup

Short Description

Returns a security group that will be associated with the Amazon archiver appliance.

Syntax

Get-VBOAmazonSecurityGroup -VPC <VBOAmazonVpc> [-Name <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns the VBOAmazonSecurityGroup object.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
VPC	Specifies the Amazon VPC.	Accepts the VBOAmazonVpc object. To get this object, run the Get-VBOAmazonVPC cmdlet.	True	Named	False	False
Name	Specifies a name of the security group. The cmdlet will return the security group with this name.	String	False	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

VPC

Specifies the Amazon VPC.

Accepts the VBOAmazonVpc object.

To get this object, run the Get-VBOAmazonVPC cmdlet.

True

Named

False

Name

Specifies a name of the security group. The cmdlet will return the security group with this name.

String

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBOAmazonSecurityGroup object that will be associated with the Amazon archiver appliance.

Examples

Get-VBOAmazonSecurityGroup Example 1. Getting Security Group

This example shows how to get the security group that will be associated with the Amazon archiver appliance.

$S3account = Get-VBOAmazonS3Account -AccessKey "?Iqws8NewidZydk"

$S3connection = New-VBOAmazonS3ConnectionSettings -Account $S3account -RegionType Global

$VPC = Get-VBOAmazonVPC -AmazonS3ConnectionSettings $S3connection -RegionId eu-central-1 -Name "VPCName"

Get-VBOAmazonSecurityGroup -VPC $VPC -Name "SecurityGroupName"

Perform the following steps:

Run the Get-VBOAmazonS3Account cmdlet. Specify the AccessKey parameter value. Save the result to the $S3account variable.
Run the New-VBOAmazonS3ConnectionSettings cmdlet. Set the $S3account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $S3connection variable.
Run the Get-VBOAmazonVPC cmdlet. Set the $S3connection variable as the AmazonS3ConnectionSettings parameter value. Specify the RegionId parameter value. Specify the Name parameter value. Save the result to the $VPC variable.
Run the Get-VBOAmazonSecurityGroup cmdlet. Set the $VPC variable as the VPC parameter value. Specify the Name parameter value.

Related Commands