[help-main]

NAME:

    admconfig - command line tool for Administration Server


SYNOPSIS:

    admconfig [options] <task> [args] [<task> [args] ...]


OPTIONS:

    Valid [options] are:

        -con[tinueOnError]
             Finish the remaining tasks even when an error occurs. Default
             behavior is to quit when any task fails without running the
             remaining tasks.

        -enc[ryption]
             Use encrypted protocol (https) to connect to the server. The
             default protocol is http.

        -h[elp] [<task>]
             Display the usage information [for task]. To display the usage
             information for a particular task, specify the task as the
             argument to -h without the leading hyphen, i.e. -h restart.

        -i[nputFile] <filename>
             Get options from the specified file. The same options can
             also be specified on the command line along with the option
             file. In this case, the options on the command line override
             the options in the file. The -inputFile option within the
             option file is ignored to prevent recursion.

        -ser[ver] [<host>]:<port>
             Connect to the server on host at specified port. If no host is
             specified, the localhost is used. The server port number
             (preceded by the colon) is required.

        -u[ser] [<uid>]:[<pwd>]
             Connect to the server using username and password. If the
             username is not specified, the user's login name is used. If
             the password is not specified, the user is prompted for the
             password. The password is echoed back on the user's screen so
             if security is a concern, the -inputFile option should be used
             to provide the username and password in a file with suitable
             permissions. Note that if the -user option is specified, then
             at the minimum, the colon must be specified. If the -user
             option is not specified, then the user is prompted for both
             the username and password.

        -verb[ose] [<0-9>]
             Set the level of screen output (9=full output, 0=no output).
             The default level is 5.

        -vers[ion]
             Display the version and copyright information.

    The [options] can be specified using the terse single character form
    such as -u if applicable, or they can be specified using the longer but
    more descriptive form such as -user. The complete option name does not
    have to be specified. For example, -us will work just as well as -user.
    The option name just needs to be specified so that it is not ambiguous
    among other [options] as well as the tasks below.

    Note that [options] are not case sensitive. Thus, -USER and -User are
    both accepted as the -user option.


    Valid <task> includes:

        -countA[ccessLogEntries]
             Count the number of entries in the access log file.
        -viewA[ccessLogEntries]
             View the specified entries in the access log file.

        -countE[rrorLogEntries]
             Count the number of entries in the error log file.
        -viewE[rrorLogEntries]
             View the specified entries in the error log file.

        -enableD[SGWAccess]
             Enable Directory Server Gateway access to the admin server.
        -disableD[SGWAccess]
             Disable Directory Server Gateway access to the admin server.

        -enableE[ndUserAccess]
             Enable end user access to the admin server.
        -disableE[ndUserAccess]
             Disable end user access to the admin server.

        -getAc[cessLog]
             Get the name of the server access log file.
        -setAc[cessLog]
             Set the name of the server access log file.

        -getAdd[resses]
             Get the addresses from which connections are allowed.
        -setAdd[resses]
             Set the addresses from which connections are allowed.

        -getAdminUI[D]
             Get the admistrator's username.
        -setAdminUI[D]
             Set the admistrator's username to the specified UID.
        -setAdminP[wd]
             Set the admistrator's password to the specified value.

        -getAdminUs[ers]
             Get the name of the adminusers file.
        -setAdminUs[ers]
             Set the name of the adminusers file.

        -getCa[cheLifetime]
             Get the amount of time that the user authentication is cached.
        -setCa[cheLifetime]
             Set the amount of time to cache the user authentication.

        -getCl[assname]
             Get the Java classname for the admin server.
        -setCl[assname]
             Set the Java classname for the admin server.

        -getDe[faultAcceptLanguage]
             Get the defaultacceptlanguage.
        -setDe[faultAcceptLanguage]
             Set the defaultacceptlanguage.

        -getDS[Config]
             Retrieve the current LDAP server host, port, baseDN, and whether
             the LDAP server is running SSL.
        -setDS[Config]
             Set the LDAP server host, port, baseDN, and whether the LDAP
             server is running SSL.

        -getE[rrorLog]
             Get the name of the server error log file.
        -setE[rrorLog]
             Set the name of the server error log file.

        -getH[osts]
             Get the hosts from which connections are allowed.
        -setH[osts]
             Set the hosts from which connections are allowed.

        -getO[neACLDir]
             Get the oneacldir.
        -setO[neACLDir]
             Set the oneacldir.

        -getPo[rt]
             Get the current admin server port number.
        -setPo[rt]
             Set the admin server port number.

        -getSe[rverAddress]
             Get the current admin server address.
        -setSe[rverAddress]
             Set the admin server address.

        -getSy[ystemUser]
             Get the user name that the server is currently running as.
        -setSy[ystemUser]
             Set the user name that the server should run as.

        -getU[GDSConfig]
             Retrieve the current user/group LDAP server information,
             including the host, port, baseDN, and authentication DN.
        -setU[GDSConfig]
             Set the user/group LDAP server host, port, baseDN,
             authentication DN, and authentication password.

        -r[estart]
             Restart the admin server.

        -st[op]
             Stop the admin server.

    The task to be done can be specified using the abbreviated name such as
    -r for restarting the server or using the complete name -restart.
    The task name just needs to be specified so that it is not ambiguous
    among other tasks or the [options] above. The task key words are also
    case insensitive, so both -RESTART and -Restart are accepted as the
    -restart task.

    Multiple tasks can be run from the same invocation of admconfig. Tasks
    specified in an input file are run first. Tasks are run in the order
    specified in the input file and command line.


