Share via

Get-SCVirtualNetwork

  • Reference
Module:
VirtualMachineManager

Gets virtual network objects configured on a VMM host.

Syntax

Get-SCVirtualNetwork
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   [<CommonParameters>]
Get-SCVirtualNetwork
   -VMHostCluster <HostCluster>
   [[-Name] <String>]
   [<CommonParameters>]
Get-SCVirtualNetwork
   -ID <Guid>
   [[-Name] <String>]
   [<CommonParameters>]
Get-SCVirtualNetwork
   -VMHost <Host>
   [[-Name] <String>]
   [<CommonParameters>]

Description

The Get-SCVirtualNetwork cmdlet gets one or more virtual network objects configured on a host managed by Virtual Machine Manager (VMM).

For information about virtual networks in VMM, type Get-Help New-SCVirtualNetwork -Detailed.

Examples

Example 1: Get all virtual networks in the VMM database

PS C:\> $VirtualNetworks = Get-SCVirtualNetwork 
PS C:\> $VirtualNetworks | Format-List Name,VMHost,VMHostNetworkadapters

The first command gets all virtual network objects on all hosts managed by VMM and stores the virtual network objects in $VirtualNetworks.

The second command displays a subset of information about each virtual network object in $VirtualNetworks: the name of each virtual network, the physical host on which each virtual network is configured, and the physical network adapters configured on the host for each virtual network.

Example 2: Get all virtual networks on a specific host

PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01.Contoso.com" 
PS C:\> Get-SCVirtualNetwork -VMHost $VMHost

The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.

The second command gets all virtual network objects on VMHost01 and displays information about each virtual network.

Example 3: Get a virtual network by name from a specific host

PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost02.Contoso.com" 
PS C:\> $VN = Get-SCVirtualNetwork -VMHost $VMHost -Name "InternalVNet01"
PS C:\> $VN

The first command gets the host object named VMHost02 and stores the object in the $VMHost variable.

The second command gets the virtual network object named InternalVNet01 from VMHost02 and stores the object in the $VN variable.

The last command displays information about the virtual network stored in $VN to the user.

Parameters

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of a VMM object.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMHost

Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts.

For more information about each type of host, see the Add-SCVMHost cmdlet.

Type:Host
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMHostCluster

Specifies a VMM host cluster object.

Type:HostCluster
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

VirtualNetwork

This cmdlet returns a VirtualNetwork object.