Get-SCLogicalNetworkDefinition
Get-SCLogicalNetworkDefinition
Gets a logical network definition.
Syntax
Parameter Set: All
Get-SCLogicalNetworkDefinition [[-Name] <String> ] [-LogicalNetwork <LogicalNetwork> ] [-ReturnAllTypes] [-Subnet <String> ] [-VLanID <Int32]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByCloud
Get-SCLogicalNetworkDefinition [[-Name] <String> ] -Cloud <Cloud> [-LogicalNetwork <LogicalNetwork> ] [-ReturnAllTypes] [-Subnet <String> ] [-VLanID <Int32]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByHostGroup
Get-SCLogicalNetworkDefinition [[-Name] <String> ] -VMHostGroup <HostGroup> [-LogicalNetwork <LogicalNetwork> ] [-ReturnAllTypes] [-Subnet <String> ] [-VLanID <Int32]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed 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.
Parameters
-Cloud<Cloud>
Specifies a private cloud object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LogicalNetwork<LogicalNetwork>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 |
-ReturnAllTypes
Returns logical network definitions of any isolation type.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Subnet<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VLanID<Int32]>
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 $True -VLanMode "Access" -VLanID 35
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHostGroup<HostGroup>
Specifies a virtual machine host group object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
- LogicalNetworkDefiniton
Examples
Example Example 1: Retrieve the logical network definition for a logical network.
The first command gets the logical network named LogicalNetwork01, and then stores it in the $LogicalNetwork variable.
The second command gets the host group named HostGroup01, and then 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.
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
Related topics
New-SCLogicalNetworkDefinition
Remove-SCLogicalNetworkDefinition