Get-AdmComputer

Gets one or more Active Directory computers.

Description

The Get-AdmComputer cmdlet gets a computer or performs a search to retrieve multiple computers.

The Identity parameter specifies the Active Directory computer to retrieve. You can identify a computer by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name (sAMAccountName). You can also set the parameter to a computer object variable, such as $<localComputerObject> or pass a computer object through the pipeline to the Identity parameter.

To search for and retrieve more than one computer, use the Filter or LDAPFilter parameter. The Filter parameter uses the PowerShell Expression Language to write query strings for Active Directory. PowerShell Expression Language syntax provides rich type conversion support for value types received by the Filter parameter. If you have existing LDAP query strings, you can use the LDAPFilter parameter.

This cmdlet retrieves a default set of computer object properties. To retrieve additional properties use the Properties parameter.

Examples

Example 1 – Get specific computer that shows all properties

Get-AdmComputer "Fabrikam-SRV1" -Properties *

DistinguishedName                 : CN=Fabrikam-SRV1,CN=Computers,DC=fabrikam,DC=com
ObjectClass                       : computer
CN                                : Fabrikam-SRV1
Created                           : 1/21/2020 6:06:59 AM
DisplayName                       : Fabrikam-SRV1$
Modified                          : 1/21/2020 6:07:00 AM
ObjectCategory                    : CN=Computer,CN=Schema,CN=Configuration,DC=fabrikam,DC=com
Name                              : Fabrikam-SRV1
ObjectGUID                        : 17b61380-9069-4579-a913-6afc3c04d664
ProtectedFromAccidentalDeletion   : False
SamAccountName                    : Fabrikam-SRV1$
SID                               : S-1-5-21-2718492785-1413807572-3629993048-2094144
AccountNotDelegated               : False
AllowReversiblePasswordEncryption : False
CannotChangePassword              : False
DoesNotRequirePreAuth             : False
Enabled                           : True
HomedirRequired                   : False
LockedOut                         : False
ManagedBy                         : CN=SQL Administrator 01,OU=UserAccounts,OU=Managed,DC=fabrikam,DC=com
MNSLogonAccount                   : False
PasswordExpired                   : False
PasswordNeverExpires              : False
PasswordNotRequired               : True
PrimaryGroup                      : CN=Domain Computers,CN=Users,DC=fabrikam,DC=com
TrustedForDelegation              : False
TrustedToAuthForDelegation        : False
UseDESKeyOnly                     : False
codepage                          : 0
iscriticalsystemobject            : False
usnchanged                        : 65348869
instancetype                      : 4
ntsecuritydescriptor              : {1, 0, 4, 140...}
samaccounttype                    : 805306369
usncreated                        : 65348869
dscorepropagationdata             : 1/1/1601 12:00:00 AM
localpolicyflags                  : 0
whencreated                       : 1/21/2020 12:06:59 PM
adspath                           : LDAP://fabrikam.com/CN=Fabrikam-SRV1,CN=Computers,DC=fabrikam,DC=com
countrycode                       : 0
whenchanged                       : 1/21/2020 12:07:00 PM
accountexpires                    : 9223372036854775807

This command gets a specific computer showing all the properties.

Example 2 – Get all computers whose name starts with a particular string

Get-AdmComputer -Filter 'Name -like "Fabrikam*"' -Properties IPv4Address | FT Name,DNSHostName,IPv4Address -A

Name                DNSHostName                     IPv4Address
----                -----------                     -----------
FABRIKAM-SRV1       FABRIKAM-SRV1.Fabrikam.com      10.194.99.181
FABRIKAM-SRV2       FABRIKAM-SRV2.Fabrikam.com      10.194.100.37

This command gets all the computers whose name starts with Fabrikam and shows the name, dns hostname and IPv4 address.

Example 3 – Gets all computers whose passwords changed in specific time frame

$date = [DateTime]::Today.AddDays(-90)
Get-AdmComputer -Filter 'PasswordLastSet -ge $date' -Properties PasswordLastSet | FT Name,PasswordLastSet

Name                PasswordLastSet  
----                ---------------  
FABRIKAM-SRV4       3/12/2009 6:40:37 PM  
FABRIKAM-SRV5       3/12/2009 7:05:45 PM  

This command gets all the computers whose passwords changed during the last 90 days.

Example 4 – Get computer accounts in a specific location using an LDAPFilter

Get-AdmComputer -LDAPFilter "(name=*laptop*)" -SearchBase "CN=Computers,DC=Fabrikam,DC=com"

Name  
----  
saradavi-laptop  
jeffpr-laptop  

This command gets computer accounts in location CN=Computers,DC=Fabrikam,DC=com that are listed as laptops by using an LDAPFilter.

Example 5 – Get all computer accounts using a filter

Get-AdmComputer -Filter *

This command gets all computer accounts.

Parameters

-AdaxesService

Specifies the DNS name of an Adaxes service that will be used to execute this cmdlet. If this parameter is not specified, and the cmdlet is running from an Adaxes Active Directory provider drive, the value for this parameter can be determined from the current path. For example, if the current path is Adaxes:/example.com, the Adaxes service on example.com will be used. If the parameter is not specified and the service DNS name can't be determined from the current path, the cmdlet will access Active Directory directly.

-Credential

Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Adaxes Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default one.

To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.

You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object.

If the acting credentials do not have permission to perform the task, the cmdlet returns a terminating error.

-Filter

Specifies a query string that retrieves Active Directory computers. This string must follow the PowerShell Expression Language syntax.

-Identity

Specifies an Active Directory computer object by providing one of the following property values. The identifier in parentheses is the LDAP name of the attribute.

Possible values for this parameter are:

• Distinguished name (distinguishedName)
• GUID (objectGUID)
• Security identifier (objectSid)
• SAM account name (sAMAccountName)

The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error.

This parameter can also get an object through the pipeline or you can set the parameter to an object instance.

-LDAPFilter

Specifies an LDAP query string that is used to filter Active Directory objects. You can use this parameter to run your existing LDAP queries. The Filter parameter syntax supports the same functionality as the LDAP syntax.

-Partition

Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. The cmdlet searches this partition to find the object defined by the Identity parameter.

In many cases, a default value will be used for the Partition parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first, and once a default value can be determined, no further rules will be evaluated.

• If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name.
• If running cmdlets from an Adaxes Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive.
• If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain.

-Properties

Specifies the properties of the output object to retrieve from the server. Use this parameter to retrieve properties that are not included into the default set.

Specify properties for this parameter as a comma-separated list of names. To display all of the attributes that are set on the object, specify * (asterisk).

To specify an individual extended property, use the name of the property. For properties that are not default or extended properties, you must specify the LDAP name.

To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet.

-ResultPageSize

Specifies the number of objects to include in one page for an Active Directory Domain Services query.

The default is 256 objects per page.

-ResultSetSize

Specifies the maximum number of objects to return for an Active Directory Domain Services query. If you want to receive all of the objects, set this parameter to $null (null value). You can use Ctrl+C to stop the query and return of objects.

The default is $null.

-SearchBase

Specifies an Active Directory path to search under.

When you run a cmdlet from an Adaxes Active Directory provider drive, the default value of this parameter is the current path of the drive.

When you run a cmdlet outside of an Adaxes Active Directory provider drive, the default value of this parameter is the default naming context of the target domain.

The following example shows how to set this parameter to search under an OU.

-SearchBase "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com"

When the value of the SearchBase parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. If the value of the SearchBase parameter is set to an empty string and you are not connected to a GC port, an error will be thrown.

-SearchScope

Specifies the scope of an Active Directory search.

Possible values for this parameter are:

• Base or 0
• OneLevel or 1
• Subtree or 2

A Base query searches only the current path or object. A OneLevel query searches the immediate children of that path or object. A Subtree query searches the current path or object and all children of that path or object.

-Server

Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. Specify the AD DS instance in one of the following ways:

Domain name values:

• Fully qualified domain name
• NetBIOS name

Directory server values:

• Fully qualified directory server name
• NetBIOS name
• Fully qualified directory server name and port

The default value for the Server parameter is determined by one of the following methods in the order that they are listed:

• By using Server value from objects passed through the pipeline.
• By using the server information associated with the Adaxes Active Directory PowerShell provider drive, when running under that drive.
• By using the domain of the computer running PowerShell.

Inputs

None or Softerra.Adaxes.PowerShellModule.Directory.ADComputer

A computer object is received by the Identity parameter.

Outputs

Softerra.Adaxes.PowerShellModule.Directory.ADComputer

Returns one or more computer objects.

This cmdlet returns a default set of ADComputer property values. To retrieve additional properties, use the Properties parameter.

See also

• New-AdmComputer
• Set-AdmComputer
• Remove-AdmComputer