+

Search Tips   |   Advanced Search

Invoking an administrative command in interactive mode using wsadmin.sh

These steps demonstrate how to invoke an administrative command in interactive mode.

The steps describe how to invoking an administrative command in interactive mode.

To invoke an administrative command in batch mode, see the topic on invoking a command batch mode.


Tasks

  1. Invoke the AdminTask object commands interactively, in a script, or use the wsadmin -c command from an operating system command prompt.

    See the topic on starting the wsadmin scripting client.

  2. Invoke an administrative command in interactive mode by issuing one of the following commands:

    • Use the following command invocation to enter interactive mode without providing another input in the command invocation:

      Use Jacl:

      $AdminTask commandName {-interactive}
      

      Use Jython:

      AdminTask.commandName('[-interactive]')
      

      Element Description
      $ Jacl operator for substituting a variable name with its value
      AdminTask is an object that supports administrative command management
      commandName is the name of the administrative command to invoke
      -interactive is the interactive option

    • Use the following command invocation to enter interactive mode using an administrative command that takes a target object. We do not have to provide a target object to enter interactive mode. Target objects provided in the command invocation will be applied to the command and displayed as the current target object value during interactive prompting.

      Use Jacl:

      $AdminTask commandName targetObject {-interactive}
      

      Use Jython:

      AdminTask.commandName(targetObject, '[-interactive]')
      

      Element Description
      $ Jacl operator for substituting a variable name with its value
      AdminTask object that supports administrative command management
      commandName Name of the administrative command to invoke
      targetObject is the target object string for the invoked administrative command. The target object is different for each administrative command. View the online help for the invoked administrative command to learn more about what to specify as a target object.
      -interactive is the interactive option

    • Use the following command invocation to enter interactive mode for an administrative command that takes options. We do not have to provide other options to enter interactive mode. Options provided in the command invocation are applied to the command and the option values will be displayed as the current values during interactive prompting.

      Use Jacl:

      $AdminTask commandName {-interactive commandOptions}
      

      Use Jython:

      AdminTask.commandName('[-interactive commandOptions]')
      

      Element Description
      $ Jacl operator for substituting a variable name with its value
      AdminTask object that supports administrative command management
      commandName Name of the administrative command to invoke
      -interactive is the interactive option
      commandOptions is the command option available for the associated administrative command. Available command options are different for each administrative command. View the online help for the invoked administrative command to obtain more information about which options are available. Arguments and steps listed on the online administrative command help are specified as command options. Each option consists of a dash followed immediately by an option name, and then followed by an option value if the option requires a value. For example, using the output of the following online help for the createJ2CConnectionFactory command:
      WASX8006I: Detailed help for command: 
      createJ2CConnectionFactory
      
      Description: Create a J2C connection 
      factory
      
      *Target object: The parent J2C resource 
      adapter of the created J2C connection 
      factory.
      
      Arguments:
      *connectionFactoryInterface - A connection 
      factory interface that is 
      defined in the deployment description of 
      the parent J2C resource adapter.
      *name - The name of the J2C connection factory.
      *jndiName - The JNDI name of the created 
      J2C connection factory.
      description - The description for the created 
      J2C connection factory.
      authDataAlias - the authentication data alias 
      of the created J2C connection factory.
      
      Steps:
      None
      
      In this example, five options are available:

      • -connectionFactoryInterface
      • -name
      • -jndiName
      • -description
      • -authDataAlias

      Each option requires a value. Three of the options are required and are denoted with a star (*).

    • Use the following command invocation to enter interactive mode for an administrative command that has a target object and options. We do not have to specify a target object to enter interactive mode. The values specified are applied to the command before the command data is displayed. As a result, the values specified will be displayed as the current values during interactive prompting.

      Use Jacl:

      $AdminTask commandName targetObject {-interactive commandOptions}
      

      Use Jython:

      AdminTask.commandName(targetObject, '[-interactive commandOptions]')
      

      Element Description
      $ Jacl operator for substituting a variable name with its value
      AdminTask object that supports administrative command management
      commandName Name of the administrative command to invoke
      targetObject is the target object string for the invoked administrative command. The expect target object varies with each admin command. Consult the online help on the invoked administrative command to learn more about what to specify as target object.
      -interactive is the interactive option
      commandOptions is the command option available for the associated administrative command. Available command options are different for each administrative command. View the online help for the invoked administrative command to obtain more information about which options are available. Arguments and steps listed on the online administrative command help are specified as command options. Each option consists of a dash followed immediately by an option name, and then followed by an option value if the option requires a value. For example, using the output of the following online help for the createJ2CConnectionFactory command:
      WASX8006I: Detailed help for command: 
      createJ2CConnectionFactory
      
      Description: Create a J2C connection factory
      
      *Target object: The parent J2C resource adapter of 
      the created J2C connection factory.
      
      Arguments:
      *connectionFactoryInterface - A connection factory 
      interface that is 
      defined in the deployment description of the 
      parent J2C resource adapter.
      *name - The name of the J2C connection factory.
      *jndiName - The JNDI name of the created J2C 
      connection factory.
      description - The description for the created 
      J2C connection factory.
      authDataAlias - the authentication data alias 
      of the created J2C connection factory.
      
      Steps:
      None
      
      In this example, five options are available:

      • -connectionFactoryInterface
      • -name
      • -jndiName
      • -description
      • -authDataAlias

      Each option requires a value. Three of the options are required and are denoted with a star (*).


Example


Subtopics

  • Invoking an administrative command in batch mode
  • Start the wsadmin scripting client