PowerCLI Reference

Get-OrgNetwork

Synopsis

This cmdlet retrieves cloud organization networks.

Syntax

Get-OrgNetwork [[-Name] <String[]>] [-ExternalNetwork <ExternalNetwork[]>] [-NetworkPool <NetworkPool[]>] [-Org <Org[]>] [-Server <CIServer[]>] [-VM <CIVM[]>] [<CommonParameters>]

Get-OrgNetwork -Id <String[]> [-Server <CIServer[]>] [<CommonParameters>]

Related Commands

Online Version
Get-Org
Get-OrgVdc

Detailed Description

This cmdlet is deprecated. Use Get-OrgVdcNetwork instead.


This cmdlet retrieves cloud organization networks. You can filter the output by using the cmdlet parameters.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the cloud organization networks you want to retrieve.falseFalse
ExternalNetworkExternalNetwork[]Retrieves only the organization networks connected to the specified external networks. Note: This parameter is only available to Provider Administrators.falseTrue (ByValue)
IdString[]Specifies the IDs of the cloud organization networks 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
NetworkPoolNetworkPool[]Retrieves only the organization networks that have been created from the specified pools. Note: This parameter is only available to Provider Administrators.falseTrue (ByValue)
OrgOrg[]Specifies the organizations for which you want to retrieve networks.falseTrue (ByValue)
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
VMCIVM[]Retrieves only the networks to which the specified virtual machines are connected.falseTrue (ByValue)

Return Type

Zero or more OrgNetwork objects

Notes

Examples

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

Get-OrgNetwork

Gets all visible organization networks for the current user.

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

Get-OrgNetwork -Name "OrgNetwork1"

Gets an existing organization network named "OrgNetwork1".

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

Get-OrgNetwork -ID $orgNetwork1Id

Gets an organization network with given ID.

-------------------------- Example 4 --------------------------

$myOrg = Get-Org -Name "Organization1"
Get-OrgNetwork -Org $myOrg

Gets all visible networks within an organization.

-------------------------- Example 5 --------------------------

$myExternalNetwork = Get-ExternalNetwork -Name "ExternalNetwork1"
Get-OrgNetwork -ExternalNetwork $myExternalNetwork

Gets all visible organization networks for an external network.

-------------------------- Example 6 --------------------------

$myNetworkPool = Get-NetworkPool -Name 'MyNetworkPool'
Get-OrgNetwork -NetworkPool $myNetworkPool

Gets all visible organization networks for a network pool.

-------------------------- Example 7 --------------------------

Get-CIVM -Name "CloudVM1" | Get-OrgNetwork

Gets an organization network for a CIVM.


Copyright © VMware, Inc. All rights reserved.