Skip to content

Commit 93d4ce5

Browse files
Add content from articles.
1 parent 8392900 commit 93d4ce5

File tree

10 files changed

+309
-104
lines changed

10 files changed

+309
-104
lines changed

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

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description:
2+
description: The Get-PmemDedicatedMemory cmdlet gets dedicated persistent memory.
33
external help file: Microsoft.Storage.PersistentMemory.Management.Commands.dll-Help.xml
44
Module Name: PersistentMemory
55
online version: https://docs.microsoft.com/powershell/module/persistentmemory/get-pmemdedicatedmemory?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
@@ -11,7 +11,7 @@ title: Get-PmemDedicatedMemory
1111
# Get-PmemDedicatedMemory
1212

1313
## SYNOPSIS
14-
{{ Fill in the Synopsis }}
14+
Gets dedicated persistent memory.
1515

1616
## SYNTAX
1717

@@ -26,21 +26,29 @@ Get-PmemDedicatedMemory [[-DeviceNumber] <UInt32[]>] [<CommonParameters>]
2626
```
2727

2828
## DESCRIPTION
29-
{{ Fill in the Description }}
29+
The **Get-PmemDedicatedMemory** cmdlet gets dedicated persistent memory. You can display all dedicated persistent memory or memory for a specific device.
3030

3131
## EXAMPLES
3232

33-
### Example 1
33+
### Example 1: Get all dedicated persistent memory
3434
```powershell
35-
PS C:\> {{ Add example code here }}
35+
Get-PmemDedicatedMemory
3636
```
3737

38-
{{ Add example description here }}
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.
3946

4047
## PARAMETERS
4148

4249
### -DeviceNumber
43-
{{ Fill DeviceNumber Description }}
50+
Specifies the device number for the physical device.
51+
The cmdlet gets dedicated memory for that device.
4452

4553
```yaml
4654
Type: UInt32[]
@@ -64,6 +72,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6472
## OUTPUTS
6573
6674
### System.Object
75+
6776
## NOTES
6877
6978
## 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: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description:
2+
description: The Get-PmemDisk cmdlet gets persistent memory disks.
33
external help file: Microsoft.Storage.PersistentMemory.Management.Commands.dll-Help.xml
44
Module Name: PersistentMemory
55
online version: https://docs.microsoft.com/powershell/module/persistentmemory/get-pmemdisk?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
@@ -11,7 +11,7 @@ title: Get-PmemDisk
1111
# Get-PmemDisk
1212

1313
## SYNOPSIS
14-
{{ Fill in the Synopsis }}
14+
Gets persistent memory disks.
1515

1616
## SYNTAX
1717

@@ -41,21 +41,56 @@ Get-PmemDisk [-InputObject <CimInstance>] [<CommonParameters>]
4141
```
4242

4343
## DESCRIPTION
44-
{{ Fill in the Description }}
44+
The **Get-PmemDisk** cmdlet gets persistent memory disks.
45+
You can get disks by number or physical device.
4546

4647
## EXAMPLES
4748

48-
### Example 1
49+
### Example 1: Get persistent memory disks
4950
```powershell
50-
PS C:\> {{ Add example code here }}
51+
Get-PmemDisk
5152
```
5253

53-
{{ Add example description here }}
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.
5489

5590
## PARAMETERS
5691

5792
### -DiskNumber
58-
{{ Fill DiskNumber Description }}
93+
Specifies the disk number of persistent memory disk to get.
5994

6095
```yaml
6196
Type: UInt32[]
@@ -70,7 +105,7 @@ Accept wildcard characters: False
70105
```
71106
72107
### -InputObject
73-
{{ Fill InputObject Description }}
108+
Specifies the input object that is used in a pipeline command.
74109
75110
```yaml
76111
Type: CimInstance
@@ -85,7 +120,8 @@ Accept wildcard characters: False
85120
```
86121
87122
### -PhysicalDevice
88-
{{ Fill PhysicalDevice Description }}
123+
Specifies a physical disk.
124+
The cmdlet gets persistent memory disks on the physical disk.
89125
90126
```yaml
91127
Type: PmemPhysicalDevice
@@ -100,7 +136,8 @@ Accept wildcard characters: False
100136
```
101137
102138
### -PhysicalDeviceId
103-
{{ Fill PhysicalDeviceId Description }}
139+
Specifies the ID of a physical disk.
140+
The cmdlet gets persistent memory disks on the physical disk.
104141
105142
```yaml
106143
Type: String[]
@@ -126,6 +163,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
126163
## OUTPUTS
127164
128165
### System.Object
166+
129167
## NOTES
130168
131169
## RELATED LINKS
170+
171+
[Get-PhysicalDisk](../storage/Get-PhysicalDisk.md)
172+
173+
[New-PmemDisk](New-PmemDisk.md)
174+
175+
[Remove-PmemDisk](Remove-PmemDisk.md)

