en-US/PSActiveDirectoryReports-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-DevicesOrgUnitReport</command:name> <command:verb>Get</command:verb> <command:noun>DevicesOrgUnitReport</command:noun> <maml:description> <maml:para>Retrieves a report of devices and their organizational units (OUs) in Active Directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-DevicesOrgUnitReport` function queries all computers in Active Directory, retrieves their distinguished names, and extracts their organizational unit (OU) and domain information. The results include the device name, fully qualified domain name (FQDN), organizational unit, and domain name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DevicesOrgUnitReport</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing:</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DeviceName (computer name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- Hostname (FQDN in lowercase)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- OrgUnit (OU structure in a readable format)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DomainName (derived from distinguished name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-DevicesOrgUnitReport Retrieves a list of all devices in Active Directory and their corresponding OUs.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-DevicesOrgUnitReport | Export-Csv -Path "C:\Reports\DevicesOUReport.csv" -NoTypeInformation Retrieves the report and exports it to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-DisabledUsersReport</command:name> <command:verb>Get</command:verb> <command:noun>DisabledUsersReport</command:noun> <maml:description> <maml:para>Retrieves a report of all disabled Active Directory users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-DisabledUsersReport` function queries all disabled Active Directory user accounts and extracts details such as username, account name, organizational unit (OU), and domain name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DisabledUsersReport</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing:</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- UserName (Full Name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- AccountName (SAM Account Name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- OrgUnit (OU structure)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DomainName (AD domain name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-DisabledUsersReport Retrieves all disabled users in Active Directory.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-DisabledUsersReport | Export-Csv -Path "C:\Reports\DisabledUsers.csv" -NoTypeInformation Exports the disabled users report to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-DomainControllerReport</command:name> <command:verb>Get</command:verb> <command:noun>DomainControllerReport</command:noun> <maml:description> <maml:para>Retrieves a report of all domain controllers in the Active Directory environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-DomainControllerReport` function queries all domain controllers in the Active Directory domain and returns key details such as name, hostname, IP address, operating system, domain, forest, and location. The function formats the output as a collection of custom PowerShell objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DomainControllerReport</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing details of each domain controller.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-DomainControllerReport Retrieves a list of all domain controllers and their details.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-DomainControllerReport | Export-Csv -Path "C:\Reports\DCReport.csv" -NoTypeInformation Retrieves domain controller details and exports them to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-ExpiredUsersReport</command:name> <command:verb>Get</command:verb> <command:noun>ExpiredUsersReport</command:noun> <maml:description> <maml:para>Retrieves a report of expired Active Directory user accounts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-ExpiredUsersReport` function queries Active Directory for user accounts that have already expired. It returns details such as username, account name, organizational unit (OU), domain name, and expiration date.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ExpiredUsersReport</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing:</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- UserName (full name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- AccountName (SAM account name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- OrgUnit (OU structure)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DomainName (AD domain name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- ExpirationDate (account expiration date or "Never Expires")</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ExpiredUsersReport Retrieves all expired user accounts.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ExpiredUsersReport | Export-Csv -Path "C:\Reports\ExpiredUsers.csv" -NoTypeInformation Retrieves expired users and exports them to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-ExpiringUsersReport</command:name> <command:verb>Get</command:verb> <command:noun>ExpiringUsersReport</command:noun> <maml:description> <maml:para>Retrieves a report of Active Directory user accounts that are expiring soon.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-ExpiringUsersReport` function queries Active Directory for user accounts that are set to expire within a specified number of days. It returns details including username, account name, organizational unit (OU), domain name, and expiration date.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ExpiringUsersReport</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing:</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- UserName (full name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- AccountName (SAM account name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- OrgUnit (OU structure)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DomainName (AD domain name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- ExpirationDate (account expiration date or "Never Expires")</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ExpiringUsersReport -Days 14 Retrieves users whose accounts will expire within the next 14 days.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ExpiringUsersReport | Export-Csv -Path "C:\Reports\ExpiringUsers.csv" -NoTypeInformation Retrieves the expiring users and exports them to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-InactiveDevicesReport</command:name> <command:verb>Get</command:verb> <command:noun>InactiveDevicesReport</command:noun> <maml:description> <maml:para>Retrieves a list of inactive devices in Active Directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-InactiveDevicesReport` function finds computers in Active Directory that have not logged in within the specified number of days. It retrieves their names, organizational units (OU), last logon timestamps, and domain names.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-InactiveDevicesReport</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Days</maml:name> <maml:description> <maml:para>Specifies the number of days of inactivity to filter devices. Defaults to 30 days.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Days</maml:name> <maml:description> <maml:para>Specifies the number of days of inactivity to filter devices. Defaults to 30 days.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing:</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DeviceName (computer name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- Hostname (FQDN in lowercase, if available)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- OrgUnit (OU structure in readable format)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DomainName (derived from distinguished name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- LastLogon (last logon timestamp in human-readable format)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-InactiveDevicesReport -Days 90 Retrieves devices that have been inactive for over 90 days.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-InactiveDevicesReport | Export-Csv -Path "C:\Reports\InactiveDevices.csv" -NoTypeInformation Retrieves the inactive devices and exports them to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-InactiveUsersReport</command:name> <command:verb>Get</command:verb> <command:noun>InactiveUsersReport</command:noun> <maml:description> <maml:para>Retrieves a report of inactive Active Directory users based on the LastLogonTimestamp.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-InactiveUsersReport` function queries Active Directory for users who haven't logged in within a specified number of days and returns a report containing details such as user name, account name, organizational unit (OU), domain name, and the last logon date.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-InactiveUsersReport</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Days</maml:name> <maml:description> <maml:para>The number of days to consider a user as inactive. The default is 30 days.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Days</maml:name> <maml:description> <maml:para>The number of days to consider a user as inactive. The default is 30 days.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>[int]$Days (default: 30)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>The number of days a user must be inactive to be included in the report.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing:</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- UserName (Full Name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- AccountName (SAM Account Name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- OrgUnit (OU structure)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DomainName (AD domain name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- LastLogon (Last logon date)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-InactiveUsersReport -Days 60 Retrieves all users who have been inactive for 60 days.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-InactiveUsersReport | Export-Csv -Path "C:\Reports\InactiveUsers.csv" -NoTypeInformation Exports the inactive users report to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-LockedUsersReport</command:name> <command:verb>Get</command:verb> <command:noun>LockedUsersReport</command:noun> <maml:description> <maml:para>Retrieves a report of all locked-out Active Directory users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-LockedUsersReport` function queries all locked-out Active Directory user accounts and extracts details such as username, account name, organizational unit (OU), and domain name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LockedUsersReport</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing:</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- UserName (Full Name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- AccountName (SAM Account Name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- OrgUnit (OU structure)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DomainName (AD domain name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-LockedUsersReport Retrieves all locked-out users in Active Directory.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-LockedUsersReport | Export-Csv -Path "C:\Reports\LockedUsers.csv" -NoTypeInformation Exports the locked-out users report to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-OnlineDevicesReport</command:name> <command:verb>Get</command:verb> <command:noun>OnlineDevicesReport</command:noun> <maml:description> <maml:para>Retrieves a report of online devices within the Active Directory environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-OnlineDevicesReport` function queries all computers in Active Directory and performs a network connectivity check using `Test-Connection`. It returns a list of devices that are online, along with their hostname, IP address, and the last seen timestamp.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OnlineDevicesReport</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing hostname, IP address, and last seen timestamp of online devices.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-OnlineDevicesReport Retrieves a list of online devices in the Active Directory domain.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-OnlineDevicesReport | Export-Csv -Path "C:\Reports\OnlineDevices.csv" -NoTypeInformation Retrieves the list of online devices and exports it to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</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-UsersOrgUnitReport</command:name> <command:verb>Get</command:verb> <command:noun>UsersOrgUnitReport</command:noun> <maml:description> <maml:para>Retrieves a report of Active Directory users and their organizational units.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-UsersOrgUnitReport` function queries all Active Directory users and extracts details such as username, account name, organizational unit (OU), and domain name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UsersOrgUnitReport</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. This function does not accept pipeline input.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject[]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>A collection of objects containing:</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- UserName (Full Name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- AccountName (SAM Account Name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- OrgUnit (OU structure)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- DomainName (AD domain name)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Michael Free Date : 2025-02-27 License : BSD 3-Clause License Copyright : 2025, Michael Free. All Rights Reserved. Requires : Active Directory module</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UsersOrgUnitReport Retrieves all users and their OU information.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-UsersOrgUnitReport | Export-Csv -Path "C:\Reports\UsersOU.csv" -NoTypeInformation Exports the users' OU report to a CSV file.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:linkText> <maml:uri>https://github.com/Michael-Free/PSActiveDirectoryReports/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |