Directory Services

These keywords give you access to Active Directory objects.

distinguished name

The <distinguished name> Inspectors refer to the distinguished name (DN) as defined by the Microsoft Active Directory service. See the core inspector guide for a list of properties of a distinguished name object.

Creation Methods

Declaration	Description	Platforms (?)
distinguished name <string>	Interprets a distinguishedname in the textual format described by RFC 2253 and used by LDAP/Active Directory.	Win
active directory path of <bes computer>	Returns the result of the 'Active Directory Path' property of the specified computer.	Win

Properties

Declaration	Return type	Description	Platforms (?)
component <integer> of <distinguished name>	<distinguished name component> Plural: components	Returns the component (as specified by <integer>) of the distinguished name.	Win
component of <distinguished name>	<distinguished name component> Plural: components	Used as a plural, returns a list of the components of the given distinguished name.	Win

distinguished name component

The <distinguished name component> Inspectors refer to the various components of the distinguished name (DN) as defined by the Microsoft Active Directory API. A DN is a sequence of relative distinguished names (RDN) connected by commas. An RDN is an attribute with an associated value in the form attribute=value; normally expressed in a UTF-8 string format. For more information, see the MSDN article on Distinguished Names.

Creation Methods

Declaration	Description	Platforms (?)
component <integer> of <distinguished name>	Returns the component (as specified by <integer>) of the distinguished name. Example: component 0 of distinguished name "CN=BIGFOOT,CN=Computers,DC=devlan,DC=bigfix,DC=com" - Returns "CN=BIGFOOT".	Win
component of <distinguished name>	Used as a plural, returns a list of the components of the given distinguished name.	Win

Properties

Declaration	Return type	Description	Platforms (?)
type of <distinguished name component>	<string> Plural: types	Returns the type of the specified component of the distinguished name.	Win
value of <distinguished name component>	<string> Plural: values	Returns the value of the specified component of the distinguished name.	Win

active directory group

The <active directory group> Inspectors constitute the base types that allow access to the AD group information, such as distinguished name.

Creation Methods

Declaration	Description	Platforms (?)
group <string> of <active directory local user>	Returns the Active Directory group corresponding to the specified group of the given AD local user.	Win:8.1, Mac:8.1
group of <active directory local user>	Returns a list of the active directory groups for the specified local computer.	Win:8.1, Mac:8.1
group <string> of <active directory local computer>	Returns the Active Directory group corresponding to the specified group of the given AD local computer.	Win:8.1, Mac:8.1
group of <active directory local computer>	Returns a list of the active directory groups for the specified local user.	Win:8.1, Mac:8.1
local group <string> of <active directory server>	Returns the named group if a local active directory user has this group membership	Mac:9.0, Win:9.0
logged on group <string> of <active directory server>	Returns the named group if a logged on active directory user has this group membership	Mac:9.0, Win:9.0

Properties

Declaration	Return type	Description	Platforms (?)
distinguished name error message of <active directory group>	<string> Plural: distinguished name error messages	Returns the error message (if any) received when trying to get the distinguished name for the specified active directory group.	Win:8.1, Mac:8.1
distinguished name of <active directory group>	<string> Plural: distinguished names	Returns the distinguished name (as a string) of the specified active directory group.	Win:8.1, Mac:8.1
name of <active directory group>	<string> Plural: names	Returns the name (as strings) of the specified Active Directory group for the local machine.	Win:8.1, Mac:8.1
sample time of <active directory group>	<time> Plural: sample times	Returns the last sample time for the specified active directory group.	Win:8.1, Mac:8.1
sid of <active directory group>	<security identifier> Plural: sids	Returns the security identifier object corresponding to the specified Active Directory groups for the local machine.	Win:8.1, Mac:8.1

active directory local user

The <active directory local user> objects are the Inspectors for the AD local users. They include the distinguished name and groups.

Creation Methods

Declaration	Description	Platforms (?)
local user <string> of <active directory server>	Returns the named local user of the specified active directory server.	Win:8.1, Mac:8.1
local user of <active directory server>	Returns the local users associated with the specified active directory server.	Win:8.1, Mac:8.1
logged on user <string> of <active directory server>	Returns the Active Directory local user object which allows inspection of AD properties for the specified currently logged in user.	Win:8.1, Mac:8.1
logged on user of <active directory server>	Returns the Active Directory local user object which allows inspection of AD properties for the currently logged in users of the specified AD server.	Win:8.1, Mac:8.1
active directory user of <user>	Returns an <active directory local user> object from the specified logged-on user object. This bridges the gaps between user types when using Active Directory Inspectors. It retains the domain information of the logged-on user within the user object where other user types might not.	Win:8.1, Mac:8.1

