DSCResources/DSC_SystemLocale/en-US/about_SystemLocale.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
47
48
49
.NAME
    SystemLocale
 
.DESCRIPTION
    Ths resource is used set the system locale on a Windows machine.
 
    To get a list of valid Windows System Locales use the command:
    `[System.Globalization.CultureInfo]::GetCultures([System.Globalization.CultureTypes]::AllCultures).name`
 
    If the System Locale is changed by this resource, it will require the node
    to reboot. If the LCM is not configured to allow restarting, the configuration
    will not be able to be applied until a manual restart occurs.
 
.PARAMETER IsSingleInstance
    Key - String
    Allowed values: Yes
    Specifies the resource is a single instance, the value must be 'Yes'
 
.PARAMETER SystemLocale
    Required - String
    Specifies the System Locale.
 
.EXAMPLE 1
 
This example will set the System Locale of LocalHost to 'ja-JP'.
To use this example, run it using PowerShell.
 
Configuration SystemLocale_SetSystemLocale_Config
{
    param
    (
        [Parameter()]
        [System.String[]]
        $NodeName = 'localhost'
    )
 
    Import-DSCResource -ModuleName ComputerManagementDsc
 
    Node $NodeName
    {
        SystemLocale SystemLocaleExample
        {
            IsSingleInstance = 'Yes'
            SystemLocale = 'ja-JP'
        }
    }
}