
Administration Commands        configure-webservice-management(1)

NAME
     configure-webservice-management -  sets  the  monitoring  or
     maxhistorysize attributes of a deployed web service

SYNOPSIS
     configure-webservice-management
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--help]

     [ --monitoring  = {OFF | LOW | HIGH}] [--maxhistory maxhistory-size]  webservice-end-point

DESCRIPTION
     Use this command to configure the monitoring or the  maxhis-
     tory attributes of a deployed webservice.

OPTIONS
     -t --terse                          Indicates that any  out-
                                         put  data  must  be very
                                         concise,       typically
                                         avoiding  human-friendly
                                         sentences  and  favoring
                                         well-formatted  data for
                                         consumption by a script.
                                         Default is false.

     -e --echo                           Setting  to  true   will
                                         echo  the  command  line
                                         statement on  the  stan-
                                         dard  output. Default is
                                         false.

     -I --interactive                    If    set    to     true
                                         (default),    only   the
                                         required        password
                                         options are prompted.

     -H --host                           The machine  name  where
                                         the  domain  administra-
                                         tion server is  running.
                                         The   default  value  is
                                         localhost.

     -p --port                           The  HTTP/S   port   for
                                         administration.  This is
                                         the port  to  which  you

Java EE 5           Last change: 16 July 2007                   1

Administration Commands        configure-webservice-management(1)

                                         should     point    your
                                         browser  in   order   to
                                         manage  the  domain. For
                                         example,
                                         http://localhost:4848.

                                         The default port  number
                                         is 4848.

     -s --secure                         If  set  to  true,  uses
                                         SSL/TLS  to  communicate
                                         with the domain adminis-
                                         tration server.

     -u --user                           The  authorized   domain
                                         administration    server
                                         administrative username.

                                         If  you  have  authenti-
                                         cated  to a domain using
                                         the asadmin  login  com-
                                         mand,  then you need not
                                         specify    the    --user
                                         option   on   subsequent
                                         operations to this  par-
                                         ticular domain.

     --passwordfile                      The       --passwordfile
                                         option   specifies   the
                                         name, including the full
                                         path, of a file contain-
                                         ing the password entries
                                         in  a  specific  format.
                                         The entry for the  pass-
                                         word   must   have   the
                                         AS_ADMIN_  prefix   fol-
                                         lowed  by  the  password
                                         name    in     uppercase
                                         letters.

                                         For example, to  specify
                                         the  domain  administra-
                                         tion  server   password,
                                         use  an  entry  with the
                                         following        format:
                                         AS_ADMIN_PASSWORD=password,
                                         where  password  is  the
                                         actual     administrator
                                         password.          Other

Java EE 5           Last change: 16 July 2007                   2

Administration Commands        configure-webservice-management(1)

                                         passwords  that  can  be
                                         specified        include
                                         AS_ADMIN_MAPPEDPASSWORD,
                                         AS_ADMIN_USERPASSWORD,
                                         and
                                         AS_ADMIN_ALIASPASSWORD.

                                         All remote commands must
                                         specify  the admin pass-
                                         word to authenticate  to
                                         the  domain  administra-
                                         tion   server,    either
                                         through   --passwordfile
                                         or  asadmin  login,   or
                                         interactively   on   the
                                         command   prompt.    The
                                         asadmin   login  command
                                         can  be  used  only   to
                                         specify  the admin pass-
                                         word.  For  other  pass-
                                         words,   that   must  be
                                         specified   for   remote
                                         commands,   use  the  --
                                         passwordfile  or   enter
                                         them   at   the  command
                                         prompt.

                                         If  you  have  authenti-
                                         cated  to a domain using
                                         the asadmin  login  com-
                                         mand,  then you need not
                                         specify the admin  pass-
                                         word   through   the  --
                                         passwordfile  option  on
                                         subsequent operations to
                                         this particular  domain.
                                         However,  this is appli-
                                         cable      only       to
                                         AS_ADMIN_PASSWORD
                                         option. You  will  still
                                         need   to   provide  the
                                         other   passwords,   for
                                         example,
                                         AS_ADMIN_USERPASSWORD,
                                         as  and when required by
                                         individual     commands,
                                         such   as   update-file-
                                         user.

                                         For  security   reasons,
                                         passwords  specified  as
                                         an environment  variable

Java EE 5           Last change: 16 July 2007                   3

Administration Commands        configure-webservice-management(1)

                                         will   not  be  read  by
                                         asadmin.

                                         The  default  value  for
                                         AS_ADMIN_MASTERPASSWORD
                                         is changeit.

     --help                              Displays the  help  text
                                         for the command.

     --monitoring                        Enables  monitoring  for
                                         webservices. If enabled,
                                         tracks       operational
                                         statistics,  such as the
                                         number of  requests  per
                                         second, average response
                                         time,  and   throughput.
                                         Allowed values are:

                                             o    LOW:    Enables
                                                  monitoring  for
                                                  the whole  web-
                                                  service.     No
                                                  method    level
                                                  monitoring will
                                                  be done.

                                             o    HIGH:   Message
                                                  Trace  is  also
                                                  enabled      in
                                                  addition     to
                                                  enabling number
                                                  of requests per
                                                  second, average
                                                  response  time,
                                                  and  throughput
                                                  attributes.

                                             o    OFF:   Disables
                                                  monitoring  and
                                                  this   is   the
                                                  default.

     --maxhistorysize                     indicates  the  maximum
                                         number   of   monitoring
                                         records stored  in  his-
                                         tory  for  this web ser-
                                         vice  endpoint.  Default
                                         value is 25.

Java EE 5           Last change: 16 July 2007                   4

Administration Commands        configure-webservice-management(1)

OPERANDS
     webservice-end-point        name of the webservice  endpoint
                                 to   which   the   configuration
                                 management attributes are  being
                                 set.

EXAMPLES
     Example 1 To turn on monitoring for a webservice endpoint

       asadmin> configure-webservice-management --monitoring=LOW
       jaxrpc-simple#jaxrpc-simple.war#HelloIF
       Command configure-webservice-management executed successfully

     Example 2 To turn message tracing facility on for a  webser-
     vice endpoint

       asadmin> configure-webservice-management --monitoring=HIGH
       --maxhistorysize=250 jaxrpc-simple#jaxrpc-simple.war#HelloIF
       Command configure-webservice-management executed successfully

     Where jaxrpc-simple#jaxrpc-simple.war#HelloIF is  the  fully
     qualified name of a webservice endpoint.

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

Java EE 5           Last change: 16 July 2007                   5

