Get-OrgNetwork

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
optional
ExternalNetwork
ExternalNetwork[] named
  • wildcards
  • pipeline
  • Retrieves only the organization networks connected to the specified external networks. Note: This parameter is only available to Provider Administrators.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the cloud organization networks you want to retrieve.
    optional
    NetworkPool
    NetworkPool[] named
  • wildcards
  • pipeline
  • Retrieves only the organization networks that have been created from the specified pools. Note: This parameter is only available to Provider Administrators.
    optional
    Org
    Org[] named
  • wildcards
  • pipeline
  • Specifies the organizations for which you want to retrieve networks.
    optional
    Server
    CIServer[] named
  • wildcards
  • 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.
    optional
    VM
    CIVM[] named
  • wildcards
  • pipeline
  • Retrieves only the networks to which the specified virtual machines are connected.

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named Specifies the IDs of the cloud organization networks you want to retrieve.
    optional
    Server
    CIServer[] named
  • wildcards
  • 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.

    Output

    VMware.VimAutomation.Cloud.Types.V1.OrgNetwork

    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.

    Related Commands

    Feedback

    Was this page helpful?