docset/winserver2022-ps/persistentmemory/Get-PmemPhysicalDevice.md

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description:
2+
description: The Get-PmemPhysicalDevice cmdlet gets the physical devices associated with persistent memory.
33
external help file: Microsoft.Storage.PersistentMemory.Management.Commands.dll-Help.xml
44
Module Name: PersistentMemory
55
online version: https://docs.microsoft.com/powershell/module/persistentmemory/get-pmemphysicaldevice?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
@@ -11,7 +11,7 @@ title: Get-PmemPhysicalDevice
1111
# Get-PmemPhysicalDevice
1212

1313
## SYNOPSIS
14-
{{ Fill in the Synopsis }}
14+
Gets the physical devices associated with persistent memory.
1515

1616
## SYNTAX
1717

@@ -41,21 +41,46 @@ Get-PmemPhysicalDevice [-InputObject <CimInstance>] [<CommonParameters>]
4141
```
4242

4343
## DESCRIPTION
44-
{{ Fill in the Description }}
44+
The **Get-PmemPhysicalDevice** cmdlet gets the physical devices associated with persistent memory.
4545

4646
## EXAMPLES
4747

48-
### Example 1
48+
### Example 1: Get physical devices that have persistent memory
4949
```powershell
50-
PS C:\> {{ Add example code here }}
50+
Get-PmemPhysicalDevice
5151
```
5252

53-
{{ Add example description here }}
53+
```output
54+
DeviceId DeviceType HealthStatus OperationalStatus PhysicalLocation FirmwareRevision Persistent memory size Volatile
55+
memory size
56+
-------- ---------- ------------ ----------------- ---------------- ---------------- ---------------------- --------------
57+
1020 Intel INVDIMM device Healthy {Ok} CPU2_DIMM_C1 102005310 126 GB 0 GB
58+
1120 Intel INVDIMM device Healthy {Ok} CPU2_DIMM_F1 102005310 126 GB 0 GB
59+
120 Intel INVDIMM device Healthy {Ok} CPU1_DIMM_F1 102005310 126 GB 0 GB
60+
20 Intel INVDIMM device Healthy {Ok} CPU1_DIMM_C1 102005310 126 GB 0 GB
61+
```
62+
63+
This command gets all the physical devices with persistent memory.
64+
65+
66+
### Example 2: Get physical device for a persistent memory disk
67+
```powershell
68+
(Get-PmemDisk)[0] | Get-PmemPhysicalDevice
69+
```
70+
71+
```output
72+
DeviceId DeviceType HealthStatus OperationalStatus PhysicalLocation FirmwareRevision Persistent memory size Volatile memory size
73+
-------- ---------- ------------ ----------------- ---------------- ---------------- ---------------------- --------------------
74+
20 Intel INVDIMM device Healthy {Ok} CPU1_DIMM_C1 102005310 126 GB 0 GB
75+
120 Intel INVDIMM device Healthy {Ok} CPU1_DIMM_F1 102005310 126 GB 0 GB
76+
```
77+
78+
This example uses the **Get-PmemDisk** cmdlet to get a persistent memory disk and gets the physical device for that disk.
5479

5580
## PARAMETERS
5681

5782
### -DeviceId
58-
{{ Fill DeviceId Description }}
83+
Specifies the device ID of the physical device to get.
5984

6085
```yaml
6186
Type: String[]
@@ -70,7 +95,8 @@ Accept wildcard characters: False
7095
```
7196
7297
### -DiskNumber
73-
{{ Fill DiskNumber Description }}
98+
Specifies the disk number of persistent memory disk.
99+
The cmdlet gets the physical device for that disk.
74100
75101
```yaml
76102
Type: UInt32
@@ -85,7 +111,7 @@ Accept wildcard characters: False
85111
```
86112
87113
### -InputObject
88-
{{ Fill InputObject Description }}
114+
Specifies the input object that is used in a pipeline command.
89115
90116
```yaml
91117
Type: CimInstance
@@ -100,7 +126,8 @@ Accept wildcard characters: False
100126
```
101127
102128
### -LogicalDisk
103-
{{ Fill LogicalDisk Description }}
129+
Specifies a logical persistent memory disk.
130+
The cmdlet gets the physical device for that disk.
104131
105132
```yaml
106133
Type: PmemDisk
@@ -130,3 +157,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
130157
## NOTES
131158
132159
## RELATED LINKS
160+
161+
[Get-PmemDisk](Get-PmemDisk.md)
162+
163+
[Initialize-PmemPhysicalDevice](Initialize-PmemPhysicalDevice.md)

