Edit

Share via

New-NetIntentGlobalClusterOverrides

Module:
NetworkATC Module

Creates a new instance of cluster setting overrides which can be used to supply granular values to Add-NetIntent, Get-NetIntent, and Set-NetIntent.

Syntax

Default (Default) 

New-NetIntentGlobalClusterOverrides
    [[-EnableNetworkNaming] <Boolean>]
    [[-EnableLiveMigrationNetworkSelection] <Boolean>]
    [[-EnableVirtualMachineMigrationPerformanceSelection] <Boolean>]
    [[-VirtualMachineMigrationPerformanceOption] <String>]
    [[-MaximumVirtualMachineMigrations] <Byte>]
    [[-MaximumSMBMigrationBandwidthInGbps] <UInt32>]
    [<CommonParameters>]

Description

The New-NetIntentGlobalClusterOverrides cmdlet creates a new instance of cluster settings which can be used to supply granular configuration values to the Add-NetIntent and Set-NetIntent cmdlets. These settings can also be retrieved using the Get-NetIntent cmdlet.

Examples

Example

New-NetIntentGlobalClusterOverrides -EnableNetworkNaming $true -MaximumVirtualMachineMigrations 5

This example creates a new instance of a cluster override with network naming enabled and sets the maximum number of virtual machine migrations to 5.

Parameters

-EnableLiveMigrationNetworkSelection

Indicates whether live migration network selection is enabled. When set to $true, this setting allows the cluster to choose the best network for live migrations.

Parameter properties

Type:Boolean
Default value:False
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

-EnableNetworkNaming

Indicates whether network naming is enabled for the cluster. When set to $true, this setting allows the cluster to use descriptive network names.

Parameter properties

Type:Boolean
Default value:False
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

-EnableVirtualMachineMigrationPerformanceSelection

Indicates whether the selection of virtual machine migration performance options is enabled. When set to $true, this setting allows the selection of performance options for virtual machine migrations.

Parameter properties

Type:Boolean
Default value:False
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

-MaximumSMBMigrationBandwidthInGbps

Specifies the maximum bandwidth in gigabits per second (Gbps) that can be used for SMB migrations. This setting helps to limit the network bandwidth usage for migrations.

Parameter properties

Type:UInt32
Default value:0
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

-MaximumVirtualMachineMigrations

Specifies the maximum number of virtual machine migrations that can occur simultaneously. Setting this to a higher number can increase the load on the network and hosts.

Parameter properties

Type:Byte
Default value:0
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

-VirtualMachineMigrationPerformanceOption

Specifies the performance option for virtual machine migrations.

Parameter properties

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

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.