PingAuthorize Server Documentation Index
Command-Line Tool Reference Home

ldap-result-code

↓Description
↓Examples
↓Arguments

Description

Display and query LDAP result codes.

This tool may be used to list all known defined LDAP result codes, retrieve the name of the result code with a given integer value, or search for all result codes with names containing a given substring.

At most one of the --list, --int-value, and --search arguments may be provided. If none of them is provided, then the --list option will be chosen by default.

Examples

Display a table with all defined LDAP result codes.
ldap-result-code


Display information about the result code with an integer value of '49'. The matching result code should be formatted as a JSON object.
ldap-result-code --int-value 49 --output-format json


Display information about any defined result codes whose name contains the substring 'attribute'.
ldap-result-code --search attribute

Arguments

-V
--version

Description Display PingAuthorize Server version information

-H
--help

Description Display general usage information

--help-debug

Description Display help for using debug options
Advanced Yes

-l
--list

Description List all defined result codes.

-i {intValue}
--int-value {intValue}

Description Retrieve the result code with the specified integer value.
Lower Bound -2147483648
Upper Bound 2147483647
Required No
Multi-Valued No

-S {searchString}
--search {searchString}

Description Search for result codes whose name contains the given substring.
Required No
Multi-Valued No

-a
--alphabetic-order

Description List result codes in alphabetic order rather than in numeric order.

--output-format {csv|json|tab-delimited|table}

Description The format to use for the output. The value may be one of 'csv', 'json', 'tab-delimited', or 'table'. If the output format is not specified, then the 'table' format will be used by default.
Required No
Multi-Valued No

--interactive

Description Launch the tool in interactive mode.

--outputFile {path}

Description Write all standard output and standard error messages to the specified file instead of to the console.
Required No
Multi-Valued No

--appendToOutputFile

Description Indicates that the tool should append to the file specified by the --outputFile argument if it already exists. If this argument is not provided and the output file already exists, it will be overwritten.

--teeOutput

Description Write all standard output and standard error messages to the console as well as to the specified output file. The --outputFile argument must also be provided.

--propertiesFilePath {path}

Description The path to a properties file used to specify default values for arguments not supplied on the command line.
Required No
Multi-Valued No

--generatePropertiesFile {path}

Description Write an empty properties file that may be used to specify default values for arguments.
Required No
Multi-Valued No

--noPropertiesFile

Description Do not obtain any argument values from a properties file.

--suppressPropertiesFileComment

Description Suppress output listing the arguments obtained from a properties file.