
Administration Commands                   create-jndi-resource(1)

NAME
     create-jndi-resource - registers a JNDI resource

SYNOPSIS
     create-jndi-resource
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--help]
     [ --target target]
     --jndilookupname lookup_name --restype type
     --factoryclass class_name [--enabled=true]
     [ --description  text] [--property (name=value)[:name=value]*]
     jndi_name

DESCRIPTION
     The create-jndi-resource command registers a JNDI  resource.
     This command is supported in remote mode only.

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.

     -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.

Java EE 5           Last change: 30 Jan 2007                    1

Administration Commands                   create-jndi-resource(1)

                                 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 --
                                 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

Java EE 5           Last change: 30 Jan 2007                    2

Administration Commands                   create-jndi-resource(1)

                                 specified 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                    This option  helps  specify  the
                                 target   on   which   the   JNDI
                                 resource is registered .

                                 Valid  values  for  target   are
                                 described below.

                                     o    server-  Specifies  the
                                          default server instance
                                          as   the   target   for
                                          registering   the  JNDI
                                          resource.   server   is
                                          the name of the default
                                          server instance and  is
                                          the default value.

                                     o    domain-   Specifies   a
                                          certain  domain  as the
                                          target for  registering

Java EE 5           Last change: 30 Jan 2007                    3

Administration Commands                   create-jndi-resource(1)

                                          the JNDI resource.

                                     o    cluster_name- Specifies
                                          a  certain  cluster  as
                                          the target  for  regis-
                                          tering     the     JNDI
                                          resource.

                                     o    instance_name-   Speci-
                                          fies a certain instance
                                          as   the   target   for
                                          registering   the  JNDI
                                          resource.

     --jndilookupname            The lookup name that the  exter-
                                 nal container uses.

     --resourcetype              This option is  deprecated.  Use
                                 ---restype instead.

     --restype                   The JNDI resource type.  It  can
                                 be topic or queue.

     --factoryclass              The class that creates the  JNDI
                                 resource.

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

     --description               The text that  provides  details
                                 about the JNDI resource.

     --property                  Optional  attribute   name/value
                                 pairs    for   configuring   the
                                 resource.  The following proper-
                                 ties are available:

                                 http-listener-1-port         This
                                                              pro-
                                                              perty
                                                              speci-
                                                              fies
                                                              the
                                                              port
                                                              number

Java EE 5           Last change: 30 Jan 2007                    4

Administration Commands                   create-jndi-resource(1)

                                                              for
                                                              http-
                                                              listener-
                                                              1.
                                                              Valid
                                                              values
                                                              are
                                                              1-
                                                              65535.
                                                              On
                                                              UNIX,
                                                              creat-
                                                              ing
                                                              sock-
                                                              ets
                                                              that
                                                              listen
                                                              on
                                                              ports
                                                              1-1024
                                                              requires
                                                              superuser
                                                              privileges.

                                 http-listener-2-port         This
                                                              pro-
                                                              perty
                                                              speci-
                                                              fies
                                                              the
                                                              port
                                                              number
                                                              for
                                                              http-
                                                              listener-
                                                              2.
                                                              Valid
                                                              values
                                                              are
                                                              1-
                                                              65535.
                                                              On
                                                              UNIX,
                                                              creat-
                                                              ing
                                                              sock-
                                                              ets
                                                              that
                                                              listen
                                                              on
                                                              ports

Java EE 5           Last change: 30 Jan 2007                    5

Administration Commands                   create-jndi-resource(1)

                                                              1-1024
                                                              requires
                                                              superuser
                                                              privileges.

                                 orb-listener-1-port          This
                                                              pro-
                                                              perty
                                                              speci-
                                                              fies
                                                              the
                                                              ORB
                                                              listener
                                                              port
                                                              for
                                                              IIOP
                                                              con-
                                                              nec-
                                                              tions
                                                              that
                                                              orb-
                                                              listener-
                                                              1
                                                              listens
                                                              on.

                                 IIOP_SSL_LISTENER_PORT       This
                                                              pro-
                                                              perty
                                                              speci-
                                                              fies
                                                              the
                                                              ORB
                                                              listener
                                                              port
                                                              for
                                                              IIOP
                                                              con-
                                                              nec-
                                                              tions
                                                              that
                                                              the
                                                              IIOP
                                                              listener
                                                              called
                                                              SSL
                                                              listens
                                                              on.

Java EE 5           Last change: 30 Jan 2007                    6

Administration Commands                   create-jndi-resource(1)

                                 IIOP_SSL_MUTUALAUTH_PORT     This
                                                              pro-
                                                              perty
                                                              speci-
                                                              fies
                                                              the
                                                              ORB
                                                              listener
                                                              port
                                                              for
                                                              IIOP
                                                              con-
                                                              nec-
                                                              tions
                                                              that
                                                              the
                                                              IIOP
                                                              listener
                                                              called
                                                              SSL_MUTUALAUTH
                                                              listens
                                                              on.

                                 JMX_SYSTEM_Connector-port    This
                                                              pro-
                                                              perty
                                                              speci-
                                                              fies
                                                              the
                                                              port
                                                              number
                                                              on
                                                              which
                                                              the
                                                              JMX
                                                              con-
                                                              nec-
                                                              tor
                                                              listens.
                                                              Valid
                                                              values
                                                              are
                                                              1-
                                                              65535.
                                                              On
                                                              UNIX,
                                                              creat-
                                                              ing
                                                              sock-
                                                              ets
                                                              that

Java EE 5           Last change: 30 Jan 2007                    7

Administration Commands                   create-jndi-resource(1)

                                                              listen
                                                              on
                                                              ports
                                                              1-1024
                                                              requires
                                                              superuser
                                                              privileges.

OPERANDS
     jndi_name                   The name of the JNDI resource to
                                 be  created.  This  name must be
                                 unique.

EXAMPLES
     Example 1 Using the create-jndi-resource command

       asadmin> create-jndi-resource --user admin --passwordfile passwords.txt
       --host pigeon --port 4001 --jndilookupname sample_jndi --restype queue
       --factoryclass sampleClass --description "this is a sample jndi
       resource" sample_jndi_resource
       Command create-jndi-resource executed successfully

     Where sample_jndi_resource is the new JNDI resource created.

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

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

Java EE 5           Last change: 30 Jan 2007                    8

