Set-NetIntent
Allows provisioning of override values for the given network intent.
Syntax
Set-NetIntent
[-Name] <String>
[[-ComputerName] <String>]
[-AdapterPropertyOverrides <NetAdapterAdvancedConfiguration>]
[-QoSPolicyOverrides <QoSPolicy>]
[-AdapterRssOverrides <RssConfiguration>]
[-SwitchOverrides <SwitchConfigurationOverride>]
[-StorageOverrides <NetAdapterStorageOverride>]
[-SiteOverrides <SiteConfiguration[]>]
[-StorageVlans <Int32[]>]
[-ManagementVlan <Int32>]
[-Wait]
[<CommonParameters>]
Set-NetIntent
[-Name] <String>
[-ClusterName] <String>
[-AdapterPropertyOverrides <NetAdapterAdvancedConfiguration>]
[-QoSPolicyOverrides <QoSPolicy>]
[-AdapterRssOverrides <RssConfiguration>]
[-SwitchOverrides <SwitchConfigurationOverride>]
[-StorageOverrides <NetAdapterStorageOverride>]
[-SiteOverrides <SiteConfiguration[]>]
[-StorageVlans <Int32[]>]
[-ManagementVlan <Int32>]
[-Wait]
[<CommonParameters>]
Set-NetIntent
[[-ComputerName] <String>]
[[-ClusterName] <String>]
[-GlobalProxyOverrides <WinHttpAdvProxy>]
[-GlobalClusterOverrides <ClusterSettings>]
[-Wait]
[<CommonParameters>]
Description
The Set-NetIntent
cmdlet allows provisioning of override values for given network intents. All
properties inside the override objects are nullable, meaning only the properties which are set will
be applied.
Examples
Example 1
$adapterOverrides = @{
JumboPacket = 9000
InterruptModeration = "Enabled"
}
$qosOverrides = @{
Name = "HighPriority"
Priority = 1
BandwidthPercentage = 50
}
$params = @{
Name = "MyIntent"
ComputerName = "Server01"
AdapterPropertyOverrides = $adapterOverrides
QoSPolicyOverrides = $qosOverrides
}
Set-NetIntent @params
This example sets the network intent named MyIntent
on the computer Server01
with specified
adapter property overrides and QoS policy overrides.
Parameters
-AdapterPropertyOverrides
Specifies the overrides for network adapter properties.
Type: | NetAdapterAdvancedConfiguration |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AdapterRssOverrides
Specifies the overrides for Receive Side Scaling (RSS) configuration on network adapters.
Type: | RssConfiguration |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClusterName
Specifies the name of the cluster on which the network intent should be set.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ComputerName
Specifies the name of the computer on which the network intent should be set.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GlobalClusterOverrides
Specifies the global overrides for cluster settings.
Type: | ClusterSettings |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GlobalProxyOverrides
Specifies the global overrides for proxy settings.
Type: | WinHttpAdvProxy |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManagementVlan
Specifies the VLAN for management traffic.
Type: | Int32 |
Position: | Named |
Default value: | -1 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the network intent to be set.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-QoSPolicyOverrides
Specifies the overrides for Quality of Service (QoS) policies.
Type: | QoSPolicy |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SiteOverrides
Specifies the overrides for site configuration.
Type: | SiteConfiguration[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StorageOverrides
Specifies the overrides for storage-related network adapter properties.
Type: | NetAdapterStorageOverride |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StorageVlans
Specifies the VLANs for storage networks.
Type: | Int32[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SwitchOverrides
Specifies the overrides for network switch configuration.
Type: | SwitchConfigurationOverride |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Wait
Indicates that the cmdlet should wait for the operation to complete before returning control to the command line.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Notes
Once the request has been successfully placed, all services will eventually detect and apply the
updated override policies. Use Get-NetIntentStatus
to see the current status. This may take
several minutes to retrieve.
To force policy updates, use the Set-NetIntentRetryState
to put a given policy in a retry pending
state in which case the policy will be forcefully applied.