Module/Rule.AuditPolicy/AuditPolicyRule.psm1

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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
using module .\..\Common\Common.psm1
using module .\..\Rule\Rule.psm1
#header

<#
    .SYNOPSIS
        Audit Policy object to manage Audit Policy STIG Rules
    .DESCRIPTION
        The AuditPolicyRule class is used to manage the Audit Policy Settings
    .PARAMETER Subcategory
        The name of the subcategory to configure
    .PARAMETER AuditFlag
        The Success or failure flag
    .PARAMETER Ensure
        A present or absent flag
#>

class AuditPolicyRule : Rule
{
    [string] $Subcategory
    [string] $AuditFlag
    [ensure] $Ensure <#(ExceptionValue)#>

    <#
        .SYNOPSIS
            Default constructor to support the AsRule cast method
    #>

    AuditPolicyRule ()
    {
    }

    <#
        .SYNOPSIS
            Used to load PowerSTIG data from the processed data directory
        .PARAMETER Rule
            The STIG rule to load
    #>

    AuditPolicyRule ([xml.xmlelement] $Rule) : base ($Rule)
    {
    }

    <#
        .SYNOPSIS
            The Convert child class constructor
        .PARAMETER Rule
            The STIG rule to convert
        .PARAMETER Convert
            A simple bool flag to create a unique constructor signature
    #>

    AuditPolicyRule ([xml.xmlelement] $Rule, [switch] $Convert) : base ($Rule, $Convert)
    {
    }

    <#
        .SYNOPSIS
            Creates class specifc help content
    #>

    [PSObject] GetExceptionHelp()
    {
        if ($this.Ensure -eq 'Absent')
        {
            $value = 'Present'
        }
        else
        {
            $value = 'Absent'
        }

        return @{
            Value = $value
            Notes = "'Present' and 'Absent' are the only valid values"
        }
    }
}