export const frontMatter = {
'external help file': 'Keldor-help.xml',
'Module Name': 'Keldor',
'online version': 'https://docs.keldor.dev/powershell/keldor/Get-ADComplianceReport',
schema: '2.0.0'
};
export const contentTitle = 'Get-ADComplianceReport';
export {default as metadata} from '@site/.docusaurus/docusaurus-plugin-content-docs/powershell/site-docs-powershell-keldor-get-ad-compliance-report-md-a35.json'
export const assets = {
};
import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "react/jsx-runtime";
import {useMDXComponents as _provideComponents} from "@mdx-js/react";
export const toc = [{
"value": "SYNOPSIS",
"id": "synopsis",
"level": 2
}, {
"value": "SYNTAX",
"id": "syntax",
"level": 2
}, {
"value": "DESCRIPTION",
"id": "description",
"level": 2
}, {
"value": "EXAMPLES",
"id": "examples",
"level": 2
}, {
"value": "EXAMPLE 1",
"id": "example-1",
"level": 3
}, {
"value": "EXAMPLE 2",
"id": "example-2",
"level": 3
}, {
"value": "EXAMPLE 3",
"id": "example-3",
"level": 3
}, {
"value": "PARAMETERS",
"id": "parameters",
"level": 2
}, {
"value": "-AdminGroupSearchBase",
"id": "-admingroupsearchbase",
"level": 3
}, {
"value": "-AdminSearchBase",
"id": "-adminsearchbase",
"level": 3
}, {
"value": "-ComputerSearchBase",
"id": "-computersearchbase",
"level": 3
}, {
"value": "-MSASearchBase",
"id": "-msasearchbase",
"level": 3
}, {
"value": "-OrganizationalSearchBase",
"id": "-organizationalsearchbase",
"level": 3
}, {
"value": "-ReportFolder",
"id": "-reportfolder",
"level": 3
}, {
"value": "-SaveADReports",
"id": "-saveadreports",
"level": 3
}, {
"value": "-SaveReport",
"id": "-savereport",
"level": 3
}, {
"value": "-ServerSearchBase",
"id": "-serversearchbase",
"level": 3
}, {
"value": "-ServiceAccountSearchBase",
"id": "-serviceaccountsearchbase",
"level": 3
}, {
"value": "-UserGroupSearchBase",
"id": "-usergroupsearchbase",
"level": 3
}, {
"value": "-UserSearchBase",
"id": "-usersearchbase",
"level": 3
}, {
"value": "CommonParameters",
"id": "commonparameters",
"level": 3
}, {
"value": "INPUTS",
"id": "inputs",
"level": 2
}, {
"value": "System.String",
"id": "systemstring",
"level": 3
}, {
"value": "OUTPUTS",
"id": "outputs",
"level": 2
}, {
"value": "System.Management.Automation.PSCustomObject",
"id": "systemmanagementautomationpscustomobject",
"level": 3
}, {
"value": "NOTES",
"id": "notes",
"level": 2
}, {
"value": "RELATED LINKS",
"id": "related-links",
"level": 2
}];
function _createMdxContent(props) {
const _components = {
a: "a",
code: "code",
h1: "h1",
h2: "h2",
h3: "h3",
header: "header",
p: "p",
pre: "pre",
..._provideComponents(),
...props.components
};
return _jsxs(_Fragment, {
children: [_jsx(_components.header, {
children: _jsx(_components.h1, {
id: "get-adcompliancereport",
children: "Get-ADComplianceReport"
})
}), "\n", _jsx(_components.h2, {
id: "synopsis",
children: "SYNOPSIS"
}), "\n", _jsx(_components.p, {
children: "Checks attributes on Active Directory objects against a set of compliance rules."
}), "\n", _jsx(_components.h2, {
id: "syntax",
children: "SYNTAX"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Get-ADComplianceReport [[-UserSearchBase] <String[]>] [[-UserGroupSearchBase] <String[]>]\n [[-AdminSearchBase] <String[]>] [[-AdminGroupSearchBase] <String[]>] [[-ComputerSearchBase] <String[]>]\n [[-MSASearchBase] <String[]>] [[-OrganizationalSearchBase] <String[]>] [[-ServerSearchBase] <String[]>]\n [[-ServiceAccountSearchBase] <String[]>] [-SaveADReports] [[-ReportFolder] ] [-SaveReport]\n []\n"
})
}), "\n", _jsx(_components.h2, {
id: "description",
children: "DESCRIPTION"
}), "\n", _jsx(_components.p, {
children: "Checks attributes on Active Directory objects against a set of compliance rules and provides a report.\nIt also\ntakes several attributes and makes them human readable."
}), "\n", _jsx(_components.h2, {
id: "examples",
children: "EXAMPLES"
}), "\n", _jsx(_components.h3, {
id: "example-1",
children: "EXAMPLE 1"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Get-ADComplianceReport\n"
})
}), "\n", _jsx(_components.p, {
children: "Example of how to use this cmdlet.\nWill default to OUs in config file."
}), "\n", _jsx(_components.h3, {
id: "example-2",
children: "EXAMPLE 2"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Get-ADComplianceReport -UserSearchBase 'OU=Example User OU,DC=keldor,DC=dev'\n"
})
}), "\n", _jsx(_components.p, {
children: "Will search the 'OU=Example User OU,DC=keldor,DC=dev' OU for user objects and report on them."
}), "\n", _jsx(_components.h3, {
id: "example-3",
children: "EXAMPLE 3"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Get-ADComplianceReport -UserSearchBase 'OU=Example User OU,DC=keldor,DC=dev' -SaveReport\n"
})
}), "\n", _jsx(_components.p, {
children: "Will search the 'OU=Example User OU,DC=keldor,DC=dev' OU for user objects and because the -ReportFolder parameter\nis not used to specify a path, it will save the report to C:\Scripts."
}), "\n", _jsx(_components.h2, {
id: "parameters",
children: "PARAMETERS"
}), "\n", _jsx(_components.h3, {
id: "-admingroupsearchbase",
children: "-AdminGroupSearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for group objects that have admins."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 4\nDefault value: None\nAccept pipeline input: True (ByPropertyName)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-adminsearchbase",
children: "-AdminSearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for admin objects."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases: Admin, Admins\n\nRequired: False\nPosition: 3\nDefault value: None\nAccept pipeline input: True (ByPropertyName)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-computersearchbase",
children: "-ComputerSearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for computer objects."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases: Computer, Computers\n\nRequired: False\nPosition: 5\nDefault value: None\nAccept pipeline input: True (ByPropertyName)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-msasearchbase",
children: "-MSASearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for Managed Service Account objects."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases: MSA, MSAs, gMSA, sMSA\n\nRequired: False\nPosition: 6\nDefault value: None\nAccept pipeline input: True (ByPropertyName)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-organizationalsearchbase",
children: "-OrganizationalSearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for org boxes or shared account objects."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases: Orgs, Organizational, Shared\n\nRequired: False\nPosition: 7\nDefault value: None\nAccept pipeline input: True (ByPropertyName)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-reportfolder",
children: "-ReportFolder"
}), "\n", _jsx(_components.p, {
children: "Specify where you want to save reports to.\nIf you do not specify a path and use either the SaveADReports or\nSaveReport switches this defaults to C:\Scripts."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 10\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-saveadreports",
children: "-SaveADReports"
}), "\n", _jsx(_components.p, {
children: "Will save data pulled from Active Directory to reports for each object matching their type to path in\nReportFolder parameter."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: SwitchParameter\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: Named\nDefault value: False\nAccept pipeline input: False\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-savereport",
children: "-SaveReport"
}), "\n", _jsx(_components.p, {
children: "Will save the report in csv format.\nIf a path isn't specified using the ReportFolder parameter it will save to\nC:\Scripts."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: SwitchParameter\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: Named\nDefault value: False\nAccept pipeline input: False\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-serversearchbase",
children: "-ServerSearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for server objects."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases: Servers, MemberServer, MemberServers, DomainControllers\n\nRequired: False\nPosition: 8\nDefault value: None\nAccept pipeline input: True (ByPropertyName)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-serviceaccountsearchbase",
children: "-ServiceAccountSearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for Service Account objects."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases: ServiceAccounts\n\nRequired: False\nPosition: 9\nDefault value: None\nAccept pipeline input: True (ByPropertyName)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-usergroupsearchbase",
children: "-UserGroupSearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for group objects that have users."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 2\nDefault value: None\nAccept pipeline input: True (ByPropertyName)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-usersearchbase",
children: "-UserSearchBase"
}), "\n", _jsx(_components.p, {
children: "Specify the distinguishedName(s) of organizational units (OUs) to search for user objects."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String[]\nParameter Sets: (All)\nAliases: User, Users\n\nRequired: False\nPosition: 1\nDefault value: None\nAccept pipeline input: True (ByPropertyName, ByValue)\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "commonparameters",
children: "CommonParameters"
}), "\n", _jsxs(_components.p, {
children: ["This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see ", _jsx(_components.a, {
href: "http://go.microsoft.com/fwlink/?LinkID=113216",
children: "about_CommonParameters"
}), "."]
}), "\n", _jsx(_components.h2, {
id: "inputs",
children: "INPUTS"
}), "\n", _jsx(_components.h3, {
id: "systemstring",
children: "System.String"
}), "\n", _jsx(_components.h2, {
id: "outputs",
children: "OUTPUTS"
}), "\n", _jsx(_components.h3, {
id: "systemmanagementautomationpscustomobject",
children: "System.Management.Automation.PSCustomObject"
}), "\n", _jsx(_components.h2, {
id: "notes",
children: "NOTES"
}), "\n", _jsx(_components.p, {
children: "Author: Skyler Hart\nCreated: 2019-07-02 13:32:53\nLast Edit: 2023-05-06 21:50:15\nRequires:\n-Module ActiveDirectory"
}), "\n", _jsx(_components.h2, {
id: "related-links",
children: "RELATED LINKS"
}), "\n", _jsx(_components.p, {
children: _jsx(_components.a, {
href: "https://docs.keldor.dev",
children: "https://docs.keldor.dev"
})
})]
});
}
export default function MDXContent(props = {}) {
const {wrapper: MDXLayout} = {
..._provideComponents(),
...props.components
};
return MDXLayout ? _jsx(MDXLayout, {
...props,
children: _jsx(_createMdxContent, {
...props
})
}) : _createMdxContent(props);
}