Share via

Get-SCLogicalNetworkDefinition

  • Reference
Module:
VirtualMachineManager

Gets a logical network definition.

Syntax

Get-SCLogicalNetworkDefinition
   [-VMMServer <ServerConnection>]
   [-LogicalNetwork <LogicalNetwork>]
   [[-Name] <String>]
   [-Subnet <String>]
   [-VLanID <Int32>]
   [-ReturnAllTypes]
   [<CommonParameters>]
Get-SCLogicalNetworkDefinition
   [-VMMServer <ServerConnection>]
   [-LogicalNetwork <LogicalNetwork>]
   [[-Name] <String>]
   [-Subnet <String>]
   [-VLanID <Int32>]
   -ID <Guid>
   [-ReturnAllTypes]
   [<CommonParameters>]
Get-SCLogicalNetworkDefinition
   [-VMMServer <ServerConnection>]
   [-LogicalNetwork <LogicalNetwork>]
   [[-Name] <String>]
   [-Subnet <String>]
   [-VLanID <Int32>]
   -VMHostGroup <HostGroup>
   [-ReturnAllTypes]
   [<CommonParameters>]
Get-SCLogicalNetworkDefinition
   [-VMMServer <ServerConnection>]
   [-LogicalNetwork <LogicalNetwork>]
   [[-Name] <String>]
   [-Subnet <String>]
   [-VLanID <Int32>]
   -Cloud <Cloud>
   [-ReturnAllTypes]
   [<CommonParameters>]

Description

The Get-SCLogicalNetworkDefinition cmdlet gets one or more logical network definitions. A logical network definition (also called a network site) can be associated with one or more logical networks.

Examples

Example 1: Retrieve the logical network definition for a logical network

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

The first command gets the logical network named "LogicalNetwork01" and stores it in the $LogicalNetwork variable.

The second command gets the host group named "HostGroup01" and stores it in the $HostGroup variable.

The third command gets the logical network definition for the logical network stored in $LogicalNetwork and the host group stored in the $HostGroup variable (including its parent host group if inheritance is enabled).

Parameters

-Cloud

Specifies a private cloud object.

Type:Cloud
Position:Named
Default value:None
Required:True
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
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LogicalNetwork

Specifies a logical network. A logical network is a named grouping of IP subnets and virtual local area networks (VLANs) that is used to organize and simplify network assignments.

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

-Name

Specifies the name of a Virtual Machine Manager (VMM) object.

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

-ReturnAllTypes

Indicates that this cmdlet returns the logical network definitions of any isolation type.

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

-Subnet

Specifies an IP subnet (IPv4 or IPv6) in Classless Inter-Domain Routing (CIDR) notation.

Example format for an IPv4 subnet: 192.168.0.1/24

Example format for an IPv6 subnet: FD4A:29CD:184F:3A2C::/64

Note that an IP subnet cannot overlap with any other subnet in a host group or child host groups.

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

-VLanID

Specifies a numerical identifier in the range 1-4094 for a virtual network adapter on a virtual machine or for a physical network adapter on a virtual machine host.

Configure a VLanID on a Hyper-V, VMware ESX, or Citrix XenServer host on an externally bound physical network adapter when the VLan mode is Access.

Configure a VLanID on a virtual network adapter of a virtual machine if it is either of the following:

-- Bound to a physical network adapter on the host.

  • Bound to an internal virtual network on the host.
Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMHostGroup

Specifies a virtual machine host group object.

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

-VMMServer

Specifies a Virtual Machine Manager (VMM) server object.

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

Outputs

LogicalNetworkDefiniton

This cmdlet returns a LogicalNetworkDefiniton object.