Get-VmcOutpost Command | Vmware PowerCLI Reference

Get-VmcOutpost

This cmdlet retrieves a list of AWS Outposts registered with your VMC organization based on the specified criteria.

Syntax

Get-VmcOutpost
-Id < String[] >
[-Server < VmcServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id String[] named
Specifies one or more IDs of outposts to retrieve.
optional Server VmcServer[] named
  • wildcards
Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.
Get-VmcOutpost
[-Name < String[] > ]
[-Server < VmcServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
  • wildcards
Specifies one or more wildcard string filters. The retrieved outposts must have a name that matches at least one of those filters.
optional Server VmcServer[] named
  • wildcards
Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.

Output

VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcOutpost

Examples

Example 1

Get-VmcOutpost

Retrieves all the AWS Outposts in the organization.

Example 2

Get-VmcOutpost "my-outpost*"

Retrieves all outposts with a name that begins with "my-outpost".

Example 3

Get-VmcOutpost -Id "9367fec4-0090-46f8-949d-b286c7e730c9"

Retrieves the outpost with the specified ID.

Related Commands

VmcOutpost

This cmdlet retrieves a list of AWS Outposts based on the specified criteria.