ADS Input Format Parameters
The ADS input format supports the following parameters:
| objClass | ||
| Values: | Active Directory object class name | |
| Default: | not specified | |
| Description: | Object class name for "object mode" operation. | |
| Details: | When this parameter is left unspecified,
the ADS input format works in "property mode", returning a record for each
property of each object visited during the enumeration. On the other hand, when the name of an Active Directory object class is specified for this parameter, the ADS input format works in "object mode", returning a record for each object visited during the enumeration that is an instance of the specified class. For more information on the different modes of operation, see ADS Input Format Fields. |
|
| Example: | -objClass:User | |
| username | ||
| Values: | username | |
| Default: | not specified | |
| Description: | Username for the Active Directory connection. | |
| Details: | When a username is not specified for this parameter,
the ADS input format uses the username specified in the
from-entity of the query. If the from-entity does not
include a username, the ADS input format will use the current user's credentials.
|
|
| Example: | -username:MyUser | |
| password | ||
| Values: | password | |
| Default: | not specified | |
| Description: | Password for the Active Directory connection. | |
| Details: | Password for the username specified with the "username"
parameter.
|
|
| Example: | -password:MyPassword | |
| recurse | ||
| Values: | recursion level (number) | |
| Default: | -1 | |
| Description: | Max ADS container recursion level. | |
| Details: | 0 disables container recursion; -1 enables unlimited recursion. | |
| Example: | -recurse:2 | |
| multiValuedSep | ||
| Values: | any string | |
| Default: | | | |
| Description: | Separator between values of multi-valued types. | |
| Details: | Multi-valued property values are returned as a single string, built by concatenating the multiple values one after the other using the value of this parameter as a separator between the elements. | |
| Example: | -multiValuedSep:, | |
| ignoreDSErrors | ||
| Values: | ON | OFF | |
| Default: | ON | |
| Description: | Ignore Directory Service errors. | |
| Details: | When this parameter is set to "OFF", Directory Service
errors occurring during the enumeration of objects and properties are returned as
Parse Errors. When this parameter is set to "ON", Directory Service errors are silently ignored, and input record fields corresponding to unretrievable objects or properties are returned as NULL values. |
|
| Example: | -ignoreDSErrors:OFF | |
| parseBinary | ||
| Values: | ON | OFF | |
| Default: | OFF | |
| Description: | Return value of binary properties. | |
| Details: | This parameter specifies whether properties containing
binary values are returned or not. When this parameter is set to "ON", binary values are returned as STRING values formatted according to the value specified for the "binaryFormat" parameter. |
|
| Example: | -parseBinary:ON | |
| binaryFormat | ||
| Values: | ASC | PRINT | HEX | |
| Default: | HEX | |
| Description: | Format of binary properties. | |
| Details: | When the "parseBinary" property is set to "ON",
the ADS input format returns properties containing binary values. In this case,
binary values are returned as STRING values formatted according to the value specified
for this parameter. When this parameter is set to "ASC", data bytes belonging to the 0x20-0x7F range are returned as ASCII characters, while data bytes outside the range are returned as period (.) characters, as shown in the following example: Bucket: 02096553..rundll32.exeWhen this parameter is set to "PRINT", data bytes representing printable ASCII characters are returned as ASCII characters, while data bytes that do not represent printable ASCII characters are returned as period (.) characters, as shown in the following example: Bucket: 02096553 rundll32.exeWhen this parameter is set to "HEX", all data bytes are returned as two-digit hexadecimal values, as shown in the following example: 4275636B65743A2030323039363535330D0A72756E646C6C33322E657865 |
|
| Example: | -binaryFormat:PRINT | |
Note: For security reasons, values specified for this parameter are not
persisted when using the Log Parser command-line