Skip to content

Commit be6dbd9

Browse files
author
Joe Gast
committed
Get-HgsClienConfiguration.md - documentation formatting
1 parent 556ce69 commit be6dbd9

File tree

1 file changed

+37
-21
lines changed

1 file changed

+37
-21
lines changed

docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,20 @@ Gets the configuration of a Host Guardian Service client.
1616
## SYNTAX
1717

1818
```
19-
Get-HgsClientConfiguration [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
19+
Get-HgsClientConfiguration [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
20+
[<CommonParameters>]
2021
```
2122

2223
## DESCRIPTION
23-
The **Get-HgsClientConfiguration** cmdlet get the configuration of the local Host Guardian Service client.
24+
25+
The **Get-HgsClientConfiguration** cmdlet get the configuration of the local Host Guardian Service
26+
client.
2427

2528
## EXAMPLES
2629

2730
### Example 1: Get client configuration
28-
```
31+
32+
```powershell
2933
PS C:\> Get-HgsClientConfiguration
3034
```
3135

@@ -34,20 +38,22 @@ This command gets the configuration of the local Host Guardian Service client.
3438
## PARAMETERS
3539

3640
### -AsJob
37-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
3841

39-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
40-
You can continue to work in the session while the job completes.
41-
To manage the job, use the `*-Job` cmdlets.
42-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
42+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
43+
complete.
4344

44-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
45+
The cmdlet immediately returns an object that represents the job and then displays the command
46+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
47+
`*-Job` cmdlets. To get the job results, use the
48+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
4549

50+
For more information about Windows PowerShell background jobs, see
51+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
4652

4753
```yaml
4854
Type: SwitchParameter
4955
Parameter Sets: (All)
50-
Aliases:
56+
Aliases:
5157

5258
Required: False
5359
Position: Named
@@ -57,9 +63,11 @@ Accept wildcard characters: False
5763
```
5864
5965
### -CimSession
60-
Runs the cmdlet in a remote session or on a remote computer.
61-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
62-
The default is the current session on the local computer.
66+
67+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
68+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
69+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
70+
current session on the local computer.
6371
6472
```yaml
6573
Type: CimSession[]
@@ -74,14 +82,17 @@ Accept wildcard characters: False
7482
```
7583
7684
### -ThrottleLimit
77-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
78-
If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
79-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
85+
86+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
87+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
88+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
89+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
90+
computer.
8091

8192
```yaml
8293
Type: Int32
8394
Parameter Sets: (All)
84-
Aliases:
95+
Aliases:
8596
8697
Required: False
8798
Position: Named
@@ -91,20 +102,25 @@ Accept wildcard characters: False
91102
```
92103

93104
### CommonParameters
94-
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).
105+
106+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
107+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
108+
-WarningAction, and -WarningVariable. For more information, see
109+
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
95110

96111
## INPUTS
97112

98113
## OUTPUTS
99114

100115
### CimInstance#MSFT_HgsClientConfiguration
116+
101117
This cmdlet returns the configuration of a Host Guardian Service client as a **CimInstance** object.
102-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
103-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
118+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
119+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
120+
namespace and class name for the underlying WMI object.
104121

105122
## NOTES
106123

107124
## RELATED LINKS
108125

109126
[Set-HgsClientConfiguration](./Set-HgsClientConfiguration.md)
110-

0 commit comments

Comments
 (0)