
Administration Commands                    create-admin-object(1)

NAME
     create-admin-object - adds the administered object with  the
     specified JNDI name

SYNOPSIS
     create-admin-object   --restype aorestype
     --raname  resource_adapter_name
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--help]

     [ --enabled ={true | false}] [--target target] [--description text]
     [--property name=value[:name=value]*]
     jndi_name

DESCRIPTION
     This command creates the  administered  object  that  has  a
     specified JNDI name.

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: 24 July 2007                   1

Administration Commands                    create-admin-object(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: 24 July 2007                   2

Administration Commands                    create-admin-object(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                    Specifies the  target  on  which
                                 you   are  creating  the  admin-
                                 istered object. Valid values are

                                     o    server-  Specifies  the
                                          default server instance
                                          as   the   target   for
                                          creating   the   admin-
                                          istered   object.   The
                                          name   of  the  default
                                          server   instance    is
                                          server   and   is   the
                                          default value for  this
                                          option.

                                     o    configuration_name-
                                          Specifies  a particular
                                          configuration  as   the
                                          target for creating the

Java EE 5           Last change: 24 July 2007                   3

Administration Commands                    create-admin-object(1)

                                          administered object.

                                     o    cluster_name- Specifies
                                          a particular cluster as
                                          the target for creating
                                          the        administered
                                          object.

                                     o    instance_name-   Speci-
                                          fies    a    particular
                                          server instance as  the
                                          target for creating the
                                          administered object.

     --enabled                   Specifies  if  this  object   is
                                 enabled.  The  default  value is
                                 true.

     --restype                   This option is used to  adminis-
                                 ter  the  object resource types,
                                 as  defined  by   the   resource
                                 adapter in the ra.xml file.

      --raname                   This is the name of the resource
                                 adapter   associated  with  this
                                 object.

     --description               This option is the text descrip-
                                 tion of the administered object.

     --property                  This   option   describes    the
                                 "name/values"  pairs  for confi-
                                 guring the resource.

OPERANDS
     jndi_name                   This is the  JNDI  name  of  the
                                 administered    object   to   be
                                 created.

EXAMPLES
     Example 1 Using create-admin-object

     The javax.jms.Queue  resource  type  is  obtained  from  the
     ra.xml  file.  The  jmsrar.rar  must  be  deployed  prior to

Java EE 5           Last change: 24 July 2007                   4

Administration Commands                    create-admin-object(1)

     executing this command.

       asadmin> create-admin-object --user admin1 --passwordfile  passwords.txt
       --restype javax.jms.Queue --raname jmsra --description "sample administered object"
       --property Name=sample_jmsqueue jms/samplequeue
       Command create-admin-object executed successfully

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

SEE ALSO
     delete-admin-object(1), list-admin-objects(1)

Java EE 5           Last change: 24 July 2007                   5

