PowerCLI Reference

Get-CIVAppNetwork

Synopsis

This cmdlet retrieves the vApp networks available on a vCloud Director server.

Syntax

Get-CIVAppNetwork [[-Name] <String[]>] [-ConnectionType <CIVAppNetworkConnectionType[]>] [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Get-CIVAppNetwork -Id <String[]> [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Get-CIVAppNetwork [[-Name] <String[]>] [-ConnectionType <CIVAppNetworkConnectionType[]>] -VApp <CIVApp[]> [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Get-CIVAppNetwork [[-Name] <String[]>] [-ConnectionType <CIVAppNetworkConnectionType[]>] -ParentOrgVdcNetwork <OrgNetworkBase[]> [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Related Commands

Online version
New-CIVAppNetwork
Remove-CIVAppNetwork
Set-CIVAppNetwork

Detailed Description

This cmdlet retrieves the vApp networks available on a vCloud Director server.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the vApp networks you want to retrieve.falsefalse
ConnectionTypeCIVAppNetworkConnectionType[]Specifies the type of connectivity between the vApp networks you want to retrieve and their parent organization networks. This parameter accepts Direct, Fenced, Routed, and Isolated values.falsefalse
IdString[]Specifies the IDs of the vApp networks that you want to retrieve.

Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
truefalse
InformationActionActionPreferencefalsefalse
InformationVariableStringfalsefalse
ParentOrgVdcNetworkOrgNetworkBase[]Specifies the parent organization vDC networks of the vApp networks you want to retrieve.truetrue (ByValue)
PipelineVariableStringfalsefalse
ServerCIServer[]Specifies the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.falsefalse
VAppCIVApp[]Specifies the vApps for which you want to retrieve vApp networks.truetrue (ByValue)

Return Type

Zero or more CIVAppNetwork objects

Notes

Examples

-------------- Example 1 --------------

Get-CIVAppNetwork -ConnectionType Direct

Retrieves all vApp networks that are directly connected to a parent organization network and are available to the user.

-------------- Example 2 --------------

$myVApp = Get-CIVApp -Name 'MyVApp'
Get-CIVAppNetwork -VApp $myVApp

Retrieves all vApp networks for the specified vApp.

-------------- Example 3 --------------

$parentOrgNetwork = Get-OrgNetwork -Name 'MyOrgNetwork'
Get-CIVAppNetwork -ParentOrgNetwork 'MyOrgNetwork'

Retrieves all vApp networks that are connected to the specified parent organization network.


Copyright © VMware, Inc. All rights reserved.