Skip to content

Commit a0f5476

Browse files
author
Joe Gast
committed
Get-HgsGuardian.md - documentation formatting
1 parent be6dbd9 commit a0f5476

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

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

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,24 @@ Get-HgsGuardian [[-Name] <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimi
2121
```
2222

2323
## DESCRIPTION
24+
2425
The **Get-HgsGuardian** cmdlet gets Host Guardian Service guardian objects from persistent storage.
2526
For a computer configured in **HostGuardianService** mode, this cmdlet returns no result.
2627
The **New-HgsKeyProtector** cmdlet requires **HgsGuardian** objects.
2728

2829
## EXAMPLES
2930

3031
### Example 1: Get all guardians
31-
```
32-
PS C:\> Get-HgsGuardian
32+
33+
```powershell
34+
Get-HgsGuardian
3335
```
3436

3537
This command gets all guardians configured for this computer.
3638

3739
### Example 2: Get a guardian by using its name
38-
```
40+
41+
```powershell
3942
PS C:\> Get-HgsGuardian -Name "Guardian11"
4043
```
4144

@@ -44,20 +47,22 @@ This command gets a guardian named Guardian11.
4447
## PARAMETERS
4548

4649
### -AsJob
47-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4850

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

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

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

5762
```yaml
5863
Type: SwitchParameter
5964
Parameter Sets: (All)
60-
Aliases:
65+
Aliases:
6166

6267
Required: False
6368
Position: Named
@@ -67,6 +72,7 @@ Accept wildcard characters: False
6772
```
6873
6974
### -CimSession
75+
7076
Runs the cmdlet in a remote session or on a remote computer.
7177
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.
7278
The default is the current session on the local computer.
@@ -84,12 +90,13 @@ Accept wildcard characters: False
8490
```
8591
8692
### -Name
93+
8794
Specifies an array of names of guardians to get.
8895
8996
```yaml
9097
Type: String[]
9198
Parameter Sets: (All)
92-
Aliases:
99+
Aliases:
93100

94101
Required: False
95102
Position: 1
@@ -99,14 +106,17 @@ Accept wildcard characters: False
99106
```
100107
101108
### -ThrottleLimit
102-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
103-
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.
104-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
109+
110+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
111+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
112+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
113+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
114+
computer.
105115

106116
```yaml
107117
Type: Int32
108118
Parameter Sets: (All)
109-
Aliases:
119+
Aliases:
110120
111121
Required: False
112122
Position: Named
@@ -116,13 +126,15 @@ Accept wildcard characters: False
116126
```
117127

118128
### CommonParameters
119-
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).
129+
130+
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).
120131

121132
## INPUTS
122133

123134
## OUTPUTS
124135

125136
### CimInstance#MSFT_HgsGuardian
137+
126138
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
127139
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
128140

@@ -137,4 +149,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th
137149
[New-HgsGuardian](./New-HgsGuardian.md)
138150

139151
[Remove-HgsGuardian](./Remove-HgsGuardian.md)
140-

0 commit comments

Comments
 (0)