EXAMPLES:

    The following example changes the port number to 33333 and restarts the
    admin server. Note that the verbose level will be set to 5.

        % admconfig -server jaffer.mcom.com:22222 -user phlee:password
        -verbose 5 -setPort 33333 -restart


    The following example retrieves the hosts from which connections are
    allowed. Note that the verbose level will be set to 9.

        % admconfig -ser jaffer.mcom.com:33333 -u phlee:password -verb -geth


    The following example displays the help information for restarting the
    admin server.

        % admconfig -h r


[help-getaccesslog]

usage:  admconfig [options] -getAc[cessLog]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getaddresses]

usage:  admconfig [options] -getAdd[resses]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getclassname]

usage:  admconfig [options] -getCl[assname]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getcachelifetime]

usage:  admconfig [options] -getCa[cheLifetime]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getadminusers]

usage:  admconfig [options] -getAdminUs[ers]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getdefaultacceptlanguage]

usage:  admconfig [options] -getDe[faultAcceptLanguage]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-geterrorlog]

usage:  admconfig [options] -getE[rrorLog]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-gethosts]

usage:  admconfig [options] -getH[osts]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getoneacldir]

usage:  admconfig [options] -getO[neACLDir]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getport]

usage:  admconfig [options] -getPo[rt]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getserveraddress]

usage:  admconfig [options] -getSe[rverAddress]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getsystemuser]

usage:  admconfig [options] -getSy[ystemUser]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-restart]

usage:  admconfig [options] -r[estart]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-setaccesslog]

usage:  admconfig [options] -setAc[cessLog] <filename>

  Required parameter includes:
      <filename>     New server access log file.

  Use the admconfig -h option for help on [options].


[help-setaddresses]

usage:  admconfig [options] -setAdd[resses] <addresses>

  Required parameter includes:
      <addresses>    New addresses from which connections are allowed.

  Use the admconfig -h option for help on [options].


[help-setclassname]

usage:  admconfig [options] -setCl[assname] <filename>

  Required parameter includes:
      <filename>     New admin class file name.

  Use the admconfig -h option for help on [options].


[help-setcachelifetime]

usage:  admconfig [options] -setCa[cheLifetime] <msec>

  Required parameter includes:
      <msec>         New cache lifetime in msecs.

  Use the admconfig -h option for help on [options].


[help-setadminusers]

usage:  admconfig [options] -setAdminUs[ers] <adminusers>

  Required parameter includes:
      <adminusers>   New name for the admin users file.

  Use the admconfig -h option for help on [options].


[help-setdefaultacceptlanguage]

usage:  admconfig [options] -setDe[faultAcceptLanguage] <language>

  Required parameter includes:
      <language>     New default accept language.

  Use the admconfig -h option for help on [options].


