Get-SCVirtualNetwork
Get-SCVirtualNetwork
Gets virtual network objects configured on a VMM host.
Syntax
Parameter Set: NoFilter
Get-SCVirtualNetwork [[-Name] <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: Cluster
Get-SCVirtualNetwork [[-Name] <String> ] -VMHostCluster <HostCluster> [ <CommonParameters>]
Parameter Set: FilterByVMHost
Get-SCVirtualNetwork [[-Name] <String> ] -VMHost <Host> [ <CommonParameters>]
Detailed 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.
Parameters
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHost<Host>
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, type Get-Help Add-SCVMHost -detailed. See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMHostCluster<HostCluster>
Specifies a VMM host cluster object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- VirtualNetwork
Examples
Example 1: Get all virtual networks in the VMM database
The first command gets all virtual network objects on all hosts managed by VMM, and then 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.
PS C:\> $VirtualNetworks = Get-SCVirtualNetwork
PS C:\> $VirtualNetworks | Format-List Name,VMHost,VMHostNetworkadapters
Example Example 2: Get all virtual networks on a specific host.
The first command gets the host object named VMHost01, and then stores the object in the $VMHost variable.
The second command gets all virtual network objects on VMHost01 and displays information about each virtual network.
PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01.Contoso.com"
PS C:\> Get-SCVirtualNetwork -VMHost $VMHost
Example 3: Get a virtual network by name from a specific host
The first command gets the host object named VMHost02, and then stores the object in the $VMHost variable.
The second command gets the virtual network object named InternalVNet01 from VMHost02, and then stores the object in the $VN variable.
The last command displays information about the virtual network stored in $VN.
PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost02.Contoso.com"
PS C:\> $VN = Get-SCVirtualNetwork -VMHost $VMHost -Name "InternalVNet01"
PS C:\> $VN