From 196232412e8334ded72b912d9f29741ff3eb7fb3 Mon Sep 17 00:00:00 2001 From: Xelu86 Date: Mon, 17 Mar 2025 13:31:38 -0400 Subject: [PATCH 1/2] Updated command set --- .../NetworkATC/Add-NetIntent.md | 351 ++++++++++-------- .../NetworkATC/Copy-NetIntent.md | 138 ++++--- .../NetworkATC/Get-AllNetIntents.md | 38 +- .../NetworkATC/Get-HUDSwitchlessMapping.md | 26 +- .../NetworkATC/Get-NetIntent.md | 76 ++-- .../NetworkATC/Get-NetIntentAllGoalStates.md | 33 +- .../NetworkATC/Get-NetIntentStatus.md | 78 ++-- .../winserver2025-ps/NetworkATC/NetworkATC.md | 70 +++- .../New-NetIntentAdapterPropertyOverrides.md | 223 ++++++----- .../New-NetIntentAdapterRssOverrides.md | 107 ++++-- .../New-NetIntentGlobalClusterOverrides.md | 87 +++-- .../New-NetIntentGlobalProxyOverrides.md | 60 ++- .../New-NetIntentQoSPolicyOverrides.md | 58 +-- .../NetworkATC/New-NetIntentSiteOverrides.md | 71 ++-- .../New-NetIntentStorageOverrides.md | 45 ++- ...w-NetIntentSwitchConfigurationOverrides.md | 97 +++-- .../NetworkATC/Remove-NetIntent.md | 90 +++-- .../NetworkATC/Set-NetIntent.md | 171 +++++---- .../NetworkATC/Set-NetIntentRetryState.md | 86 +++-- .../NetworkATC/Set-NetIntentTracing.md | 48 ++- .../NetworkATC/Start-NetworkAtc.md | 44 ++- .../NetworkATC/Stop-NetworkAtc.md | 44 ++- .../NetworkATC/Update-NetIntentAdapter.md | 55 +-- .../NetworkATC/Update-NetIntentType.md | 63 ++-- .../NetworkATC/Update-NetworkATC.md | 37 +- 25 files changed, 1325 insertions(+), 871 deletions(-) diff --git a/docset/winserver2025-ps/NetworkATC/Add-NetIntent.md b/docset/winserver2025-ps/NetworkATC/Add-NetIntent.md index 3080995f1d..a688481713 100644 --- a/docset/winserver2025-ps/NetworkATC/Add-NetIntent.md +++ b/docset/winserver2025-ps/NetworkATC/Add-NetIntent.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/add-netintent?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-NetIntent @@ -10,7 +10,7 @@ title: Add-NetIntent # Add-NetIntent ## SYNOPSIS -Configures network host using intent based tags for adapters +Configures the network host using intent-based tags for adapters. ## SYNTAX @@ -50,82 +50,102 @@ Add-NetIntent -ClusterName -AdapterName -Name [-Wai ## DESCRIPTION -`Add-NetIntent` is used to communicate the default networking configurations required on the host. -Each intent is uniquely identified by the list of physical adapters provided. Which means no two -intents can have overlapping physical nic names. - -Intents are supported per cluster or as a standalone host. - -- For Standalone **ComputerName** should point to the available DNS host Name. (Ensure that the - current used of the script has administrator priviliges on the remote machine) -- For Cluster: **ClusterName** should point to the available DNS ClusterName. Cluster intents are - policies which 'floats' across the cluster and any node which finds compatible (matching names ) - will automatically apply the intended networking configuration on it. -- If **ComputerName** and **ClusterName** are null, clustered hosts will use the name of their - cluster and standalone hosts will use their own host name. - -If you're logged into using a remote session, giving a remote cluster name would very likely result -in a 'double hop issue'. For more information, see -[Understanding Kerberos Double Hop](https://techcommunity.microsoft.com/t5/ask-the-directory-services-team/understanding-kerberos-double-hop/ba-p/395463) - -Cluster DNS name is 'floating' and may be actively registered to any of the node's IP address. If -the active IP does not belong to the node this script is being run, then a remote call will be made. -In a remote session, this is a double hop and will fail. - -As an alternative, you can try giving `-ClusterName ` as the target endpoint. This -will cause the resolution to be forced to the local instance of the cluster. This is different from -calling `-ComputerName `, calling with -ComputerName updates only the local reposity. -Intents in the local repositories are skipped if the ndoe is a part of a cluster. - -Once an intent is created, it may not be modified. The only way to re-do is to do a cleanup using -`Clear-NetIntent` and then applying `Add-NetIntent` again. - -However, configuration changes like providing override for defaults is possible. This can be -achieved by providing _policy overrides_ (see **AdapterPropertyOverrides**, **QoSPolicyOverrides**, -**AdapterRssOverrides**, and **SwitchOverrides**). These can also be supplied during `Add-NetIntent` -and can also be applied post facto using `Add-NetIntentOverride`. - -`Set-NetIntentTracing` can be used to enable / disable tracing for collecting dignostic information -about operations of NetworkAtc - -Intent status is retried a few times and then the engine gives up. This would be marked as -**Failed**. You can query the status by running `Get-NetIntentStatus`. +The `Add-NetIntent` cmdlet is used to communicate the default networking +configurations required on the host. Each intent is uniquely identified by the +list of physical adapters provided, which means no two intents can have +overlapping physical NIC names. If an intent requires switch creation, one +switch will be created. If a switch is created with multiple adapters, NIC +teaming will be automatically created. + +For clustering, intents are supported per cluster or as a standalone host. + +- **Standalone**: `$ComputerName` should point to the available DNS host Name. + Ensure that the current used of the script has administrator privileges on the + remote machine. + +- **Cluster**: `$ClusterName` should point to the available DNS ClusterName. + Cluster intents are policies which 'floats' across the cluster and any node + which finds matching names will automatically apply the intended networking + configuration on it. + +- Acceptable intent values are: + + - `Compute` + - `Management` + - `Storage` + - `Stretch` + +Once an intent is created, it may not be modified. The only way to override is +to do a cleanup using `Clear-NetIntent` and then applying `Add-NetIntent` again. +However, configuration changes like providing override for defaults are +possible. This can be achieved by applying the override cmdlets. These can also +be supplied when running `Add-NetIntent` and can also be applied post facto +using `Add-NetIntentOverride`. + +If `$ComputerName` and `$ClusterName` are null, clustered hosts will use the +name of their cluster for `$Clustername` and standalone hosts will use their own +host name for `$ComputerName`. If you're logged in using a remote session, +providing a remote cluster name would result in a "double hop issue". To learn +more, see +[Understanding Kerberos Double Hop](https://techcommunity.microsoft.com/t5/ask-the-directory-services-team/understanding-kerberos-double-hop/ba-p/395463). + +Cluster DNS name is "floating" and may be actively registered to any of the +node's IP address. If the active IP doesn't belong to the node this script is +being run, then a remote call will be made. In a remote session, this is a +double hop and will fail. As an alternative, you can try using +`-ClusterName ` as the target endpoint. This will cause the +resolution to be forced to the local instance of the cluster. This is different +from using `-ComputerName ` as calling with **ComputerName** +updates only the local reposity. Intents in the local repositories are skipped +if the node is a part of a cluster. + +`Set-NetIntentTracing` can be used to enable or disable tracing for collecting +diagnostic information about operations of the NetworkATC module. The intent +status is retried a few times and then the engine gives up. This would be marked +as "Failed" and you can query the status by running `Get-NetIntentStatus`. ## EXAMPLES ### EXAMPLE 1 +```powershell +Add-NetIntent –AdapterName "Ethernet0" –ComputerName "Server01" –Name "MyIntent" -Compute ``` -Add-NetIntent -``` + +This example creates a new `Compute` intent for the standalone device named +`Server01` on network adapter `Ethernet0`. ## PARAMETERS -### -AdapterName +### -ComputerName -A list of physical network adapters on which this intent will be created. If an intent requires -switch creation, one switch will be created. If a switch is created with multiple adapters, a NIC -teaming will be automatically be created. +Specifies the computer name of the target host on which the network +intent configuration will be applied. For standalone hosts, use the local +computer name; for scenarios where the script is executed remotely, ensure the +current user has administrative privileges on the target machine. ```yaml -Type: System.String[] -Parameter Sets: ComputerName, Cluster +Type: String +Parameter Sets: ComputerName, Global Aliases: -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AdapterPropertyOverrides +### -ClusterName -{{ Fill AdapterPropertyOverrides Description }} +Specifies the name of the cluster for which the network intent is being +defined. When used, the intent "floats" across the cluster. Any node with +matching physical adapter names will automatically apply the intended +configuration. ```yaml -Type: FabricManager.NetAdapterAdvancedConfiguration -Parameter Sets: ComputerName, Cluster +Type: String +Parameter Sets: Global Aliases: Required: False @@ -135,41 +155,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdapterRssPropertyOverrides - -{{ Fill AdapterRssPropertyOverrides Description }} - ```yaml -Type: FabricManager.RssConfiguration -Parameter Sets: ComputerName, Cluster +Type: String +Parameter Sets: Cluster Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ClusterName +### -AdapterName -The name of the target cluster for the intents. +Specifies one or more physical network adapter names on which the network intent will be applied. ```yaml -Type: System.String -Parameter Sets: Global +Type: String[] +Parameter Sets: ComputerName, Cluster Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Name + +Defines a unique name that identifies the network intent. Since intents are +uniquely determined by their list of physical adapters, the name is used as an +identifier to ensure that each intent is distinct. + ```yaml -Type: System.String -Parameter Sets: Cluster +Type: String +Parameter Sets: ComputerName, Cluster Aliases: Required: True @@ -179,13 +201,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Compute +### -Wait -Specifies the intent is for compute. +When specified, the command will wait for the network configuration commands to +complete or for status confirmation before returning control. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ComputerName, Cluster +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False @@ -195,60 +218,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName +### -Compute -The name of the target computer for the intents. +Indicates that the network intent includes configuration related to compute workloads. ```yaml -Type: System.String -Parameter Sets: ComputerName, Global +Type: SwitchParameter +Parameter Sets: ComputerName, Cluster Aliases: Required: False -Position: 1 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalClusterOverrides +### -Management -{{ Fill GlobalClusterOverrides Description }} +Designates that the network intent includes configuration for management traffic. ```yaml -Type: FabricManager.ClusterSettings -Parameter Sets: Global +Type: SwitchParameter +Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalProxyOverrides +### -Storage -{{ Fill GlobalProxyOverrides Description }} +Signals that the network intent includes storage-specific settings. ```yaml -Type: FabricManager.WinHttpAdvProxy -Parameter Sets: Global +Type: SwitchParameter +Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Management +### -Switchless -Specifies the intent is for management. +Indicates that the configuration should be applied without creating a virtual +switch. This mode is used when you want to configure the physical adapters +directly without introducing additional switch constructs. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: ComputerName, Cluster Aliases: @@ -259,60 +284,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagementVlan +### -Stretch -{{ Fill ManagementVlan Description }} +Enables stretch mode, allowing the network configuration to extend across +multiple physical networks or sites. This option is useful for environments that +require network intents to span more than one location or subnet. ```yaml -Type: System.Int32 +Type: SwitchParameter Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: -1 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -AdapterPropertyOverrides -The name of the intent. +Allows you to specify a custom set of advanced property values for the network +adapter(s), overriding the default settings applied by the intent. ```yaml -Type: System.String +Type: NetAdapterAdvancedConfiguration Parameter Sets: ComputerName, Cluster Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PutGlobal +### -QoSPolicyOverrides -{{ Fill PutGlobal Description }} +Provides the ability to supply custom Quality of Service (QoS) policy settings +that override the defaults. ```yaml -Type: System.Boolean +Type: QoSPolicy Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -QoSPolicyOverrides +### -AdapterRssPropertyOverrides -{{ Fill QoSPolicyOverrides Description }} +Allows you to provide custom overrides for Receive Side Scaling (RSS) +configurations on the network adapter(s). ```yaml -Type: FabricManager.QoSPolicy +Type: RssConfiguration Parameter Sets: ComputerName, Cluster Aliases: @@ -323,12 +353,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteOverrides +### -SwitchPropertyOverrides -{{ Fill SiteOverrides Description }} +Provides custom configuration overrides for virtual switch properties. These +settings allow you to fine-tune the behavior of the virtual switch that might be +created as part of the network intent, replacing the default switch +configurations as needed. ```yaml -Type: FabricManager.SiteConfiguration[] +Type: SwitchConfigurationOverride Parameter Sets: ComputerName, Cluster Aliases: @@ -339,44 +372,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipNetworkInterfaceValidation +### -StorageOverrides -{{ Fill SkipNetworkInterfaceValidation Description }} +Enables custom override settings specific to storage adapter configurations. Use +this parameter to replace default storage network settings with those that +better suit your storage traffic. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: NetAdapterStorageOverride Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Storage +### -SiteOverrides -Specifies the intent is for storage. +Allows you to apply site-specific configuration overrides for different physical or logical sites. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SiteConfiguration[] Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StorageOverrides +### -StorageVlans -{{ Fill StorageOverrides Description }} +Specifies an array of VLAN IDs that should be used for storage traffic. ```yaml -Type: FabricManager.NetAdapterStorageOverride +Type: Int32[] Parameter Sets: ComputerName, Cluster Aliases: @@ -387,28 +422,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StorageVlans +### -ManagementVlan -{{ Fill StorageVlans Description }} +Specifies the VLAN ID for management traffic. When set, network management tasks +(administrative traffic) are aligned with the designated VLAN. The default value +of `–1` indicates that no specific VLAN is used unless explicitly defined. ```yaml -Type: System.Int32[] +Type: Int32 Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: None +Default value: -1 Accept pipeline input: False Accept wildcard characters: False ``` -### -Stretch +### -SkipNetworkInterfaceValidation -{{ Fill Stretch Description }} +If specified, the command bypasses the standard validation checks for network +interfaces. This might be required in environments where non-standard or virtual +interfaces are in use. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: ComputerName, Cluster Aliases: @@ -419,29 +458,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Switchless +### -GlobalProxyOverrides -{{ Fill Switchless Description }} +Used with global intents, this parameter allows you to override the default HTTP +proxy settings with custom proxy configurations. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ComputerName, Cluster +Type: WinHttpAdvProxy +Parameter Sets: Global Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SwitchPropertyOverrides +### -GlobalClusterOverrides -{{ Fill SwitchPropertyOverrides Description }} +Allows you to provide cluster-wide configuration overrides that replace the +default cluster settings. ```yaml -Type: FabricManager.SwitchConfigurationOverride -Parameter Sets: ComputerName, Cluster +Type: ClusterSettings +Parameter Sets: Global Aliases: Required: False @@ -451,28 +492,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Wait +### -PutGlobal -{{ Fill Wait Description }} +Determines whether the network intent should be registered or persisted +globally. When set to `$true` (the default), the intent is applied to the global +repository, making it visible across the cluster. If `$false`, the intent is +only updated locally and not propagated to the global context. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Type: Boolean +Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: False +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -481,3 +526,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Copy-NetIntent](Copy-NetIntent.md) + +- [Get-NetIntent](Get-NetIntent.md) + +- [Get-NetIntentStatus](Get-NetIntentStatus.md) + +- [Remove-NetIntent](Remove-NetIntent.md) + +- [Set-NetIntent](Set-NetIntent.md) diff --git a/docset/winserver2025-ps/NetworkATC/Copy-NetIntent.md b/docset/winserver2025-ps/NetworkATC/Copy-NetIntent.md index db480b56af..6ce2964ac5 100644 --- a/docset/winserver2025-ps/NetworkATC/Copy-NetIntent.md +++ b/docset/winserver2025-ps/NetworkATC/Copy-NetIntent.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/copy-netintent?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Copy-NetIntent @@ -10,7 +10,7 @@ title: Copy-NetIntent # Copy-NetIntent ## SYNOPSIS -Moves (or copies) net intent across different hosts or clusters +Moves or copies network intents across different hosts or clusters. ## SYNTAX @@ -72,136 +72,146 @@ Copy-NetIntent [-GlobalOverrides] [-SourceComputerName] [-DestinationCo ## DESCRIPTION -{{ Fill in the Description }} +The `Copy-NetIntent` cmdlet copies or moves a network intent from one host or +cluster to another. The source intent is removed if the **RemoveSource** +parameter is provided. ## EXAMPLES ### EXAMPLE 1 +```powershell +Copy-NetIntent -Name "MyIntent" -SourceComputerName "Server01" -DestinationComputerName "Server02" ``` -Copy-NetIntent -``` + +This example copies a network intent from the standalone device `Server01` to +the standalone destination device `Server02`. ## PARAMETERS -### -DestinationClusterName +### -Name -The name of the cluster that the intent is copied to. +Defines a unique name that identifies the network intent. Since intents are +uniquely determined by their list of physical adapters, the name is used as an +identifier to ensure that each intent is distinct. ```yaml -Type: System.String -Parameter Sets: ClusterToCluster, LocalToCluster, GlobalClusterToCluster, GlobalLocalToCluster +Type: String +Parameter Sets: LocalToLocal, ClusterToCluster, ClusterToLocal, LocalToCluster Aliases: -Required: True -Position: 3 +Required: False +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -DestinationComputerName +### -GlobalOverrides -The name of the computer that the intent is copied to. +Specifies that global override settings during the copy operation for any local +settings. ```yaml -Type: System.String -Parameter Sets: LocalToLocal, ClusterToLocal, GlobalClusterToLocal, GlobalLocalToLocal +Type: SwitchParameter +Parameter Sets: GlobalClusterToLocal, GlobalClusterToCluster, GlobalLocalToCluster, GlobalLocalToLocal Aliases: Required: True -Position: 3 -Default value: None -Accept pipeline input: False +Position: Named +Default value: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -GlobalOverrides +### -SourceComputerName -{{ Fill GlobalOverrides Description }} +Specifies the name of the source computer that holds the network intent to be copied. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GlobalClusterToLocal, GlobalClusterToCluster, GlobalLocalToCluster, GlobalLocalToLocal +Type: String +Parameter Sets: LocalToLocal, LocalToCluster, GlobalLocalToCluster, GlobalLocalToLocal Aliases: Required: True -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName, ByValue) +Position: 2 +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -SourceClusterName -The name of the intent to be copied. +Specifies the name of the source cluster that contains the network intent to be copied. ```yaml -Type: System.String -Parameter Sets: LocalToLocal, ClusterToCluster, ClusterToLocal, LocalToCluster +Type: String +Parameter Sets: ClusterToCluster, ClusterToLocal, GlobalClusterToLocal, GlobalClusterToCluster Aliases: -Required: False -Position: 1 +Required: True +Position: 2 Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoveSource +### -DestinationComputerName -Indicates that the source needs to be removed after the copy. +Specifies the name of the destination computer where the network intent is to be copied. ```yaml -Type: System.Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: LocalToLocal, ClusterToLocal, GlobalClusterToLocal, GlobalLocalToLocal Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SourceClusterName +### -DestinationClusterName -The name of the cluster that the intent is copied from. +Specifies the name of the destination cluster to which the network intent is to be copied. ```yaml -Type: System.String -Parameter Sets: ClusterToCluster, ClusterToLocal, GlobalClusterToLocal, GlobalClusterToCluster +Type: String +Parameter Sets: ClusterToCluster, LocalToCluster, GlobalClusterToCluster, GlobalLocalToCluster Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SourceComputerName +### -RemoveSource -The name of the computer that the intent is copied from. +Indicates whether the original network intent should be removed from the source +after the copy operation is completed. ```yaml -Type: System.String -Parameter Sets: LocalToLocal, LocalToCluster, GlobalLocalToCluster, GlobalLocalToLocal +Type: Boolean +Parameter Sets: (All) Aliases: -Required: True -Position: 2 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -Wait -{{ Fill Wait Description }} +When specified, the command will wait for the network configuration commands to +complete or for status confirmation before returning control. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -214,7 +224,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -222,6 +236,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -The copy & removal operation of the intent is not a transacted operation\`. +The copy and removal operation of the intent isn't a transacted operation. ## RELATED LINKS + +- [Add-NetIntent](Add-NetIntent.md) + +- [Get-NetIntent](Get-NetIntent.md) + +- [Get-NetIntentStatus](Get-NetIntentStatus.md) + +- [Remove-NetIntent](Remove-NetIntent.md) + +- [Set-NetIntent](Set-NetIntent.md) diff --git a/docset/winserver2025-ps/NetworkATC/Get-AllNetIntents.md b/docset/winserver2025-ps/NetworkATC/Get-AllNetIntents.md index 1094a2cf7f..ea388e580d 100644 --- a/docset/winserver2025-ps/NetworkATC/Get-AllNetIntents.md +++ b/docset/winserver2025-ps/NetworkATC/Get-AllNetIntents.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/get-allnetintents?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AllNetIntents @@ -10,7 +10,7 @@ title: Get-AllNetIntents # Get-AllNetIntents ## SYNOPSIS -Looks up all intent requests configurations available +Looks up all intent request configurations available. ## SYNTAX @@ -21,26 +21,28 @@ Get-AllNetIntents [[-ClusterName] ] [[-ComputerName] ] [-GlobalO ## DESCRIPTION -{{ Fill in the Description }} +The `Get-AllNetIntents` cmdlet retrieves all network intent configurations +available based on the computer name or cluster name. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Get-AllNetIntents -ComputerName "Server01" ``` -{{ Add example description here }} +This example retrieves all network intent configurations from the `Server01` standalone host. ## PARAMETERS ### -ClusterName -{{ Fill ClusterName Description }} +Specifies the name of the cluster for which the network intent is to be +retrieved. When used, the intent "floats" across the cluster. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -53,10 +55,13 @@ Accept wildcard characters: False ### -ComputerName -{{ Fill ComputerName Description }} +Specifies the computer name of the target host on which the network +intent configuration is to be retrieved. For standalone hosts, use the local +computer name; for scenarios where the script is executed remotely, ensure the +current user has administrative privileges on the target machine. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -69,10 +74,10 @@ Accept wildcard characters: False ### -GlobalOverrides -{{ Fill GlobalOverrides Description }} +Retrieves the global override settings. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -85,10 +90,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS diff --git a/docset/winserver2025-ps/NetworkATC/Get-HUDSwitchlessMapping.md b/docset/winserver2025-ps/NetworkATC/Get-HUDSwitchlessMapping.md index bca56f7f44..b7162ad977 100644 --- a/docset/winserver2025-ps/NetworkATC/Get-HUDSwitchlessMapping.md +++ b/docset/winserver2025-ps/NetworkATC/Get-HUDSwitchlessMapping.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/get-hudswitchlessmapping?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-HUDSwitchlessMapping @@ -10,7 +10,7 @@ title: Get-HUDSwitchlessMapping # Get-HUDSwitchlessMapping ## SYNOPSIS -{{ Fill in the Synopsis }} +Retrieves the HUD switchless mapping configuration for the specified cluster. ## SYNTAX @@ -20,26 +20,27 @@ Get-HUDSwitchlessMapping [-ClusterName] [] ## DESCRIPTION -{{ Fill in the Description }} +The `Get-HUDSwitchlessMapping` cmdlet queries retrieves the configuration +mapping for switchless operation within the HUD subsystem on the target cluster. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Get-HUDSwitchlessMapping -ClusterName "Cluster01" ``` -{{ Add example description here }} +This example retrieves the HUD switchless mapping configuration for the cluster `Cluster01`. ## PARAMETERS ### -ClusterName -{{ Fill ClusterName Description }} +Specifies the name of the cluster. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -52,10 +53,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS diff --git a/docset/winserver2025-ps/NetworkATC/Get-NetIntent.md b/docset/winserver2025-ps/NetworkATC/Get-NetIntent.md index 8b2225f863..cd2d070d73 100644 --- a/docset/winserver2025-ps/NetworkATC/Get-NetIntent.md +++ b/docset/winserver2025-ps/NetworkATC/Get-NetIntent.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/get-netintent?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-NetIntent @@ -10,7 +10,7 @@ title: Get-NetIntent # Get-NetIntent ## SYNOPSIS -Gets the current set of intents configured on the node / cluster +Gets the current set of intents configured on the node or cluster. ## SYNTAX @@ -28,90 +28,100 @@ Get-NetIntent [-ClusterName] [-Name ] [-GlobalOverrides] [ {{ Add example code here }} +Get-NetIntent -ComputerName "Server01" -Name "MyIntent" ``` -{{ Add example description here }} +This example retrieves the network intent `MyIntent` on the standalone host `Server01`. ## PARAMETERS -### -ClusterName +### -ComputerName -{{ Fill ClusterName Description }} +Specifies the computer name of the target host on which the network +intent configuration will be applied. For standalone hosts, use the local +computer name; for scenarios where the script is executed remotely, ensure the +current user has administrative privileges on the target machine. ```yaml -Type: System.String -Parameter Sets: Cluster +Type: String +Parameter Sets: ComputerName Aliases: -Required: True +Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName +### -ClusterName -{{ Fill ComputerName Description }} +Specifies the name of the cluster for which the network intent is being +defined. When used, the intent "floats" across the cluster. Any node with +matching physical adapter names will automatically apply the intended +configuration. ```yaml -Type: System.String -Parameter Sets: ComputerName +Type: String +Parameter Sets: Cluster Aliases: -Required: False +Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalOverrides +### -Name -{{ Fill GlobalOverrides Description }} +Defines a unique name that identifies the network intent. Since intents are +uniquely determined by their list of physical adapters, the name is used as an +identifier to ensure that each intent is distinct. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -GlobalOverrides -{{ Fill Name Description }} +Retrieves the global override settings of the network intent. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -120,3 +130,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Add-NetIntent](Add-NetIntent.md) + +- [Copy-NetIntent](Copy-NetIntent.md) + +- [Get-NetIntentStatus](Get-NetIntentStatus.md) + +- [Remove-NetIntent](Remove-NetIntent.md) + +- [Set-NetIntent](Set-NetIntent.md) diff --git a/docset/winserver2025-ps/NetworkATC/Get-NetIntentAllGoalStates.md b/docset/winserver2025-ps/NetworkATC/Get-NetIntentAllGoalStates.md index 8675f82cd9..9c15e46023 100644 --- a/docset/winserver2025-ps/NetworkATC/Get-NetIntentAllGoalStates.md +++ b/docset/winserver2025-ps/NetworkATC/Get-NetIntentAllGoalStates.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/get-netintentallgoalstates?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-NetIntentAllGoalStates @@ -10,7 +10,7 @@ title: Get-NetIntentAllGoalStates # Get-NetIntentAllGoalStates ## SYNOPSIS -Looks up all intent goal state configurations available +Looks up all intent goal state configurations available. ## SYNTAX @@ -20,24 +20,28 @@ Get-NetIntentAllGoalStates [[-ClusterName] ] [[-ComputerName] ] ## DESCRIPTION -Long description +The `Get-NetIntentAllGoalStates` retrieves the goal states stored for each +intent. These configurations are the settings used for initial provisioning and +drift checks. This information is useful for debugging and troubleshooting. ## EXAMPLES ### EXAMPLE 1 +```powershell +Get-NetIntentAllGoalStates -ComputerName "Server01" ``` - -``` + +This example retrieves all of the network intent goal states from the `Server01` standalone host. ## PARAMETERS ### -ClusterName -{{ Fill ClusterName Description }} +Specifies the name of the cluster for which the goal states are to be retrieved. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -50,10 +54,10 @@ Accept wildcard characters: False ### -ComputerName -{{ Fill ComputerName Description }} +Specifies the name of the computer for which the goal states are to be retrieved. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -66,10 +70,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS diff --git a/docset/winserver2025-ps/NetworkATC/Get-NetIntentStatus.md b/docset/winserver2025-ps/NetworkATC/Get-NetIntentStatus.md index 5d6bb7c3b5..eff7be1dcc 100644 --- a/docset/winserver2025-ps/NetworkATC/Get-NetIntentStatus.md +++ b/docset/winserver2025-ps/NetworkATC/Get-NetIntentStatus.md @@ -1,17 +1,16 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 -online version: https://learn.microsoft.com/powershell/module/networkatc/get-netintentstatus?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +ms.date: 03/14/2025 +online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentstatus?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 -title: Get-NetIntentStatus +title: New-NetIntentStatus --- # Get-NetIntentStatus ## SYNOPSIS -Displays consolidated status of all the intent configurations for a node or across multiple nodes in -case of a cluster. +Displays the consolidated status of all the intent configurations for a node or across multiple nodes in a cluster. ## SYNTAX @@ -31,31 +30,35 @@ Get-NetIntentStatus [[-Name] ] [-ClusterName] [-GlobalOverrides ## DESCRIPTION -{{ Fill in the Description }} +The `Get-NetIntentStatus` cmdlet retrieves the status of all the network intent +configurations for a standalone host or a cluster. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Get-NetIntentStatus -Name "MyIntent" -ComputerName "Server01" ``` -{{ Add example description here }} +This example retrieves the status of the network intent configuration `MyIntent` +for the computer named `Server01`. ## PARAMETERS -### -ClusterName +### -Name -{{ Fill ClusterName Description }} +Defines a unique name that identifies the network intent. Since intents are +uniquely determined by their list of physical adapters, the name is used as an +identifier to ensure that each intent is distinct. ```yaml -Type: System.String -Parameter Sets: Cluster +Type: String +Parameter Sets: (All) Aliases: -Required: True -Position: 2 +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -63,10 +66,13 @@ Accept wildcard characters: False ### -ComputerName -{{ Fill ComputerName Description }} +Specifies the computer name of the target host on which the network intent +status is to be retrieved. For standalone hosts, use the local computer name; +for scenarios where the script is executed remotely, ensure the current user has +administrative privileges on the target machine. ```yaml -Type: System.String +Type: String Parameter Sets: ComputerName Aliases: @@ -77,44 +83,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalOverrides +### -ClusterName -{{ Fill GlobalOverrides Description }} +Specifies the name of the cluster for which the network intent status is to be +retrieved. When used, the intent "floats" across the cluster. Any node with +matching physical adapter names will automatically apply the intended +configuration. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Cluster Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 2 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -GlobalOverrides -{{ Fill Name Description }} +Retrieves the global override settings of the network intent status. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 1 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -123,3 +133,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Get-NetIntent](Get-NetIntent.md) diff --git a/docset/winserver2025-ps/NetworkATC/NetworkATC.md b/docset/winserver2025-ps/NetworkATC/NetworkATC.md index 3de994fd8e..39b0d62d95 100644 --- a/docset/winserver2025-ps/NetworkATC/NetworkATC.md +++ b/docset/winserver2025-ps/NetworkATC/NetworkATC.md @@ -4,84 +4,114 @@ Help Version: 5.1.0.2025 Locale: en-US Module Guid: 74bd14cc-e0b8-42f9-b940-0ad938bb852b Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 title: NetworkATC module --- # NetworkATC Module + ## Description -{{ Fill in the Description }} + +The NetworkATC modules are part of a toolset provided for automating and +managing network configurations in a software-defined networking (SDN) +environment. These modules enable administrators to automate the setup, +configuration, and monitoring of network traffic policies and routes, ensuring +optimal performance and resource allocation. ## NetworkATC Cmdlets ### [Add-NetIntent](Add-NetIntent.md) -Configures network host using intent based tags for adapters + +Configures the network host using intent-based tags for adapters. ### [Copy-NetIntent](Copy-NetIntent.md) -Moves (or copies) net intent across different hosts or clusters + +Moves or copies network intents across different hosts or clusters. ### [Get-AllNetIntents](Get-AllNetIntents.md) + Looks up all intent requests configurations available ### [Get-HUDSwitchlessMapping](Get-HUDSwitchlessMapping.md) -{{ Fill in the Synopsis }} + +Retrieves the HUD switchless mapping configuration for the specified cluster. ### [Get-NetIntent](Get-NetIntent.md) -Gets the current set of intents configured on the node / cluster + +Gets the current set of intents configured on the node or cluster. ### [Get-NetIntentAllGoalStates](Get-NetIntentAllGoalStates.md) + Looks up all intent goal state configurations available ### [Get-NetIntentStatus](Get-NetIntentStatus.md) -Displays consolidated status of all the intent configurations for a node or across multiple nodes in case of a cluster. + +Displays the consolidated status of all the intent configurations for a node or across multiple nodes in a cluster. ### [New-NetIntentAdapterPropertyOverrides](New-NetIntentAdapterPropertyOverrides.md) -Creates a new instance of AdapterPropertyOverrides which can be used to supply granular values to `Set-NetIntent`. + +Creates a new instance of network adapter property overrides which can be used to supply granular values to `Set-NetIntent`. ### [New-NetIntentAdapterRssOverrides](New-NetIntentAdapterRssOverrides.md) -Creates a new instance of Rss overrides which can be used to supply granular values to `Set-NetIntent`. + +Creates a new instance of RSS overrides which can be used to supply granular values to `Set-NetIntent`. ### [New-NetIntentGlobalClusterOverrides](New-NetIntentGlobalClusterOverrides.md) -Creates a new instance of ClusterSettings which can be used to supply granular values to `Add-NetIntent` and `Set-NetIntent`. + +Creates a new instance of cluster setting overrides which can be used to supply granular values to `Add-NetIntent`, `Get-NetIntent`, and `Set-NetIntent`. ### [New-NetIntentGlobalProxyOverrides](New-NetIntentGlobalProxyOverrides.md) -{{ Fill in the Synopsis }} + +Creates a new instance for global proxy overrides. ### [New-NetIntentQoSPolicyOverrides](New-NetIntentQoSPolicyOverrides.md) -Creates a new instance of **QoSPolicyOverrides** which can be used to supply granular values to `Set-NetIntent` + +Creates a new instance of QoS policy overrides which can be used to supply granular values to `Set-NetIntent`. ### [New-NetIntentSiteOverrides](New-NetIntentSiteOverrides.md) -Creates a new instance of SiteConfiguration which can be used to supply granular values to `Set-NetIntent`. + +Creates a new instance of site configuration overrides which can be used to supply granular values to `Set-NetIntent`. ### [New-NetIntentStorageOverrides](New-NetIntentStorageOverrides.md) -Creates a new instance of **NetAdapterStorageOverride** which can be used to supply granular values to `Set-NetIntent`. + +Creates a new instance of network adapter storage overrides which can be used to supply granular values to `Set-NetIntent`. ### [New-NetIntentSwitchConfigurationOverrides](New-NetIntentSwitchConfigurationOverrides.md) -Creates a new instance of **SwitchConfigurationOverride** which can be used to supply granular values to `Set-NetIntent`. + +Creates a new instance of virtual switch configuration overrides which can be used to supply granular values to `Set-NetIntent`. ### [Remove-NetIntent](Remove-NetIntent.md) -Removes the requested net intent. + +Removes the requested network intent. ### [Set-NetIntent](Set-NetIntent.md) -Allows provisioning of override values for given intents + +Allows provisioning of override values for the given network intent. ### [Set-NetIntentRetryState](Set-NetIntentRetryState.md) + Changes the provisioning state of the goal state for an intent on a given host. ### [Set-NetIntentTracing](Set-NetIntentTracing.md) + Starts and stops Atc tracing sessions on the host ### [Start-NetworkAtc](Start-NetworkAtc.md) + Starts the Atc Service on all hosts for a cluster or a given single node. ### [Stop-NetworkAtc](Stop-NetworkAtc.md) + Stops the Atc Service on all hosts for a cluster or a given single node. ### [Update-NetIntentAdapter](Update-NetIntentAdapter.md) -{{ Fill in the Synopsis }} + +Updates the network intent configuration for specified network adapters. ### [Update-NetIntentType](Update-NetIntentType.md) -{{ Fill in the Synopsis }} + +Updates the configuration types of network intents for specified computers or clusters. ### [Update-NetworkATC](Update-NetworkATC.md) -{{ Fill in the Synopsis }} + +Updates the Network ATC configuration settings. diff --git a/docset/winserver2025-ps/NetworkATC/New-NetIntentAdapterPropertyOverrides.md b/docset/winserver2025-ps/NetworkATC/New-NetIntentAdapterPropertyOverrides.md index 059903a9e9..c86aa651f7 100644 --- a/docset/winserver2025-ps/NetworkATC/New-NetIntentAdapterPropertyOverrides.md +++ b/docset/winserver2025-ps/NetworkATC/New-NetIntentAdapterPropertyOverrides.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentadapterpropertyoverrides?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetIntentAdapterPropertyOverrides @@ -10,48 +10,68 @@ title: New-NetIntentAdapterPropertyOverrides # New-NetIntentAdapterPropertyOverrides ## SYNOPSIS - -Creates a new instance of AdapterPropertyOverrides which can be used to supply granular values to -`Set-NetIntent`. +Creates a new instance of network adapter property overrides which can be used to supply granular values to `Set-NetIntent`. ## SYNTAX ``` -New-NetIntentAdapterPropertyOverrides [-EncapsulatedPacketTaskOffload ] - [-EncapsulatedPacketTaskOffloadNvgre ] [-EncapsulatedPacketTaskOffloadVxlan ] - [-FlowControl ] [-InterruptModeration ] [-IPChecksumOffloadIPv4 ] - [-JumboPacket ] [-LsoV2IPv4 ] [-LsoV2IPv6 ] [-NetworkDirect ] - [-NetworkDirectTechnology ] [-NumaNodeId ] [-PacketDirect ] - [-PriorityVLANTag ] [-PtpHardwareTimestamp ] [-QOS ] [-QosOffload ] - [-ReceiveBuffers ] [-RscIPv4 ] [-RscIPv6 ] [-RssOnHostVPorts ] - [-Sriov ] [-TCPUDPChecksumOffloadIPv4 ] [-TCPUDPChecksumOffloadIPv6 ] - [-UDPChecksumOffloadIPv4 ] [-UDPChecksumOffloadIPv6 ] [-TransmitBuffers ] - [-UsoIPv4 ] [-UsoIPv6 ] [-VMQ ] [-VxlanUDPPortNumber ] - [-VlanID ] [] +New-NetIntentAdapterPropertyOverrides [-EncapOverhead ] + [-EncapsulatedPacketTaskOffload ] [-EncapsulatedPacketTaskOffloadNvgre ] + [-EncapsulatedPacketTaskOffloadVxlan ] [-FlowControl ] [-InterruptModeration ] + [-IPChecksumOffloadIPv4 ] [-JumboPacket ] [-LsoV2IPv4 ] [-LsoV2IPv6 ] + [-NetworkDirect ] [-NetworkDirectTechnology ] [-NumaNodeId ] + [-PacketDirect ] [-PriorityVLANTag ] [-PtpHardwareTimestamp ] [-QOS ] + [-QosOffload ] [-ReceiveBuffers ] [-RscIPv4 ] [-RscIPv6 ] + [-RssOnHostVPorts ] [-Sriov ] [-TCPUDPChecksumOffloadIPv4 ] + [-TCPUDPChecksumOffloadIPv6 ] [-UDPChecksumOffloadIPv4 ] + [-UDPChecksumOffloadIPv6 ] [-TransmitBuffers ] [-UsoIPv4 ] [-UsoIPv6 ] + [-VMQ ] [-VxlanUDPPortNumber ] [-VlanID ] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +The `New-NetIntentAdapterPropertyOverrides` cmdlet creates a new instance of +network adapter property overrides, which is used to specify granular settings +for adapter properties that can be applied using the `Set-NetIntent` cmdlet. +These settings allow administrators to fine-tune network adapter properties to +optimize performance and functionality for specific network intents. ## EXAMPLES -### Example 1 +### Example ```powershell -PS C:\> {{ Add example code here }} +New-NetIntentAdapterPropertyOverrides -EncapOverhead 50 -FlowControl 1 -JumboPacket 9000 ``` -{{ Add example description here }} +This example creates a new instance of adapter property override with an +encapsulation overhead of `50` bytes, with flow control enabled, and jumbo +packets set to `9000` bytes. ## PARAMETERS +### -EncapOverhead + +Specifies the value of the encapsulation overhead. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EncapsulatedPacketTaskOffload -{{ Fill EncapsulatedPacketTaskOffload Description }} +Specifies the value of the encapsulated packet task offload. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -64,10 +84,10 @@ Accept wildcard characters: False ### -EncapsulatedPacketTaskOffloadNvgre -{{ Fill EncapsulatedPacketTaskOffloadNvgre Description }} +Specifies the value of the encapsulated packet task offload for NVGRE. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -80,10 +100,10 @@ Accept wildcard characters: False ### -EncapsulatedPacketTaskOffloadVxlan -{{ Fill EncapsulatedPacketTaskOffloadVxlan Description }} +Specifies the value of the encapsulated packet task offload for VXLAN. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -96,10 +116,10 @@ Accept wildcard characters: False ### -FlowControl -{{ Fill FlowControl Description }} +Specifies if flow control is to be used. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -112,10 +132,10 @@ Accept wildcard characters: False ### -InterruptModeration -{{ Fill InterruptModeration Description }} +Specifies the interrupt moderation rate. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -128,10 +148,10 @@ Accept wildcard characters: False ### -IPChecksumOffloadIPv4 -{{ Fill IPChecksumOffloadIPv4 Description }} +Specifies the IPv4 checksum offload value. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -144,10 +164,10 @@ Accept wildcard characters: False ### -JumboPacket -{{ Fill JumboPacket Description }} +Specifies the maximum size for jumbo packets. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -160,10 +180,10 @@ Accept wildcard characters: False ### -LsoV2IPv4 -{{ Fill LsoV2IPv4 Description }} +Specifies the value of large send offload version 2 (LSO V2) for IPv6. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -176,10 +196,10 @@ Accept wildcard characters: False ### -LsoV2IPv6 -{{ Fill LsoV2IPv6 Description }} +Specifies the value of large send offload version 2 (LSO V2) for IPv6. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -192,10 +212,10 @@ Accept wildcard characters: False ### -NetworkDirect -{{ Fill NetworkDirect Description }} +Specifies the Network Direct value. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -208,10 +228,10 @@ Accept wildcard characters: False ### -NetworkDirectTechnology -{{ Fill NetworkDirectTechnology Description }} +Specifies the Network Direct technology value. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -224,10 +244,10 @@ Accept wildcard characters: False ### -NumaNodeId -{{ Fill NumaNodeId Description }} +Specifies the NUMA node ID to use for the network adapter. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -240,10 +260,10 @@ Accept wildcard characters: False ### -PacketDirect -{{ Fill PacketDirect Description }} +Specifies the Packet Direct value. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -256,10 +276,10 @@ Accept wildcard characters: False ### -PriorityVLANTag -{{ Fill PriorityVLANTag Description }} +Specifies the priority value of VLAN tagging. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -272,10 +292,10 @@ Accept wildcard characters: False ### -PtpHardwareTimestamp -{{ Fill PtpHardwareTimestamp Description }} +Specifies the hardware timestamp for the Precision Time Protocol (PTP). ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -288,10 +308,10 @@ Accept wildcard characters: False ### -QOS -{{ Fill QOS Description }} +Specifies the Quality of Service (QoS) value for the network adapter. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -304,10 +324,10 @@ Accept wildcard characters: False ### -QosOffload -{{ Fill QosOffload Description }} +Specifies whether QoS offloading is to be enabled. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -320,10 +340,10 @@ Accept wildcard characters: False ### -ReceiveBuffers -{{ Fill ReceiveBuffers Description }} +Specifies the number of receive buffers to use. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -336,10 +356,10 @@ Accept wildcard characters: False ### -RscIPv4 -{{ Fill RscIPv4 Description }} +Specifies the value of Receive Segment Coalescing (RSC) for IPv4. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -352,10 +372,10 @@ Accept wildcard characters: False ### -RscIPv6 -{{ Fill RscIPv6 Description }} +Specifies the value of Receive Segment Coalescing (RSC) for IPv6. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -368,10 +388,10 @@ Accept wildcard characters: False ### -RssOnHostVPorts -{{ Fill RssOnHostVPorts Description }} +Specifies the RSS on host virtual ports. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -384,10 +404,10 @@ Accept wildcard characters: False ### -Sriov -{{ Fill Sriov Description }} +Specifies the SR-IOV value. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -400,10 +420,10 @@ Accept wildcard characters: False ### -TCPUDPChecksumOffloadIPv4 -{{ Fill TCPUDPChecksumOffloadIPv4 Description }} +Specifies the TCP/UDP checksum offload value for IPv4. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -416,10 +436,10 @@ Accept wildcard characters: False ### -TCPUDPChecksumOffloadIPv6 -{{ Fill TCPUDPChecksumOffloadIPv6 Description }} +Specifies the TCP/UDP checksum offload value for IPv6. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -430,12 +450,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TransmitBuffers +### -UDPChecksumOffloadIPv4 -{{ Fill TransmitBuffers Description }} +Specifies the UDP checksum offload for IPv4. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -446,12 +466,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UDPChecksumOffloadIPv4 +### -UDPChecksumOffloadIPv6 -{{ Fill UDPChecksumOffloadIPv4 Description }} +Specifies the UDP checksum offload for IPv6. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -462,12 +482,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UDPChecksumOffloadIPv6 +### -TransmitBuffers -{{ Fill UDPChecksumOffloadIPv6 Description }} +Specifies the number of transmit buffers to be used. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -480,10 +500,10 @@ Accept wildcard characters: False ### -UsoIPv4 -{{ Fill UsoIPv4 Description }} +Specifies the UDP segment offload (USO) for IPv4. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -496,10 +516,10 @@ Accept wildcard characters: False ### -UsoIPv6 -{{ Fill UsoIPv6 Description }} +Specifies the UDP segment offload (USO) for IPv6. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -510,12 +530,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VlanID +### -VMQ -{{ Fill VlanID Description }} +Specifies the Virtual Machine Queue (VMQ) to use. ```yaml -Type: System.UInt16 +Type: Int32 Parameter Sets: (All) Aliases: @@ -526,12 +546,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VMQ +### -VxlanUDPPortNumber -{{ Fill VMQ Description }} +Specifies the UDP port number to use for VXLAN. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -542,12 +562,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VxlanUDPPortNumber +### -VlanID -{{ Fill VxlanUDPPortNumber Description }} +Specifies the VLAN ID. ```yaml -Type: System.Int32 +Type: UInt16 Parameter Sets: (All) Aliases: @@ -560,10 +580,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -572,3 +593,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [New-NetIntentAdapterRssOverrides](New-NetIntentAdapterRssOverrides.md) + +- [New-NetIntentGlobalClusterOverrides](New-NetIntentGlobalClusterOverrides.md) + +- [New-NetIntentGlobalProxyOverrides](New-NetIntentGlobalProxyOverrides.md) + +- [New-NetIntentQoSPolicyOverrides](New-NetIntentQoSPolicyOverrides.md) + +- [New-NetIntentSiteOverrides](New-NetIntentSiteOverrides.md) + +- [New-NetIntentStorageOverrides](New-NetIntentStorageOverrides.md) + +- [New-NetIntentSwitchConfigurationOverrides](New-NetIntentSwitchConfigurationOverrides.md) diff --git a/docset/winserver2025-ps/NetworkATC/New-NetIntentAdapterRssOverrides.md b/docset/winserver2025-ps/NetworkATC/New-NetIntentAdapterRssOverrides.md index ca7d970261..6d9f0660a8 100644 --- a/docset/winserver2025-ps/NetworkATC/New-NetIntentAdapterRssOverrides.md +++ b/docset/winserver2025-ps/NetworkATC/New-NetIntentAdapterRssOverrides.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentadapterrssoverrides?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetIntentAdapterRssOverrides @@ -10,8 +10,7 @@ title: New-NetIntentAdapterRssOverrides # New-NetIntentAdapterRssOverrides ## SYNOPSIS -Creates a new instance of Rss overrides which can be used to supply granular values to -`Set-NetIntent`. +Creates a new instance of RSS overrides which can be used to supply granular values to `Set-NetIntent`. ## SYNTAX @@ -23,42 +22,58 @@ New-NetIntentAdapterRssOverrides [-RssEnabled ] [-BaseProcessorGroup {{ Add example code here }} +$params = @{ + RssEnabled = $true + BaseProcessorGroup = 0 + BaseProcessorNumber = 2 + MaxProcessorGroup = 0 + MaxProcessorNumber = 8 + MaxProcessors = 4 +} +New-NetIntentAdapterRssOverrides @params ``` -{{ Add example description here }} +This example demonstrates how to create a new RSS override instance with RSS +enabled. It specifies the base processor group and number, as well as the +maximum processor group and number. Additionally, it sets the total number of +processors to be used for RSS to `4`. ## PARAMETERS -### -BaseProcessorGroup +### -RssEnabled -{{ Fill BaseProcessorGroup Description }} +Specifies whether RSS should be enabled. When RSS is enabled, network traffic is +distributed across multiple processors to improve performance. ```yaml -Type: System.UInt16 +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -BaseProcessorNumber +### -BaseProcessorGroup -{{ Fill BaseProcessorNumber Description }} +Specifies the base processor group. This is the starting group number for the +processors that will be used by RSS. ```yaml -Type: System.Byte +Type: UInt16 Parameter Sets: (All) Aliases: @@ -69,12 +84,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxProcessorGroup +### -BaseProcessorNumber -{{ Fill MaxProcessorGroup Description }} +Specifies the base processor number within the base processor group in bytes. +This is the starting processor number within the base group for RSS. ```yaml -Type: System.UInt16 +Type: Byte Parameter Sets: (All) Aliases: @@ -85,12 +101,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxProcessorNumber +### -MaxProcessorGroup -{{ Fill MaxProcessorNumber Description }} +Specifies the maximum processor group. This defines the last group number that will be used by RSS. ```yaml -Type: System.Byte +Type: UInt16 Parameter Sets: (All) Aliases: @@ -101,12 +117,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxProcessors +### -MaxProcessorNumber -{{ Fill MaxProcessors Description }} +Specifies the maximum processor number within the maximum processor group. This +defines the last processor number within the maximum group that will be used by +RSS. ```yaml -Type: System.UInt32 +Type: Byte Parameter Sets: (All) Aliases: @@ -117,44 +135,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Profile +### -MaxProcessors -{{ Fill Profile Description }} +Specifies the total number of processors that RSS can use. This limits the +number of processors that can handle network traffic. ```yaml -Type: System.String +Type: UInt32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -RssEnabled +### -Profile -{{ Fill RssEnabled Description }} +Specifies the profile to be used for the RSS settings. This can be a custom +profile name that contains predefined RSS settings. ```yaml -Type: System.Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -163,3 +184,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [New-NetIntentAdapterPropertyOverrides](New-NetIntentAdapterPropertyOverrides.md) + +- [New-NetIntentGlobalClusterOverrides](New-NetIntentGlobalClusterOverrides.md) + +- [New-NetIntentGlobalProxyOverrides](New-NetIntentGlobalProxyOverrides.md) + +- [New-NetIntentQoSPolicyOverrides](New-NetIntentQoSPolicyOverrides.md) + +- [New-NetIntentSiteOverrides](New-NetIntentSiteOverrides.md) + +- [New-NetIntentStorageOverrides](New-NetIntentStorageOverrides.md) + +- [New-NetIntentSwitchConfigurationOverrides](New-NetIntentSwitchConfigurationOverrides.md) diff --git a/docset/winserver2025-ps/NetworkATC/New-NetIntentGlobalClusterOverrides.md b/docset/winserver2025-ps/NetworkATC/New-NetIntentGlobalClusterOverrides.md index af6067ab20..048b24c50e 100644 --- a/docset/winserver2025-ps/NetworkATC/New-NetIntentGlobalClusterOverrides.md +++ b/docset/winserver2025-ps/NetworkATC/New-NetIntentGlobalClusterOverrides.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentglobalclusteroverrides?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetIntentGlobalClusterOverrides @@ -10,8 +10,7 @@ title: New-NetIntentGlobalClusterOverrides # New-NetIntentGlobalClusterOverrides ## SYNOPSIS -Creates a new instance of ClusterSettings which can be used to supply granular values to -`Add-NetIntent` and `Set-NetIntent`. +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 @@ -25,26 +24,31 @@ New-NetIntentGlobalClusterOverrides [[-EnableNetworkNaming] ] ## DESCRIPTION -{{ Fill in the 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 1 +### Example ```powershell -PS C:\> {{ Add example code here }} +New-NetIntentGlobalClusterOverrides -EnableNetworkNaming $true -MaximumVirtualMachineMigrations 5 ``` -{{ Add example description here }} +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 +### -EnableNetworkNaming -{{ Fill EnableLiveMigrationNetworkSelection Description }} +Indicates whether network naming is enabled for the cluster. When set to +`$true`, this setting allows the cluster to use descriptive network names. ```yaml -Type: System.Boolean +Type: Boolean Parameter Sets: (All) Aliases: @@ -55,12 +59,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNetworkNaming +### -EnableLiveMigrationNetworkSelection -{{ Fill EnableNetworkNaming Description }} +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. ```yaml -Type: System.Boolean +Type: Boolean Parameter Sets: (All) Aliases: @@ -73,10 +79,12 @@ Accept wildcard characters: False ### -EnableVirtualMachineMigrationPerformanceSelection -{{ Fill EnableVirtualMachineMigrationPerformanceSelection Description }} +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. ```yaml -Type: System.Boolean +Type: Boolean Parameter Sets: (All) Aliases: @@ -87,28 +95,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumSMBMigrationBandwidthInGbps +### -VirtualMachineMigrationPerformanceOption -{{ Fill MaximumSMBMigrationBandwidthInGbps Description }} +Specifies the performance option for virtual machine migrations. ```yaml -Type: System.UInt32 +Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -MaximumVirtualMachineMigrations -{{ Fill MaximumVirtualMachineMigrations Description }} +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. ```yaml -Type: System.Byte +Type: Byte Parameter Sets: (All) Aliases: @@ -119,28 +129,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VirtualMachineMigrationPerformanceOption +### -MaximumSMBMigrationBandwidthInGbps -{{ Fill VirtualMachineMigrationPerformanceOption Description }} +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. ```yaml -Type: System.String +Type: UInt32 Parameter Sets: (All) Aliases: Required: False Position: 1 -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -149,3 +162,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [New-NetIntentAdapterPropertyOverrides](New-NetIntentAdapterPropertyOverrides.md) + +- [New-NetIntentAdapterRssOverrides](New-NetIntentAdapterRssOverrides.md) + +- [New-NetIntentGlobalProxyOverrides](New-NetIntentGlobalProxyOverrides.md) + +- [New-NetIntentQoSPolicyOverrides](New-NetIntentQoSPolicyOverrides.md) + +- [New-NetIntentSiteOverrides](New-NetIntentSiteOverrides.md) + +- [New-NetIntentStorageOverrides](New-NetIntentStorageOverrides.md) + +- [New-NetIntentSwitchConfigurationOverrides](New-NetIntentSwitchConfigurationOverrides.md) diff --git a/docset/winserver2025-ps/NetworkATC/New-NetIntentGlobalProxyOverrides.md b/docset/winserver2025-ps/NetworkATC/New-NetIntentGlobalProxyOverrides.md index 9165d866d6..f575b03b60 100644 --- a/docset/winserver2025-ps/NetworkATC/New-NetIntentGlobalProxyOverrides.md +++ b/docset/winserver2025-ps/NetworkATC/New-NetIntentGlobalProxyOverrides.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentglobalproxyoverrides?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetIntentGlobalProxyOverrides @@ -10,7 +10,7 @@ title: New-NetIntentGlobalProxyOverrides # New-NetIntentGlobalProxyOverrides ## SYNOPSIS -{{ Fill in the Synopsis }} +Creates a new instance for global proxy overrides. ## SYNTAX @@ -29,26 +29,33 @@ New-NetIntentGlobalProxyOverrides [-AutoDetect] -AutoConfigUrl [ {{ Add example code here }} +$params = @{ + ProxyServer = "proxy.example.com" + ProxyBypass = "localhost;*.example.com" +} +New-NetIntentGlobalProxyOverrides @params ``` -{{ Add example description here }} +This example sets the proxy server to `proxy.example.com` and specifies that +traffic to `localhost` and any subdomains of `example.com` should bypass the +proxy. ## PARAMETERS ### -AutoConfigUrl -{{ Fill AutoConfigUrl Description }} +Specifies the URL of the automatic configuration script. ```yaml -Type: System.String +Type: String Parameter Sets: AutoDetect Aliases: @@ -61,10 +68,10 @@ Accept wildcard characters: False ### -AutoDetect -{{ Fill AutoDetect Description }} +Configures the system to automatically detect proxy settings. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -77,10 +84,10 @@ Accept wildcard characters: False ### -ProxyBypass -{{ Fill ProxyBypass Description }} +Specifies a list of addresses that should bypass the proxy server. ```yaml -Type: System.String +Type: String Parameter Sets: Default Aliases: @@ -93,10 +100,10 @@ Accept wildcard characters: False ### -ProxyServer -{{ Fill ProxyServer Description }} +Specifies the address of the proxy server. ```yaml -Type: System.String +Type: String Parameter Sets: Default Aliases: @@ -109,10 +116,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -125,3 +133,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [New-NetIntentAdapterPropertyOverrides](New-NetIntentAdapterPropertyOverrides.md) + +- [New-NetIntentAdapterRssOverrides](New-NetIntentAdapterRssOverrides.md) + +- [New-NetIntentGlobalClusterOverrides](New-NetIntentGlobalClusterOverrides.md) + +- [New-NetIntentQoSPolicyOverrides](New-NetIntentQoSPolicyOverrides.md) + +- [New-NetIntentSiteOverrides](New-NetIntentSiteOverrides.md) + +- [New-NetIntentStorageOverrides](New-NetIntentStorageOverrides.md) + +- [New-NetIntentSwitchConfigurationOverrides](New-NetIntentSwitchConfigurationOverrides.md) diff --git a/docset/winserver2025-ps/NetworkATC/New-NetIntentQoSPolicyOverrides.md b/docset/winserver2025-ps/NetworkATC/New-NetIntentQoSPolicyOverrides.md index 550132bb43..f6c7876eeb 100644 --- a/docset/winserver2025-ps/NetworkATC/New-NetIntentQoSPolicyOverrides.md +++ b/docset/winserver2025-ps/NetworkATC/New-NetIntentQoSPolicyOverrides.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentqospolicyoverrides?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetIntentQoSPolicyOverrides @@ -10,9 +10,7 @@ title: New-NetIntentQoSPolicyOverrides # New-NetIntentQoSPolicyOverrides ## SYNOPSIS - -Creates a new instance of **QoSPolicyOverrides** which can be used to supply granular values to -`Set-NetIntent` +Creates a new instance of QoS policy overrides which can be used to supply granular values to `Set-NetIntent`. ## SYNTAX @@ -24,26 +22,31 @@ New-NetIntentQoSPolicyOverrides [-PriorityValue8021Action_SMB ] ## DESCRIPTION -{{ Fill in the Description }} +The `New-NetIntentQoSPolicyOverrides` cmdlet creates a new instance of Quality +of Service (QoS) policy overrides. This cmdlet is used to provide specific +granular values that can be utilized by the `Set-NetIntent` cmdlet to define QoS +policies for network traffic. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +New-NetIntentQoSPolicyOverrides -PriorityValue8021Action_SMB 3 -BandwidthPercentage_SMB 30 ``` -{{ Add example description here }} +This example creates a new QoS policy override setting the 802.1 priority value +for SMB traffic to `3` with `30%` of the available network bandwidth allocated +to SMB traffic. ## PARAMETERS -### -BandwidthPercentage_Cluster +### -PriorityValue8021Action_SMB -{{ Fill BandwidthPercentage_Cluster Description }} +Specifies the 802.1 priority value for SMB traffic. ```yaml -Type: System.Byte +Type: Byte Parameter Sets: (All) Aliases: @@ -54,12 +57,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BandwidthPercentage_SMB +### -PriorityValue8021Action_Cluster -{{ Fill BandwidthPercentage_SMB Description }} +Specifies the 802.1 priority value for Cluster traffic. ```yaml -Type: System.Byte +Type: Byte Parameter Sets: (All) Aliases: @@ -70,12 +73,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetDirectPortMatchCondition +### -BandwidthPercentage_SMB -{{ Fill NetDirectPortMatchCondition Description }} +Specifies the percentage of allocated bandwidth for the SMB traffic. ```yaml -Type: System.Int32 +Type: Byte Parameter Sets: (All) Aliases: @@ -86,12 +89,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PriorityValue8021Action_Cluster +### -BandwidthPercentage_Cluster -{{ Fill PriorityValue8021Action_Cluster Description }} +Specifies the percentage of allocated bandwidth for the Cluster traffic. ```yaml -Type: System.Byte +Type: Byte Parameter Sets: (All) Aliases: @@ -102,12 +105,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PriorityValue8021Action_SMB +### -NetDirectPortMatchCondition -{{ Fill PriorityValue8021Action_SMB Description }} +Specifies the port number used to match NetDirect traffic. ```yaml -Type: System.Byte +Type: Int32 Parameter Sets: (All) Aliases: @@ -120,10 +123,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS diff --git a/docset/winserver2025-ps/NetworkATC/New-NetIntentSiteOverrides.md b/docset/winserver2025-ps/NetworkATC/New-NetIntentSiteOverrides.md index 5d65b25a06..7b41226ba4 100644 --- a/docset/winserver2025-ps/NetworkATC/New-NetIntentSiteOverrides.md +++ b/docset/winserver2025-ps/NetworkATC/New-NetIntentSiteOverrides.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentsiteoverrides?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetIntentSiteOverrides @@ -10,9 +10,7 @@ title: New-NetIntentSiteOverrides # New-NetIntentSiteOverrides ## SYNOPSIS - -Creates a new instance of SiteConfiguration which can be used to supply granular values to -`Set-NetIntent`. +Creates a new instance of site configuration overrides which can be used to supply granular values to `Set-NetIntent`. ## SYNTAX @@ -23,42 +21,46 @@ New-NetIntentSiteOverrides [[-StorageVLAN] ] [[-StretchVLAN] {{ Add example code here }} +New-NetIntentSiteOverrides -Name "MySite" -StorageVLAN 101,102 ``` -{{ Add example description here }} +This example configures a site named `MySite` and sets up VLAN IDs `101` and +`102` for storage traffic. ## PARAMETERS -### -ManagementVLAN +### -StorageVLAN -{{ Fill ManagementVLAN Description }} +Specifies the VLAN IDs used for storage traffic. This parameter accepts an array of VLAN IDs. ```yaml -Type: System.UInt16 +Type: UInt16[] Parameter Sets: (All) Aliases: Required: False Position: 1 -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -StretchVLAN -{{ Fill Name Description }} +Specifies the VLAN IDs used for stretch networking. This parameter accepts an array of VLAN IDs. ```yaml -Type: System.String +Type: UInt16[] Parameter Sets: (All) Aliases: @@ -69,28 +71,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StorageVLAN +### -ManagementVLAN -{{ Fill StorageVLAN Description }} +Specifies the VLAN ID used for network management traffic. This parameter accepts a single VLAN ID. ```yaml -Type: System.UInt16[] +Type: UInt16 Parameter Sets: (All) Aliases: Required: False Position: 1 -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -StretchVLAN +### -Name -{{ Fill StretchVLAN Description }} +Specifies the name of the site configuration. This parameter allows you to +assign a unique name making it easier to reference and manage your network +policies. ```yaml -Type: System.UInt16[] +Type: String Parameter Sets: (All) Aliases: @@ -103,10 +107,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -115,3 +120,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [New-NetIntentAdapterPropertyOverrides](New-NetIntentAdapterPropertyOverrides.md) + +- [New-NetIntentAdapterRssOverrides](New-NetIntentAdapterRssOverrides.md) + +- [New-NetIntentGlobalClusterOverrides](New-NetIntentGlobalClusterOverrides.md) + +- [New-NetIntentGlobalProxyOverrides](New-NetIntentGlobalProxyOverrides.md) + +- [New-NetIntentQoSPolicyOverrides](New-NetIntentQoSPolicyOverrides.md) + +- [New-NetIntentStorageOverrides](New-NetIntentStorageOverrides.md) + +- [New-NetIntentSwitchConfigurationOverrides](New-NetIntentSwitchConfigurationOverrides.md) diff --git a/docset/winserver2025-ps/NetworkATC/New-NetIntentStorageOverrides.md b/docset/winserver2025-ps/NetworkATC/New-NetIntentStorageOverrides.md index 257e0e6862..15c42c2b83 100644 --- a/docset/winserver2025-ps/NetworkATC/New-NetIntentStorageOverrides.md +++ b/docset/winserver2025-ps/NetworkATC/New-NetIntentStorageOverrides.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentstorageoverrides?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetIntentStorageOverrides @@ -10,9 +10,7 @@ title: New-NetIntentStorageOverrides # New-NetIntentStorageOverrides ## SYNOPSIS - -Creates a new instance of **NetAdapterStorageOverride** which can be used to supply granular values -to `Set-NetIntent`. +Creates a new instance of network adapter storage overrides which can be used to supply granular values to `Set-NetIntent`. ## SYNTAX @@ -22,26 +20,30 @@ New-NetIntentStorageOverrides [-EnableAutomaticIPGeneration ] [ {{ Add example code here }} +New-NetIntentStorageOverrides -EnableAutomaticIPGeneration $true ``` -{{ Add example description here }} +This example creates a new storage override with automatic IP generation enabled. ## PARAMETERS ### -EnableAutomaticIPGeneration -{{ Fill EnableAutomaticIPGeneration Description }} +Indicates whether automatic IP generation should be enabled for the network +adapter storage configuration. When set to `$true`, IP addresses will be +automatically generated based on the network settings. ```yaml -Type: System.Boolean +Type: Boolean Parameter Sets: (All) Aliases: @@ -54,10 +56,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -66,3 +69,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [New-NetIntentAdapterPropertyOverrides](New-NetIntentAdapterPropertyOverrides.md) + +- [New-NetIntentAdapterRssOverrides](New-NetIntentAdapterRssOverrides.md) + +- [New-NetIntentGlobalClusterOverrides](New-NetIntentGlobalClusterOverrides.md) + +- [New-NetIntentGlobalProxyOverrides](New-NetIntentGlobalProxyOverrides.md) + +- [New-NetIntentQoSPolicyOverrides](New-NetIntentQoSPolicyOverrides.md) + +- [New-NetIntentSiteOverrides](New-NetIntentSiteOverrides.md) + +- [New-NetIntentSwitchConfigurationOverrides](New-NetIntentSwitchConfigurationOverrides.md) diff --git a/docset/winserver2025-ps/NetworkATC/New-NetIntentSwitchConfigurationOverrides.md b/docset/winserver2025-ps/NetworkATC/New-NetIntentSwitchConfigurationOverrides.md index c854f9d1ed..9213303fdd 100644 --- a/docset/winserver2025-ps/NetworkATC/New-NetIntentSwitchConfigurationOverrides.md +++ b/docset/winserver2025-ps/NetworkATC/New-NetIntentSwitchConfigurationOverrides.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/new-netintentswitchconfigurationoverrides?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetIntentSwitchConfigurationOverrides @@ -10,9 +10,7 @@ title: New-NetIntentSwitchConfigurationOverrides # New-NetIntentSwitchConfigurationOverrides ## SYNOPSIS - -Creates a new instance of **SwitchConfigurationOverride** which can be used to supply granular -values to `Set-NetIntent`. +Creates a new instance of virtual switch configuration overrides which can be used to supply granular values to `Set-NetIntent`. ## SYNTAX @@ -25,42 +23,54 @@ New-NetIntentSwitchConfigurationOverrides [-EnableSoftwareRsc ] ## DESCRIPTION -{{ Fill in the Description }} +The `New-NetIntentSwitchConfigurationOverrides` cmdlet creates a new instance of +a virtual switch configuration override that allows you to provide specific +configuration values for network intent settings. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +$params = @{ + DefaultQueueVrssMaxQueuePairs = 16 + EnableSoftwareRsc = $true + EnableIov = $false +} +New-NetIntentSwitchConfigurationOverrides @params ``` -{{ Add example description here }} +This example creates a new switch configuration override with the maximum number +of Vrss queue pairs to `16` while enabling Software RSC and disabling IOV. ## PARAMETERS -### -DefaultQueueVrssMaxQueuePairs +### -EnableSoftwareRsc -{{ Fill DefaultQueueVrssMaxQueuePairs Description }} +Indicates whether Software Receive Side Coalescing (RSC) is enabled. When +enabled, this feature can improve network performance by reducing the CPU load +associated with processing received packets. ```yaml -Type: System.UInt32 +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultQueueVrssMinQueuePairs +### -DefaultQueueVrssMaxQueuePairs -{{ Fill DefaultQueueVrssMinQueuePairs Description }} +Specifies the maximum number of Virtual RSS (Vrss) queue pairs to be used by +default. This parameter can help optimize network performance by balancing the +load across multiple CPU cores. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -71,12 +81,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultQueueVrssQueueSchedulingMode +### -DefaultQueueVrssMinQueuePairs -{{ Fill DefaultQueueVrssQueueSchedulingMode Description }} +Specifies the minimum number of Virtual RSS (Vrss) queue pairs to be used by +default. Setting this can ensure a minimum level of resource allocation for +network traffic processing. ```yaml -Type: System.UInt32 +Type: UInt32 Parameter Sets: (All) Aliases: @@ -87,28 +99,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableEmbeddedTeaming +### -DefaultQueueVrssQueueSchedulingMode -{{ Fill EnableEmbeddedTeaming Description }} +Defines the scheduling mode for Virtual RSS (Vrss) queues. This parameter can be +used to configure how Virtual RSS queues are scheduled for processing network +traffic. ```yaml -Type: System.Boolean +Type: UInt32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableIov -{{ Fill EnableIov Description }} +Indicates whether Input-Output Virtualization (IOV) is enabled. IOV allows VMs +to have direct access to hardware I/O resources, potentially improving +performance. ```yaml -Type: System.Boolean +Type: Boolean Parameter Sets: (All) Aliases: @@ -119,12 +135,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSoftwareRsc +### -EnableEmbeddedTeaming -{{ Fill EnableSoftwareRsc Description }} +Specifies whether Embedded Teaming is enabled. Embedded Teaming allows multiple +network adapters to be grouped together for redundancy and load balancing. ```yaml -Type: System.Boolean +Type: Boolean Parameter Sets: (All) Aliases: @@ -137,10 +154,12 @@ Accept wildcard characters: False ### -LoadBalancingAlgorithm -{{ Fill LoadBalancingAlgorithm Description }} +Determines the load balancing algorithm used for distributing network traffic. +This parameter can be used to select a specific algorithm that best suits the +network environment. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -153,7 +172,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -162,3 +185,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [New-NetIntentAdapterPropertyOverrides](New-NetIntentAdapterPropertyOverrides.md) + +- [New-NetIntentAdapterRssOverrides](New-NetIntentAdapterRssOverrides.md) + +- [New-NetIntentGlobalClusterOverrides](New-NetIntentGlobalClusterOverrides.md) + +- [New-NetIntentGlobalProxyOverrides](New-NetIntentGlobalProxyOverrides.md) + +- [New-NetIntentQoSPolicyOverrides](New-NetIntentQoSPolicyOverrides.md) + +- [New-NetIntentSiteOverrides](New-NetIntentSiteOverrides.md) + +- [New-NetIntentStorageOverrides](New-NetIntentStorageOverrides.md) diff --git a/docset/winserver2025-ps/NetworkATC/Remove-NetIntent.md b/docset/winserver2025-ps/NetworkATC/Remove-NetIntent.md index a5433e463d..af14864662 100644 --- a/docset/winserver2025-ps/NetworkATC/Remove-NetIntent.md +++ b/docset/winserver2025-ps/NetworkATC/Remove-NetIntent.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/remove-netintent?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-NetIntent @@ -10,8 +10,7 @@ title: Remove-NetIntent # Remove-NetIntent ## SYNOPSIS - -Removes the requested net intent. +Removes the requested network intent. ## SYNTAX @@ -37,37 +36,40 @@ Remove-NetIntent [-GlobalOverrides] [-SkipServiceStop ] [ {{ Add example code here }} +Remove-NetIntent -Name "MyIntent" -ComputerName "Server01" ``` -{{ Add example description here }} +This example removes the network intent named `MyIntent` from the standalone computer `Server01`. ## PARAMETERS -### -ClusterName +### -Name -{{ Fill ClusterName Description }} +Specifies the name of the network intent to be removed. ```yaml -Type: System.String -Parameter Sets: Cluster +Type: String +Parameter Sets: ComputerName, Cluster Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -75,10 +77,10 @@ Accept wildcard characters: False ### -ComputerName -{{ Fill ComputerName Description }} +Specifies the name of the computer from which the network intent should be removed. ```yaml -Type: System.String +Type: String Parameter Sets: ComputerName Aliases: @@ -89,44 +91,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalOverrides +### -ClusterName -{{ Fill GlobalOverrides Description }} +Specifies the name of the cluster from which the network intent should be +removed. The removal will affect all nodes in the specified cluster. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Global +Type: String +Parameter Sets: Cluster Aliases: -Required: False +Required: True Position: 2 -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -GlobalOverrides -{{ Fill Name Description }} +Indicates that global overrides should be removed. This affects all +configurations using these global overrides. ```yaml -Type: System.String -Parameter Sets: ComputerName, Cluster +Type: SwitchParameter +Parameter Sets: Global Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: 2 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -SkipServiceStop -{{ Fill SkipServiceStop Description }} +Specifies whether to skip stopping the service during the removal process. If +set to `$true`, the service will not be stopped. ```yaml -Type: System.Boolean +Type: Boolean Parameter Sets: (All) Aliases: @@ -139,10 +144,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -151,3 +157,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Add-NetIntent](Add-NetIntent.md) + +- [Copy-NetIntent](Copy-NetIntent.md) + +- [Get-NetIntent](Get-NetIntent.md) + +- [Get-NetIntentStatus](Get-NetIntentStatus.md) + +- [Set-NetIntent](Set-NetIntent.md) diff --git a/docset/winserver2025-ps/NetworkATC/Set-NetIntent.md b/docset/winserver2025-ps/NetworkATC/Set-NetIntent.md index 778facb8d5..65ee998017 100644 --- a/docset/winserver2025-ps/NetworkATC/Set-NetIntent.md +++ b/docset/winserver2025-ps/NetworkATC/Set-NetIntent.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/set-netintent?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-NetIntent @@ -10,7 +10,7 @@ title: Set-NetIntent # Set-NetIntent ## SYNOPSIS -Allows provisioning of override values for given intents +Allows provisioning of override values for the given network intent. ## SYNTAX @@ -44,48 +44,65 @@ Set-NetIntent [[-ComputerName] ] [[-ClusterName] ] ## DESCRIPTION -All properties inside the override objects are nullable. Only the properties which are not set will -be applied +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 ```powershell -PS C:\> {{ Add example code here }} +$adapterOverrides = @{ + JumboPacket = 9000 + InterruptModeration = "Enabled" +} +$qosOverrides = @{ + Name = "HighPriority" + Priority = 1 + BandwidthPercentage = 50 +} +$params = @{ + Name = "MyIntent" + ComputerName = "Server01" + AdapterPropertyOverrides = $adapterOverrides + QoSPolicyOverrides = $qosOverrides +} +Set-NetIntent @params ``` -{{ Add example description here }} +This example sets the network intent named `MyIntent` on the computer `Server01` +with specified adapter property overrides and QoS policy overrides. ## PARAMETERS -### -AdapterPropertyOverrides +### -Name -{{ Fill AdapterPropertyOverrides Description }} +Specifies the name of the network intent to be set. ```yaml -Type: FabricManager.NetAdapterAdvancedConfiguration +Type: String Parameter Sets: ComputerName, Cluster Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AdapterRssOverrides +### -ComputerName -{{ Fill AdapterRssOverrides Description }} +Specifies the name of the computer on which the network intent should be set. ```yaml -Type: FabricManager.RssConfiguration -Parameter Sets: ComputerName, Cluster +Type: String +Parameter Sets: ComputerName, Global Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -93,10 +110,10 @@ Accept wildcard characters: False ### -ClusterName -{{ Fill ClusterName Description }} +Specifies the name of the cluster on which the network intent should be set. ```yaml -Type: System.String +Type: String Parameter Sets: Cluster Aliases: @@ -108,7 +125,7 @@ Accept wildcard characters: False ``` ```yaml -Type: System.String +Type: String Parameter Sets: Global Aliases: @@ -119,29 +136,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName +### -AdapterPropertyOverrides -{{ Fill ComputerName Description }} +Specifies the overrides for network adapter properties. ```yaml -Type: System.String -Parameter Sets: ComputerName, Global +Type: NetAdapterAdvancedConfiguration +Parameter Sets: ComputerName, Cluster Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalClusterOverrides +### -QoSPolicyOverrides -{{ Fill GlobalClusterOverrides Description }} +Specifies the overrides for Quality of Service (QoS) policies. ```yaml -Type: FabricManager.ClusterSettings -Parameter Sets: Global +Type: QoSPolicy +Parameter Sets: ComputerName, Cluster Aliases: Required: False @@ -151,13 +168,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalProxyOverrides +### -AdapterRssOverrides -{{ Fill GlobalProxyOverrides Description }} +Specifies the overrides for Receive Side Scaling (RSS) configuration on network adapters. ```yaml -Type: FabricManager.WinHttpAdvProxy -Parameter Sets: Global +Type: RssConfiguration +Parameter Sets: ComputerName, Cluster Aliases: Required: False @@ -167,44 +184,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagementVlan +### -SwitchOverrides -{{ Fill ManagementVlan Description }} +Specifies the overrides for network switch configuration. ```yaml -Type: System.Int32 +Type: SwitchConfigurationOverride Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: -1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -StorageOverrides -{{ Fill Name Description }} +Specifies the overrides for storage-related network adapter properties. ```yaml -Type: System.String +Type: NetAdapterStorageOverride Parameter Sets: ComputerName, Cluster Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -QoSPolicyOverrides +### -SiteOverrides -{{ Fill QoSPolicyOverrides Description }} +Specifies the overrides for site configuration. ```yaml -Type: FabricManager.QoSPolicy +Type: SiteConfiguration[] Parameter Sets: ComputerName, Cluster Aliases: @@ -215,12 +232,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteOverrides +### -StorageVlans -{{ Fill SiteOverrides Description }} +Specifies the VLANs for storage networks. ```yaml -Type: FabricManager.SiteConfiguration[] +Type: Int32[] Parameter Sets: ComputerName, Cluster Aliases: @@ -231,29 +248,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StorageOverrides +### -ManagementVlan -{{ Fill StorageOverrides Description }} +Specifies the VLAN for management traffic. ```yaml -Type: FabricManager.NetAdapterStorageOverride +Type: Int32 Parameter Sets: ComputerName, Cluster Aliases: Required: False Position: Named -Default value: None +Default value: -1 Accept pipeline input: False Accept wildcard characters: False ``` -### -StorageVlans +### -GlobalProxyOverrides -{{ Fill StorageVlans Description }} +Specifies the global overrides for proxy settings. ```yaml -Type: System.Int32[] -Parameter Sets: ComputerName, Cluster +Type: WinHttpAdvProxy +Parameter Sets: Global Aliases: Required: False @@ -263,13 +280,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SwitchOverrides +### -GlobalClusterOverrides -{{ Fill SwitchOverrides Description }} +Specifies the global overrides for cluster settings. ```yaml -Type: FabricManager.SwitchConfigurationOverride -Parameter Sets: ComputerName, Cluster +Type: ClusterSettings +Parameter Sets: Global Aliases: Required: False @@ -281,10 +298,11 @@ Accept wildcard characters: False ### -Wait -{{ Fill Wait Description }} +Indicates that the cmdlet should wait for the operation to complete before +returning control to the command line. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -297,10 +315,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -308,11 +327,21 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -Once the request has been successfully placed, all services will eventually detect and apply the -updated override policies. Use `Get-NetIntentStatus` to see if the current status. It may take -several minutes for policy application. +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 update policy application, use the `Set-NetIntentRetryState` to put a given policy in a -retry pending state in which case the policy will be forcefully applied. +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. ## RELATED LINKS + +- [Add-NetIntent](Add-NetIntent.md) + +- [Copy-NetIntent](Copy-NetIntent.md) + +- [Get-NetIntent](Get-NetIntent.md) + +- [Get-NetIntentStatus](Get-NetIntentStatus.md) + +- [Remove-NetIntent](Remove-NetIntent.md) diff --git a/docset/winserver2025-ps/NetworkATC/Set-NetIntentRetryState.md b/docset/winserver2025-ps/NetworkATC/Set-NetIntentRetryState.md index 513c53c33f..f5af03c024 100644 --- a/docset/winserver2025-ps/NetworkATC/Set-NetIntentRetryState.md +++ b/docset/winserver2025-ps/NetworkATC/Set-NetIntentRetryState.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/set-netintentretrystate?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-NetIntentRetryState @@ -10,7 +10,7 @@ title: Set-NetIntentRetryState # Set-NetIntentRetryState ## SYNOPSIS -Changes the provisioning state of the goal state for an intent on a given host. +Changes the provisioning state of the goal state for the network intent on a given host. ## SYNTAX @@ -23,38 +23,42 @@ Set-NetIntentRetryState [-ComputerName ] -Name [-Wait] [] [-ComputerName ] [-NodeName ] [-Wait] - [-GlobalOverrides] [] +Set-NetIntentRetryState [-ClusterName ] [-ComputerName ] [-NodeName ] + [-Wait] [-GlobalOverrides] [] ``` ### Cluster ``` -Set-NetIntentRetryState [-ClusterName ] -Name -NodeName [-Wait] [] +Set-NetIntentRetryState [-ClusterName ] -Name -NodeName [-Wait] + [] ``` ## DESCRIPTION -Use this to reset failed provisioning. The state of the request is reset to `RetryRequired`. +The `Set-NetIntentRetryState` cmdlet changes the provisioning state of the goal +state for a network intent on a given host. This is useful for resetting failed +provisioning attempts, as it resets the **RetryRequired** state. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Set-NetIntentRetryState -ComputerName "Server01" -Name "MyIntent" -Wait ``` -{{ Add example description here }} +This example resets the provisioning state for the network intent named +`MyIntent` on the computer `Server01` and waits for the operation to complete. ## PARAMETERS ### -ClusterName -{{ Fill ClusterName Description }} +Specifies the name of the cluster. ```yaml -Type: System.String +Type: String Parameter Sets: Global, Cluster Aliases: @@ -67,10 +71,10 @@ Accept wildcard characters: False ### -ComputerName -{{ Fill ComputerName Description }} +Specifies the name of the computer. ```yaml -Type: System.String +Type: String Parameter Sets: ComputerName, Global Aliases: @@ -81,28 +85,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalOverrides - -{{ Fill GlobalOverrides Description }} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Global -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name -{{ Fill Name Description }} +Specifies the name of the network intent to be reset. ```yaml -Type: System.String +Type: String Parameter Sets: ComputerName, Cluster Aliases: @@ -115,10 +103,10 @@ Accept wildcard characters: False ### -NodeName -{{ Fill NodeName Description }} +Specifies the name of the node within the cluster. ```yaml -Type: System.String +Type: String Parameter Sets: Global Aliases: @@ -130,7 +118,7 @@ Accept wildcard characters: False ``` ```yaml -Type: System.String +Type: String Parameter Sets: Cluster Aliases: @@ -143,10 +131,11 @@ Accept wildcard characters: False ### -Wait -{{ Fill Wait Description }} +Indicates that the cmdlet should wait for the operation to complete before +returning control to the command line. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -157,12 +146,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -GlobalOverrides + +Indicates the global overrides that should be applied when resetting the provisioning state. + +```yaml +Type: SwitchParameter +Parameter Sets: Global +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS diff --git a/docset/winserver2025-ps/NetworkATC/Set-NetIntentTracing.md b/docset/winserver2025-ps/NetworkATC/Set-NetIntentTracing.md index c0f5954e70..66c311a3aa 100644 --- a/docset/winserver2025-ps/NetworkATC/Set-NetIntentTracing.md +++ b/docset/winserver2025-ps/NetworkATC/Set-NetIntentTracing.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/set-netintenttracing?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-NetIntentTracing @@ -10,7 +10,7 @@ title: Set-NetIntentTracing # Set-NetIntentTracing ## SYNOPSIS -Starts and stops Atc tracing sessions on the host +Starts or stops ATC tracing sessions on the host. ## SYNTAX @@ -20,54 +20,70 @@ Set-NetIntentTracing [-StopTracing] [[-ComputerName] ] ## DESCRIPTION -{{ Fill in the Description }} +The `Set-NetIntentTracing` cmdlet starts or stops ATC tracing sessions on the +specified host. Tracing sessions are useful for diagnosing issues related to +network intents by capturing relevant data. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Set-NetIntentTracing -ComputerName "Server01" +``` + +This example starts an ATC tracing session on the computer named `Server01`. + +### Example 2 + +```powershell +Set-NetIntentTracing -StopTracing -ComputerName "Server01" ``` -{{ Add example description here }} +This example stops an ATC tracing session on the computer named `Server01`. ## PARAMETERS -### -ComputerName +### -StopTracing -{{ Fill ComputerName Description }} +Indicates that the cmdlet should stop the tracing session instead of starting it. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 1 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -StopTracing +### -ComputerName -{{ Fill StopTracing Description }} +Specifies the name of the computer on which to start or stop the tracing +session. If this parameter is not specified, the cmdlet operates on the local +computer. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ## INPUTS +### [switch] $StopTracing, switch to stop tracing + +### [string] $ComputerName, target computer name + ## OUTPUTS ## NOTES diff --git a/docset/winserver2025-ps/NetworkATC/Start-NetworkAtc.md b/docset/winserver2025-ps/NetworkATC/Start-NetworkAtc.md index 7107da2a3f..fb83daa84c 100644 --- a/docset/winserver2025-ps/NetworkATC/Start-NetworkAtc.md +++ b/docset/winserver2025-ps/NetworkATC/Start-NetworkAtc.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/start-networkatc?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Start-NetworkAtc @@ -10,7 +10,7 @@ title: Start-NetworkAtc # Start-NetworkAtc ## SYNOPSIS -Starts the Atc Service on all hosts for a cluster or a given single node. +Starts the Network ATC service on specified hosts. ## SYNTAX @@ -28,46 +28,47 @@ Start-NetworkAtc [-ClusterName] [] ## DESCRIPTION -Starts the Atc Service on all hosts for a cluster or a given single node. +The `Start-NetworkATC` cmdlet starts the ATC service on all hosts for a cluster +or a given single node. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Start-NetworkAtc -ComputerName "Server01" ``` -{{ Add example description here }} +This example starts the Network ATC service on the host specified by the computer name `Server01`. ## PARAMETERS -### -ClusterName +### -ComputerName -{{ Fill ClusterName Description }} +Specifies the name of the computer on which to start the Network ATC service. ```yaml -Type: System.String -Parameter Sets: Cluster +Type: String +Parameter Sets: ComputerName Aliases: -Required: True +Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName +### -ClusterName -{{ Fill ComputerName Description }} +Specifies the name of the cluster on which to start the Network ATC service on all hosts. ```yaml -Type: System.String -Parameter Sets: ComputerName +Type: String +Parameter Sets: Cluster Aliases: -Required: False +Required: True Position: 1 Default value: None Accept pipeline input: False @@ -76,10 +77,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -88,3 +90,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Stop-NetworkAtc](Stop-NetworkAtc.md) diff --git a/docset/winserver2025-ps/NetworkATC/Stop-NetworkAtc.md b/docset/winserver2025-ps/NetworkATC/Stop-NetworkAtc.md index be6954835d..f00da5f8bf 100644 --- a/docset/winserver2025-ps/NetworkATC/Stop-NetworkAtc.md +++ b/docset/winserver2025-ps/NetworkATC/Stop-NetworkAtc.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/stop-networkatc?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Stop-NetworkAtc @@ -10,7 +10,7 @@ title: Stop-NetworkAtc # Stop-NetworkAtc ## SYNOPSIS -Stops the Atc Service on all hosts for a cluster or a given single node. +Stops the Network ATC service on specified hosts. ## SYNTAX @@ -28,46 +28,47 @@ Stop-NetworkAtc [-ClusterName] [] ## DESCRIPTION -Stops the Atc Service on all hosts for a cluster or a given single node. +The `Stop-NetworkATC` cmdlet stops the ATC service on all hosts for a cluster +or a given single node. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Stop-NetworkAtc -ComputerName "Server01" ``` -{{ Add example description here }} +This example stops the Network ATC service on the host specified by the computer name `Server01`. ## PARAMETERS -### -ClusterName +### -ComputerName -{{ Fill ClusterName Description }} +Specifies the name of the computer on which to stop the Network ATC service. ```yaml -Type: System.String -Parameter Sets: Cluster +Type: String +Parameter Sets: ComputerName Aliases: -Required: True +Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName +### -ClusterName -{{ Fill ComputerName Description }} +Specifies the name of the cluster on which to stop the Network ATC service on all hosts. ```yaml -Type: System.String -Parameter Sets: ComputerName +Type: String +Parameter Sets: Cluster Aliases: -Required: False +Required: True Position: 1 Default value: None Accept pipeline input: False @@ -76,10 +77,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -88,3 +90,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Start-NetworkAtc](Start-NetworkAtc.md) diff --git a/docset/winserver2025-ps/NetworkATC/Update-NetIntentAdapter.md b/docset/winserver2025-ps/NetworkATC/Update-NetIntentAdapter.md index ed01308c8c..31c6ca9714 100644 --- a/docset/winserver2025-ps/NetworkATC/Update-NetIntentAdapter.md +++ b/docset/winserver2025-ps/NetworkATC/Update-NetIntentAdapter.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/update-netintentadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Update-NetIntentAdapter @@ -10,37 +10,40 @@ title: Update-NetIntentAdapter # Update-NetIntentAdapter ## SYNOPSIS -{{ Fill in the Synopsis }} +Updates the network intent configuration for specified network adapters. ## SYNTAX ``` -Update-NetIntentAdapter [-AdapterName] [[-ClusterName] ] [[-ComputerName] ] - [-Name] [-Wait] [] +Update-NetIntentAdapter [-AdapterName] [[-ClusterName] ] + [[-ComputerName] ] [-Name] [-Wait] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +The `Update-NetIntentAdapter` cmdlet updates the configuration of network +adapters to align with the specified network intent. It can be used on +individual computers or across clusters. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Update-NetIntentAdapter -AdapterName "Ethernet1" -Name "MyIntent" -ComputerName "Server01" ``` -{{ Add example description here }} +This example updates the configuration of the adapter named `Ethernet1` on the +computer `Server01` to match the network intent named `MyIntent`. ## PARAMETERS ### -AdapterName -{{ Fill AdapterName Description }} +Specifies the network adapter(s) to be updated. This parameter accepts an array of adapter names. ```yaml -Type: System.String[] +Type: String[] Parameter Sets: (All) Aliases: @@ -53,10 +56,11 @@ Accept wildcard characters: False ### -ClusterName -{{ Fill ClusterName Description }} +Specifies the name of the cluster on which to update the network intent +configuration across all nodes. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -69,10 +73,11 @@ Accept wildcard characters: False ### -ComputerName -{{ Fill ComputerName Description }} +Specifies the name of the computer on which to update the network intent +configuration for the specified adapter(s). ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -85,10 +90,10 @@ Accept wildcard characters: False ### -Name -{{ Fill Name Description }} +Specifies the name of the network intent to be applied to the adapter(s). ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -101,10 +106,11 @@ Accept wildcard characters: False ### -Wait -{{ Fill Wait Description }} +Indicates that the cmdlet waits for the operation to complete before returning +control to the command line. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -117,10 +123,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -133,3 +140,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Update-NetIntentType](Update-NetIntentType.md) + +- [Update-NetworkATC](Update-NetworkATC.md) diff --git a/docset/winserver2025-ps/NetworkATC/Update-NetIntentType.md b/docset/winserver2025-ps/NetworkATC/Update-NetIntentType.md index 9b41f9e3c6..8ca5ed5d3c 100644 --- a/docset/winserver2025-ps/NetworkATC/Update-NetIntentType.md +++ b/docset/winserver2025-ps/NetworkATC/Update-NetIntentType.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/update-netintenttype?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Update-NetIntentType @@ -10,8 +10,7 @@ title: Update-NetIntentType # Update-NetIntentType ## SYNOPSIS - -{{ Fill in the Synopsis }} +Updates the configuration types of network intents for specified computers or clusters. ## SYNTAX @@ -31,26 +30,30 @@ Update-NetIntentType [-Name] [-ClusterName] [-Wait] [-Compute] ## DESCRIPTION -{{ Fill in the Description }} +The `Update-NetIntentType` cmdlet updates the configuration types (such as +Compute, Management, Storage, and Stretch) for a specified network intent across +individual computers or an entire cluster. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Update-NetIntentType -Name "MyIntent" -ComputerName "Server01" -Compute -Wait ``` -{{ Add example description here }} +This example updates the network intent named `MyIntent` on the computer +`Server01` to include the **Compute** configuration type and waits for the operation +to complete before returning control. ## PARAMETERS ### -ClusterName -{{ Fill ClusterName Description }} +Specifies the name of the cluster on which to update the network intent types across all nodes. ```yaml -Type: System.String +Type: String Parameter Sets: Cluster Aliases: @@ -63,10 +66,10 @@ Accept wildcard characters: False ### -Compute -{{ Fill Compute Description }} +Indicates that the Compute configuration type should be included in the update. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -79,10 +82,10 @@ Accept wildcard characters: False ### -ComputerName -{{ Fill ComputerName Description }} +Specifies the name of the computer on which to update the network intent types. ```yaml -Type: System.String +Type: String Parameter Sets: ComputerName Aliases: @@ -95,10 +98,10 @@ Accept wildcard characters: False ### -Management -{{ Fill Management Description }} +Indicates that the Management configuration type should be included in the update. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -111,10 +114,10 @@ Accept wildcard characters: False ### -Name -{{ Fill Name Description }} +Specifies the name of the network intent to be updated. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: @@ -127,10 +130,10 @@ Accept wildcard characters: False ### -Storage -{{ Fill Storage Description }} +Indicates that the Storage configuration type should be included in the update. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -143,10 +146,10 @@ Accept wildcard characters: False ### -Stretch -{{ Fill Stretch Description }} +Indicates that the Stretch configuration type should be included in the update. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -159,10 +162,11 @@ Accept wildcard characters: False ### -Wait -{{ Fill Wait Description }} +Indicates that the cmdlet waits for the operation to complete before returning +control to the command line. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -175,10 +179,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -191,3 +196,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Update-NetIntentAdapter](Update-NetIntentAdapter.md) + +- [Update-NetworkATC](Update-NetworkATC.md) diff --git a/docset/winserver2025-ps/NetworkATC/Update-NetworkATC.md b/docset/winserver2025-ps/NetworkATC/Update-NetworkATC.md index 56e8770f7e..be03235a20 100644 --- a/docset/winserver2025-ps/NetworkATC/Update-NetworkATC.md +++ b/docset/winserver2025-ps/NetworkATC/Update-NetworkATC.md @@ -1,7 +1,7 @@ ---- +--- external help file: NetworkAtc-help.xml Module Name: NetworkATC -ms.date: 02/21/2024 +ms.date: 03/14/2025 online version: https://learn.microsoft.com/powershell/module/networkatc/update-networkatc?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Update-NetworkATC @@ -10,7 +10,7 @@ title: Update-NetworkATC # Update-NetworkATC ## SYNOPSIS -{{ Fill in the Synopsis }} +Updates the Network ATC configuration settings. ## SYNTAX @@ -21,26 +21,30 @@ Update-NetworkATC [[-DriftTimerInMinutes] ] [[-ConfigurationChangeInSecon ## DESCRIPTION -{{ Fill in the Description }} +The `Update-NetworkATC` cmdlet updates the global configuration settings for +Network ATC, such as the drift detection timer and the configuration change +detection interval. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +Update-NetworkATC -DriftTimerInMinutes 10 -ConfigurationChangeInSeconds 30 ``` -{{ Add example description here }} +This example updates the Network ATC configuration to set the drift detection +timer to `10` minutes and the configuration change detection interval to `30` +seconds. ## PARAMETERS ### -ConfigurationChangeInSeconds -{{ Fill ConfigurationChangeInSeconds Description }} +Specifies the interval, in seconds, for detecting changes in network configuration. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -53,10 +57,10 @@ Accept wildcard characters: False ### -DriftTimerInMinutes -{{ Fill DriftTimerInMinutes Description }} +Specifies the timer, in minutes, for detecting drift in network configuration settings. ```yaml -Type: System.Int32 +Type: Int32 Parameter Sets: (All) Aliases: @@ -69,10 +73,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, +-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, +-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -85,3 +90,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +- [Update-NetIntentAdapter](Update-NetIntentAdapter.md) + +- [Update-NetIntentType](Update-NetIntentType.md) From 9148d3c30d777fb1110a96c9dc756da94fdbb773 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Thu, 20 Mar 2025 10:57:46 -0400 Subject: [PATCH 2/2] Applied PM/Dev feedback --- docset/winserver2025-ps/NetworkATC/Add-NetIntent.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docset/winserver2025-ps/NetworkATC/Add-NetIntent.md b/docset/winserver2025-ps/NetworkATC/Add-NetIntent.md index a688481713..534c8de016 100644 --- a/docset/winserver2025-ps/NetworkATC/Add-NetIntent.md +++ b/docset/winserver2025-ps/NetworkATC/Add-NetIntent.md @@ -74,13 +74,11 @@ For clustering, intents are supported per cluster or as a standalone host. - `Management` - `Storage` - `Stretch` + - `Switchless` -Once an intent is created, it may not be modified. The only way to override is -to do a cleanup using `Clear-NetIntent` and then applying `Add-NetIntent` again. -However, configuration changes like providing override for defaults are -possible. This can be achieved by applying the override cmdlets. These can also -be supplied when running `Add-NetIntent` and can also be applied post facto -using `Add-NetIntentOverride`. +Configuration changes like providing override for defaults are possible. These +override objects can be supplied when running `Add-NetIntent` and can also be +applied post facto using `Set-NetIntent`. If `$ComputerName` and `$ClusterName` are null, clustered hosts will use the name of their cluster for `$Clustername` and standalone hosts will use their own