interface

LDAP Schema

Display LDAP schema information including object classes and attributes. Schema browsing enables discovery of available LDAP object classes, their attributes, inheritance hierarchies, and attribute syntax definitions. Features include object class and attribute listing with detailed metadata for understanding directory structure and planning schema extensions.

0 commands
interface

Provides API introspection capabilities.

EXAMPLES

Show user-find details:

ipa command-show user-find

Find user-find parameters:

ipa param-find user-find

Commands


Command Description


class-find Search for classes.

class-show Display information about a class.

command-find Search for commands.

command-show Display information about a command.

output-find Search for command outputs.

output-show Display information about a command output.

param-find Search command parameters.

param-show Display information about a command parameter.

topic-find Search for help topics.

topic-show Display information about a help topic.


class-find

Usage: ipa [global-options] class-find [CRITERIA] [options]

Search for classes.

Arguments


Argument Required Description


CRITERIA no A string searched in all relevant object attributes


Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

--pkey-only Results should contain primary key attribute only (“name”)


class-show

Usage: ipa [global-options] class-show FULL-NAME [options]

Display information about a class.

Arguments


Argument Required Description


FULL-NAME yes Full name


Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.


command-find

Usage: ipa [global-options] command-find [CRITERIA] [options]

Search for commands.

Arguments


Argument Required Description


CRITERIA no A string searched in all relevant object attributes


Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

--pkey-only Results should contain primary key attribute only (“name”)


command-show

Usage: ipa [global-options] command-show FULL-NAME [options]

Display information about a command.

Arguments


Argument Required Description


FULL-NAME yes Full name


Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.


output-find

Usage: ipa [global-options] output-find COMMAND [CRITERIA] [options]

Search for command outputs.

Arguments


Argument Required Description


COMMAND yes Full name

CRITERIA no A string searched in all relevant object attributes

Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

--pkey-only Results should contain primary key attribute only (“name”)


output-show

Usage: ipa [global-options] output-show COMMAND NAME [options]

Display information about a command output.

Arguments


Argument Required Description


COMMAND yes Full name

NAME yes Name

Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.


param-find

Usage: ipa [global-options] param-find METAOBJECT [CRITERIA] [options]

Search command parameters.

Arguments


Argument Required Description


METAOBJECT yes Full name

CRITERIA no A string searched in all relevant object attributes

Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

--pkey-only Results should contain primary key attribute only (“name”)


param-show

Usage: ipa [global-options] param-show METAOBJECT NAME [options]

Display information about a command parameter.

Arguments


Argument Required Description


METAOBJECT yes Full name

NAME yes Name

Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.


topic-find

Usage: ipa [global-options] topic-find [CRITERIA] [options]

Search for help topics.

Arguments


Argument Required Description


CRITERIA no A string searched in all relevant object attributes


Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

--pkey-only Results should contain primary key attribute only (“name”)


topic-show

Usage: ipa [global-options] topic-show FULL-NAME [options]

Display information about a help topic.

Arguments


Argument Required Description


FULL-NAME yes Full name


Options


Option Description


--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

Related Topics