Get-SCLogicalNetworkDefinition

Gets a logical network definition.

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. 

For more information about Get-SCLogicalNetworkDefinition, type: "Get-Help Get-SCLogicalNetworkDefinition -online".

Parameters

Name

Required? false
Accept Pipeline Input? false
Position? 0 
Specifies the name of a VMM object.

Cloud

Required? true
Accept Pipeline Input? false
Position? named 
Specifies a private cloud object.

LogicalNetwork

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a logical network. A logical network is a named grouping of IP subnets and VLANs that is used to organize and simplify network assignments.

Subnet

Required? false
Accept Pipeline Input? false
Position? named 
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: An IP subnet cannot overlap with any other subnet in a host group or child host groups.

VLanID

Required? false
Accept Pipeline Input? false
Position? named 
Assigns a numerical identifier in the range 1-4094 to a virtual network adapter on a virtual machine or to 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:
 - Bound to a physical network adapter on the host, or
 - Bound to an internal virtual network on the host.

Example format:  -VLanEnabled
 -VLanMode "Access" -VLANID 35

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

Name

Required? false
Accept Pipeline Input? false
Position? 0 
Specifies the name of a VMM object.

VMHostGroup

Required? true
Accept Pipeline Input? false
Position? named 
Specifies a virtual machine host group object.

LogicalNetwork

Required? false
Accept Pipeline Input? false
Position? named 
Specifies a logical network. A logical network is a named grouping of IP subnets and VLANs that is used to organize and simplify network assignments.

Subnet

Required? false
Accept Pipeline Input? false
Position? named 
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: An IP subnet cannot overlap with any other subnet in a host group or child host groups.

VLanID

Required? false
Accept Pipeline Input? false
Position? named 
Assigns a numerical identifier in the range 1-4094 to a virtual network adapter on a virtual machine or to 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:
 - Bound to a physical network adapter on the host, or
 - Bound to an internal virtual network on the host.

Example format:  -VLanEnabled
 -VLanMode "Access" -VLANID 35

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

Examples

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).

See Also