Get-SCLogicalNetworkDefinition
Gets a logical network definition.
Syntax
All (Default)
Get-SCLogicalNetworkDefinition
[[-Name] <String>]
[-VMMServer <ServerConnection>]
[-LogicalNetwork <LogicalNetwork>]
[-Subnet <String>]
[-VLanID <Int32>]
[-ReturnAllTypes]
[<CommonParameters>]
ById
Get-SCLogicalNetworkDefinition
[[-Name] <String>]
-ID <Guid>
[-VMMServer <ServerConnection>]
[-LogicalNetwork <LogicalNetwork>]
[-Subnet <String>]
[-VLanID <Int32>]
[-ReturnAllTypes]
[<CommonParameters>]
ByHostGroup
Get-SCLogicalNetworkDefinition
[[-Name] <String>]
-VMHostGroup <HostGroup>
[-VMMServer <ServerConnection>]
[-LogicalNetwork <LogicalNetwork>]
[-Subnet <String>]
[-VLanID <Int32>]
[-ReturnAllTypes]
[<CommonParameters>]
ByCloud
Get-SCLogicalNetworkDefinition
[[-Name] <String>]
-Cloud <Cloud>
[-VMMServer <ServerConnection>]
[-LogicalNetwork <LogicalNetwork>]
[-Subnet <String>]
[-VLanID <Int32>]
[-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.
Parameter properties
| Type: | Cloud |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByCloud
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ID
Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | LogicalNetwork |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of a Virtual Machine Manager (VMM) object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ReturnAllTypes
Indicates that this cmdlet returns the logical network definitions of any isolation type.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMHostGroup
Specifies a virtual machine host group object.
Parameter properties
| Type: | HostGroup |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByHostGroup
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMMServer
Specifies a Virtual Machine Manager (VMM) server object.
Parameter properties
| Type: | ServerConnection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
LogicalNetworkDefiniton
This cmdlet returns a LogicalNetworkDefiniton object.