
Administration Commands                create-lifecycle-module(1)

NAME
     create-lifecycle-module - adds a lifecycle module

SYNOPSIS
     create-lifecycle-module  --classname classname
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--help]

     [ --enabled =true] [--target target]
     [--classpath classpath] [--loadorder loadorder]
     [--failurefatal=false ] [ --description  description]
     [--property (name=value)[:name=value]*]
     module_name

DESCRIPTION
     Creates the lifecycle module. The lifecycle modules  provide
     a  means  of running short or long duration Java-based tasks
     within the environment.  This command is supported in remote
     mode only.

OPTIONS
     --classname                 This is the fully qualified name
                                 of the startup class.

     -t --terse                  Indicates that any  output  data
                                 must  be very concise, typically
                                 avoiding   human-friendly   sen-
                                 tences    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
                                 standard  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  administration server is
                                 running. The  default  value  is
                                 localhost.

Java EE 5           Last change: 30 Jan 2007                    1

Administration Commands                create-lifecycle-module(1)

     -p --port                   The HTTP/S port for  administra-
                                 tion.  This is the port to which
                                 you 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
                                 administration server.

     -u --user                   The authorized  domain  adminis-
                                 tration   server  administrative
                                 username.

                                 If you have authenticated  to  a
                                 domain  using  the asadmin login
                                 command,  then  you   need   not
                                 specify  the  --user  option  on
                                 subsequent  operations  to  this
                                 particular domain.

     --passwordfile              The --passwordfile option speci-
                                 fies  the  name,  including  the
                                 full path, of a file  containing
                                 the   password   entries   in  a
                                 specific format. The  entry  for
                                 the   password   must  have  the
                                 AS_ADMIN_ prefix followed by the
                                 password   name   in   uppercase
                                 letters.

                                 For  example,  to  specify   the
                                 domain   administration   server
                                 password, use an entry with  the
                                 following                format:
                                 AS_ADMIN_PASSWORD=password,
                                 where  password  is  the  actual
                                 administrator  password.   Other
                                 passwords  that can be specified
                                 include AS_ADMIN_MAPPEDPASSWORD,
                                 AS_ADMIN_USERPASSWORD,       and
                                 AS_ADMIN_ALIASPASSWORD.

                                 All remote commands must specify
                                 the  admin password to authenti-
                                 cate to the  domain  administra-
                                 tion  server,  either through --

Java EE 5           Last change: 30 Jan 2007                    2

Administration Commands                create-lifecycle-module(1)

                                 passwordfile or  asadmin  login,
                                 or  interactively on the command
                                 prompt. The asadmin  login  com-
                                 mand can be used only to specify
                                 the admin  password.  For  other
                                 passwords,  that  must be speci-
                                 fied for  remote  commands,  use
                                 the --passwordfile or enter them
                                 at the command prompt.

                                 If you have authenticated  to  a
                                 domain  using  the asadmin login
                                 command,  then  you   need   not
                                 specify   the   admin   password
                                 through    the    --passwordfile
                                 option  on subsequent operations
                                 to this particular domain.  How-
                                 ever, this is applicable 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 com-
                                 mands, such as update-file-user.

                                 For security reasons,  passwords
                                 specified   as   an  environment
                                 variable will  not  be  read  by
                                 asadmin.

                                 The    default     value     for
                                 AS_ADMIN_MASTERPASSWORD       is
                                 changeit.

     --help                      Displays the help text  for  the
                                 command.

     --target                    Indicates the location where the
                                 lifecycle is to be created.  The
                                 valid targets for  this  command
                                 are  name  of  a  configuration,
                                 instance, cluster,  and  server.
                                 The  default is server, which is
                                 the name of the  default  server
                                 instance.

     --classpath                 This option indicates where this
                                 module is actually located if it
                                 is not under applications-root.

Java EE 5           Last change: 30 Jan 2007                    3

Administration Commands                create-lifecycle-module(1)

     --loadorder                 This   option   represents    an
                                 integer  value  that can be used
                                 to  force  the  order  in  which
                                 deployed  lifecycle  modules are
                                 loaded   at   server    startup.
                                 Smaller   numbered  modules  get
                                 loaded sooner. Order is unspeci-
                                 fied  if  two  or more lifecycle
                                 modules have the same load-order
                                 value.

     --failurefatal              This options  tells  the  system
                                 what  to  do  if  the  lifecycle
                                 module does not load  correctly.
                                 When this option is set to true,
                                 the  system  aborts  the  server
                                 startup  if this module does not
                                 load properly. The default value
                                 is false.

     --enabled                   This option  determines  whether
                                 the  resource is enabled at run-
                                 time.  The  default  values   is
                                 true.

     --description               This is the text description  of
                                 the   resource  associated  with
                                 this module.

     --property                  This is  an  optional  attribute
                                 containing name/value pairs used
                                 to configure the resource.

OPERANDS
     module_name                 This operand is a  unique  iden-
                                 tifier  for  the deployed server
                                 lifecycle event listener module.

EXAMPLES
     Example 1 using create-lifecycle-module

       asadmin> create-lifecycle-module --user admin --passwordfile adminpassword.txt
       --host fuyako --port 7070 --classname "com.acme.CustomSetup"
       --classpath "/export/customSetup" --loadorder 1 --failurefatal=true
       --description "this is a sample customSetup"
       --property rmi="Server=acme1:7070":timeout=30 customSetup

Java EE 5           Last change: 30 Jan 2007                    4

Administration Commands                create-lifecycle-module(1)

       Command create-lifecycle-module executed successfully

     Where: customSetup is the  lifecycle  module  created.   The
     escape  character  is used in the property option to distin-
     guish the colons (:).

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

SEE ALSO
     delete-lifecycle-module(1), list-lifecycle-modules(1)

Java EE 5           Last change: 30 Jan 2007                    5

