Remove-SCLogicalNetworkDefinition

Applies To: System Center 2012 - Virtual Machine Manager

Remove-SCLogicalNetworkDefinition

Deletes a logical network definition.

Syntax

Parameter Set: Default
Remove-SCLogicalNetworkDefinition [-LogicalNetworkDefinition] <LogicalNetworkDefinition> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Remove-SCLogicalNetworkDefinition cmdlet deletes a logical network definition (also called a network site).

For more information about Remove-SCLogicalNetworkDefinition, type: "Get-Help Remove-SCLogicalNetworkDefinition -online".

Parameters

-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

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

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

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

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

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

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

Examples

1: Delete a logical network definition.

The first command gets the logical network definition named "Logical Network Definition 01" and stores it in the $Definition variable.

The second command deletes the logical network definition stored in the $Definition variable.

PS C:\> $Definition = Get-SCLogicalNetworkDefinition -Name "Logical Network Definition 01"
PS C:\> Remove-SCLogicalNetworkDefinition -LogicalNetworkDefinition $Definition

Get-SCLogicalNetworkDefinition

New-SCLogicalNetworkDefinition

Set-SCLogicalNetworkDefinition