Set-SCLogicalNetwork

Set-SCLogicalNetwork

Changes the properties of a logical network object.

Syntax

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

Parameter Set: RemoveDefaultNetworkManager
Set-SCLogicalNetwork [-LogicalNetwork] <LogicalNetwork> -RemoveVMNetworkCreationDefaultNetworkManager [-Description <String> ] [-EnableNetworkVirtualization <Boolean]> ] [-JobVariable <String> ] [-LogicalNetworkDefinitionIsolation <Boolean]> ] [-Name <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-UseGRE <Boolean]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed 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.

Parameters

-Description<String>

States a description for the specified object.

-EnableNetworkVirtualization<Boolean]>

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

-JobVariable<String>

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

-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.

-LogicalNetworkDefinitionIsolation<Boolean]>

Specifies whether logical network definition isolation is enabled.

-Name<String>

Specifies the name of a VMM object.

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-RemoveVMNetworkCreationDefaultNetworkManager

Indicates that the VM Network default network manager is removed.

-RunAsynchronously

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

-UseGRE<Boolean]>

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

-VMMServer<ServerConnection>

Specifies a VMM server object.

-VMNetworkCreationDefaultNetworkManager<VirtualSwitchExtensionManager>

Specifies a virtual switch extension manager object.

<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

Notes

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

Examples

Example 1: Change the name of a logical network

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

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

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

Related topics

Get-SCLogicalNetwork

New-SCLogicalNetwork

Remove-SCLogicalNetwork