Set-SCLogicalNetworkDefinition

Set-SCLogicalNetworkDefinition

Modifies a logical network definition.

Syntax

Parameter Set: Default
Set-SCLogicalNetworkDefinition [-LogicalNetworkDefinition] <LogicalNetworkDefinition> [-AddVMHostGroup <HostGroup[]> ] [-JobVariable <String> ] [-Name <String> ] [-PROTipID <Guid]> ] [-RemoveVMHostGroup <HostGroup[]> ] [-RunAsynchronously] [-SubnetVLan <SubnetVLan[]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Set-SCLogicalNetworkDefinition cmdlet modifies a logical network definition. For example, you can add a host group to or remove a host group from a logical network definition, also called a network site.

Parameters

-AddVMHostGroup<HostGroup[]>

Adds one or more host groups to an existing host group array or private cloud.

-JobVariable<String>

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

-LogicalNetworkDefinition<LogicalNetworkDefinition>

Specifies a logical network definition, also called a network site, that contains the subnet that the IP address pool serves as specified by the Subnet parameter.

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

-RemoveVMHostGroup<HostGroup[]>

Removes one or more host groups from a host group array or private cloud.

-RunAsynchronously

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

-SubnetVLan<SubnetVLan[]>

Specifies one or more IP subnet and VLAN sets.

For information about creating a SubnetVLan, type Get-Help New-SCSubNetVLan.

-VMMServer<ServerConnection>

Specifies a VMM server 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.

• LogicalNetworkDefiniton

Notes

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

Examples

Example 1: Change the host groups associated with a logical network definition

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

The second command gets the host group named All Hosts\HostGroup02\Production, and then stores it in the $VMHostGroup variable.

The third command gets the logical network definition named Logical Network Definition 01 associated with the logical network stored in $LogicalNetwork and the host group stored in $VMHostGroup, and then stores it in the $Definition variable.

The fourth command gets the host group object named All Hosts\HostGroup-3\Production, and then stores the object in the $HostGroup variable.

The last command adds the host group stored in $HostGroup to the existing host groups array for the logical network definition stored in $Definition.

PS C:\> $LogicalNetwork = Get-SCLogicalNetwork -Name "LogicalNetwork01"
PS C:\> $VMHostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup02\Production"}
PS C:\> $Definition = Get-SCLogicalNetworkDefinition -LogicalNetwork $LogicalNetwork -VMHostGroup $VMHostGroup -Name "Logical Network Definition 01"
PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup03\Production" }
PS C:\> Set-SCLogicalNetworkDefinition -LogicalnetworkDefinition $Definition -AddVMHostGroup $HostGroup

Related topics

Get-SCLogicalNetworkDefinition

New-SCLogicalNetworkDefinition

Remove-SCLogicalNetworkDefinition

Get-SCLogicalNetwork

Get-SCVMHostGroup