Set-SCLogicalNetwork

Changes the properties of a logical network object.

Syntax

Set-SCLogicalNetwork
   [-VMNetworkCreationDefaultNetworkManager <VirtualSwitchExtensionManager>]
   [-VMMServer <ServerConnection>]
   [-LogicalNetwork] <LogicalNetwork>
   [-Name <String>]
   [-Description <String>]
   [-EnableNetworkVirtualization <Boolean>]
   [-UseGRE <Boolean>]
   [-LogicalNetworkDefinitionIsolation <Boolean>]
   [-AllowDynamicVlanOnVnic <Boolean>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCLogicalNetwork
   [-VMMServer <ServerConnection>]
   [-LogicalNetwork] <LogicalNetwork>
   [-Name <String>]
   [-Description <String>]
   [-EnableNetworkVirtualization <Boolean>]
   [-UseGRE <Boolean>]
   [-LogicalNetworkDefinitionIsolation <Boolean>]
   [-AllowDynamicVlanOnVnic <Boolean>]
   [-RemoveVMNetworkCreationDefaultNetworkManager]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The Set-SCLogicalNetwork cmdlet changes the properties of a Virtual Machine Manager (VMM) logical network object. Properties that you can update include the name and description of the logical network.

Examples

Example 1: Change the name of a logical network

PS C:\> $LogicalNetwork = Get-SCLogicalNetwork -Name "LogicalNetwork01"
PS C:\> Set-SCLogicalNetwork -LogicalNetwork $LogicalNetwork -Name "LogicalNetwork02"

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

The second command changes the name of the logical network stored in $LogicalNetwork to "LogicalNetwork02".

Required Parameters

-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:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-RemoveVMNetworkCreationDefaultNetworkManager

Indicates that the VM Network default network manager is removed.

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

Optional Parameters

-AllowDynamicVlanOnVnic

Specifies whether this vNIC is configured for Dynamic VLAN. VMM does not expect a VLAN for this adapter.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description for the logical network object.

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

Indicates whether network virtualization is enabled. The default value is $False.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

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

Indicates whether logical network definition isolation is enabled.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of a VMM object.

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

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
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.

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

Indicates whether network virtualization Generic Routing Encapsulation (GRE) is used. The default value is $False.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMNetworkCreationDefaultNetworkManager

Specifies a virtual switch extension manager object.

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

Outputs

LogicalNetwork

This cmdlet returns a LogicalNetwork object.

Notes

  • Requires a VMM logical network object, which can be retrieved by using the Get-SCLogicalNetwork cmdlet.