Skip to content

Get-ADObjectNotes

SYNOPSIS

Retrieves notes associated with an Active Directory object.

SYNTAX

Get-ADObjectNotes [-Identity] <String> [-UseDNInsteadOfSID] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The `Get-ADObjectNotes` function retrieves notes associated with a specified Active Directory object. It queries a SQL database to fetch details such as the date, task, action, and the user who performed the action. The query can use either the object's SID or DistinguishedName, based on the provided parameters.

EXAMPLES

EXAMPLE 1

Get-ADObjectNotes -Identity "CN=John Doe,OU=Users,DC=example,DC=com"

Retrieves notes associated with the Active Directory object "John Doe."

EXAMPLE 2

Get-ADObjectNotes -Identity "jdoe" -UseDNInsteadOfSID

Retrieves notes for the user "jdoe" using the DistinguishedName instead of the SID.

PARAMETERS

-Identity

The identity of the Active Directory object (e.g., DistinguishedName, GUID, or SamAccountName).

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-UseDNInsteadOfSID

A switch parameter that, when specified, forces the query to use the DistinguishedName instead of the SID.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES