From 8d78c8d1fa9cb7389f4cf579dae6548f6a6142e7 Mon Sep 17 00:00:00 2001 From: Borislav Velkov Date: Fri, 27 Sep 2019 14:37:00 +0300 Subject: [PATCH 1/6] Add Parameter description in 2016 version Added description for all parameters in 2016 version and fixed few missing in 2012 R2 version. --- .../remove-clustervmmonitoreditem.md | 22 +++++++++++-------- .../Remove-ClusterVMMonitoredItem.md | 8 ++++--- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/docset/windows/failoverclusters/remove-clustervmmonitoreditem.md b/docset/windows/failoverclusters/remove-clustervmmonitoreditem.md index ae2889da6e..774baea15d 100644 --- a/docset/windows/failoverclusters/remove-clustervmmonitoreditem.md +++ b/docset/windows/failoverclusters/remove-clustervmmonitoreditem.md @@ -62,7 +62,8 @@ This example removes monitoring on the print spooler service on the virtual mach ## PARAMETERS ### -Cluster - +Specifies the name of the cluster on which to run this cmdlet. +If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. ```yaml Type: String @@ -77,7 +78,7 @@ Accept wildcard characters: False ``` ### -EventId - +Specifies the event identifier (ID) of the Event Tracing for Windows (ETW) event to be removed from monitoring. ```yaml Type: Int32 @@ -92,7 +93,7 @@ Accept wildcard characters: False ``` ### -EventLog - +Specifies the event log of the event to be removed from monitoring. ```yaml Type: String @@ -107,7 +108,7 @@ Accept wildcard characters: False ``` ### -EventSource - +Specifies the event source of the event to be removed from monitoring. ```yaml Type: String @@ -122,7 +123,7 @@ Accept wildcard characters: False ``` ### -InputObject - +Specifies the cluster on which to run the cmdlet, the clustered virtual machine from which to remove monitoring, or the clustered virtual machine monitored item object to stop monitoring ```yaml Type: PSObject @@ -137,7 +138,7 @@ Accept wildcard characters: False ``` ### -Service - +Specifies the name of the service to be removed from monitoring. ```yaml Type: StringCollection @@ -152,7 +153,7 @@ Accept wildcard characters: False ``` ### -VMId - +Specifies the virtual machine identifier (ID). ```yaml Type: Guid @@ -167,7 +168,8 @@ Accept wildcard characters: False ``` ### -VirtualMachine - +Specifies the name of the clustered virtual machine from which to remove monitoring. +When this parameter is specified, this cmdlet must be run on one of the host cluster nodes, or else the **Cluster** parameter must also be specified. ```yaml Type: String @@ -182,7 +184,9 @@ Accept wildcard characters: False ``` ### -Wait - +Specifies the time in seconds to wait for the cmdlet. +If the *Wait* parameter is not specified, then the cmdlet waits for completion. +If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. ```yaml Type: Int32 diff --git a/docset/winserver2012r2-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md b/docset/winserver2012r2-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md index 28c722b66e..a7289ea2ae 100644 --- a/docset/winserver2012r2-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md +++ b/docset/winserver2012r2-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md @@ -152,7 +152,7 @@ Accept wildcard characters: False ``` ### -VMId -{{Fill VMId Description}} +Specifies the virtual machine identifier (ID). ```yaml Type: Guid @@ -183,7 +183,9 @@ Accept wildcard characters: False ``` ### -Wait -{{Fill Wait Description}} +Specifies the time in seconds to wait for the cmdlet. +If the *Wait* parameter is not specified, then the cmdlet waits for completion. +If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. ```yaml Type: Int32 @@ -198,7 +200,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS From 50b1794d7d3ddfc21edffe6c5a21c903294bb930 Mon Sep 17 00:00:00 2001 From: Borislav Velkov Date: Fri, 27 Sep 2019 19:06:22 +0300 Subject: [PATCH 2/6] Add parameter description --- .../failoverclusters/get-clustervmmonitoreditem.md | 9 ++++++--- .../failoverclusters/Get-ClusterVMMonitoredItem.md | 8 +++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docset/windows/failoverclusters/get-clustervmmonitoreditem.md b/docset/windows/failoverclusters/get-clustervmmonitoreditem.md index bc328538db..2ce584f376 100644 --- a/docset/windows/failoverclusters/get-clustervmmonitoreditem.md +++ b/docset/windows/failoverclusters/get-clustervmmonitoreditem.md @@ -93,7 +93,7 @@ Accept wildcard characters: False ``` ### -VMId - +Specifies the virtual machine identifier (ID). ```yaml Type: Guid @@ -108,7 +108,8 @@ Accept wildcard characters: False ``` ### -VirtualMachine - +Specifies the name of the clustered virtual machine on which to perform monitoring. +When this parameter is specified, the cmdlet must be run on one of the host cluster nodes, or else the **Cluster** parameter must also be specified. ```yaml Type: String @@ -123,7 +124,9 @@ Accept wildcard characters: False ``` ### -Wait - +Specifies the time in seconds to wait for the cmdlet. +If the *Wait* parameter is not specified, then the cmdlet waits for completion. +If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. ```yaml Type: Int32 diff --git a/docset/winserver2012r2-ps/failoverclusters/Get-ClusterVMMonitoredItem.md b/docset/winserver2012r2-ps/failoverclusters/Get-ClusterVMMonitoredItem.md index ca9b49cac3..07703637cc 100644 --- a/docset/winserver2012r2-ps/failoverclusters/Get-ClusterVMMonitoredItem.md +++ b/docset/winserver2012r2-ps/failoverclusters/Get-ClusterVMMonitoredItem.md @@ -92,7 +92,7 @@ Accept wildcard characters: False ``` ### -VMId -{{Fill VMId Description}} +Specifies the virtual machine identifier (ID). ```yaml Type: Guid @@ -123,7 +123,9 @@ Accept wildcard characters: False ``` ### -Wait -{{Fill Wait Description}} +Specifies the time in seconds to wait for the cmdlet. +If the *Wait* parameter is not specified, then the cmdlet waits for completion. +If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. ```yaml Type: Int32 @@ -138,7 +140,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS From be7e5e498933550a77a9c1fc2fa87cd947bb5828 Mon Sep 17 00:00:00 2001 From: Borislav Velkov Date: Fri, 27 Sep 2019 19:36:10 +0300 Subject: [PATCH 3/6] Add parameter description. --- .../failoverclusters/add-clustervmmonitoreditem.md | 9 ++++++--- .../failoverclusters/Add-ClusterVMMonitoredItem.md | 6 +++--- .../failoverclusters/Add-ClusterVMMonitoredItem.md | 14 ++++++++------ 3 files changed, 17 insertions(+), 12 deletions(-) diff --git a/docset/windows/failoverclusters/add-clustervmmonitoreditem.md b/docset/windows/failoverclusters/add-clustervmmonitoreditem.md index f448b2fe11..702d478549 100644 --- a/docset/windows/failoverclusters/add-clustervmmonitoreditem.md +++ b/docset/windows/failoverclusters/add-clustervmmonitoreditem.md @@ -191,7 +191,7 @@ Accept wildcard characters: False ``` ### -VMId - +Specifies the virtual machine identifier (ID). ```yaml Type: Guid @@ -206,7 +206,8 @@ Accept wildcard characters: False ``` ### -VirtualMachine - +Specifies the name of the clustered virtual machine on which to perform monitoring. +When this parameter is specified, the cmdlet must be run on one of the host cluster nodes, or else the **Cluster** parameter must also be specified. ```yaml Type: String @@ -221,7 +222,9 @@ Accept wildcard characters: False ``` ### -Wait - +Specifies the time in seconds to wait for the cmdlet. +If the *Wait* parameter is not specified, then the cmdlet waits for completion. +If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. ```yaml Type: Int32 diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterVMMonitoredItem.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterVMMonitoredItem.md index b783a2d5aa..1285b6a998 100644 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterVMMonitoredItem.md +++ b/docset/winserver2012-ps/failoverclusters/Add-ClusterVMMonitoredItem.md @@ -131,11 +131,11 @@ Accept wildcard characters: False Specifies that the cluster service will fix, by overriding, the service recovery actions in the event that it is not properly configured for monitoring. To be configured for monitoring the following conditions need to be met: - -- None of the service recovery actions are set to Restart the computer. +- None of the service recovery actions are set to Restart the computer. - ---- AND +AND - -- At least one of the service recovery actions are set to Take no action. +- At least one of the service recovery actions are set to Take no action. ```yaml Type: SwitchParameter diff --git a/docset/winserver2012r2-ps/failoverclusters/Add-ClusterVMMonitoredItem.md b/docset/winserver2012r2-ps/failoverclusters/Add-ClusterVMMonitoredItem.md index b3d0e252ed..557e14c758 100644 --- a/docset/winserver2012r2-ps/failoverclusters/Add-ClusterVMMonitoredItem.md +++ b/docset/winserver2012r2-ps/failoverclusters/Add-ClusterVMMonitoredItem.md @@ -154,11 +154,11 @@ Accept wildcard characters: False Specifies that the cluster service will fix, by overriding, the service recovery actions in the event that it is not properly configured for monitoring. To be configured for monitoring the following conditions need to be met: - -- None of the service recovery actions are set to Restart the computer. +- None of the service recovery actions are set to Restart the computer. - ---- AND +AND - -- At least one of the service recovery actions are set to Take no action. +- At least one of the service recovery actions are set to Take no action. ```yaml Type: SwitchParameter @@ -190,7 +190,7 @@ Accept wildcard characters: False ``` ### -VMId -{{Fill VMId Description}} +Specifies the virtual machine identifier (ID). ```yaml Type: Guid @@ -221,7 +221,9 @@ Accept wildcard characters: False ``` ### -Wait -{{Fill Wait Description}} +Specifies the time in seconds to wait for the cmdlet. +If the *Wait* parameter is not specified, then the cmdlet waits for completion. +If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. ```yaml Type: Int32 @@ -236,7 +238,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS From b87df6687f11ac9d22b840ef7b1cc38a9fa6b4af Mon Sep 17 00:00:00 2001 From: Borislav Velkov Date: Mon, 30 Sep 2019 19:58:37 +0300 Subject: [PATCH 4/6] Update docset/windows/failoverclusters/remove-clustervmmonitoreditem.md Co-Authored-By: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../windows/failoverclusters/remove-clustervmmonitoreditem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/windows/failoverclusters/remove-clustervmmonitoreditem.md b/docset/windows/failoverclusters/remove-clustervmmonitoreditem.md index 774baea15d..59e18c65de 100644 --- a/docset/windows/failoverclusters/remove-clustervmmonitoreditem.md +++ b/docset/windows/failoverclusters/remove-clustervmmonitoreditem.md @@ -123,7 +123,7 @@ Accept wildcard characters: False ``` ### -InputObject -Specifies the cluster on which to run the cmdlet, the clustered virtual machine from which to remove monitoring, or the clustered virtual machine monitored item object to stop monitoring +Specifies the cluster on which to run the cmdlet, the clustered virtual machine from which to remove monitoring, or the clustered virtual machine monitored item to stop monitoring. ```yaml Type: PSObject From 05831fc15317abc3bf55a4e03aca7f4b18a75446 Mon Sep 17 00:00:00 2001 From: Rebecca Agiewich Date: Mon, 30 Sep 2019 15:33:34 -0700 Subject: [PATCH 5/6] changed instance of "http" to "https" --- .../failoverclusters/Remove-ClusterVMMonitoredItem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md b/docset/winserver2012r2-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md index a7289ea2ae..c92eb6d4de 100644 --- a/docset/winserver2012r2-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md +++ b/docset/winserver2012r2-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md @@ -200,7 +200,7 @@ 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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS From b93e5d8c4b10e2db7a7342c24d6a4a7549cc1f08 Mon Sep 17 00:00:00 2001 From: Raaj Baskaran Date: Tue, 1 Oct 2019 08:40:19 -0500 Subject: [PATCH 6/6] updated http -> https --- .../failoverclusters/Add-ClusterVMMonitoredItem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/failoverclusters/Add-ClusterVMMonitoredItem.md b/docset/winserver2012r2-ps/failoverclusters/Add-ClusterVMMonitoredItem.md index 557e14c758..2dd960f86f 100644 --- a/docset/winserver2012r2-ps/failoverclusters/Add-ClusterVMMonitoredItem.md +++ b/docset/winserver2012r2-ps/failoverclusters/Add-ClusterVMMonitoredItem.md @@ -238,7 +238,7 @@ 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](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS