en-US/ADReportingTools-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADBackupStatus</command:name> <command:verb>Get</command:verb> <command:noun>ADBackupStatus</command:noun> <maml:description> <maml:para>Get an Active Directory backup status</maml:para> </maml:description> </command:details> <maml:description> <maml:para>There aren't any explicit PowerShell commands to tell if Active Directory has been backed up. One indirect approach is to use the command-line tool repadmin.exe. This command has a /showbackup parameter which will indicate when the different Active Directory partitions have been backed up. This command is a PowerShell wrapper for repadmin.exe that runs on the specified domain controller in a PowerShell remoting session.</maml:para> <maml:para>If running in a console host, the date value may be shown in red, if the date is beyond the backup limit of 3 days. This is a user-customizable value in $ADReportingHash.</maml:para> <maml:para>$ADReportinghash.BackupLimit = 5</maml:para> <maml:para>If you want a limit like this all the time, in your PowerShell profile script import the module and add this line.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADBackupStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DomainController</maml:name> <maml:description> <maml:para>Specify the name of a domain controller</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DomainController</maml:name> <maml:description> <maml:para>Specify the name of a domain controller</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADBackupStatus dom1 DomainController: Dom1.Company.Pri Partition LocalUSN OriginUSN Date --------- -------- --------- ---- DC=ForestDnsZones,DC=Company,DC=Pri 13777 13777 01/25/2021 14:27:01 DC=DomainDnsZones,DC=Company,DC=Pri 13776 13776 01/25/2021 14:27:01 CN=Schema,CN=Configuration,DC=Comp.... 13775 13775 01/25/2021 14:27:01 CN=Configuration,DC=Company,DC=Pri 13774 13774 01/25/2021 14:27:01 DC=Company,DC=Pri 13773 13773 01/25/2021 14:27:01</dev:code> <dev:remarks> <maml:para>Any date that is beyond the number of days that is beyond $ADReportingHash.BackupLimit, will be displaySed in red, if running in a console host.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://bit.ly/3fPV1AE</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NTDSInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>repadmin.exe</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADBranch</command:name> <command:verb>Get</command:verb> <command:noun>ADBranch</command:noun> <maml:description> <maml:para>Get a listing of members in an AD branch.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will get all users, groups, and computers from a given Active Directory organizational unit or container and display a hierarchical report. The search is recursive from the starting search base.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADBranch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeletedObjects</maml:name> <maml:description> <maml:para>Show deleted objects. This parameter has no effect unless you are searching from the domain root.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeContainers</maml:name> <maml:description> <maml:para>Exclude containers like USERS. This will only have no effect unless your search base is the domain root.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectClass</maml:name> <maml:description> <maml:para>Only show objects of the matching classes. Valid choices are user, group, and computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeletedObjects</maml:name> <maml:description> <maml:para>Show deleted objects. This parameter has no effect unless you are searching from the domain root.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeContainers</maml:name> <maml:description> <maml:para>Exclude containers like USERS. This will only have no effect unless your search base is the domain root.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectClass</maml:name> <maml:description> <maml:para>Only show objects of the matching classes. Valid choices are user, group, and computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADBranchMember</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADBranch "OU=IT,DC=company,DC=pri" DistinguishedName Name Description ----------------- ---- ----------- CN=AprilS,OU=IT,DC=Company,DC=Pri AprilS PowerShell Guru Branch: OU=It,DC=Company,DC=Pri [User] DistinguishedName Name Description ----------------- ---- ----------- CN=ArtD,OU=IT,DC=Company,DC=Pri ArtD PowerShell Engineer CN=GladysK,OU=IT,DC=Company,DC=Pri GladysK Senior AD and Ide... CN=MaryL,OU=IT,DC=Company,DC=Pri MaryL Main IT CN=MikeS,OU=IT,DC=Company,DC=Pri MikeS Backup IT Branch: OU=It,DC=Company,DC=Pri [Group] DistinguishedName Name Description ----------------- ---- ----------- CN=IT,OU=IT,DC=Company,DC=Pri IT CN=Web Servers,OU=IT,DC=Company,DC=Pri Web Servers ...</dev:code> <dev:remarks> <maml:para>Get members of the IT organizational unit. There is a formatting bug where the first item isn't properly grouped.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADBranch "Ou=accounting,Dc=company,dc=pri" -objectclass group DistinguishedName Name Description ----------------- ---- ----------- CN=Accounting,OU=Accounting, Accounting Company Accounting DC=Company,DC=Pri Branch: OU=Corp Investment,OU=Finance,OU=Accounting,DC=Company,DC=Pri [Group] DistinguishedName Name Description ----------------- ---- ----------- CN=StrategyDL,OU=Corp StrategyDL Strategic plann... Investment,OU=Finance,OU=Accounting, DC=Company,DC=Pri Branch: OU=Payroll,OU=Accounting,DC=Company,DC=Pri [Group] DistinguishedName Name Description ----------------- ---- ----------- CN=Payroll Managers,OU=Payroll, Payroll Managers OU=Accounting,DC=Company,DC=Pri</dev:code> <dev:remarks> <maml:para>Get only groups in the Accounting OU tree.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://bit.ly/3tbCeDc</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-Domain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADCanonicalUser</command:name> <command:verb>Get</command:verb> <command:noun>ADCanonicalUser</command:noun> <maml:description> <maml:para>Get an AD user account using a canonical name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Often you will find user names in the form domain\username. This command makes it easier to find the Active Directory user account using this value. If you have enabled the Active Directory Recycle Bin feature, you can use the IncludeDeletedObjects parameter to search for the user account if it can't be found with the initial search.</maml:para> <maml:para>There is an assumption that you will know the domain controller responsible for the given domain component. Or that all accounts are in your current user domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADCanonicalUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter the username in the form domain\username.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeletedObjects</maml:name> <maml:description> <maml:para>Search deleted objects if the user account can't be found.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Enter one or more user properties or * to select everything.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeletedObjects</maml:name> <maml:description> <maml:para>Search deleted objects if the user account can't be found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter the username in the form domain\username.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Enter one or more user properties or * to select everything.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.ActiveDirectory.Management.ADUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADCanonicalUser company\gladysk -Properties title,description,department Department : IT Description : Senior AD and Identity Goddess DistinguishedName : CN=GladysK,OU=IT,DC=Company,DC=Pri Enabled : True GivenName : Gladys Name : GladysK ObjectClass : user ObjectGUID : 445c8817-3c53-4861-9221-407b5af8bdc6 SamAccountName : GladysK SID : S-1-5-21-493037332-564925384-1585924867-1105 Surname : Kravitz Title : AD Operations Lead UserPrincipalName : gladysk@Company.Pri</dev:code> <dev:remarks> <maml:para>Get the Active Directory user account for Company\Gladysk and some select properties.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $a = Get-ADUserAudit -Since "2/1/2021" -Events Disabled PS C:\> $a.targets | Get-Unique | Get-ADCanonicalUser | Select-Object DistinguishedName DistinguishedName ----------------- CN=MaryL,OU=IT,DC=Company,DC=Pri CN=E.Ratti,OU=Employees,DC=Company,DC=Pri CN=Roy Biv,OU=Accounting,DC=Company,DC=Pri CN=D.Monroy,OU=Employees,DC=Company,DC=Pri CN=MaryL,OU=IT,DC=Company,DC=Pri CN=S.Montbriand,OU=Employees,DC=Company,DC=Pri CN=R.Freil,OU=Employees,DC=Company,DC=Pri CN=N.Wobser,OU=Employees,DC=Company,DC=Pri CN=Y.Graffney,OU=Employees,DC=Company,DC=Pri CN=D.Waldow,OU=Employees,DC=Company,DC=Pri</dev:code> <dev:remarks> <maml:para>The first command is using the Get-ADUserAudit command to find all user accounts disabled since February 1. The resulting targets in the canonical name format. These values are piped to Get-ADCanonicalUser to retrieve the corresponding distinguished name values.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/38yrc2R</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADComputerReport</command:name> <command:verb>Get</command:verb> <command:noun>ADComputerReport</command:noun> <maml:description> <maml:para>Get AD Computer account information</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-ADComputerReport will gather information about computer objects in Active Directory. The default is to find all objects. But you can filter on a category of Server or Desktop. The filtering is done based on the operating system value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADComputerReport</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter an AD conmputer identity. Wildcard are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Filter by the operating system.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Any</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Server</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Desktop</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>Filter by location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Filter by the operating system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>Filter by location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter an AD conmputer identity. Wildcard are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADComputerInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADComputerReport Name Description Location IPAddress LastLogonDate ---- ----------- -------- --------- ------------- DOM1 HQ domain controllers hqdc 192.168.3.10 3/26/2021 3:12... DOM2 HQ domain controllers hqdc 192.168.3.11 3/26/2021 3:21... Mail01 SRV1 corp resource server hqdc 192.168.3.50 3/26/2021 10:4... SRV2 Omaha 192.168.3.51 3/26/2021 10:4... ...</dev:code> <dev:remarks> <maml:para>If you are running in a PowerShell console, domain controllers and member servers will be highlighted with an ANSI sequence.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADComputerReport -Name srv1 | select * Name : SRV1 DNSHostname : SRV1.Company.Pri Description : corp resource server OperatingSystem : Windows Server 2016 Standard Evaluation IsServer : True Location : hqdc LastLogonDate : 3/26/2021 10:45:27 AM IPAddress : 192.168.3.50 Created : 1/25/2021 1:33:02 PM Modified : 3/26/2021 9:04:03 PM DistinguishedName : CN=SRV1,CN=Computers,DC=Company,DC=Pri</dev:code> <dev:remarks> <maml:para>Get all report properties.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3dFHB7E</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADDomainControllerHealth</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADManager</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADComputer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADDepartment</command:name> <command:verb>Get</command:verb> <command:noun>ADDepartment</command:noun> <maml:description> <maml:para>Get members of a department from Active Directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this command to retrieve user account information from Active Directory for members of a specific department. You can specify multiple departments. User information is displayed in a grouped table by default.</maml:para> <maml:para>When you import the ADReportingTools module, it will define a global variable called ADReportingHash, which is a hashtable. The variable has a key called Departments. This variable is used in an argument completer for the -Department parameter. This allows you to tab-complete the parameter value. If you add a department after loading the module, you will need to update the variable. You can manually add a department:</maml:para> <maml:para>$ADReportingHash.Departments+='Bottle Washing'</maml:para> <maml:para>Or reload the module:</maml:para> <maml:para>Import-Module ADReportingTools -force</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADDepartment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Department</maml:name> <maml:description> <maml:para>Specify one or more department names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="runas"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify alternate credentials for authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DC"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="runas"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify alternate credentials for authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Department</maml:name> <maml:description> <maml:para>Specify one or more department names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DC"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADDeptMember</maml:name> </dev:type> <maml:description> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert /> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADDepartment -Department sales -Server dom1 -Credential company\artd Department: Sales Name Title City Phone ---- ----- ---- ----- Sonya Smith Account Executive Omaha x2345 Garret Guillary Intern Omaha x8877 Sam Smith Sales Support Omaha x5678 Samantha Smith Sales Assistant Omaha x9875</dev:code> <dev:remarks> <maml:para>Get all members of the Sales department. This example queries a specific domain controller and uses alternate credentials. If your PowerShell session supports it, disabled accounts will be displayed in red.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADDepartment Sales | Format-Table -view manager Manager: CN=Alfonso Dente,OU=Sales,DC=Company,DC=Pri [Sales] Name Description Title City ---- ----------- ----- ---- Sonya Smith Sales Account Executive Omaha Manager: CN=SamanthaS,OU=Sales,DC=Company,DC=Pri [Sales] Name Description Title City ---- ----------- ----- ---- Garret Guillary sales intern Intern Omaha Manager: CN=SonyaS,OU=Sales,DC=Company,DC=Pri [Sales] Name Description Title City ---- ----------- ----- ---- Sam Smith Sales Sales Support Omaha Samantha Smith Sales Sales Assistant Omaha</dev:code> <dev:remarks> <maml:para>The command has a corresponding formatting file with a custom view.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ADUserCategory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADDomainControllerHealth</command:name> <command:verb>Get</command:verb> <command:noun>ADDomainControllerHealth</command:noun> <maml:description> <maml:para>Get a summary view of domain controller health.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command is intended to give you a quick summary of the overall health of your Active Directory domain controllers. The concept of "health" is based on the following:</maml:para> <maml:para>- How much free space remains on drive C:?</maml:para> <maml:para>- How much free physical memory?</maml:para> <maml:para>- What percentage of the Security event log is in use?</maml:para> <maml:para>- Are any critical services not running?</maml:para> <maml:para></maml:para> <maml:para>The services checked are ntds,kdc,adws,dfs,dfsr,netlogon,samss, and w32time. Not every organization runs DNS and/or DHCP on their domain controllers so those services have been omitted.</maml:para> <maml:para>Output will be color-coded using ANSI escape sequences.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADDomainControllerHealth</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADDomainControllerHealth</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADDomainControllerHealth DC: DOM1.Company.Pri [192.168.3.10] Uptime PctFreeC PctFreeMem PctSecLog ServiceAlert ------ -------- ---------- --------- ------------ 12.22:29:47 89.61 25.17 33.8 False DC: DOM2.Company.Pri [192.168.3.11] Uptime PctFreeC PctFreeMem PctSecLog ServiceAlert ------ -------- ---------- --------- ------------ 5.16:38:00 90.63 48.36 14.56 True</dev:code> <dev:remarks> <maml:para>Get a health snapshot of your domain controllers. A ServiceAlert of True means that one of the defined critical services is not running.</maml:para> <maml:para>Output might be color-coded. A ServiceAlert value of True will be displayed in Red. Free space on C and percent free physical memory will be shown in red if the value is 10% or less. A percent free less than 30$ will be displayed in an orange/yellow color. The percent Security log usage threshholds are 15% and 50%.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADDomainControllerHealth | Format-Table -view info Domain Controller: CN=DOM1,OU=Domain Controllers,DC=Company,DC=Pri OperatingSystem IsGC IsRO Roles --------------- ---- ---- ----- Windows Server 2019 Standard True False {SchemaMaster,DomainNam... Domain Controller: CN=DOM2,OU=Domain Controllers,DC=Company,DC=Pri OperatingSystem IsGC IsRO Roles --------------- ---- ---- ----- Windows Server 2019 Standard True False {}</dev:code> <dev:remarks> <maml:para>Get domain controller health using a custom table view.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADDomainControllerHealth | Select-Object -Expand Services Computername: DOM1.Company.Pri ProcessID Displayname Name State StartMode Started --------- ----------- ---- ----- --------- ------- 2544 Active Directory Web Services ADWS Running Auto True 2652 DFS Namespace Dfs Running Auto True 2624 DFS Replication DFSR Running Auto True 660 Kerberos Key Distribution Center Kdc Running Auto True 660 Netlogon Netlogon Running Auto True 660 Active Directory Domain Services NTDS Running Auto True 660 Security Accounts Manager SamSs Running Auto True 1028 Windows Time W32Time Running Auto True ...</dev:code> <dev:remarks> <maml:para>View the service status for each domain controller.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/38u96PJ</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADDomainController</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADFSMO</command:name> <command:verb>Get</command:verb> <command:noun>ADFSMO</command:noun> <maml:description> <maml:para>Get FSMO holders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will display all FSMO role holders for the forest and domain at a glance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADFSMO</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="name"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the domain name. The default is the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="name"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the domain name. The default is the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADFSMORole</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> PS C:\> Get-ADFSMO Domain: Company.Pri Forest: Company.Pri PDCEmulator : DOM1.Company.Pri RIDMaster : DOM1.Company.Pri InfrastructureMaster : DOM1.Company.Pri SchemaMaster : DOM1.Company.Pri DomainNamingMaster : DOM1.Company.Pri</dev:code> <dev:remarks> <maml:para>Get the FSMO holders for the current domain and forest.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3ctNioz</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADSummary</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADForest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADGroupReport</command:name> <command:verb>Get</command:verb> <command:noun>ADGroupReport</command:noun> <maml:description> <maml:para>Create a custom group report</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-ADGroupReport will create a custom report for a group showing members. Get-ADGroupUser is intended to display group membership details Get-ADGroupReport focuses on the group, although members are also displayed. Members are always gathered recursively. You can filter for specific types of groups. You can also opt to exclude groups under CN=Users and CN=BuiltIn. The groups "Domain Users", "Domain Computers", and "Domain Guests" are always excluded from this command.</maml:para> <maml:para>If your PowerShell hosts supports it, ANSI color schemes will be used to highlight things such as Distribution groups and disabled user accounts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADGroupReport</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter an AD Group name. Wildcards are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Filter on the group category</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Distribution</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Security</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeBuiltIn</maml:name> <maml:description> <maml:para>Exclude BuiltIn and Users. Domain Users, Domain Guests, and Domain Computers are always excluded regardless of this parameter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter on group scope</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Any</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DomainLocal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Universal</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Any</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Filter on the group category</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeBuiltIn</maml:name> <maml:description> <maml:para>Exclude BuiltIn and Users. Domain Users, Domain Guests, and Domain Computers are always excluded regardless of this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter an AD Group name. Wildcards are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter on group scope</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Any</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADGroupReport</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADGroupReport sales Name : CN=Sales,OU=Sales,DC=Company,DC=Pri [Global|Security] ManagedBy : CN=SamanthaS,OU=Sales,DC=Company,DC=Pri Description : Sales Force Resources ________________________________________________________________________________ Displayname Name Description DistinguishedName ----------- ---- ----------- ----------------- Sam Smith SamS Sales CN=SamS,OU=Sales,DC=Company,DC=Pri Sonya Smith SonyaS Sales CN=SonyaS,OU=Sales,DC=Company,DC=Pri Samantha Smith SamanthaS Sales CN=SamanthaS,OU=Sales,DC=Company,DC=Pri</dev:code> <dev:remarks> <maml:para>If your PowerShell host supports it, Disabled user accounts will display the distinguished name in red.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADGroupReport -ExcludeBuiltIn | Format-Table -View age Name Members Created Modified Age ---- ------- ------- -------- --- IT 5 1/25/2021 1:32:44 PM 3/15/2021 5:42:50 PM 17:04:02 Sales 3 1/25/2021 1:32:44 PM 3/16/2021 9:52:29 AM 00:54:23 Marketing 3 1/25/2021 1:32:44 PM 3/16/2021 9:52:29 AM 00:54:24 Accounting 3 1/25/2021 1:32:44 PM 3/4/2021 9:25:39 AM 12.01:21:14 JEA Operators 4 1/25/2021 1:32:44 PM 1/28/2021 11:34:57 AM 46.23:11:56 Web Servers 1 1/25/2021 1:32:45 PM 3/15/2021 5:42:33 PM 17:04:20 DevOpsPrimary 0 1/25/2021 4:47:53 PM 1/27/2021 10:35:11 AM 48.00:11:42 DevOpsBackup 3 1/25/2021 4:48:02 PM 3/16/2021 10:12:01 AM 00:34:52 ...</dev:code> <dev:remarks> <maml:para>If your console supports it, Distribution Lists will be displayed in green, and a member count of 0 will be displayed in red.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADGroupReport -ExcludeBuiltIn | Format-Table -view summary DistinguishedName: CN=IT,OU=IT,DC=Company,DC=Pri Name Members Category Scope Branch ---- ------- -------- ----- ------ IT 5 Security Global OU=IT,DC=Company,DC=Pri DistinguishedName: CN=Sales,OU=Sales,DC=Company,DC=Pri Name Members Category Scope Branch ---- ------- -------- ----- ------ Sales 3 Security Global OU=Sales,DC=Company,DC=Pri DistinguishedName: CN=Marketing,OU=Marketing,DC=Company,DC=Pri Name Members Category Scope Branch ---- ------- -------- ----- ------ Marketing 3 Security Global OU=Marketing,DC=Company,DC=Pri ...`</dev:code> <dev:remarks> <maml:para>Get groups and format with a custom view. If your console session supports it, some of the output will be color-coded with ANSI sequences.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3dBUcZq</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADGroupUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-ADGroupReport</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADGroupMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADManager</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADGroupUser</command:name> <command:verb>Get</command:verb> <command:noun>ADGroupUser</command:noun> <maml:description> <maml:para>Get user members of an AD group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will display all users of a given Active Directory group. The search is automatically recursive. The default output is a formatted table that will highlight disabled accounts in red.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADGroupUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter the name of an Active Directory group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter the name of an Active Directory group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADGroupUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADGroupUser sales DistinguishedName: CN=SamS,OU=Sales,DC=Company,DC=Pri [Sam Smith] Name Title Description PasswordLastSet ---- ----- ----------- -------------- SamS Sales Staff 1/25/2021 1:32:36 PM DistinguishedName: CN=SonyaS,OU=Sales,DC=Company,DC=Pri [Sonya Smith] Name Title Description PasswordLastSet ---- ----- ----------- -------------- SonyaS Account Executive Sales 1/25/2021 1:32:37 PM DistinguishedName: CN=SamanthaS,OU=Sales,DC=Company,DC=Pri [Samantha Smith] Name Title Description PasswordLastSet ---- ----- ----------- -------------- SamanthaS Sales Assistant Sales Staff 1/25/2021 1:32:37 PM</dev:code> <dev:remarks> <maml:para>Disabled accounts will have their distinguished name displayed in red.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADGroupUser sales | format-list Group: CN=Sales,OU=Sales,DC=Company,DC=Pri DistinguishedName : CN=SamS,OU=Sales,DC=Company,DC=Pri Name : SamS Displayname : Sam Smith Description : Sales Staff Title : Department : Sales Enabled : False PasswordLastSet : 3/4/2021 4:03:23 PM DistinguishedName : CN=SonyaS,OU=Sales,DC=Company,DC=Pri Name : SonyaS Displayname : Sonya Smith Description : Sales Title : Account Executive Department : Sales Enabled : True PasswordLastSet : 1/25/2021 1:32:37 PM ...</dev:code> <dev:remarks> <maml:para>Using the defined list view.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/38wecuU</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADGroupReport</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADGroupMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADManager</command:name> <command:verb>Get</command:verb> <command:noun>ADManager</command:noun> <maml:description> <maml:para>Get a manager from Active Directory</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In Active Directory, you can designate a manager for users and objects. From the manager account's perspective, users are designated as DirectReports, and items such as Computers, Groups, and OrganizationalUnits are referred to as ManagedObjects. Get-ADManager is a simple way to get a manager account and view everything that they manage. The default is to get all users and all objects, but you can filter using command parameters. Note that if you filter to show only DirectReports or only ManagedObjects, the other property will show a count of 0, even if there are managed items.</maml:para> <maml:para>If you are running in a PowerShell console host, the default output will be colorized with ANSI escape sequences.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADManager</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter an Active Directory account's SAMAccountname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Detail</maml:name> <maml:description> <maml:para>Specify what managed detail you want.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DirectReports</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ManagedObjects</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectClass</maml:name> <maml:description> <maml:para>Specify what managed object class you want. The default is everything. This parameter has no effect if you only get Direct Reports.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OU</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Detail</maml:name> <maml:description> <maml:para>Specify what managed detail you want.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter an Active Directory account's SAMAccountname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectClass</maml:name> <maml:description> <maml:para>Specify what managed object class you want. The default is everything. This parameter has no effect if you only get Direct Reports.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADManager</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADManager artd Name : CN=ArtD,OU=IT,DC=Company,DC=Pri [ArtD] Title : IT Operations Lead Description : PowerShell Engineer Direct Reports : 1 User: CN=GladysK,OU=IT,DC=Company,DC=Pri [GladysK] DisplayName Description Title Department ----------- ----------- ----- ---------- Gladys Kravitz Senior AD and Identity Goddess AD Operations Lead IT Managed Objects : 11 Computer CN=DOM2,OU=Domain Controllers,DC=Company,DC=Pri [DOM2.Company.Pri] Name Location IPAddress OperatingSystem Description ---- -------- --------- --------------- ----------- DOM2 hqdc 192.168.3.11 Windows Server 2019 HQ domain controllers CN=RX-ba-3465-fb,CN=Computers,DC=Company,DC=Pri [] Name Location IPAddress OperatingSystem Description ---- -------- --------- --------------- ----------- RX-ba-3465-fb ...</dev:code> <dev:remarks> <maml:para>Get the manager account ArtD and show all direct reports and managed objects.Disabled computer and user accounts will be shown in Red.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADManager Gladysk -Detail DirectReports Name : CN=GladysK,OU=IT,DC=Company,DC=Pri [GladysK] Title : AD Operations Lead Description : Senior AD and Identity Goddess Direct Reports : 4 User: CN=Darren Stevens,OU=Help Desk,OU=IT,DC=Company,DC=Pri [Darren Stevens] DisplayName Description Title Department ----------- ----------- ----- ---------- Darren Stevens Darren 1 IT Audit Information Services User: CN=Gustav Klimt,OU=Help Desk,OU=IT,DC=Company,DC=Pri [Gustav Klimt] DisplayName Description Title Department ----------- ----------- ----- ---------- Gustav Klimt Help Desk Staff Tier I ...</dev:code> <dev:remarks> <maml:para>Only display the managers direct reports.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADManager Gladysk -Detail ManagedObjects -ObjectClass Group,OU Name : CN=GladysK,OU=IT,DC=Company,DC=Pri [GladysK] Title : AD Operations Lead Description : Senior AD and Identity Goddess Direct Reports : 0 Managed Objects : 6 Computer OrganizationalUnit DistinguishedName: OU=Research,DC=Company,DC=Pri Name Description ---- ----------- Research DistinguishedName: OU=TechStaff,OU=Help Desk,OU=IT,DC=Company,DC=Pri Name Description ---- ----------- TechStaff Help and Support Staff accounts Group Group: CN=AcctTalk,OU=Accounting,DC=Company,DC=Pri [Universal|Distribution] Name Description ---- ----------- AcctTalk company finance mail list Group: CN=JEA Operators,OU=JEA_Operators,DC=Company,DC=Pri [Global|Security] Name Description ---- ----------- JEA Operators Trusted JEA users ...</dev:code> <dev:remarks> <maml:para>Display Groups and Organizational Units managed by the specified user. OUs not marked for protection from deletion will be shown in red. Universal and Distribution groups will be highlighted by color as well.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-ADGroupReport</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADComputerReport</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADReportingTools</command:name> <command:verb>Get</command:verb> <command:noun>ADReportingTools</command:noun> <maml:description> <maml:para>Get a summary list of AD Reporting commands</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will present a summary of commands in the ADReportingTools module grouped by verb. The default output will show the command name, any defined aliases, and the help synopsis.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADReportingTools</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADReportingTool</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADReportingTools</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3vtugaC</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-ADReportingToolsHelp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Module</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Command</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADReportingToolsOptions</command:name> <command:verb>Get</command:verb> <command:noun>ADReportingToolsOptions</command:noun> <maml:description> <maml:para>Get ADReportingTools color options</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Many of the commands in the ADReportingTools module have custom format files that utilize ANSI escape sequences to highlight key elements. The module defaults are stored in a variable called ADReportingToolsOptions. Use this command to view the current settings. If you access the variable directly, you won't see the actual ANSI settings, and you might have to reset your console by typing "$([char]0x1b)[0m".</maml:para> <maml:para>The ANSI sequences use the [char]0x1b escape character because it works in both Windows PowerShell and PowerShell 7.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADReportingToolsOptions</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADReportingToolsOption</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>An easy way to see ANSI samples is to install the PSScriptTools module from the PowerShell Gallery and use the Show-ANSISequence command.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADReportingToolsOptions Name Value ---- ----- Alert $([char]0x1b)[91m Warning $([char]0x1b)[38;5;220m DistributionList $([char]0x1b)[92m</dev:code> <dev:remarks> <maml:para>The actual values will be color-coded with the ANSI sequence.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/2RiXoln</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ADReportingToolsOIptions</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADSiteDetail</command:name> <command:verb>Get</command:verb> <command:noun>ADSiteDetail</command:noun> <maml:description> <maml:para>Get a more detailed AD site report.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will present a summary report of your Active Directory sites showing a description, associated subnets, and when the site object was created and last modified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADSiteDetail</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the name of an Active Directory site. The default is all sites.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the name of an Active Directory site. The default is all sites.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADSiteDetail</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADSiteDetail Name: Default-First-Site-Name Description Subnets Created Modified ----------- ------- ------- -------- Home Office {192.168.3.0/24, 19... 2/23/2021 3:36:58 PM 2/23/2021... Name: NoCal Description Subnets Created Modified ----------- ------- ------- -------- Bay Area Office 172.17.0.0/16 2/23/2021 3:38:33 PM 2/23/2021...</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/38QzYK3</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADSiteSummary</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADReplicationSite</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADSiteSummary</command:name> <command:verb>Get</command:verb> <command:noun>ADSiteSummary</command:noun> <maml:description> <maml:para>Get summary information about AD sites.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will display a summary report of each Active Directory site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADSiteSummary</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the name of an Active Directory site. The default is all sites.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the name of an Active Directory site. The default is all sites.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADSiteSummary</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADSiteSummary Site: Default-First-Site-Name Description: Home Office Subnet Description Location ------ ----------- -------- 192.168.3.0/24 Employees 192.168.99.0/24 Datacenter HQDC Site: NoCal Description: Bay Area Office Subnet Description Location ------ ----------- -------- 172.17.0.0/16</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3esumcq</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADSiteDetail</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADReplicationSite</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADSummary</command:name> <command:verb>Get</command:verb> <command:noun>ADSummary</command:noun> <maml:description> <maml:para>Get a summary report of your AD domain and forest.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This simple command will give you a snapshot-sized summary of your Active Directory domain and forest.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADSummary</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="name"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the domain name. The default is the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="name"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the domain name. The default is the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADSummary</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADSummary Forest: Company.Pri [Windows2016Forest] RootDomain : Company.Pri Domains : {Company.Pri} Domain : Company.Pri DomainMode : Windows2016Domain DomainControllers : {DOM1.Company.Pri, DOM2.Company.Pri} GlobalCatalogs : {DOM1.Company.Pri, DOM2.Company.Pri} SiteCount : 2</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/38BNf98</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADFSMO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADForest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADUserAudit</command:name> <command:verb>Get</command:verb> <command:noun>ADUserAudit</command:noun> <maml:description> <maml:para>Audit AD user management events.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will search the Security event logs on your domain controllers for specific user-related events. These activities are not replicated, so you have to search each domain controller. Be aware that you may see related events for some actions. For example, if you create and enable a new user, you'll see multiple entries for the same event.</maml:para> <maml:para>The output will show you the user accounts that match the search criteria, and the domain account that was responsible. Although, this command can't tell you which administrator is responsible for which activity. The best you can learn is that for a given time frame, these user accounts were managed. Or these administrators did something. You would need to search the event log on the domain controller for more information.</maml:para> <maml:para>You may need to enable logging and/or increase the size of the Security event log.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADUserAudit</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DomainController</maml:name> <maml:description> <maml:para>Specify one or more domain controllers to query. The default is all domain controllers in the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Events</maml:name> <maml:description> <maml:para>Select one or more user account events</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Created</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Deleted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Changed</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Since</maml:name> <maml:description> <maml:para>Find all matching user management events since what date and time?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DomainController</maml:name> <maml:description> <maml:para>Specify one or more domain controllers to query. The default is all domain controllers in the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Events</maml:name> <maml:description> <maml:para>Select one or more user account events</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Since</maml:name> <maml:description> <maml:para>Find all matching user management events since what date and time?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>An earlier version of this command was first published at: http://bit.ly/ADUserAudit</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-aduseraudit -Events Created -Since 2/1/2021 DomainController: DOM1.Company.Pri EventType : UserCreated Since : 2/1/2021 12:00:00 AM TargetCount : 10 Targets : {COMPANY\darrens, COMPANY\S.Talone, COMPANY\ntesla, COMPANY...} Administrators : {COMPANY\ArtD, COMPANY\Administrator, COMPANY\GladysK, COMP...} DomainController: DOM2.Company.Pri EventType : UserCreated Since : 2/1/2021 12:00:00 AM TargetCount : 6 Targets : {COMPANY\astark, COMPANY\georgejet, COMPANY\maef, COMPANY\bo..} Administrators : {COMPANY\GladysK, COMPANY\ArtD}</dev:code> <dev:remarks> <maml:para>Find all user accounts created since February 1, 2021.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3cponT4</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-WinEvent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADUserCategory</command:name> <command:verb>Get</command:verb> <command:noun>ADUserCategory</command:noun> <maml:description> <maml:para>Get AD User information based on category</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-ADUserCategory is based on the concept of getting user information from a pre-defined category. For example, you might want to get the properties DisplayName, Name, Title, Department, and Manager for a Department category. The ADReportingTools module will define a set of pre-defined categories that you can reference through $ADUserReportingConfiguration.</maml:para> <maml:para>These are the current defaults.</maml:para> <maml:para>Department DisplayName,Name,Title,Department,Manager Basic DisplayName,Name,SamAccountname,UserPrincipalName,Enabled,WhenCreated,WhenChanged Address DisplayName,Name,TelephoneNumber,Office,StreetAddress,POBox,City,State,PostalCode Organization DisplayName,Name,Title,Department,Manager,Company,Office Pwinfo DisplayName,Name,PasswordExpired,PasswordLastSet,PasswordNeverExpires</maml:para> <maml:para>The user's distinguishedname will always be included.</maml:para> <maml:para>You don't have to remember what property names to include or reference.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADUserCategory</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify an AD filter like "department -eq 'sales'". The default is all Enabled user accounts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Select a defined category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ADUserCategory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Enter an AD user identity</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Select a defined category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Select a defined category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential. This will be used to query the domain and all domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify an AD filter like "department -eq 'sales'". The default is all Enabled user accounts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Enter an AD user identity</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query for a list of domain controllers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADUserCategory</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ADUserCategory artd -Category basic DistinguishedName : CN=ArtD,OU=IT,DC=Company,DC=Pri DisplayName : Art Deco Name : ArtD SamAccountname : ArtD UserPrincipalName : artd@company.com Enabled : True WhenCreated : 1/25/2021 1:32:35 PM WhenChanged : 3/11/2021 6:32:58 PM</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADUserCategory -filter "department -eq 'sales'" -Category Department DistinguishedName : CN=SamS,OU=Sales,DC=Company,DC=Pri DisplayName : Sam Smith Name : SamS Title : Department : Sales Manager : CN=SonyaS,OU=Sales,DC=Company,DC=Pri DistinguishedName : CN=SonyaS,OU=Sales,DC=Company,DC=Pri DisplayName : Sonya Smith Name : SonyaS Title : Account Executive Department : Sales Manager : DistinguishedName : CN=SamanthaS,OU=Sales,DC=Company,DC=Pri DisplayName : Samantha Smith Name : SamanthaS Title : Sales Assistant Department : Sales Manager : CN=SonyaS,OU=Sales,DC=Company,DC=Pri</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $ADUserReportingConfiguration += [pscustomobject]@{Name="Custom";Properties="DisplayName","Description"} PS C:\> Get-ADUserCategory -filter "givenname -like 'a*'" -Category custom DistinguishedName DisplayName Description ----------------- ----------- ----------- CN=AaronS,OU=Accounting,DC=Company,DC=Pri Aaron Smith Accountant CN=Al Fresco,OU=Dev,DC=Company,DC=Pri Al Fresco CN=A.Henaire,OU=Employees,DC=Company,DC=Pri Alexander Henaire CN=Alfonso Dente,OU=Sales,DC=Company,DC=Pri Alfonso Dente CN=AndreaS,OU=Accounting,DC=Company,DC=Pri Andrea Smith Accountant CN=AndyS,OU=Accounting,DC=Company,DC=Pri Andy Smith Accountant CN=Anthony Stark,OU=Research,DC=Company,DC=Pri Tony Stark CN=AprilS,OU=IT,DC=Company,DC=Pri April Showers PowerShell Guru CN=A.Fieldhouse,OU=Employees,DC=Company,DC=Pri Aron Fieldhouse sample user ... CN=ArtD,OU=IT,DC=Company,DC=Pri Art Deco PowerShell E... CN=Art Frame,OU=Accounting,DC=Company,DC=Pri Art Frame Test User</dev:code> <dev:remarks> <maml:para>The first command is adding a new category. The second command uses the category.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3eE8o6t</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADDepartmentMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NTDSInfo</command:name> <command:verb>Get</command:verb> <command:noun>NTDSInfo</command:noun> <maml:description> <maml:para>Get information about the NTDS.dit and related files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-NTDSInfo will query a domain controller using PowerShell remoting to get information about the NTDS.dit and related files. You might use this to track the size of the file or to check on backups. A high log count might indicate a backup is needed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NTDSInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="name"> <maml:name>Computername</maml:name> <maml:description> <maml:para>Specify a domain controller name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="name"> <maml:name>Computername</maml:name> <maml:description> <maml:para>Specify a domain controller name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NTDSInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-NTDSInfo -computername dom1 | format-list DomainController : DOM1.Company.Pri Path : C:\NTDS\ntds.dit Size : 16777216 FileDate : 3/26/2021 1:13:26 PM LogCount : 34 Date : 3/26/2021 4:15:00 PM</dev:code> <dev:remarks> <maml:para>The default display is a table. The LogCount is the number of temp edb files in the NTDS folder. The FileDate is the timestamp of ntds.dit, and the Date property reflects when you ran the command.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3dFy3ta</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADBackupStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ADChangeReport</command:name> <command:verb>New</command:verb> <command:noun>ADChangeReport</command:noun> <maml:description> <maml:para>Create an HTML change report.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>New-ADChangeReport will create an HTML report showing changes to Active Directory users, computers, and groups since a given date and time. The command uses Get-ADObject to query the WhenChanged property. The objects are organized by class and/or container and written to an HTML file. The command uses a CSS file from the ADReportingTools module, although you can specify your own. To make the HTML file portable, you can opt to embed the CSS content from a file source.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADChangeReport</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Since</maml:name> <maml:description> <maml:para>Enter a last modified datetime for AD objects. The default is the last 4 hours.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AuthType</maml:name> <maml:description> <maml:para>Specifies the authentication method to use. Possible values for this parameter include:</maml:para> <maml:para> Negotiate or 0</maml:para> <maml:para> Basic or 1</maml:para> <maml:para> The default authentication method is Negotiate.</maml:para> <maml:para> A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Negotiate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Basic</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Negotiate</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ByContainer</maml:name> <maml:description> <maml:para>Add a second grouping based on the object's container or OU.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>-CSSUri</maml:name> <maml:description> <maml:para>Specify the path to the CSS file. If you don't specify one, the default module file will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>changereport.css</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential for authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmbedCSS</maml:name> <maml:description> <maml:para>Embed the CSS file into the HTML document head. You can only embed from a file, not a URL.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Logo</maml:name> <maml:description> <maml:para>Specify the path to an image file to use as a logo in the report.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path for the output file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReportTitle</maml:name> <maml:description> <maml:para>What is the report title?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"Active Directory Change Report"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the Active Directory Domain Services domain controller to query. The default is your Logon server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AuthType</maml:name> <maml:description> <maml:para>Specifies the authentication method to use. Possible values for this parameter include:</maml:para> <maml:para> Negotiate or 0</maml:para> <maml:para> Basic or 1</maml:para> <maml:para> The default authentication method is Negotiate.</maml:para> <maml:para> A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Negotiate</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ByContainer</maml:name> <maml:description> <maml:para>Add a second grouping based on the object's container or OU.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>-CSSUri</maml:name> <maml:description> <maml:para>Specify the path to the CSS file. If you don't specify one, the default module file will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>changereport.css</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential for authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmbedCSS</maml:name> <maml:description> <maml:para>Embed the CSS file into the HTML document head. You can only embed from a file, not a URL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Logo</maml:name> <maml:description> <maml:para>Specify the path to an image file to use as a logo in the report.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path for the output file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReportTitle</maml:name> <maml:description> <maml:para>What is the report title?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"Active Directory Change Report"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the Active Directory Domain Services domain controller to query. The default is your Logon server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Since</maml:name> <maml:description> <maml:para>Enter a last modified datetime for AD objects. The default is the last 4 hours.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>An earlier version of this command was first described at https://jdhitsolutions.com/blog/powershell/8087/an-active-directory-change-report-from-powershell/</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-ADChangeReport -Since "3/1/2021" -Path C:\work\March-2021-Change.html -ReportTitle "March AD Change Report" -EmbedCSS</dev:code> <dev:remarks> <maml:para>This example will create a report called March-2021-Change.html with Active Directory changes since March 1, 2021l. The HTML report will use the default CSS file from the ADReportingTools module and embed it into the file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3dFGuoh</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ADDomainReport</command:name> <command:verb>New</command:verb> <command:noun>ADDomainReport</command:noun> <maml:description> <maml:para>Create an HTML report of your domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will create an HTML report of your domain. The report layout is by container and organizational unit. Underneath each branch will be a table display of users, computers, and groups. Beneath each group will be a table of recursive group members. You should get detail about users and computers if you hover the mouse over the distinguished name.</maml:para> <maml:para>The ADReportingTools module includes a CSS file which will be used by default. But you can specify an alternate CSS file. If you want to make the file portable, you can opt to embed the CSS into the HTML file. You can only embed from a file, not a URL reference.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADDomainReport</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="domain"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the domain name. The default is the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CSSUri</maml:name> <maml:description> <maml:para>Specify the path to the CSS file. If you don't specify one, the default module file will be used. The default file is in the Reports folder of this module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmbedCSS</maml:name> <maml:description> <maml:para>Embed the CSS file into the HTML document head. You can only embed from a file, not a URL.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specify the output HTML file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReportTitle</maml:name> <maml:description> <maml:para>Enter the name of the report to be displayed in the web browser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Domain Report</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CSSUri</maml:name> <maml:description> <maml:para>Specify the path to the CSS file. If you don't specify one, the default module file will be used. The default file is in the Reports folder of this module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmbedCSS</maml:name> <maml:description> <maml:para>Embed the CSS file into the HTML document head. You can only embed from a file, not a URL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specify the output HTML file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="domain"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the domain name. The default is the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReportTitle</maml:name> <maml:description> <maml:para>Enter the name of the report to be displayed in the web browser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Domain Report</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.File</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-ADDomainReport -filepath c:\work\company.html -embedcss</dev:code> <dev:remarks> <maml:para>Create the HTML report and embed the default CSS file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3exlja5</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-DomainTree</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ADGroupReport</command:name> <command:verb>New</command:verb> <command:noun>ADGroupReport</command:noun> <maml:description> <maml:para>Create an HTML report of AD groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>New-ADGroupReport will create an HTML report of specified groups from Active Directory. This function is based on Get-ADGroupReport and converts the output to an HTML file. You can specify a CSS file or use the default from the module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADGroupReport</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter an AD Group name. Wildcards are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CSSUri</maml:name> <maml:description> <maml:para>Specify the path the CSS file. If you don't specify one, the default module file will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>groupreport.css</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Filter on the group category.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Distribution</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Security</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmbedCSS</maml:name> <maml:description> <maml:para>Embed the CSS file into the HTML document head. You can only embed from a file, not a URL.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeBuiltIn</maml:name> <maml:description> <maml:para>Exclude BuiltIn and Users containers. Domain Users, Domain Guests, and Domain Computers are always excluded regardless of this parameter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specify the output HTML file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReportTitle</maml:name> <maml:description> <maml:para>Enter the name of the report to be displayed in the web browser</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AD Group Report</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter on group scope</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Any</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DomainLocal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Universal</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CSSUri</maml:name> <maml:description> <maml:para>Specify the path the CSS file. If you don't specify one, the default module file will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>groupreport.css</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Filter on the group category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmbedCSS</maml:name> <maml:description> <maml:para>Embed the CSS file into the HTML document head. You can only embed from a file, not a URL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeBuiltIn</maml:name> <maml:description> <maml:para>Exclude BuiltIn and Users containers. Domain Users, Domain Guests, and Domain Computers are always excluded regardless of this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specify the output HTML file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter an AD Group name. Wildcards are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReportTitle</maml:name> <maml:description> <maml:para>Enter the name of the report to be displayed in the web browser</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AD Group Report</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter on group scope</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchBase</maml:name> <maml:description> <maml:para>Enter the distinguished name of the top-level container or organizational unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.File</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-ADGroupReport -excludeBuiltIn -embedCSS -server dom2 -category security -filepath c:\work\secgroup.html</dev:code> <dev:remarks> <maml:para>This example will create a new HTML report of all Security groups, excluding the built-in groups. Disabled user accounts will be highlighted in red since the command is using the module's CSS file, which is also being embedded. User detail will pop-up when the mouse hovers over the user's distinguishedname.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3uthsPX</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADGroupReport</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-ADReportingToolsHelp</command:name> <command:verb>Open</command:verb> <command:noun>ADReportingToolsHelp</command:noun> <maml:description> <maml:para>Open a PDF help file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Open-ADReportingToolsHelp will launch a PDF file with all module documentation for the ADReportingTools module. The command should launch the file with whatever application is associated with the .PDF extension.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-ADReportingToolsHelp</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Open=ADReportingToolsHelp</dev:code> <dev:remarks> <maml:para>Launch the help PDF file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3usgsM4</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADReportingTools</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADReportingToolsOptions</command:name> <command:verb>Set</command:verb> <command:noun>ADReportingToolsOptions</command:noun> <maml:description> <maml:para>Change an ADReportingToolsOptions setting.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Many of the commands in the ADReportingTools module have custom format files that utilize ANSI escape sequences to highlight key elements. The module defaults are stored in a variable called ADReportingToolsOptions. Use this command to modify a current setting.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADReportingToolsOptions</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify an option.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DistributionList</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ANSI</maml:name> <maml:description> <maml:para>Specify the opening ANSI sequence. The module uses the [char]0x1b escape sequence because it works in both Windows PowerShell and PowerShell 7.x.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ANSI</maml:name> <maml:description> <maml:para>Specify the opening ANSI sequence. The module uses the [char]0x1b escape sequence because it works in both Windows PowerShell and PowerShell 7.x.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify an option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>An easy way to see ANSI samples is to install the PSScriptTools module from the PowerShell Gallery and use the Show-ANSISequence command.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-ADReportingToolsOptions DistributionList -ANSI "$([char]0x1b)[36m"</dev:code> <dev:remarks> <maml:para>This will change the color value for DistributionList entries. The change is not persistent unless you put it in a PowerShell profile script.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3uuvotg</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ADReportingToolsOptions</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-DomainTree</command:name> <command:verb>Show</command:verb> <command:noun>DomainTree</command:noun> <maml:description> <maml:para>Display the domain in a tree format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will display your domain in a tree view at the console. By default, Show-DomainTree will use color-coded ANSI formatting. The default display uses the organizational unit names. Although, you can use the distinguishedname of each branch. If you use -Containers, containers like Users will be included.</maml:para> <maml:para>NOTE: This command will only run in a console host session. It will not run in the PowerShell ISE or VSCode.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-DomainTree</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the domain name. The default is the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cn"> <maml:name>Containers</maml:name> <maml:description> <maml:para>Include containers and non-OU elements. Items with a GUID in the name will be omitted.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dn"> <maml:name>UseDN</maml:name> <maml:description> <maml:para>Display the domain tree using distinguished names.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cn"> <maml:name>Containers</maml:name> <maml:description> <maml:para>Include containers and non-OU elements. Items with a GUID in the name will be omitted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specify an alternate credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the domain name. The default is the user domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dc, domaincontroller"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify a domain controller to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dn"> <maml:name>UseDN</maml:name> <maml:description> <maml:para>Display the domain tree using distinguished names.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Show-DomainTree DC=Company,DC=Pri │ ├── Accounting │ ├── Banking │ ├── Finance │ ├── Corp Investment │ ├── Payroll ├── Dev │ ├── Ops ├── Domain Controllers ├── Employees │ ├── Exec │ ├── VIP │ ├── Temporary Hires ├── IT │ ├── Help Desk │ ├── TechStaff │ ├── Test │ ├── SecOps ├── JEA_Operators ├── Marketing │ ├── Agency ├── Research ├── Sales │ ├── InsideSales │ ├── OutsideSales ├── Servers │ ├── AppDev │ ├── DMZ │ ├── Web │ ├── Staging └── Suspended</dev:code> <dev:remarks> <maml:para>Output will color-coded using ANSI escape sequences.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> PS C:\> Show-DomainTree -usedn DC=Company,DC=Pri │ ├── OU=Accounting,DC=Company,DC=Pri │ ├── OU=Banking,OU=Accounting,DC=Company,DC=Pri │ ├── OU=Finance,OU=Accounting,DC=Company,DC=Pri │ ├── OU=Corp Investment,OU=Finance,OU=Accounting,DC=Company,DC=Pri │ ├── OU=Payroll,OU=Accounting,DC=Company,DC=Pri ├── OU=Dev,DC=Company,DC=Pri │ ├── OU=Ops,OU=Dev,DC=Company,DC=Pri ├── OU=Domain Controllers,DC=Company,DC=Pri ├── OU=Employees,DC=Company,DC=Pri │ ├── OU=Exec,OU=Employees,DC=Company,DC=Pri │ ├── OU=VIP,OU=Exec,OU=Employees,DC=Company,DC=Pri │ ├── OU=Temporary Hires,OU=Employees,DC=Company,DC=Pri ├── OU=IT,DC=Company,DC=Pri │ ├── OU=Help Desk,OU=IT,DC=Company,DC=Pri │ ├── OU=TechStaff,OU=Help Desk,OU=IT,DC=Company,DC=Pri │ ├── OU=Test,OU=TechStaff,OU=Help Desk,OU=IT,DC=Company,DC=Pri │ ├── OU=SecOps,OU=IT,DC=Company,DC=Pri ...</dev:code> <dev:remarks> <maml:para>Display the domain tree using distinguishednames.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/2PXbvfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-ADDomainReport</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Split-DistinguishedName</command:name> <command:verb>Split</command:verb> <command:noun>DistinguishedName</command:noun> <maml:description> <maml:para>Split a distinguished name into its components.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Split-DistinguishedName will take a disdinguishedname and break it down to its component elements. The command does not verify the name or any of its elements.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Split-DistinguishedName</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="dn"> <maml:name>DistinguishedName</maml:name> <maml:description> <maml:para>Enter an Active Directory DistinguishedName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="dn"> <maml:name>DistinguishedName</maml:name> <maml:description> <maml:para>Enter an Active Directory DistinguishedName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ADDistinguishedNameInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>Get-ADGroup supporttech | Split-Distinguishedname Name : SupportTech Branch : Help Desk BranchDN : OU=Help Desk,OU=IT,DC=Company,DC=Pri Domain : Company DomainDN : DC=Company,DC=Pri DomainDNS : Company.Pri</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Split-DistinguishedName "CN=Foo,OU=Bar,OU=Oz,DC=Research,DC=Globomantics,DC=com" Name : Foo Branch : Bar BranchDN : OU=Bar,OU=Oz,DC=Research,DC=Globomantics,DC=com Domain : Research DomainDN : DC=Research,DC=Globomantics,DC=com DomainDNS : Research.Globomantics.com</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://bit.ly/3uyBoRt</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |