Cmdlets for Microsoft Active Directory

Build 24.0.9060

OrganizationalPerson

This class is used for objects that contain organizational information about a user, such as the employee number, department, manager, title, office address, and so on.

Table Specific Information

Select

All columns support server-side processing for the operators =, >= , <=, !=, LIKE, AND, and OR. Other filters are executed client side within the cmdlet. For example, the following query is processed by Microsoft Active Directory:

SELECT * FROM OrganizationalPerson WHERE  CN != 'NewUser' AND  BaseDN = 'CN=Users,DC=MyDC' LIMIT 5 

Insert

To add a OrganizationalPerson, all fields can be specified except Id, DN, and BaseDN. Required fields that should be provided are RDN and ObjectClass. For example:

INSERT INTO OrganizationalPerson (RDN, ObjectClass) VALUES ('CN=NewUser', 'top;person;organizationalPerson;user;inetOrgPerson')

Update

All columns except Id, DN, and BaseDN can be updated by providing the Id in the WHERE clause. For example:

UPDATE OrganizationalPerson SET Description = 'desc' WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Delete

OrganizationalPersons can be deleted by providing the Id of the OrganizationalPerson in a DELETE statement. For example:

DELETE FROM OrganizationalPerson WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Columns

Name Type ReadOnly References DataFormat Description
Id [KEY] String True

Combined index and DN. Multiple indices are only possible when a column is set to SplitDataByRow.

DN String True

The full distinguished name.

RDN String False

The relative distinguished name.

BaseDN String True

The base distinguished name.

InstanceType String False DelimitedData

A bitfield that dictates how the object is instantiated on a particular server. The value of this attribute can differ on different replicas even if the replicas are in sync.

NTSecurityDescriptor String False DelimitedData

The Windows NT security descriptor for the schema object. A security descriptor is a data structure that contains security information about an object, such as the ownership and permissions of the object.

ObjectCategory String False DelimitedData

An object class name used to group objects of this or derived classes.

ObjectClass String False DelimitedData

The list of classes from which this class is derived.

StreetAddress String False DelimitedData

The user's address.

HomePostalAddress String False DelimitedData

A user's home address.

AdminDescription String False DelimitedData

The description displayed on admin screens.

AdminDisplayName String False DelimitedData

The name to be displayed on admin screens.

AllowedAttributes String False DelimitedData

Attributes that will be permitted to be assigned to a class.

AllowedAttributesEffective String False DelimitedData

A list of attributes that can be modified on the object.

AllowedChildClasses String False DelimitedData

Classes that can be contained by a class.

AllowedChildClassesEffective String False DelimitedData

A list of classes that can be modified.

Assistant String False DelimitedData

The distinguished name of a user's administrative assistant.

BridgeheadServerListBL String False DelimitedData

The list of servers that are bridgeheads for replication.

CanonicalName String False DelimitedData

The name of the object in canonical format. myserver2.fabrikam.com/users/jeffsmith is an example of a distinguished name in canonical format. This is a constructed attribute. The results returned are identical to those returned by the following Active Directory function: DsCrackNames(NULL, DS_NAME_FLAG_SYNTACTICAL_ONLY, DS_FQDN_1779_NAME, DS_CANONICAL_NAME, ...).

Cn String False DelimitedData

The name that represents an object. Used to perform searches.

Company String False DelimitedData

The user's company name.

CountryCode String False DelimitedData

Specifies the country/region code for the user's language of choice. This value is not used by Windows 2000.

C String False DelimitedData

The country/region in the address of the user. The country/region is represented as a 2-character code based on ISO-3166.

CreateTimeStamp Datetime False DelimitedData

The date when this object was created. This value is replicated.

Department String False DelimitedData

Contains the name for the department in which the user works.

Description String False DelimitedData

Contains the description to display for an object. This value is restricted as single-valued for backward compatibility in some cases but is allowed to be multi-valued in others. See Remarks.

DestinationIndicator String False DelimitedData

This is part of the X.500 specification and not used by NTDS.

DisplayName String False DelimitedData

The display name for an object. This is usually the combination of the users first name, middle initial, and last name.

DisplayNamePrintable String False DelimitedData

The printable display name for an object. The printable display name is usually the combination of the user's first name, middle initial, and last name.

Division String False DelimitedData

The user's division.

DSASignature String False DelimitedData

The DSA-Signature of an object is the Invocation-ID of the last directory to modify the object.

DSCorePropagationData String False DelimitedData

The DS-Core-Propagation-Data attribute is for internal use only.

Mail String False DelimitedData

The list of email addresses for a contact.

EmployeeID String False DelimitedData

The ID of an employee.

ExtensionName String False DelimitedData

The name of a property page used to extend the UI of a directory object.

FacsimileTelephoneNumber String False DelimitedData

Contains telephone number of the user's business fax machine.

Flags String False DelimitedData

To be used by the object to store bit information.

FromEntry String False DelimitedData

This is a constructed attribute that is TRUE if the object is writable and FALSE if it is read-only, for example, a GC replica instance.

FrsComputerReferenceBL String False DelimitedData

Reference to replica sets to which this computer belongs.

FRSMemberReferenceBL String False DelimitedData

Reference to subscriber objects for this member.

FSMORoleOwner String False DelimitedData

Flexible Single-Master Operation: The distinguished name of the DC where the schema can be modified.

GenerationQualifier String False DelimitedData

Indicates a person generation. For example, Jr. or II.

GivenName String False DelimitedData

Contains the given name (first name) of the user.

Initials String False DelimitedData

Contains the initials for parts of the user's full name. This may be used as the middle initial in the Windows Address Book.

InternationalISDNNumber String False DelimitedData

Specifies an International ISDN Number associated with an object.

IsCriticalSystemObject String False DelimitedData

If TRUE, the object hosting this attribute must be replicated during installation of a new replica.

IsDeleted String False DelimitedData

If TRUE, this object has been marked for deletion and cannot be instantiated. After the tombstone period has expired, it will be removed from the system.

MemberOf String False DelimitedData

The distinguished name of the groups to which this object belongs.

IsPrivilegeHolder String False DelimitedData

Backward link to privileges held by a given principal.

LastKnownParent String False DelimitedData

The Distinguished Name (DN) of the last known parent of an orphaned object.

L String False DelimitedData

Represents the name of a locality, such as a town or city.

ThumbnailLogo String False DelimitedData

BLOB that contains a logo for this object.

ManagedObjects String False DelimitedData

Contains the list of objects that are managed by the user. The objects listed are those that have the property managedBy property set to this user. Each item in the list is a linked reference to the managed object.

Manager String False DelimitedData

Contains the distinguished name of the user who is the user's manager. The manager's user object contains a directReports property that contains references to all user objects that have their manager properties set to this distinguished name.

MasteredBy String False DelimitedData

Backward link for Has-Master-NCs attribute. The distinguished name for its NTDS Settings objects.

MhsORAddress String False DelimitedData

X.400 address.

ModifyTimeStamp Datetime False DelimitedData

A computed attribute that represents the date when this object was last changed. This value is not replicated.

MS-DS-ConsistencyChildCount String False DelimitedData

This attribute is used to check consistency between the directory and another object, database, or application, by comparing a count of child objects.

MS-DS-ConsistencyGuid String False DelimitedData

This attribute is used to check consistency between the directory and another object, database, or application, by comparing GUIDs.

NetbootSCPBL String False DelimitedData

A list of service connection points that reference this NetBoot server.

NonSecurityMemberBL String False DelimitedData

List of nonsecurity-members for an Exchange distribution list.

DistinguishedName String False DelimitedData

Same as the Distinguished Name for an object. Used by Exchange.

ObjectGUID String False DelimitedData

The unique identifier for an object.

ObjectVersion String False DelimitedData

This can be used to store a version number for the object.

Ou String False DelimitedData

The name of the organizational unit.

O String False DelimitedData

The name of the company or organization.

OtherMailbox String False DelimitedData

Contains other additional mail addresses in a form such as CCMAIL: BruceKeever.

MiddleName String False DelimitedData

Additional names for a user. For example, middle name, patronymic, matronymic, or others.

OtherWellKnownObjects String False DelimitedData

Contains a list of containers by GUID and Distinguished Name. This permits retrieving an object after it has been moved by using just the GUID and the domain name. Whenever the object is moved, the system automatically updates the Distinguished Name.

PartialAttributeDeletionList String False DelimitedData

Tracks the internal replication state of partial replicas (that is, on GCs). Attribute of the partial replica NC object. Used when the GC is in the process of removing attributes from the objects in its partial replica NCs.

PartialAttributeSet String False DelimitedData

Tracks the internal replication state of partial replicas (that is, on GCs). Attribute of the partial replica NC object. Defines the set of attributes present on a particular partial replica NC.

PersonalTitle String False DelimitedData

The user's title.

OtherFacsimileTelephoneNumber String False DelimitedData

A list of alternate facsimile numbers.

OtherHomePhone String False DelimitedData

A list of alternate home phone numbers.

HomePhone String False DelimitedData

The user's main home phone number.

OtherIpPhone String False DelimitedData

The list of alternate TCP/IP addresses for the phone. Used by Telephony.

IpPhone String False DelimitedData

The TCP/IP address for the phone. Used by Telephony.

PrimaryInternationalISDNNumber String False DelimitedData

The primary ISDN.

OtherMobile String False DelimitedData

A list of alternate mobile phone numbers.

Mobile String False DelimitedData

The primary mobile phone number.

OtherTelephone String False DelimitedData

A list of alternate office phone numbers.

OtherPager String False DelimitedData

A list of alternate pager numbers.

Pager String False DelimitedData

The primary pager number.

PhysicalDeliveryOfficeName String False DelimitedData

Contains the office location in the user's place of business.

ThumbnailPhoto String False DelimitedData

An image of the user. A space-efficient format like JPEG or GIF is recommended.

PossibleInferiors String False DelimitedData

The list of objects that this object can contain.

PostalAddress String False DelimitedData

The mailing address for the object.

PostalCode String False DelimitedData

The postal or zip code for mail delivery.

PostOfficeBox String False DelimitedData

The post office box number for this object.

PreferredDeliveryMethod String False DelimitedData

The X.500-preferred way to deliver to addressee.

ProxiedObjectName String False DelimitedData

This attribute is used internally by Active Directory to help track interdomain moves.

ProxyAddresses String False DelimitedData

A proxy address is the address by which a Microsoft Exchange Server recipient object is recognized in a foreign mail system. Proxy addresses are required for all recipient objects, such as custom recipients and distribution lists.

QueryPolicyBL String False DelimitedData

List of all objects holding references to a given Query-Policy.

Name String False DelimitedData

The Relative Distinguished Name (RDN) of an object. An RDN is the relative portion of a distinguished name (DN), which uniquely identifies an LDAP object.

RegisteredAddress String False DelimitedData

Specifies a mnemonic for an address associated with an object at a particular city location. The mnemonic is registered in the country/region in which the city is located and is used in the provision of the Public Telegram Service.

ReplPropertyMetaData String False DelimitedData

Tracks internal replication state information for DS objects. Information here can be extracted in public form through the public API DsReplicaGetInfo(). Present on all DS objects.

ReplUpToDateVector String False DelimitedData

Tracks internal replication state information for an entire NC. Information here can be extracted in public form through the API DsReplicaGetInfo(). Present on all NC root objects.

DirectReports String False DelimitedData

Contains the list of users that directly report to the user. The users listed as reports are those that have the property manager property set to this user. Each item in the list is a linked reference to the object that represents the user.

RepsFrom String False DelimitedData

Lists the servers from which the directory will accept changes for the defined naming context.

RepsTo String False DelimitedData

Lists the servers that the directory will notify of changes and servers to which the directory will send changes on Request for the defined naming context.

Revision String False DelimitedData

The revision level for a security descriptor or other change. Only used in the sam-server and ds-ui-settings objects.

SDRightsEffective String False DelimitedData

This constructed attribute returns a single DWORD value that can have up to three bits set:

SeeAlso String False DelimitedData

List of distinguished names that are related to an object.

ServerReferenceBL String False DelimitedData

Found in the domain naming context. The distinguished name of a computer under the sites folder.

ShowInAdvancedViewOnly String False DelimitedData

TRUE if this attribute is to be visible in the Advanced mode of the UI.

SiteObjectBL String False DelimitedData

The list of distinguished names for subnets that belong to this site.

St String False DelimitedData

The name of a user's state or province.

Street String False DelimitedData

The street address.

SubRefs String False DelimitedData

List of subordinate references of a Naming Context.

SubSchemaSubEntry String False DelimitedData

The distinguished name for the location of the subschema object where a class or attribute is defined.

Sn String False DelimitedData

This attribute contains the family or last name for a user.

SystemFlags String False DelimitedData

An integer value that contains flags that define additional properties of the class. See Remarks.

TelephoneNumber String False DelimitedData

The primary telephone number.

TeletexTerminalIdentifier String False DelimitedData

Specifies the Teletex terminal identifier and, optionally, parameters, for a teletex terminal associated with an object.

TelexNumber String False DelimitedData

A list of alternate telex numbers.

PrimaryTelexNumber String False DelimitedData

The primary telex number.

Co String False DelimitedData

The country/region in which the user is located.

Title String False DelimitedData

Contains the user's job title. This property is commonly used to indicate the formal job title, such as Senior Programmer, rather than occupational class, such as programmer. It is not typically used for suffix titles such as Esq. or DDS.

Comment String False DelimitedData

The user's comments.

UserPassword String False DelimitedData

The user's password in UTF-8 format. This is a write-only attribute.

USNChanged String False DelimitedData

The update sequence number (USN) assigned by the local directory for the latest change, including creation. See also , USN-Created.

USNCreated String False DelimitedData

The update sequence number (USN) assigned at object creation. See also, USN-Changed.

USNDSALastObjRemoved String False DelimitedData

Contains the update sequence number (USN) for the last system object that was removed from a server.

USNIntersite String False DelimitedData

The update sequence number (USN) for inter-site replication.

USNLastObjRem String False DelimitedData

Contains the update sequence number (USN) for the last non-system object that was removed from a server.

USNSource String False DelimitedData

Value of the USN-Changed attribute of the object from the remote directory that replicated the change to the local server.

WbemPath String False DelimitedData

References to objects in other ADSI namespaces.

WellKnownObjects String False DelimitedData

This attribute contains a list of well-known object containers by GUID and distinguished name. The well-known objects are system containers. This information is used to retrieve an object after it has been moved by using just the GUID and the domain name. Whenever the object is moved, the system automatically updates the Distinguished Name portion of the Well-Known-Objects values that referred to the object. The file Ntdsapi.h contains the following definitions, which can be used to retrieve an object (the GUIDs that are associated to these objects are contained in Ntdsapi.h):

WhenChanged Datetime False DelimitedData

The date when this object was last changed. This value is not replicated and exists in the global catalog.

WhenCreated Datetime False DelimitedData

The date when this object was created. This value is replicated and is in the global catalog.

WWWHomePage String False DelimitedData

A web page that is the primary landing page of a website.

Url String False DelimitedData

A list of alternate webpages.

X121Address String False DelimitedData

The X.121 address for an object.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Filter String

Defines the LDAP filter explicitly, overriding any other values set in the WHERE clause.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060