5. Syntax

PARAMETERS

-Base <String>
    DistinguishedName to start your search at. Always included as long as your filter matches your object.

    Required?                    false
    Position?                    1
    Default value
    Accept pipeline input?       true (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-Targets <String>

    Required?                    false
    Position?                    1
    Default value
    Accept pipeline input?       true (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-Filter <String>
    Filter. Specify your custom filter. Default is OrganizationalUnit.

    Required?                    false
    Position?                    2
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Scope <String>
    Scope. Set your scope. Default is base.

    Required?                    false
    Position?                    3
    Default value                base
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Server <String>
    Server. Specify your specific server to target your search at.

    Required?                    false
    Position?                    4
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Port <String>
    Port. Specify your custom port.

    Required?                    false
    Position?                    5
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-EffectiveRightsPrincipal <String>
    EffectiveRightsPrincipal. Specify your security principal to chech for effective permissions

    Required?                    false
    Position?                    6
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Output <String>
    Generates a HTML report, default is a CSV.

    Required?                    false
    Position?                    7
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-OutputFolder <String>
    Output folder path for where results are written.

    Required?                    false
    Position?                    8
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Template <String>
    Template to compare with.

    Required?                    false
    Position?                    9
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Returns <String>
    Template to compare with.

    Required?                    false
    Position?                    9
    Default value                ALL
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ExcelFile <String>
    Template to compare with.

    Required?                    false
    Position?                    named
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Criticality <String>
    Filter on Criticality.

    Required?                    false
    Position?                    named
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ShowCriticalityColor [<SwitchParameter>]
    Show color of criticality

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-SkipDefaults [<SwitchParameter>]
    Skip default permissions

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-SkipBuiltIn [<SwitchParameter>]
    Skip Built-in security principals

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-RecursiveFind [<SwitchParameter>]
    Expand groups

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-RecursiveObjectType <String>
    Filter on Criticality.

    Required?                    false
    Position?                    named
    Default value                *
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Translate [<SwitchParameter>]
    Skip Built-in security principals

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-GPO [<SwitchParameter>]
    Get Group Policy Objects linked

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Show [<SwitchParameter>]
    Open HTML report

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-SDDate [<SwitchParameter>]
    Include Security Descriptor modified date in report

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Owner [<SwitchParameter>]
    Include Owner in report

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-CanonicalNames [<SwitchParameter>]
    Include Canonical Names in report

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Protected [<SwitchParameter>]
    Include if inheritance is disabled in report

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-help [<SwitchParameter>]
    Data Managment Delegation OU Name

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-DefaultSecurityDescriptor [<SwitchParameter>]
    Scan Default Security Descriptor

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ObjectName <String>
    Filter Default Security Descriptor on ObjectName

    Required?                    false
    Position?                    named
    Default value                *
    Accept pipeline input?       false
    Accept wildcard characters?  false

-OnlyModified [<SwitchParameter>]
    Filter Default Security Descriptor on modified with version number higher than 1

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-IncludeInherited [<SwitchParameter>]
    Include inherited permissions

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-RAW [<SwitchParameter>]
    RAW .Net Access Permissions

    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Access <String>
    Filter ACL for access type

    Required?                    false
    Position?                    named
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ApplyTo <String>
    Filter ACL ObjectName

    Required?                    false
    Position?                    named
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

-FilterTrustee <String>
    Filter ACL for matching strings in Trustee

    Required?                    false
    Position?                    named
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false