Add-VMMigrationNetwork
Adds a network for virtual machine migration on one or more virtual machine hosts.
Syntax
Default (Default)
Add-VMMigrationNetwork
[-CimSession <CimSession[]>]
[-Subnet] <String>
[[-Priority] <UInt32>]
[-Passthru]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Add-VMMigrationNetwork cmdlet adds a network for virtual machine migration on one or more virtual machine hosts.
Examples
Example 1
PS C:\> Add-VMMigrationNetwork 192.168.0.1
This example adds an IPv4 address as a live migration network on the local Hyper-V host.
Example 2
PS C:\> Add-VMMigrationNetwork 192.168.10.0/24
This example adds an IPv4 address range as possible live migration networks on the local Hyper-V host by using a subnet mask.
Example 3
PS C:\> Add-VMMigrationNetwork 2001:836c:6456:1c99::/32
This example adds an IPv6 address range as possible live migration networks on the local Hyper-V host by adding a subnet mask.
Example 4
PS C:\> Add-VMMigrationNetwork 2001:836c:6456:1c99::/64 -Priority 8
This example adds an IPv6 address range as possible live migration networks on the local Hyper-V host by using a subnet mask and specifying the network as lower priority.
Parameters
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Parameter properties
Type: | CimSession[] |
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: | True |
Value from remaining arguments: | False |
-ComputerName
Specifies one or more Hyper-V hosts on which the network is to be added for virtual machine migration. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: | SwitchParameter |
Default value: | False |
Supports wildcards: | False |
DontShow: | False |
Aliases: | cf |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
Parameter properties
Type: | PSCredential[] |
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 |
-Passthru
Specifies that an Microsoft.HyperV.PowerShell.MigrationNetwork object is to be passed through to the pipeline representing the network added for virtual machine migration.
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 |
-Priority
Specifies the priority of the network to be added for virtual machine migration. Multiple networks can have the same priority.
Parameter properties
Type: | UInt32 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 1 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Subnet
Specifies a string representing an IPv4 or IPv6 subnet mask which identifies the network to be added for virtual machine migration.
Parameter properties
Type: | String |
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 |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: | SwitchParameter |
Default value: | False |
Supports wildcards: | False |
DontShow: | False |
Aliases: | wi |
Parameter sets
(All)
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
None
Default
Microsoft.HyperV.PowerShell.MigrationNetwork
If -PassThru is specified.