Get-SCLogicalNetwork

Gets a logical network object.

Syntax

Get-SCLogicalNetwork
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   [-All]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCLogicalNetwork
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   -VMHost <Host>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCLogicalNetwork
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   -Cloud <Cloud>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCLogicalNetwork
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   -VMHostGroup <HostGroup>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCLogicalNetwork
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   [-ID <Guid>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCLogicalNetwork
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   -CloudRootHostGroup <HostGroup[]>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCLogicalNetwork
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   -CloudRootVMwareResourcePool <VmwResourcePool>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Get-SCLogicalNetwork cmdlet retrieves one or more Virtual Machine Manager (VMM) logical network objects.

Examples

Example 1: Retrieve all available logical networks for a specified host group

PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup01" }
PS C:\> Get-SCLogicalNetwork -VMHostGroup $HostGroup

The first command gets the host group object at the path "All Hosts\HostGroup01" and stores the object in the $HostGroup variable.

The second command gets all of the logical networks for the host group stored in $HostGroup and displays information about each logical network to the user.

Required Parameters

-Cloud

Specifies a private cloud object.

Type:Cloud
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CloudRootHostGroup

Specifies a host group that is defined at the root level for a private cloud.

Type:HostGroup[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CloudRootVMwareResourcePool

Specifies a VMware resource pool that is defined at the root level for a private cloud.

Type:VmwResourcePool
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMHost

Specifies an array of virtual machine host objects.

Type:Host
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMHostGroup

Specifies a virtual machine host group object.

Type:HostGroup
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-All

Indicates that this cmdlet gets all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All gets all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ID

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

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of a VMM object.

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

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Type:UserRole
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Outputs

LogicalNetwork

This cmdlet returns a LogicalNetwork object.