Set-SCLogicalNetwork

Module:

VirtualMachineManager Module

Changes the properties of a logical network object.

Syntax

SetDefaultNetworkManager (Default)

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

RemoveDefaultNetworkManager

Set-SCLogicalNetwork
    [-LogicalNetwork] <LogicalNetwork>
    [-VMMServer <ServerConnection>]
    [-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".

Parameters

-AllowDynamicVlanOnVnic

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

Parameter properties

Type:	Boolean
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

-Description

Specifies a description for the logical network object.

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

-EnableNetworkVirtualization

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

Parameter properties

Type:	Boolean
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

-JobVariable

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

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

-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:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LogicalNetworkDefinitionIsolation

Indicates whether logical network definition isolation is enabled.

Parameter properties

Type:	Boolean
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 VMM object.

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

-PROTipID

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

Parameter properties

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

-RemoveVMNetworkCreationDefaultNetworkManager

Indicates that the VM Network default network manager is removed.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

RemoveDefaultNetworkManager

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-UseGRE

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

Parameter properties

Type:	Boolean
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

-VMMServer

Specifies a 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

-VMNetworkCreationDefaultNetworkManager

Specifies a virtual switch extension manager object.

Parameter properties

Type:	VirtualSwitchExtensionManager
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetDefaultNetworkManager

Position:	Named
Mandatory:	False
Value from pipeline:	False
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

LogicalNetwork

This cmdlet returns a LogicalNetwork object.

Notes

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

Related Links

• Get-SCLogicalNetwork
• New-SCLogicalNetwork
• Remove-SCLogicalNetwork