docset/winserver2022-ps/persistentmemory/Get-PmemUnusedRegion.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description:
2+
description: The Get-PmemUnusedRegion cmdlet gets unused regions in persistent memory.
33
external help file: Microsoft.Storage.PersistentMemory.Management.Commands.dll-Help.xml
44
Module Name: PersistentMemory
55
online version: https://docs.microsoft.com/powershell/module/persistentmemory/get-pmemUnusedregion?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
@@ -11,7 +11,7 @@ title: Get-PmemUnusedRegion
1111
# Get-PmemUnusedRegion
1212

1313
## SYNOPSIS
14-
{{ Fill in the Synopsis }}
14+
Gets unused regions in persistent memory.
1515

1616
## SYNTAX
1717

@@ -20,21 +20,42 @@ Get-PmemUnusedRegion [[-RegionId] <UInt32[]>] [<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
23-
{{ Fill in the Description }}
23+
The **Get-PmemUnusedRegion** cmdlet gets unused regions of persistent memory.
24+
Use this cmdlet with the **New-PmemDisk** cmdlet to create persistent memory disks.
2425

2526
## EXAMPLES
2627

27-
### Example 1
28+
### Example 1: Get unused regions
2829
```powershell
29-
PS C:\> {{ Add example code here }}
30+
Get-PmemUnusedRegion
3031
```
3132

32-
{{ Add example description here }}
33+
```output
34+
RegionId TotalSizeInBytes DeviceId
35+
-------- ---------------- --------
36+
1 270582939648 {20, 120}
37+
3 270582939648 {1020, 1120}
38+
```
39+
40+
This example gets all the unused regions of persistent memory.
41+
42+
### Example 1: Get a specific region
43+
```powershell
44+
Get-PmemUnusedRegion -RegionId 3
45+
```
46+
47+
```output
48+
RegionId TotalSizeInBytes DeviceId
49+
-------- ---------------- --------
50+
3 270582939648 {1020, 1120}
51+
```
52+
53+
This example gets all the unused regions of persistent memory.
3354

3455
## PARAMETERS
3556

3657
### -RegionId
37-
{{ Fill RegionId Description }}
58+
Specifies the ID of the region of the persistent memory disk to get.
3859

3960
```yaml
4061
Type: UInt32[]
@@ -61,3 +82,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6182
## NOTES
6283
6384
## RELATED LINKS
85+
86+
[Get-PmemDisk](Get-PmemDisk.md)
87+
88+
[New-PmemDisk](New-PmemDisk.md)

0 commit comments

Comments
 (0)