[help-seterrorlog]

usage:  admconfig [options] -setE[rrorLog] <filename>

  Required parameter includes:
      <filename>     New server error log file.

  Use the admconfig -h option for help on [options].


[help-sethosts]

usage:  admconfig [options] -setH[osts] <hosts>

  Required parameter includes:
      <hosts>        New hosts from which connections are allowed.

  Use the admconfig -h option for help on [options].


[help-setoneacldir]

usage:  admconfig [options] -setO[neACLDir] <directory>

  Required parameter includes:
      <directory>    New ACL directory.

  Use the admconfig -h option for help on [options].


[help-setport]

usage:  admconfig [options] -setPo[rt] <port>

  Required parameter includes:
      <port>         New server port number.

  Use the admconfig -h option for help on [options].


[help-setserveraddress]

usage:  admconfig [options] -setSe[rverAddress] <address>

  Required parameter includes:
      <address>      New server address.

  Use the admconfig -h option for help on [options].


[help-setsystemuser]

usage:  admconfig [options] -setSy[stemUser] <user>

  Required parameter includes:
      <user>         New user name that the server should run as.

  Use the admconfig -h option for help on [options].


[help-stop]

usage:  admconfig [options] -st[op]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-counterrorlogentries]

usage:  admconfig [options] -countE[rrorlogEntries]

  This task should be performed prior to -viewErrorLogEntries in order
  to determine the number of entries that can be viewed in the error log.

  There are no additional options or parameters for this task.

  Use the admconfig -h option for help on [options].


[help-viewerrorlogentries]

usage:  admconfig [options] -viewE[rrorLogEntries] \"<start> <stop>\"

  Required parameter includes:
      <start>        The first log entry number to start displaying from.
      <stop>         The last log entry number to display.

  The backslash character is required before the quotes surrounding the two
  arguments to -viewErrorLogEntries. If not provided, on UNIX systems, the
  shell will evaluate the quotes and pass the arguments without the quotes
  to the command line. This will result in only <start> being assigned as
  the parameter to -viewErrorLogEntries. The backslash character before the
  quotes will prevent the quotes from being evaluated and allow both arguments
  to be assigned as the parameter to -viewErrorLogEntries.

  Use the admconfig -h option for help on [options].


[help-countaccesslogentries]

usage:  admconfig [options] -countA[ccesslogEntries]

  This task should be performed prior to -viewAccessLogEntries in order
  to determine the number of entries that can be viewed in the access log.

  There are no additional options or parameters for this task.

  Use the admconfig -h option for help on [options].


[help-viewaccesslogentries]

usage:  admconfig [options] -viewA[ccessLogEntries] \"<start> <stop>\"

  Required parameter includes:
      <start>        The first log entry number to start displaying from.
      <stop>         The last log entry number to display.

  The backslash character is required before the quotes surrounding the two
  arguments to -viewAccessLogEntries. If not provided, on UNIX systems, the
  shell will evaluate the quotes and pass the arguments without the quotes
  to the command line. This will result in only <start> being assigned as
  the parameter to -viewAccessLogEntries. The backslash character before the
  quotes will prevent the quotes from being evaluated and allow both arguments
  to be assigned as the parameter to -viewAccessLogEntries.

  Use the admconfig -h option for help on [options].


[help-enableenduseraccess]

usage:  admconfig [options] -enableE[ndUserAccess]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-disableenduseraccess]

usage:  admconfig [options] -disableE[ndUserAccess]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-enabledsgwaccess]

usage:  admconfig [options] -enableD[SGWAccess]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-disabledsgwaccess]

usage:  admconfig [options] -disableD[SGWAccess]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-getadminuid]

usage:  admconfig [options] -getAdminUI[D]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-setadminuid]

usage:  admconfig [options] -setAdminUI[D] <uid>

  Required parameter includes:
      <uid>          The new user ID for the administrator.

  Use the admconfig -h option for help on [options].


[help-setadminpwd]

usage:  admconfig [options] -setAdminP[WD] <password>

  Required parameter includes:
      <password>     The new password for the administrator.

  Use the admconfig -h option for help on [options].


[help-getdsconfig]

