New-SCLogicalNetwork
New-SCLogicalNetwork
Creates a logical network object.
Syntax
Parameter Set: Default
New-SCLogicalNetwork [-Name] <String> [[-Description] <String> ] [-EnableNetworkVirtualization <Boolean]> ] [-IsPVLAN <Boolean]> ] [-JobVariable <String> ] [-LogicalNetworkDefinitionIsolation <Boolean]> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-UseGRE <Boolean]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The New-SCLogicalNetwork cmdlet creates a Virtual Machine Manager (VMM) logical network object. Each logical network must have a unique name within a VMM installation.
Logical networks enable network administrators to model the network based on recognizable categories that align to business needs by grouping together subnets and VLANs. To assign IP subnets and VLANs to a logical network, create a logical network definition by using the New-SCLogicalNetworkDefinition cmdlet.
Parameters
-Description<String>
States a description for the specified object.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EnableNetworkVirtualization<Boolean]>
Indicates whether network virtualization is enabled. The default value is $False.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IsPVLAN<Boolean]>
Indicates whether the logical network is a Private Virtual LAN (PVLAN).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LogicalNetworkDefinitionIsolation<Boolean]>
Indicates whether logical network definition isolation is enabled.
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? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UseGRE<Boolean]>
Indicates whether network virtualization Generic Routing Encapsulation (GRE) is used. The default value is $False.
Aliases |
none |
Required? |
false |
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.
- LogicalNetwork
Examples
Example 1: Create a logical network
This command creates a logical network named LogicalNetwork01.
PS C:\> New-SCLogicalNetwork -Name "LogicalNetwork01"
Example 2: Create a network virtualization-enabled logical network
This command creates a logical network named LogicalNetwork02 that is enabled for network virtualization and implements Generic Routing Encapsulation (GRE).
PS C:\> New-SCLogicalNetwork -Name "LogicalNetwork02" -EnableNetworkVirtualization $True -UseGRE $True