help

Obtains system help for pdadmin commands and options.

Does not require a login or authentication to use.

help {topic | command}

Options

topic

Help command topic for which help is needed.

command

Specifies the miscellaneous command for which help is needed.

Return codes

0

The command completed successfully.

1

The command failed. When a command fails, the pdadmin command provides a description of the error and an error status code in hexadecimal format (for example, 0x14c012f2). See "Error messages" in the IBM Knowledge Center which provides a list of the ISAM error messages by decimal or hexadecimal codes.

Examples

• The following example lists help topics and commands:
  pdadmin> help

  Output is similar to:

  Type 'help <topic>' or 'help <command> for more information
  
  Topics:
  acl
  action
  admin
  authzrule
  config
  context
  domain
  errtext
  exit
  group
  help
  login
  logout
  object
  objectspace
  policy
  pop
  quit
  rsrc
  rsrccred
  rsrcgroup
  server user
  
  Miscellaneous Commands:
  exit
  help
  quit

• The following example lists the options and descriptions available Whether we specify the topic action or action create:
  pdadmin> help action

  Or:

  pdadmin> help action create

  Output is similar to:

  action create <action-name> <action-label> <action-type>

  Creates a new ACL action definition

  action create <action-name> <action-label> <action-type> <action-group-name> Creates a new ACL action definition in a group ...

Parent topic: Command reference