glassfish
  1. glassfish
  2. GLASSFISH-15566

change-master-password --help has wrong content

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.1
    • Component/s: docs
    • Labels:
      None

      Description

      Note the contents of help of change-master-password.
      It shows agent dir and has references to node agent.
      Is the new content being worked on? Filing bug to keep track of the issue

      asadmin change-master-password --help

      asadmin Utility Subcommands change-master-password(1)

      NAME
      change-master-password - changes the master password

      SYNOPSIS
      change-master-password [--help] [--domaindir domain_path | --agentdir node-agent_path]
      [--nodedir node_name]
      [--savemasterpassword=

      {false|true}] [domain_name | node_agent_name]

      DESCRIPTION
      The change-master-password subcommand is used to modify the
      master password. The change-master-password subcommand is
      interactive in that the user is prompted for the old master
      password, as well as the new master password. This subcom-
      mand will not work unless the server is stopped. In a dis-
      tributed environment, this command must run on each machine
      in the domain, with the node agent stopped.

      OPTIONS
      --help
      -?

      Displays the help text for the subcommand.

      --domaindir
      This option specifies the directory used for this opera-
      tion. By default, the --domaindir option is
      $AS_DEF_DOMAINS_PATH, which is an environment variable
      defined in the file asenv.bat or asenv.conf.

      Do not specify the --domaindir option and the --agentdir
      option in the same command. Use one option or the other.

      --agentdir

      Like a domain administration server (DAS), each node
      agent resides in a top level directory named
      agentdir/nodeagent-name. If the --agentdir option is not
      specified, the directory
      $AS_DEF_DOMAINS_PATH/../nodeagents is used.

      Do not specify the --domaindir option and the --agentdir
      option in the same command. Use one option or the other.

      --nodedir
      The name of specific node instance to which the subcom-
      mand should apply. If this option is omitted, the change
      is applied to the entire domain.

      Java EE 6 Last change: 22 Dec 2010 1

      asadmin Utility Subcommands change-master-password(1)

      --savemasterpassword

      This option indicates whether the master password should
      be written to the file system. This is necessary so that
      the start-domain(1) command can start the server without
      having to prompt the user.

      The default is false.

      Caution -

      Saving the master password on disk is extremely
      insecure and should be avoided.

      Note -

      If the --savemasterpassword option is not set, the
      master password file, if it exists, will be deleted.

      OPERANDS
      domain_name
      This is the domain name whose password is to be changed.
      If there is only a single domain, this is optional.

      node_agent_name

      This is the name of the node agent whose password is to
      be changed.

      node_dir
      The directory containing the node instance for which the
      password will be changed.

      EXAMPLES
      Example 1 Changing the Master Password

      This example shows how to changed the master password for
      the domain44ps domain.

      asadmin>change-master-password domain44ps
      Please enter the new master password>
      Please enter the new master password again>
      Master password changed for domain44ps

      Java EE 6 Last change: 22 Dec 2010 2

      asadmin Utility Subcommands change-master-password(1)

      EXIT STATUS
      0 subcommand executed successfully

      1 error in executing the subcom-
      mand

      SEE ALSO
      delete-password-alias(1), list-password-aliases(1), start-
      domain(1), update-password-alias(1)

      asadmin(1M)

      Java EE 6 Last change: 22 Dec 2010 3


      asadmin Utility Subcommands change-master-password(1)

      NAME
      change-master-password - changes the master password

      SYNOPSIS
      change-master-password [--help] [--domaindir domain_path | --agentdir node-agent_path]
      [--nodedir node_name]
      [--savemasterpassword={false|true}

      ] [domain_name | node_agent_name]

      DESCRIPTION
      The change-master-password subcommand is used to modify the
      master password. The change-master-password subcommand is
      interactive in that the user is prompted for the old master
      password, as well as the new master password. This subcom-
      mand will not work unless the server is stopped. In a dis-
      tributed environment, this command must run on each machine
      in the domain, with the node agent stopped.

      OPTIONS
      --help
      -?

      Displays the help text for the subcommand.

      --domaindir
      This option specifies the directory used for this opera-
      tion. By default, the --domaindir option is
      $AS_DEF_DOMAINS_PATH, which is an environment variable
      defined in the file asenv.bat or asenv.conf.

      Do not specify the --domaindir option and the --agentdir
      option in the same command. Use one option or the other.

      --agentdir

      Like a domain administration server (DAS), each node
      agent resides in a top level directory named
      agentdir/nodeagent-name. If the --agentdir option is not
      specified, the directory
      $AS_DEF_DOMAINS_PATH/../nodeagents is used.

      Do not specify the --domaindir option and the --agentdir
      option in the same command. Use one option or the other.

      --nodedir
      The name of specific node instance to which the subcom-
      mand should apply. If this option is omitted, the change
      is applied to the entire domain.

      Java EE 6 Last change: 22 Dec 2010 1

      asadmin Utility Subcommands change-master-password(1)

      --savemasterpassword

      This option indicates whether the master password should
      be written to the file system. This is necessary so that
      the start-domain(1) command can start the server without
      having to prompt the user.

      The default is false.

      Caution -

      Saving the master password on disk is extremely
      insecure and should be avoided.

      Note -

      If the --savemasterpassword option is not set, the
      master password file, if it exists, will be deleted.

      OPERANDS
      domain_name
      This is the domain name whose password is to be changed.
      If there is only a single domain, this is optional.

      node_agent_name

      This is the name of the node agent whose password is to
      be changed.

      node_dir
      The directory containing the node instance for which the
      password will be changed.

      EXAMPLES
      Example 1 Changing the Master Password

      This example shows how to changed the master password for
      the domain44ps domain.

      asadmin>change-master-password domain44ps
      Please enter the new master password>
      Please enter the new master password again>
      Master password changed for domain44ps

      Java EE 6 Last change: 22 Dec 2010 2

      asadmin Utility Subcommands change-master-password(1)

      EXIT STATUS
      0 subcommand executed successfully

      1 error in executing the subcom-
      mand

      SEE ALSO
      delete-password-alias(1), list-password-aliases(1), start-
      domain(1), update-password-alias(1)

      asadmin(1M)

      Java EE 6 Last change: 22 Dec 2010 3

      Command change-master-password executed successfully.

        Issue Links

          Activity

          Bhakti Mehta created issue -
          Paul Davies made changes -
          Field Original Value New Value
          Assignee Paul Davies [ pauldavies ] sfordin [ sfordin ]
          Fix Version/s 3.1 [ 10968 ]
          Paul Davies made changes -
          Link This issue blocks GLASSFISH-15929 [ GLASSFISH-15929 ]
          Hide
          Scott Fordin added a comment -

          Completed edits to man page and checked page into doc workspace. Removed references to node agents and node dirs.

          Show
          Scott Fordin added a comment - Completed edits to man page and checked page into doc workspace. Removed references to node agents and node dirs.
          Scott Fordin made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]

            People

            • Assignee:
              Scott Fordin
              Reporter:
              Bhakti Mehta
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: