DSCResources/DSC_VirtualMemory/en-US/about_VirtualMemory.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
.NAME
    VirtualMemory
 
.DESCRIPTION
    The resource allows configuration of properties of the paging file on
    the local computer.
 
.PARAMETER Drive
    Key - String
    The drive letter for which paging settings should be set. Can be letter only, letter and colon or letter with colon and trailing slash.
 
.PARAMETER Type
    Key - String
    Allowed values: AutoManagePagingFile, CustomSize, SystemManagedSize, NoPagingFile
    The type of the paging setting to use. If set to AutoManagePagingFile, the drive letter will be ignored. If set to SystemManagedSize, the values for InitialSize and MaximumSize will be ignored
 
.PARAMETER InitialSize
    Write - SInt64
    The initial size of the page file in Megabyte
 
.PARAMETER MaximumSize
    Write - SInt64
    The maximum size of the page file in Megabyte
 
.EXAMPLE 1
 
Example script that sets the paging file to reside on
drive C with the custom size 2048MB.
 
Configuration VirtualMemory_SetVirtualMemory_Config
{
    Import-DSCResource -ModuleName ComputerManagementDsc
 
    Node localhost
    {
        VirtualMemory PagingSettings
        {
            Type = 'CustomSize'
            Drive = 'C'
            InitialSize = '2048'
            MaximumSize = '2048'
        }
    }
}