
Administration Commands            create-persistence-resource(1)

NAME
     create-persistence-resource  -   registers   a   persistence
     resource

SYNOPSIS
     create-persistence-resource
     [--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] [--jdbcjndiname jndi_name
     |  --connectionpoolid id] [--factoryclass classname]
     [--description text] [--property (name=value)[:name=value]*]
     jndi_name

DESCRIPTION
     The create-persistence-resource  command  registers  a  per-
     sistence  resource. This command is supported in remote mode
     only.

     The options --jdbcjndiname and --connectionpoolid are  mutu-
     ally exclusive; only one should be used.

OPTIONS
     -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-persistence-resource(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-persistence-resource(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.

     --enabled                   Determines whether the  resource
                                 is enabled at runtime.

     --target                    Specifies the target  for  which
                                 you  are  creating a persistence
                                 resource. Valid targets are:

                                     o    server-  Specifies  the
                                          default server instance
                                          as the target.   server
                                          is   the  name  of  the
                                          default server instance

Java EE 5           Last change: 30 Jan 2007                    3

Administration Commands            create-persistence-resource(1)

                                          and   is   the  default
                                          value.

                                     o    domain-   Specifies   a
                                          certain  domain  as the
                                          target.

                                     o    cluster_name- Specifies
                                          a  certain  cluster  as
                                          the target.

                                     o    instance_name-   Speci-
                                          fies  a  certain server
                                          instance as the target.
                                 This option  is  valid  only  in
                                 domains  that  are configured to
                                 support   clusters,   such    as
                                 domains  that  are  created with
                                 the  cluster  profile   or   the
                                 enterprise profile.

     --jdbcjndiname              Specifies the JDBC resource with
                                 which  database  connections are
                                 obtained. It must be the name of
                                 an existing JDBC resource.

     --connectionpoolid          This option and the  option  ---
                                 jdbcjndiname     are    mutually
                                 exclusive.         If        ---
                                 connectionpoolid  is  specified,
                                 then a  jdbc  resource  will  be
                                 created   behind the scenes with
                                 'PM' suffixed to the persistence
                                 resource name.  See example.

     --factoryclass              Deprecated, and not  needed  for
                                 the  default CMP implementation.
                                 Specifies the class that creates
                                 the      persistence     manager
                                 instance.

     --description               Specifies a text description  of
                                 the persistence resource.

     --property                  Specifies  optional   name/value
                                 pairs  for  configuring the per-
                                 sistence resource.

Java EE 5           Last change: 30 Jan 2007                    4

Administration Commands            create-persistence-resource(1)

OPERANDS
     jndi_name                   Specifies the JNDI name  of  the
                                 persistence resource.

EXAMPLES
     Example 1 Using create-persistence-resource

       asadmin> create-persistence-resource --user admin --passwordfile passwords.txt
       --jdbcjndiname jdbc/sample sample_persistence_resource
       Command create-persistence-resource executed successfully

     Example 2 Using create-persistence-resource

       asadmin> create-persistence-resource --user admin --passwordfile passwords.txt
       --connectionpoolid testPool testPersistence
       Command create-persistence-resource executed successfully

     This command creates a jdbc resource with the name  testPer-
     sistencePM  referencing  testPool.  When you delete the per-
     sistence resource, the jdbc resource created by this command
     is also removed.

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

SEE ALSO
     delete-persistence-resource(1),            list-persistence-
     resources(1)

Java EE 5           Last change: 30 Jan 2007                    5

