Skip to content

Commit ab3cf5d

Browse files
tiburdtiburd
authored
Merge pull request MicrosoftDocs#2650 from TimShererWithAquent/persistentmemory-v-tishe-a
PersistentMemory PowerShell reference update
2 parents cde74f7 + c315066 commit ab3cf5d

File tree

10 files changed

+1231
-0
lines changed

10 files changed

+1231
-0
lines changed

‎docset/winserver2022-ps/persistentmemory/Get-PmemDedicatedMemory.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
description: The Get-PmemDedicatedMemory cmdlet gets dedicated persistent memory.
3+
external help file: Microsoft.Storage.PersistentMemory.Management.Commands.dll-Help.xml
4+
Module Name: PersistentMemory
5+
online version: https://docs.microsoft.com/powershell/module/persistentmemory/get-pmemdedicatedmemory?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
6+
schema: 2.0.0
7+
ms.date: 09/24/2021
8+
title: Get-PmemDedicatedMemory
9+
---
10+
11+
# Get-PmemDedicatedMemory
12+
13+
## SYNOPSIS
14+
Gets dedicated persistent memory.
15+
16+
## SYNTAX
17+
18+
### AllDevices (Default)
19+
```
20+
Get-PmemDedicatedMemory [<CommonParameters>]
21+
```
22+
23+
### SingleDevice
24+
```
25+
Get-PmemDedicatedMemory [[-DeviceNumber] <UInt32[]>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
The **Get-PmemDedicatedMemory** cmdlet gets dedicated persistent memory. You can display all dedicated persistent memory or memory for a specific device.
30+
31+
## EXAMPLES
32+
33+
### Example 1: Get all dedicated persistent memory
34+
```powershell
35+
Get-PmemDedicatedMemory
36+
```
37+
38+
This example gets all dedicated memory.
39+
40+
### Example 2: Get dedicated persistent memory on a device
41+
```powershell
42+
Get-PmemDedicatedMemory -DeviceNumber 1
43+
```
44+
45+
This example gets all dedicated memory for the specified device.
46+
47+
## PARAMETERS
48+
49+
### -DeviceNumber
50+
Specifies the device number for the physical device.
51+
The cmdlet gets dedicated memory for that device.
52+
53+
```yaml
54+
Type: UInt32[]
55+
Parameter Sets: SingleDevice
56+
Aliases:
57+
58+
Required: False
59+
Position: 0
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### CommonParameters
66+
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).
67+
68+
## INPUTS
69+
70+
### None
71+
72+
## OUTPUTS
73+
74+
### System.Object
75+
76+
## NOTES
77+
78+
## RELATED LINKS
79+
80+
[New-PmemDedicatedMemory](New-PmemDedicatedMemory.md)
81+
82+
[Remove-PmemDedicatedMemory](Remove-PmemDedicatedMemory.md)

‎docset/winserver2022-ps/persistentmemory/Get-PmemDisk.md‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
---
2+
description: The Get-PmemDisk cmdlet gets persistent memory disks.
3+
external help file: Microsoft.Storage.PersistentMemory.Management.Commands.dll-Help.xml
4+
Module Name: PersistentMemory
5+
online version: https://docs.microsoft.com/powershell/module/persistentmemory/get-pmemdisk?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
6+
schema: 2.0.0
7+
ms.date: 09/24/2021
8+
title: Get-PmemDisk
9+
---
10+
11+
# Get-PmemDisk
12+
13+
## SYNOPSIS
14+
Gets persistent memory disks.
15+
16+
## SYNTAX
17+
18+
### AllDisks (Default)
19+
```
20+
Get-PmemDisk [<CommonParameters>]
21+
```
22+
23+
### SingleDevice
24+
```
25+
Get-PmemDisk [[-DiskNumber] <UInt32[]>] [<CommonParameters>]
26+
```
27+
28+
### ByPhysicalDevice
29+
```
30+
Get-PmemDisk [-PhysicalDevice <PmemPhysicalDevice>] [<CommonParameters>]
31+
```
32+
33+
### ByDeviceId
34+
```
35+
Get-PmemDisk [-PhysicalDeviceId <String[]>] [<CommonParameters>]
36+
```
37+
38+
### ByInputObject
39+
```
40+
Get-PmemDisk [-InputObject <CimInstance>] [<CommonParameters>]
41+
```
42+
43+
## DESCRIPTION
44+
The **Get-PmemDisk** cmdlet gets persistent memory disks.
45+
You can get disks by number or physical device.
46+
47+
## EXAMPLES
48+
49+
### Example 1: Get persistent memory disks
50+
```powershell
51+
Get-PmemDisk
52+
```
53+
54+
```output
55+
DiskNumber Size HealthStatus AtomicityType CanBeRemoved PhysicalDeviceIds UnsafeShutdownCount
56+
---------- ---- ------------ ------------- ------------ ----------------- -------------------
57+
2 252 GB Healthy None True {20, 120} 0
58+
3 252 GB Healthy None True {1020, 1120} 0
59+
```
60+
61+
This example gets all persistent memory disks.
62+
63+
### Example 2: Get persistent memory disk by number
64+
```powershell
65+
Get-PmemDisk -DiskNumber 2
66+
```
67+
68+
```output
69+
DiskNumber Size HealthStatus AtomicityType CanBeRemoved PhysicalDeviceIds UnsafeShutdownCount
70+
---------- ---- ------------ ------------- ------------ ----------------- -------------------
71+
2 252 GB Healthy None True {20, 120} 0
72+
```
73+
74+
This example gets the specified persistent memory disk.
75+
76+
### Example 3: Get physical disk information
77+
```powershell
78+
Get-PmemDisk | Get-PhysicalDisk | select SerialNumber, HealthStatus, OperationalStatus, OperationalDetails
79+
```
80+
81+
```output
82+
SerialNumber HealthStatus OperationalStatus OperationalDetails
83+
------------ ------------ ------------------ ------------------
84+
802c-01-1602-117cb5fc Healthy OK
85+
802c-01-1602-117cb64f Warning Predictive Failure {Threshold Exceeded,NVDIMM_N Error}
86+
```
87+
88+
This example gets persistent memory disks. It then gets the physical disks that host them and uses the **select** command to display serial number, health status, and operational information.
89+
90+
## PARAMETERS
91+
92+
### -DiskNumber
93+
Specifies the disk number of persistent memory disk to get.
94+
95+
```yaml
96+
Type: UInt32[]
97+
Parameter Sets: SingleDevice
98+
Aliases:
99+
100+
Required: False
101+
Position: 0
102+
Default value: None
103+
Accept pipeline input: False
104+
Accept wildcard characters: False
105+
```
106+
107+
### -InputObject
108+
Specifies the input object that is used in a pipeline command.
109+
110+
```yaml
111+
Type: CimInstance
112+
Parameter Sets: ByInputObject
113+
Aliases:
114+
115+
Required: False
116+
Position: Named
117+
Default value: None
118+
Accept pipeline input: True (ByValue)
119+
Accept wildcard characters: False
120+
```
121+
122+
### -PhysicalDevice
123+
Specifies a physical disk.
124+
The cmdlet gets persistent memory disks on the physical disk.
125+
126+
```yaml
127+
Type: PmemPhysicalDevice
128+
Parameter Sets: ByPhysicalDevice
129+
Aliases:
130+
131+
Required: False
132+
Position: Named
133+
Default value: None
134+
Accept pipeline input: True (ByValue)
135+
Accept wildcard characters: False
136+
```
137+
138+
### -PhysicalDeviceId
139+
Specifies the ID of a physical disk.
140+
The cmdlet gets persistent memory disks on the physical disk.
141+
142+
```yaml
143+
Type: String[]
144+
Parameter Sets: ByDeviceId
145+
Aliases:
146+
147+
Required: False
148+
Position: Named
149+
Default value: None
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
154+
### CommonParameters
155+
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).
156+
157+
## INPUTS
158+
159+
### Microsoft.Storage.PersistentMemory.Management.PmemPhysicalDevice
160+
161+
### Microsoft.Management.Infrastructure.CimInstance
162+
163+
## OUTPUTS
164+
165+
### System.Object
166+
167+
## NOTES
168+
169+
## RELATED LINKS
170+
171+
[Get-PhysicalDisk](../storage/Get-PhysicalDisk.md)
172+
173+
[New-PmemDisk](New-PmemDisk.md)
174+
175+
[Remove-PmemDisk](Remove-PmemDisk.md)

0 commit comments

Comments
 (0)