usage:  admconfig [options] -getDS[Config]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-setdsconfig]

usage:  admconfig [options] -setDS[Config] \"<host> <port> <ssl>\"

  Required parameter includes:
      <host>         The LDAP Server host name.
      <port>         The LDAP Server port number.
      <ssl>          "true" | "false" depending on whether to use the Secure
                     Sockets Layer to communicate with the LDAP Server.

  The backslash character is required before the quotes surrounding the four
  arguments to -setDSConfig. If not provided, on UNIX systems, the shell will
  evaluate the quotes and pass the arguments without the quotes to the
  command line. This will result in only <host> being assigned as the
  parameter to -setDSConfig. The backslash character before the quotes will
  prevent the quotes from being evaluated and allow all arguments to be
  assigned as the parameter to -setDSConfig.

  IMPORTANT NOTE: The space character is used to parse these four arguments.
  Therefore, none of the arguments may have spaces in them. In order to support
  spaces for the <baseDN> argument, the parsing function for this argument uses
  a character replacement scheme to allow spaces to be specified. Simply,
  whenever a space is required, the '+' character should be used to indicate to
  the parser to convert the character to space. For example, in order to specify
  "o=Netscape Communications Corp" as the <baseDN>, uses must type instead
  "o=Netscape+Communications+Corp". Because the  '+' character is used in place
  of the space character, the '+' character cannot be used as an actual value. For
  example, there is currently no way to specify "o=A+B Industries".

  Use the admconfig -h option for help on [options].


[help-getugdsconfig]

usage:  admconfig [options] -getU[GDSConfig]

  There are no additional options or parameters for this task.
  Use the admconfig -h option for help on [options].


[help-setugdsconfig]

usage:  admconfig [options] -setU[GDSConfig] [\"<host> <port> <baseDN> <ssl> <uid> <pwd>\"]

  Optional arguments includes:
      <host>         The user/group LDAP Server host name.
      <port>         The user/group LDAP Server port number.
      <baseDN>       The user/group LDAP Server base DN.
      <ssl>          "true" | "false" depending on whether to use the Secure
                     Sockets Layer to communicate with the LDAP Server.
      <uid>          Authentication DN used to bind to LDAP Server.
      <pwd>          Authentication password used to bind to LDAP Server.

  -setUGDSConfig can be invoked in two ways, with or without parameters. If
  this task is invoked without any arguments, for example,

    % admconfig -server jaffer.mcom.com:22222 -user admin:password -setUGDSConfig

  then the directory server configuration is reset to the installation
  defaults. On the other hand, if the task is invoked with all six arguments
  (all six arguments are required), then they override the installation
  defaults or the previous values that may have been set.

  The backslash character is required before the quotes surrounding the six
  arguments to -setUGDSConfig. If not used, on UNIX systems, the shell will
  evaluate the quotes and pass the arguments without the quotes to admconfig.
  This will result in only <host> being assigned as the parameter to
  -setUGDSConfig, which will cause the task to fail due to missing arguments.
  The backslash character before the quotes will prevent the quotes from being
  evaluated and allow all arguments to be assigned as the parameter to
  -setUGDSConfig.

  The <host>, <port>, <baseDN>, and <ssl> arguments are used to create the
  LDAP URL for the ugdsconfig.dirurl attribute. The <uid> argument is used to
  set the ugdsconfig.binddn attribute, and the <pwd> argument is used to set
  the ugdsconfig.bindpw attribute.

  IMPORTANT NOTE: The space character is used to parse these six arguments.
  Therefore, none of the arguments may have spaces in them. In order to support
  spaces for arguments such as <baseDN>, <uid>, and <pwd>, the parsing function
  for these three arguments uses a character replacement scheme to allow spaces
  to be specified. Simply, whenever a space is required, the '+' character
  should be used to indicate to the parser to convert the character to space.
  For example, in order to specify "cn=directory manager" as the <uid>, users
  must type "cn=directory+manager". Because the  '+' character is used in place
  of the space character, the '+' character cannot be used as an actual value.
  For example, there is currently no way to specify "[r@K+h1s" as the <pwd>
  since this will be translated to "Cr@K h1s".

  Use the admconfig -h option for help on [options].