Properties

Declaration	Return type	Description	Platforms (?)
distinguished name error message of <active directory local user>	<string> Plural: distinguished name error messages	Returns the error message (if any) received when trying to get the distinguished name for the specified active directory local user.	Win:8.1, Mac:8.1
distinguished name of <active directory local user>	<string> Plural: distinguished names	Returns the distinguished name (as a string) of the specified active directory local user.	Win:8.1, Mac:8.1
dns domainname of <active directory local user>	<string> Plural: dns domainnames		Win:8.2, Mac:8.2
domain of <active directory local user>	<string> Plural: domains		Win:8.2
group <string> of <active directory local user>	<active directory group> Plural: groups	Returns the Active Directory group corresponding to the specified group of the given AD local user.	Win:8.1, Mac:8.1
group of <active directory local user>	<active directory group> Plural: groups	Returns a list of the active directory groups for the specified local computer.	Win:8.1, Mac:8.1
groups error message of <active directory local user>	<string> Plural: groups error messages	Returns the error message (if any) received when trying to get the groups for the specified active directory local user.	Win:8.1, Mac:8.1
name of <active directory local user>	<string> Plural: names	Returns the name (as a string) of the specified Active Directory local user for the local machine.	Win:8.1, Mac:8.1
netbios domainname of <active directory local user>	<string> Plural: netbios domainnames		Win:8.2
sample time of <active directory local user>	<time> Plural: sample times	Returns the last sample time for the specified active directory local user.	Win:8.1, Mac:8.1

active directory local computer

The <active directory local computer> objects are the Active Directory Inspectors for the local computer. Caching (using XML files to represent the last data update) limits how often the client refreshes the AD data, reducing network traffic. These Inspectors require network access to work. If no network connection is available and the information is not cached, then the Inspectors will return NoSuchObject. AD user requests are limited to users that are either cached or have a local profile on the specified machine.

Creation Methods

Declaration	Description	Platforms (?)
local computer of <active directory server>	Represents your computer within the Active Directory.	Win, Mac

Properties

Declaration	Return type	Description	Platforms (?)
distinguished name error message of <active directory local computer>	<string> Plural: distinguished name error messages	Active Directory error if unable to get the distinguished name (this is for debugging purposes).	Win, Mac
distinguished name of <active directory local computer>	<string> Plural: distinguished names	Returns the computer's fully qualified active directory name in the distinguished name format, for instance, 'CN=ALBATROSS, CN=Computers, DC=bigfix, DC=com'.	Win, Mac
dns domainname of <active directory local computer>	<string> Plural: dns domainnames		Win:8.2, Mac:8.2
group <string> of <active directory local computer>	<active directory group> Plural: groups	Returns the Active Directory group corresponding to the specified group of the given AD local computer.	Win:8.1, Mac:8.1
group of <active directory local computer>	<active directory group> Plural: groups	Returns a list of the active directory groups for the specified local user.	Win:8.1, Mac:8.1
groups error message of <active directory local computer>	<string> Plural: groups error messages	Returns the error message (if any) received when trying to get the groups for the specified active directory local computer.	Win:8.1, Mac:8.1
netbios domainname of <active directory local computer>	<string> Plural: netbios domainnames		Win:8.2
sample time of <active directory local computer>	<time> Plural: sample times	Returns the time that the specified item was sampled from Active Directory.	Win:8.0, Mac:8.0

active directory server

The <active directory server> objects are the base types that allows access to the AD objects such as local machine and local user.

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration	Return type	Description	Platforms (?)
local group <string> of <active directory server>	<active directory group> Plural: local groups	Returns the named group if a local active directory user has this group membership	Mac:9.0, Win:9.0
logged on group <string> of <active directory server>	<active directory group> Plural: logged on groups	Returns the named group if a logged on active directory user has this group membership	Mac:9.0, Win:9.0
local computer of <active directory server>	<active directory local computer> Plural: local computers	Represents your computer within the Active Directory.	Win, Mac
local user <string> of <active directory server>	<active directory local user> Plural: local users	Returns the named local user of the specified active directory server.	Win:8.1, Mac:8.1
local user of <active directory server>	<active directory local user> Plural: local users	Returns the local users associated with the specified active directory server.	Win:8.1, Mac:8.1
logged on user <string> of <active directory server>	<active directory local user> Plural: logged on users	Returns the Active Directory local user object which allows inspection of AD properties for the specified currently logged in user.	Win:8.1, Mac:8.1
logged on user of <active directory server>	<active directory local user> Plural: logged on users	Returns the Active Directory local user object which allows inspection of AD properties for the currently logged in users of the specified AD server.	Win:8.1, Mac:8.1

Terminology

Platform

Contents