WebSphere Application Server - Express, Version 6.0.x     Operating Systems: AIX, HP-UX, Linux, Solaris, Windows

Commands for the AdminTask object

Use the AdminTask object to run an administrative command. Administrative commands are discovered dynamically when you start the wsadmin tool. The administrative commands that are available for you to use, and what you can do with them, depends on the edition of WebSphere Application Server that you have.

You can start the scripting client without having a server running by using the -conntype NONE option with the wsadmin tool. The AdminTask administrative commands are available in both connected and local modes. If a server is currently running, it is not recommended to run the AdminTask commands in local mode because any configuration changes made in local mode are not reflected in the running server configuration and vice versa. If you save a conflicting configuration, you can corrupt the configuration.

In a deployment manager environment, configuration updates are available only if a scripting client is connected to a deployment manager. When connected to a node agent or a managed application server, you cannot update the configuration because the configuration for these server processes are copies of the master configuration, which resides in the deployment manager. The copies are created on a node machine when a configuration synchronization occurs between the deployment manager and the node agent. Make configuration changes to the server processes by connecting a scripting client to a deployment manager. To change a configuration, do not run a scripting client in local mode on a node machine because this is not supported.

In the Jython language, the AdminTask commands only support string format. List format is not supported.

The following commands are available for the AdminTask object:

Command name: Group name: Description: Target object: Parameters and return values: Examples:
addNodeGroupMember NodeGroupCommands group The addNodeGroupMember command adds a member to a node group. Nodes can be members of more than one node group. The command does validity checking to ensure the following:
  • Distributed and z/OS nodes are not combined in the same node group.
  • z/OS platform from different sysplexs are not combined into the same node group.
The target object is the node group where the member will be created. This target object is required.
  • Parameters:
    - nodeName
    The name of the node that you want to add to a node group. This parameter is required.
  • Returns: Node group member object ID

Batch mode example usage:

  • Using Jacl:
    $AdminTask addNodeGroupMember WBINodeGroup {-nodeName WBINode}
  • Using Jython:
    AdminTask.addNodeGroupMember('WBINodeGroup', '[-nodeName WBINode]')
    

Interactive mode example usage:

  • Using Jacl:
    $AdminTask addNodeGroupMember {-interactive}
  • Using Jython:
    AdminTask.addNodeGroupMember ('[-interactive]')
addSIBWSInboundPort SIBWebServices group The addSIBWSInboundPort command adds the configuration for an inbound port to an inbound service. This command fails if:
  • The port name is already in use by another inbound port for the inbound service or the end point listener that you specified.
  • The template port that you specified does not exist in the template Web Services Description Language (WSDL) of the inbound service.
The object name of the inbound service to which the port will be added.
  • Parameters:
    name
    The name of the port. (required)
    endpointListener
    The name of the associated end point listener. (required)
    node
    The node where the endpoint listener is located. You must specify the node parameter, the server parameter, or the cluster parameter. (conditional)
    server
    The server where the endpoint listener is located. You must specify the node parameter, the server parameter, or the cluster parameter. (conditional)
    cluster
    The cluster where the endpoint listener is located. You must specify the node parameter, the server parameter, or the cluster parameter. (conditional)
    templatePort
    The name of the port in the template WSDL to use as a basis for the binding of the port. (optional)
  • Returns: The object name of the inbound port object that was created.

Batch mode example usage:

  • Using Jacl:
    set inPort [$AdminTask addSIBWSInboundPort $inService {-name "MyServiceSoap" -endpointListener "SOAPHTTP1" -node "MyNode" -server "server1"}]
  • Using Jython:
    inPort = AdminTask.addSIBWSInboundPort(inService, '[-name MyServiceSoap -endpointListener SOAPHTTP1 -node MyNode -server server1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask addSIBWSInboundPort {-interactive}
  • Using Jython:
    AdminTask.addSIBWSInboundPort ('[-interactive]')
addSIBWSOutboundPort SIBWebServices group The addSIBWSOutboundPort command adds the configuration for an outbound port to an outbound service. The object name of the outbound service for which the port will be associated.
  • Parameters:
    name
    The name of the port in the WSDL of the service provider. (required)
    node
    Node where the port destination will be localized. You must specify the node parameter, the server parameter, or the cluster parameter. (conditional)
    server
    The server where the port destination will be localized. You must specify the node parameter, the server parameter, or the cluster parameter. (conditional)
    cluster
    The cluster where the port destination will be localized. You must specify the node parameter, the server parameter, or the cluster parameter. (conditional)
    destination
    The name of the port destination. (optional)
    userId
    The user ID to use to retrieve the WSDL. (optional)
    password
    The password to use to retrieve the WSDL. (optional)
  • Returns: The object name of the outbound port object that you created.

Batch mode example usage:

  • Using Jacl:
    set outPort [$AdminTask addSIBWSOutboundPort $outService {-name "MyServiceSoap" -node "MyNode" -server "server"}]
  • Using Jython:
    outPort = AdminTask.addSIBWSOutboundPort(outService, '[-name MyServiceSoap -node MyNode -server server]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask addSIBWSOutboundPort {-interactive}
  • Using Jython:
    AdminTask.addSIBWSOutboundPort ('[-interactive]')
addSIBusMember SIBAdminCommands group Use this command to add a server or a cluster to a SIB bus. None
  • Parameters:
    bus
    The name of that bus to which you want to add member. (String, required)
    node
    Specifies a server bus member, a supply node, and a server name, but not a cluster name. (String, optional)
    server
    Specifies a server bus member, a supply node, and a server name, but not a cluster name. (String, optional)
    cluster
    Specifies a cluster bus member and a supply cluster name, but not a node or a server name. (String, optional)
    createDefaultDatasource
    Set this parameter to true if you want a default data source to be created when the messaging engine is created. (Boolean, optional)
    datasourceJndiName
    The JNDI name of the data source that you want referenced from the datastore that is created when the member is added to the bus. (String, optional)
  • Returns:

Batch mode example usage:

  • Using Jacl:
    $AdminTask addSIBusMember {-bus busname -node nodename -server servername -description text}
  • Using Jython:
    AdminTask.addSIBusMember('[-bus busname -node nodename -server servername -description "text"]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask addSIBusMember {-interactive}
  • Using Jython:
    AdminTask.addSIBusMember ('[-interactive]')
addWSGWTargetService WSGateway group The addWSGWTargetService command adds a target to a gateway service. You must specify the targetService parameter or the targetDestination parameter. Object name of the GatewayService object
  • Parameters:
    name
    The administrative name of the target service. (Required)
    targetDestination
    The name of the target destination. This can be within the same bus as the gateway destination or in a different bus. If the target destination is not within the same bus as the gateway destination, you must also specify the targetBus parameter. You must either specify the targetDestination parameter or the targetService parameter. (Conditional)
    targetService
    The name of the target outbound service. You must either specify the targetDestination parameter or the targetService parameter. (Conditional)
    targetBus
    The name of the WPM bus that contains the target. (Optional)
  • Returns: The object name of the target service object that you created.

Batch mode example usage:

  • Using Jacl:
    set gwTarget [$AdminTask addWSGWTargetService $gwService {-name "AnotherTarget" -targetService "AnotherService"}]
  • Using Jython:
    gwTarget=AdminTask.addWSGWTargetService(gwService, '[-name AnotherTarget -targetService AnotherService]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask addWSGWTargetService {-interactive}
  • Using Jython:
    AdminTask.addWSGWTargetService ('[-interactive]')
compareNodeVersion ManagedObjectMetadata group The compareNodeVersion command compares the WebSphere Application Server version given a node that you specify and an input version. None
  • Parameters:
    - nodeName
    The name of the node associated with the metadata you want this command to return.
    - version
    A version number that you want to compare to the WebSphere Application Server version number.
  • Returns:
    • 0 if node version matches the input version
    • -1 if node version is smaller than the input version
    • 1 is node version is higher than the input version

Batch mode example usage:

  • Using Jacl:
    $AdminTask compareNodeVersion {-nodeName node1 -version 5}
  • Using Jython:
    AdminTask.compareNodeVersion('[-nodeName node1 -version 5]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask compareNodeVersion {-interactive}
  • Using Jython:
    AdminTask.compareNodeVersion ('[-interactive]')
configureTAM        

Interactive mode example usage:

  • Using Jacl:
    $AdminTask configureTAM {-interactive}
  • Using Jython:
    AdminTask.configureTAM ('[-interactive]')
connectSIBWSEndpointListener SIBWebServices group The connectSIBWSEndpointListener command connects an end point listener to a bus. Object name of the end point listener that you want to create.
  • Parameters:
    bus
    The name of the bus to which the end point listener will be connected. (required)
    replyDestination
    The name of the reply destination for the connection. (optional)
  • Returns: The SIBWS bus connection property object.

Batch mode example usage:

  • Using Jacl:
    set busConn [$AdminTask connectSIBWSEndpointListener $epl {-bus "MyBus"}]
  • Using Jython:
    busConn = AdminTask.connectSIBWSEndpointListener(epl, '[-bus MyBus]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask connectSIBWSEndpointListener {-interactive}
  • Using Jython:
    AdminTask.connectSIBWSEndpointListener ('[-interactive]')
copyResourceAdapter JCA management group Use the copyResourceAdapter command to create a Java 2 Connector (J2C) resource adapter under the scope that you specify. J2CResourceAdapter_object_ID
  • Parameters:
    - name
    Indicates the name of the new J2C resource adapter. This parameter is required.
    - scope
    Indicates the scope object ID. This parameter is required.
    - useDeepCopy
    If you set this parameter to true, all of the J2C connection factory, J2C activation specification, and J2C administrative objects will be copied to the new J2C resource adapter (deep copy). If you set this parameter to false, the objects are not created (shallow copy). The default is false.
  • Returns: J2C resource adapter object ID

Batch mode example usage:

  • Using Jacl:
    $AdminTask copyResourceAdapter  $ra [subst {-name newRA -scope $scope}]
  • Using Jython:
    AdminTask.copyResourceAdapter(ra, '[-name newRA -scope scope]')
    

Interactive mode example usage:

  • Using Jacl:
    $AdminTask copyResourceAdapter {-interactive}
    
  • Using Jython:
    AdminTask.copyResourceAdapter ('[-interactive]')
    
createApplicationServer ServerManagement group Use the createApplicationServer command to create a new application server. Node name (optional)
  • Parameters:
    - name
    The name of the server that you want to create. (String)
    - templateName
    The name of the template from which to base the server. (String)
    - genUniquePorts
    Specifies that unique ports should be created for the server. (boolean)
    - templateLocation
    The location of a template. (ObjectName)
  • Returns: The configuration ID of the server you created.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createApplicationServer ndnode1 {-name test1 –templateName default}
  • Using Jython:
    AdminTask.createApplicationServer(ndnode1, '[-name test1 ]', ‘[-templateName default]’)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createApplicationServer {-interactive}
  • Using Jython:
    AdminTask.createApplicationServer ('[-interactive]')
createApplicationServerTemplate ServerManagement group The createApplicationServerTemplate command creates a new application server template. None
  • Parameters:
    - templateName
    The name of the application server template that you want to create. (String)
    - serverName
    The name of the server from which to base the template. (String)
    - nodeName
    The node that corresponds to the server from which to base the template. (String)
    - description
    The description of the template. (String)
    - templateLocation
    The location where you want to place the template. (String)
  • Returns: The configuration ID of a new template.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createApplicationServerTemplate {-templateName newTemplate -serverName server1 -nodeName ndnode1 -description "This is my new template"}
  • Using Jython:
    AdminTask.createApplicationServerTemplate('[-templateName newTemplate -serverName server1 -nodeName ndnode1 -description "This is my new template"]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createApplicationServerTemplate {-interactive}
  • Using Jython:
    AdminTask.createApplicationServerTemplate ('[-interactive]')
createChain ChannelFrameworkManagement group The createChain command creates a new chain of transport channels that are based on a chain template. The instance of the transport channel service under which the new chain is created. (ObjectName, required)
  • Parameters:
    - template
    The chain template on which to base the new chain. (ObjectName, required)
    - name
    The name of the new chain. (String, required)
    - endPoint
    The name of the end point to be used by the instance of the TCP inbound channel in the new chain if the chain is an inbound chain. (ObjectName, optional)
  • Returns: The object name of the channel chain that was created.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createChain (cells/rohitbuildCell01/nodes/
    rohitbuildCellManager01/servers/dmgr|server.xml#
    TransportChannelService_1) {-template WebContainer
    (templates/chains|webcontainer-chains.xml#Chain_1) 
    -name trialChain1 }
    $AdminTask createChain (cells/rohitbuildCell01/nodes/
    rohitbuildCellManager01/servers/dmgr|server.xml#
    TransportChannelService_1) {-template WebContainer
    (templates/chains|webcontainer-chains.xml#Chain_1) 
    -name trialChain1 -endPoint (cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01|serverindex.xml#EndPoint_3) }
  • Using Jython:
      AdminTask.createChain('cells/rohitbuildCell01/nodes/
    rohitbuildCellManager01/servers/dmgr|server.xml#
    TransportChannelService_1', '[-template "WebContainer
    (templates/chains|webcontainer-chains.xml#Chain_1)" 
    -name trialChain]')
    AdminTask.createChain('cells/rohitbuildCell01/nodes/rohitbuildCellManager01/
    servers/dmgr|server.xml#TransportChannelService_1', '[-template 
    "WebContainer(templates/chains|webcontainer-chains.
    xml#Chain_1)" -name trialChain -endPoint "(cells/
    rohitbuildCell01/nodes/rohitbuildCellManager01|serverindex.xml#EndPoint_3)"]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createChain {-interactive}
  • Using Jython:
    AdminTask.createChain ('[-interactive]')
createCluster ClusterConfigCommands The createCluster command creates a new server cluster. A server cluster consists of a group of application servers that are referred to as cluster members. Optionally, a replication domain can be created for the new cluster, and an existing server can be included as the first cluster member. None
  • Parameters for step one:
    -clusterConfig
    Specifies the configuration of the new server cluster. This command step is required. The following parameters can be specified for this step.
    clusterName
    The name of the new server cluster. This parameter is required.
    preferLocal
    Enables or disables node scoped routing optimization within this cluster. This parameter is optional. The value is true or false. It not specified, the default value is true.
  • Parameters for step two:
    -replicationDomain
    Specifies the configuration of a replication domain for this cluster. A replication domain is used to support HTTP session data replication. This command step is optional. The following parameters can be specified for this step:
    createDomain
    Creates a replication domain with a name set to the name of the new cluster. This parameter is optional. The value is true or false. It not specified, the default value is false.
  • Parameters for step three:
    -convertServer
    Specifies information about an existing application server to convert to be the first member of the cluster. This command step is optional. The following parameters can be specified for this step:
    serverNode
    The name of the node with the server to be converted to the first cluster member. This parameter is required for the command step. You must also specify the serverName parameter.
    serverName
    The name of the application server to be converted to the first cluster member. This parameter is required for the command step. You must also specify the serverNode parameter.
    memberWeight
    The weight of the cluster member. The weight controls the amount of work directed to the application server. If the weight is greater than the weight assigned to other cluster members, the server will receive a larger share of the workload. The value is a number between 0 and 100. If none is specified, the default is 2.
    nodeGroup
    The name of the node group which this cluster member’s node, and all future cluster members’ nodes, must belong to. All cluster members must reside on nodes in the same node group. This parameter is optional. If specified, it must be one of the node groups which this member’s node belongs to. If not specified, the default value will be the first node group listed for this member’s node.
    replicatorEntry
    Specifies a replicator entry for the converted member will be created in the cluster’s replication domain. A replicator entry is used to provide HTTP session data replication. This command parameter is optional. The value is true or false which indicates whether the replicator entry will be created. The default value is false. You can specify this parameter only if the createDomain parameter was set to true in the replicationDomain command step.
  • Returns: ObjectName of cluster created.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createCluster { -clusterConfig {{cluster1 true}}}
    $AdminTask createCluster { -clusterConfig {{cluster1 true}} -replicationDomain {{true}}}
    $AdminTask createCluster { -clusterConfig {{cluster1 true}} -convertServer {{server1 node1 "" "" ""}}}
  • Using Jython:
    AdminTask.createCluster('[-clusterConfig [[cluster1 true]]]')
    
    AdminTask.createCluster('[-clusterConfig [[cluster1 true]] -replicationDomain [[true]]]')
    AdminTask.createCluster('[-clusterConfig [[cluster1 true]] -convertServer [[server1 node1 "" "" ""]]]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createCluster {-interactive}
  • Using Jython:
    AdminTask.createCluster ('[-interactive]')
createClusterMember ClusterConfigCommands The createClusterMember command creates a member of a server cluster. A cluster member is an application server that belongs to a cluster. If this is the first member of the cluster, you must specify a template to use as the model for the cluster member. The template can be either a default server template, or an existing application server clusterObjectID - The configuration object ID of the cluster to which the new member will belong. If you do not specify the configuration ID, you must specify the clusterName parameter. You can obtain the object name programmatically through Java using the WebSphere Application Server ConfigService API or through wsadmin scripting using the AdminConfig object.
  • Parameters:
    -clusterName
    The name of the cluster to which the new member will belong. If you do not specify this parameter, you must specify the cluster object ID in the command target.
  • Parameters for step one:
    -memberConfig
    Specifies the attributes of the new cluster member to be created in the cluster. This command step is required. The following parameters can be specified for this step:
    memberName
    The name of the server to be created for the new cluster member. This parameter is required.
    memberNode
    The name of the node where the new cluster member will be created. This parameter is required.
    memberWeight
    The weight of the new cluster member. This controls the amount of work directed to the application server. If the weight is greater than the weight assigned to other cluster members, the server will receive a larger share of the workload. The value is a number between 0 and 100. The default value is 2.
    genUniquePorts
    Generates unique port numbers for each HTTP transport defined in the server. The new server will not have HTTP transports which conflict with any other servers defined on the same node. The value is true or false. The default value is true .
    replicatorEntry
    Specifies a replicator entry for the new cluster member will be created in the cluster’s replication domain. A replicator entry is used to provide HTTP session data replication. This command parameter is optional. The value is true or false which indicates whether the entry will be created. The default value is false. You can specify this parameter only if a replication domain has been created for the cluster.
  • Parameters for step two:
    -firstMember
    Specifies additional information necessary to create the first cluster member. This command step is required when creating the first member of the cluster, and is executable only when creating the first member of the cluster. The target of this command step is a Boolean value indicating whether or not to perform this step. The default value is true if any of the step parameters are specified; otherwise the default value is false. The following parameters can be specified for this step:
    templateName
    The name of an application server template to use when creating the new cluster member. If you specify a template, you cannot specify the templateServerNode and templateServerName parameters to use an existing application server as a template. You are required to specify either the templateName parameter, or the templateServerNode and templateServerName parameters in this step.
    templateServerNode
    The name of the node with an existing application server to use as the template when creating the new cluster member. If you specify the templateServerNode parameter, you must also specify the templateServerName parameter, and you cannot specify the templateName parameter. You are required to specify either the templateName parameter, or the templateServerNode and templateServerName parameters, in this step.
    templateServerName
    The name of the existing application server to use as the model when creating the new cluster member. If you specify the templateServerName parameter, you must also specify the templateServerNode parameter, and you cannot specify the templateName parameter. You are required to specify either the templateName parameter, or the templateServerNode and templateServerName parameters, in this command step.
    nodeGroup
    The name of the node group which this cluster member’s node, and all future cluster members’ nodes, must belong to. All cluster members must reside on nodes in the same node group. This parameter is optional. If specified, it must be one of the node groups which this member’s node belongs to. If not specified, the default value will be the first node group listed for this member’s node.
    coreGroup
    The name of the core group this cluster member, and all future cluster members, must belong to. All cluster members must belong to the same core group. This parameter is optional. If not specified, the default value is the default core group defined in the cell.
  • Returns: The object name of cluster member that was created.

Batch mode example usage:

  • Using Jacl:

    First member creation using template name:
    $AdminTask createClusterMember {-clusterName cluster1 -memberConfig {{node1 member1 "" "" true false}} -firstmember {{ serverTemplateName "" "" "" ""}}}
    First member creation using server and node for template:
    $AdminTask createClusterMember {-clusterName cluster1 -memberConfig {{node1 member1 "" "" true false}} -firstmember {{ "" node1 server1 "" ""}}}
    Second member creation:
    $AdminTask createClusterMember {-clusterName cluster1 -memberConfig {{node1 member2 "" "" true false}}}
  • Using Jython:

    First member creation using template name:
    AdminTask.createClusterMember('[-clusterName cluster1 -memberConfig [[node1 member1 "" "" true false]] -firstMember [[serverTemplateName "" "" "" ""]]]')
    First member creation using server and node for template:
    AdminTask.createClusterMember('[-clusterName cluster1 -memberConfig [[node1 member1 "" "" true false]] -firstMember [["" node1 server1 "" ""]]]')
    Second member creation:
    AdminTask.createClusterMember('[-clusterName cluster1 -memberConfig [[node1 member2 "" "" true false]]]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createClusterMember {-interactive}
  • Using Jython:
    AdminTask.createClusterMember ('[-interactive]')
createCoreGroup CoreGroupManagement group The createCoreGroup command creates a new core group. The core group that you create contains no members. None
  • Parameters:
    - coreGroupName
    The name of the core group that you are creating. (String required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask createCoreGroup {-coreGroupName MyCoreGroup}
  • Using Jython:
    AdminTask.createCoreGroup('[-coreGroupName MyCoreGroup]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createCoreGroup {-interactive}
  • Using Jython:
    AdminTask.createCoreGroup ('[-interactive]')
createCoreGroupAccessPoint CoreGroupBridgeManagement group The createCoreGroupAccessPoint command creates a default core group access point for the core group that you specify and adds it to the default access point group. If the default access point group does not exist, the command creates a default access point group. Core group bridge settings object for the cell. (ObjectName, required).
  • Parameters:
    - coreGroupName
    The name of the core group for which the core group access point will be created. (String required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask createCoreGroupAccessPoint (cells/
    rohitbuildCell01|coregroupbridge.xml#
    CoreGroupBridgeSettings_1) "-coreGroupName DefaultCoreGroup"
  • Using Jython:
    AdminTask.createCoreGroupAccessPoint('cells/
    rohitbuildCell01|coregroupbridge.xml#CoreGroupBridgeSettings_1', 
    '[-coreGroupName DefaultCoreGroup]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createCoreGroupAccessPoint {-interactive}
  • Using Jython:
    AdminTask.createCoreGroupAccessPoint ('[-interactive]')
createDefaultCGAP        

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createDefaultCGAP {-interactive}
  • Using Jython:
    AdminTask.createDefaultCGAP ('[-interactive]')
createGenericServer ServerManagement group

Step: ConfigProcDef

Use the createGenericServer command to create a new generic server in the configuration. A generic server is a server that the WebSphere Application Server manages, but did not supply. The createGenericServer command provides an additional step, ConfigProcDef, that you can use to configure the parameters that are specific to generic servers. None
  • Parameters:
    - name
    The name of the server that you want to create.
    - templateName
    Picks up a server template. This step provides a list of application server templates for the node and server type. The default value is the default templates for the server type. (String, optional)
    - genUniquePorts
    The port for the server.
    - templateLocation
    The location of the server template.
    - startCommand
    Indicates the path to the command that will run when this generic server is started. (String, optional)
    - startCommandArgs
    Indicates the arguments to pass to the startCommand when the generic server is started. (String, optional)
    - executableTargetKind
    Specifies whether a Java class name (use JAVA_CLASS) or the name of an executable JAR file (use EXECUTABLE_JAR) will be used as the executable target for this process. This field should be left blank for binary executables. This parameter is only applicable for Java processes. (String optional)
    - executableTarget
    Specifies the name of the executable target (a Java class containing a main() method or the name of an executable JAR), depending on the executable target type. This field should be left blank for binary executables. This parameter is only applicable for Java processes. (String, optional)
    - workingDirectory
    Specifies the working directory for the generic server.
    - stopCommand
    Indicates the path to the command that will run when this generic server is stopped. (String, optional)
    - stopCommandArgs
    Indicates the arguments to pass to the stopCommand parameter when the generic server is stopped. (String, optional)
  • Returns: null

Batch mode example usage:

  • Using Jacl:
    $AdminTask createGenericServer jim667BaseNode {-name jgeneric -ConfigProcDef {{"/usr/bin/myStartCommand" "arg1 arg2" "" "" "/tmp/workingDirectory"
     "/tmp/stopCommand" "argy argz"}}}
  • Using Jython:
    AdminTask.createGenericServer(jim667BaseNode, '[-name jgeneric -ConfigProcDef [[/usr/bin/myStartCommand "arg1 arg2" "" "" /tmp/workingDirectory /tmp/StopCommand "argy argz"]]]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createGenericServer {-interactive}
  • Using Jython:
    AdminTask.createGenericServer  ('[-interactive]')
createGenericServerTemplate        

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createGenericServerTemplate {-interactive}
  • Using Jython:
    AdminTask.createGenericServerTemplate ('[-interactive]')
createJ2CActivationSpec JCA management group Use the createJ2CActivationSpec command to create a Java 2 Connector (J2C) activation specification under a J2C resource adapter and the attributes that you specify. Use the messageListenerType parameter to indicate the activation specification that is defined for the J2C resource adapter. J2CResourceAdapter_object_ID
  • Parameters:
    - messageListenerType
    Identifies the activation specification for the J2C activation specification to be created. Use this parameter to identify the activation specification template for the J2C resource adapter that you specify.
    - name
    Indicates the name of the J2C activation specification that you are creating.
    - jndiName
    Indicates the name of the Java Naming and Directory Interface (JNDI).
    - destinationJndiName
    Indicates the name of the Java Naming and Directory Interface (JNDI) of corresponding destination.
    - authenticationAlias
    Indicates the authentication alias of the J2C activation specification that you are creating.
    - description
    Description of the created J2C activation spec.
  • Returns: J2CActivationSpec object ID

Batch mode example usage:

  • Using Jacl:
    $AdminTask createJ2CActivationSpec  $ra {-name J2CActSpec -jndiName eis/ActSpec1 -messageListenerType javax.jms.MessageListener }
    
  • Using Jython:
    AdminTask.createJ2CActivationSpec(ra, '[-name J2CActSpec -jndiName eis/ActSpec1 -messageListenerType javax.jms.MessageListener]')
    

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createJ2CActivationSpec {-interactive}
    
  • Using Jython:
    AdminTask.createJ2CActivationSpec ('[-interactive]')
createJ2CAdminObject JCA management group

Use the createJ2CAdminObject command to create an administrative object under a resource adapter with attributes that you specify. Use the administrative object interface to indicate the administrative object that is defined in the resource adapter.

J2CResourceAdapter_object_ID
  • Parameters:
    -adminObjectInterface
    Specifies the administrative object interface to identify the administrative object for the resource adapter that you specify. This parameter is required.
    -name
    Indicates the name of the administrative object.
    -jndiName
    Specifies the name of the Java Naming and Directory Interface (JNDI).
    -description
    Description of the created J2C admin object.
  • Returns: J2CAdminObject object ID

Batch mode example usage:

  • Using Jacl:
    $AdminTask createJ2CAdminObject $ra {-adminObjectInterface fvt.adapter.message.FVTMessageProvider -name J2CA01 -jndiName eis/J2CA01} 
    
  • Using Jython:
    AdminTask.createJ2CAdminObject(ra, '[-adminObjectInterface fvt.adapter.message.FVTMessageProvider -name J2CA01 -jndiName eis/J2CA01]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createJ2CAdminObject {-interactive}
    
  • Using Jython:
    AdminTask.createJ2CAdminObject ('[-interactive]')
createJ2CConnectionFactory JCA management group

Use the createJ2CConnectionFactory command to create a Java 2 connection factory under a Java 2 resource adapter and the attributes that you specify. Use the connection factory interfaces to indicate the connection definitions that are defined for the Java 2 resource adapter.

J2CConnectionFactory object ID
  • Parameters:
    -connectionFactoryInterface
    Identifies the connection definition for the Java 2 resource adapter that you specify. This parameter is required.
    -name
    Indicates the name of the connection factory.
    -jndiName
    Indicates the name of the Java Naming and Directory Interface (JNDI).
    -description
    Description of the created J2C connection factory.
  • Returns: The J2C connection factory object ID.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createJ2CConnectionFactory $ra {-connectionFactoryInterfaces javax.sql.DataSource -name J2CCF1 -jndiName eis/J2CCF1}
  • Using Jython:
    AdminTask.createJ2CConnectionFactory(ra, '[-connectionFactoryInterfaces javax.sql.DataSource -name J2CCF1 -jndiName eis/J2CCF1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createJ2CConnectionFactory {-interactive}
    
  • Using Jython:
    AdminTask.createJ2CConnectionFactory ('[-interactive]')
createNodeGroup NodeGroupCommands group The createNodeGroup command creates a new node group. A node group consists of a group of nodes that are referred to as node group members. Optionally, you can create a short name and a description for the new node group. The node group name to be created. This target object is required.
  • Parameters:
    - shortName
    The short name of the node group. This parameter is optional.
    - description
    The description of the node group. This parameter is optional.
  • Returns: The node group object ID.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createNodeGroup WBINodeGroup
  • Using Jython:
    AdminTask.createNodeGroup('WBINodeGroup')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createNodeGroup {-interactive}
  • Using Jython:
    AdminTask.createNodeGroup ('[-interactive]')
createNodeGroupProperty NodeGroupCommands group The createNodeGroupProperty command creates custom properties for a node group. The name of the node group. This target object is required.
  • Parameters:
    - name
    The name of the custom property to create. This parameter is required.
    - value
    The value of the custom property. This parameter is optional.
    - description
    The description of the custom property. This parameter is optional.
  • Returns: The properties object ID.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createNodeGroupProperty WBINodeGroup {-name Channel -value "channel1"}
  • Using Jython:
    AdminTask.createNodeGroupProperty('WBINodeGroup', '[-name Channel -value channel1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createNodeGroupProperty {-interactive}
  • Using Jython:
    AdminTask.createNodeGroupProperty ('[-interactive]')
createSIBDestination SIBAdminCommands group Use this command to create a SIB destination. None
  • Parameters:
    bus
    The name of the bus where the destination will be configured. (String, required)
    name
    The destination name. (String, required)
    type
    The destination type. Valid values include: Queue, TopicSpace, WebService or Port. If the type is not TopicSpace, you must use the node/server or cluster option to specify a bus member. (String, required)
    cluster
    To assign the destination to a cluster, provide cluster name but do not provide the node and server name. (optional)
    node
    To assign the destination to a server, provide the node name and the server name, but do not provide the cluster name. (optional)
    server
    To assign the destination to a server, provide the node name and the server name, but do not provide the cluster name. (optional)
    aliasBus
    If this is an alias destination, then the value for the parameter is the source bus name of alias mapping. (optional)
    targetBus
    If this is an alias destination, then the value for the parameter is the name of the bus for which the destination is configured. (optional)
    targetName
    If this is an alias destination, then the value for the parameter is the name of the destination to which it maps. (optional)
    foreignBus
    If this is a foreign destination, then the value of the parameter is the name of the foreign bus. (optional)
    description
    Description. (optional)
    reliability
    The reliability quality of service for message flows through the destination from BEST_EFFORT_NON-PERSISTENT to ASSURED_PERSISTENT, in order of increasing reliability. Higher levels of reliability have higher impacts on the performance. (optional)
    maxReliability
    The maximum reliability quality of service that is accepted for values specified by producers. (optional)
    overrideOfQOSByProducerAllowed
    This parameter controls the quality of service for message flows between producers and the destination. Select this option to use the quality of service specified by producers instead of the quality defined for the destination. (optional)
    defaultPriority
    The default priority for message flows through the destination, in the range 0 (lowest) through 9 (highest). This default priority is used for messages that do not contain a priority value. (Integer, optional). (optional)
    maxFailedDeliveries
    The maximum number of times that the service tries to deliver a message to the destination before forwarding it to the exception destination. (Integer, optional)
    exceptionDestination
    The name of another destination to which the system sends a message that cannot be delivered to the destination within the specified maximum number of failed deliveries. (optional)
    sendAllowed
    Set this parameter to false to stop producers from being able to send messages to this destination. (optional)
    receiveAllowed
    clear this option (setting it to false) to prevent consumers from being able to receive messages from this destination. (optional)
    quiesceMode
    Set this parameter to false to indicate that the destination is quiescing. In quiesce mode, new messages for the destination cannot be added to the bus, but any messages already in the bus can still be sent to, and processed by, the destination. The default value is false. (Boolean, optional).
    receiveExclusive
    Set this parameter to true to allow only one consumer to attach to a destination. The default value is false. (Boolean, optional).
    topicAccessCheckRequired
    Indicates if a topic access check is required. (Boolean, optional)
    replyDestination
    Set this parameter to false to stop producers from being able to send messages to the destination. (optional)
    replyDestinationBus
    Set this parameter to false to prevent consumers from being able to receive messages from the destination. (optional)
    delegateAuthorizationCheckToTarget
    Indicates whether the authorization check should be delegated to the alias or the target destination (Boolean, optional)
  • Parameters for step one:
    defaultForwardRoutingPath
    The default forward routing path.
    bus
    The name of the bus.
    destination
    The name of the destination.
  • Returns: A new SIB destination.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createSIBDestination {-bus busname -name destname -type TopicSpace}
  • Using Jython:
    AdminTask.createSIBDestination('[-bus busname -name destname -type TopicSpace]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBDestination {-interactive}
  • Using Jython:
    AdminTask.createSIBDestination ('[-interactive]')
createSIBEngine SIBAdminCommands group Use the createSIBEngine command to create a new messaging engine for a bus member. None
  • Parameters:
    bus
    name of the bus to which the messaging engine is to belong (String, optional)
    node
    to create a messaging engine on a server, supply node and server name, but not cluster name (String, optional)
    server
    to create a messaging engine on a server, supply node and server name, but not cluster name (String, optional)
    cluster
    to create a messaging engine on a cluster, supply cluster name, but not node and server name (String, optional)
    description
    description of the messaging engine (String, optional)
    initialState
    Indicates if the messaging engine is started or stopped when the associated application server starts. Until started, the messaging engine is unavailable. Valid values are Stopped and Started. (String, optional)
    destinationHighMsgs
    the maximum total number of messages that the messaging engine can place on its message points (Long, optional)
    createDefaultDatasource
    Set to true if a default data source should be created when the messaging engine is created (Boolean, optional)
    datasourceJndiName
    JNDI name of the data source to be referenced from the datastore created when the messaging engine is created (String, optional)
  • Returns: A new SIB messaging engine.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createSIBEngine {-bus busname -node nodeName -server severname}
  • Using Jython:
    AdminTask.createSIBEngine('[-bus busname -node nodeName -server severname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBEngine {-interactive}
  • Using Jython:
    AdminTask.createSIBEngine ('[-interactive]')
createSIBJMSActivationSpec SIBJMSAdminCommands group Use the createSIBJMSActivationSpec command to create a SIB JMS activation specification. Scope of the SIB JMS resource adapter to which you want to add the activation specification.
  • Parameters:
    name
    The name of the activation specification that you want to create. (String, required)
    jndiName
    The Java Naming and Directory Interface (JNDI) of the activation specification. (String, required)
    destinationJndiName
    The JNDI of a destination. (String, required)
    description
    A JMS activation specification is used by the default messaging provider to validate the activation-configuration properties for a JMS message-driven bean (MDB). (String, optional)
    acknowledgeMode
    Indicates how the session acknowledges messages that it receives. (String, optional)
    authenticationAlias
    The authentication alias. (String, optional)
    busName
    The name of the SIB bus to which you want to connect. (String, required)
    clientId
    The client identifier. Required for durable topic subscriptions. (String, optional)
    destinationType
    Indicates if the message-driven bean uses a queue or topic destination. (String, optional)
    durableSubscriptionHome
    The name of the durable subscription home. This identifies the messaging engine where all durable subscriptions accessed through this activation specification are managed. (String, optional)
    maxBatchSize
    The maximum number of messages received from the messaging engine in a single batch. (Integer, optional)
    maxConcurrency
    The maximum number of endpoints to which messages are delivered concurrently. (Integer, optional)
    messageSelector
    The JMS message selector used to determine which messages the message-driven bean (MDB) receives. (String, optional)
    password
    Indicates a password. (String, optional)
    subscriptionDurability
    Indicates if a JMS topic subscription is durable or nondurable. (String, optional)
    subscriptionName
    The subscription name needed for durable topic subscriptions (String, optional)
    shareDurableSubscriptions
    Used to control the sharing of durable subscriptions. The defaut value is AsCluster. (String, optional)
    userName
    The user name. (String, optional)
  • Returns: A new SIB JMS activation specification.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createSIBJMSActivationSpec $ra {-name specname -jndiName specname}
  • Using Jython:
    AdminTask.createSIBJMSActivationSpec(ra, '[-name specname -jndiName specname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBJMSActivationSpec {-interactive}
  • Using Jython:
    AdminTask.createSIBJMSActivationSpec ('[-interactive]')
createSIBJMSConnectionFactory SIBJMSAdminCommands group Use the createSIBJMSConnectionFactory command to create a generic, queue or topic SIB JMS connection factory. Scope of the SIB JMS resource adapter to which you want to add the SIB JMS connection factory.
  • Parameters:
    name
    The name of the SIB JMS connection factory. (String, required)
    jndiName
    The JNDI name of the SIB JMS connection factory. (String, required)
    type
    The type of connection factory to create. To create a queue connection factory, set the value to Queue. To create a topic connection factory, set to Topic. To create a generic connection factory, do not set a value. (String, optional)
    authDataAlias
    Specifies a user ID and password to be used to authenticate connections to the JMS provider for application-managed authentication. (String, optional)
    category
    Classifies or groups the connection factory. (String, optional)
    description
    The description of the connection factory. (String, optional)
    logMissingTransactionContext
    Indicates if the container logs that there is a missing transaction context when a connection is obtained. The default value is false. (Boolean, optional)
    manageCachedHandles
    Indicates if cached handles should be tracked by the container. Cached handles are handles held in instance variables within a bean. The default value is false. (Boolean, optional)
    xaRecoveryAuthAlias
    The authentication alias used during XA recovery processing. (String, optional)
    busName
    The SIB bus name. (String, optional)
    clientID
    The user-defined string. Only required for durable subscriptions. (String, optional)
    userName
    The user name that is used to create connections from the connection factory. (String, optional)
    password
    The password that is used to create connections from the connection factory. (String, optional)
    nonPersistentMapping
    The non-persistent mapping value. Valid values include: BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestination and None (String, optional)
    persistentMapping
    The persistent mapping value. Valid values include: BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestination and None (String, optional)
    durableSubscriptionHome
    The durable subscription home value. (String, optional)
    readAhead
    The read-ahead value. Valid values include: Default, AlwaysOn and AlwaysOff (String, optional)
    target
    The name of a target that resolves to a group of messaging engines. (String, optional)
    targetType
    Specifies the type of the name in the target parameter. Valid values are BusMember, Custom and ME (String, optional)
    targetSignificance
    This property specifies the significance of the target group. (String, optional)
    remoteProtocol
    The name of the protocol that you want to use to connect to a remote messaging engine. (String, optional)
    providerEndPoints
    A list of endpoint triplets that is separated by colons, for example: host:port:chain (String, optional)
    connectionProximity
    The proximity of acceptable messaging engines. Valid values include: Bus, Host, Cluster and Server (String, optional)
    tempQueueNamePrefix
    The temporary queue name prefix. (String, optional)
    tempTopicNamePrefix
    The temporary topic name prefix. (String, optional)
    shareDataSourceWithCMP
    Used to control how data sources are shared. (Boolean, optional)
    shareDurableSubscriptions
    Used to control how durable subscriptions are shared. Valid values include: AsCluster, AlwaysShared and NeverShared. The default value is AsCluster. (String, optional)
  • Returns: A new SIB JMS connection factory.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createSIBJMSConnectionFactory $ra {-name connectionfactory_name -jndiName jndi_name}
  • Using Jython:
    AdminTask.createSIBJMSConnectionFactory(ra, '[-name connectionfactory_name -jndiName jndi_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBJMSConnectionFactory {-interactive}
  • Using Jython:
    AdminTask.createSIBJMSConnectionFactory ('[-interactive]')
createSIBJMSQueue SIBJMSAdminCommands group Use the createSIBJMSQueue command to create a SIB JMS queue. Scope of the SIB JMS resource adapter to which you want to add the SIB JMS queue.
  • Parameters:
    name
    The name of the SIB JMS queue. (String, required)
    jndiName
    The JNDI name of the SIB JMS queue. (String, required)
    description
    A description of the SIB JMS queue. (String, optional)
    queueName
    The name of the underlying SIB queue to which the queue points. (String, required)
    deliveryMode
    The delivery mode for messages. Valid values include: Application, NonPersistent, and Persistent. (String, optional)
    timeToLive
    The time in milliseconds to be used for message expiration. (Long, optional)
    priority
    The priority for messages. Valid values are whole numbers between 0 to 9. (Integer, optional)
    readAhead
    The read-ahead value. Valid values include: AsConnection, AlwaysOn, and AlwaysOff. (String, optional)
    busName
    The name of the bus on which the queue resides. (String, optional)
  • Returns: A new SIB JMS queue.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createSIBJMSQueue $ra {-name queue_name -jndiName jndi_name -queueName queue_name}
  • Using Jython:
    AdminTask.createSIBJMSQueue(ra, '[-name queue_name -jndiName jndi_name -queueName queue_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBJMSQueue {-interactive}
  • Using Jython:
    AdminTask.createSIBJMSQueue ('[-interactive]')
createSIBJMSTopic SIBJMSAdminCommands group Use this command to create a SIB JMS topic. Scope of the SIB JMS resource adapter to which you want to add the SIB JMS topic.
  • Parameters:
    name
    The name of the SIB JMS topic (String, required)
    jndiName
    The JNDI name of the SIB JMS topic. (String, required)
    description
    A description of the SIB JMS queue. (String, optional)
    topicSpace
    The name of the underlying SIB topic space to which the topic points. (String, required)
    *topicName
    The topic to use inside the topic space. For example, stock/IBM. (String, required)
    deliveryMode
    The delivery mode for messages. Valid values include: Application, NonPersistent, and Persistent. (String, optional)
    timeToLive
    The time in milliseconds used for message expiration. (Long, optional)
    priority
    The priority for messages. Valid value include whole numbers between 0 and 9. (Integer, optional)
    readAhead
    The read-ahead value. Valid values include: AsConnection, AlwaysOn, and AlwaysOff. (String, optional)
    busName
    The name of the bus on which the topic resides. (String, optional)
  • Returns: A new SIB JMS topic.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createSIBJMSTopic $ra {-name topic_name -jndiName jndi_name -topicName topic_name -topicSpace topicspace_name}
  • Using Jython:
    AdminTask.createSIBJMSTopic(ra, '[-name topic_name -jndiName jndi_name -topicName topic_name -topicSpace topicspace_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBJMSTopic {-interactive}
  • Using Jython:
    AdminTask.createSIBJMSTopic ('[-interactive]')
createSIBMediation SIBAdminCommands Use this command to create a SIB mediation. None
  • Parameters:
    bus
    The name of the bus where the mediation will be created (String, required)
    mediationName
    The name of the mediation that you want to create. (String, required)
    description
    The description of the mediation. (String, optional)
    handlerListName
    name of the handler list that was defined when the mediation was deployed (String, required)
    globalTransaction
    whether or not a global transaction is started for each message processed (Boolean, optional, default = False)
    allowConcurrentMediation
    whether or not to apply the mediation to multiple messages concurrently, and preserve message ordering (Boolean, optional, default = False)
    selector
    the text string that must be present in a message for the mediation to process the message (String, optional)
    discriminator
    the text string that must not be present in a message for the mediation to process the message (String, optional)
  • Returns: A new SIB mediation.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createSIBMediation {-bus bus_name -mediationName mediation_name -handlerListName handlerList_name}
  • Using Jython:
    AdminTask.createSIBMediation('[-bus bus_name -mediationName mediation_name -handlerListName handlerList_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBMediation {-interactive}
  • Using Jython:
    AdminTask.createSIBMediation ('[-interactive]')
createSIBWSEndpointListener SIBWebServices group The createSIBWSEndpointListener command creates an end point listener object with no SIBWS bus connection property objects. Object name of the server where the end point listener will be created.
  • Parameters:
    name
    The name of the end point listener within the server. (required)
    urlRoot
    The root of the end point address URL for Web services that you access through the end point listener. (required)
    wsdlUrlRoot
    The root of the HTTP URL where you can retrieve the WSDL associated with this end point listener. (required)
  • Returns: The SIBWS end point object.

Batch mode example usage:

  • Using Jacl:
    set epl [$AdminTask createSIBWSEndpointListener $server {-name "soaphttp1" -urlRoot "http://myserver.com/wsgwsoaphttp1" -wsdlUrlRoot "http://myserver.com/wsgwsoaphttp1"}]
  • Using Jython:
    epl = AdminTask.createSIBWSEndpointListener(server, '[-name soaphttp1 -urlRoot http://myserver.com/wsgwsoaphttp1 -wsdlUrlRoot http://myserver.com/wsgwsoaphttp1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBWSEndpointListener {-interactive}
  • Using Jython:
    AdminTask.createSIBWSEndpointListener ('[-interactive]')
createSIBWSInboundService SIBWebServices group The createSIBWSInboundService command creates a new inbound service object that represents a protocol attachment that service requesters use. If you specify the UDDIReference option, the wsdlLocation option is assumed to be a UDDI service key in the following format, where each n is a hex digit: nnnnnnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnn. The object name of the messaging bus within which the service will be created.
  • Parameters:
    name
    The administrative name of the inbound service. (required)
    destination
    The name of the underlying WPM destination. (required)
    wsdlLocation
    The location of the template WSDL. The value of this parameter can be a URL or a UDDI service key (UUID). (required)
    wsdlServiceName
    The name of the service in the WSDL. You must specify this parameter or the wsdlServiceNamespace parameter. (conditional)
    wsdlServiceNamespace
    The namespace of the service in the WSDL. You must specify this parameter or the wsdlServiceName parameter. (conditional)
    uddiReference
    The reference of the UDDI registry for the WSDL. (optional)
    userId
    The user ID to use to retrieve the WSDL. (optional)
    password
    The password to use to retrieve the WSDL. (optional)
  • Returns: The object name of the created inbound service object.

Batch mode example usage:

  • Using Jacl:
    set inService [$AdminTask createSIBWSInboundService $bus {-name "MyService" -destination $destName -wsdlLocation "http://myserver.com/MyService.wsdl"}]
  • Using Jython:
    inService = AdminTask.createSIBWSInboundService(bus, '[-name MyService -destination destName -wsdlLocation http://myserver.com/MyService.wsdl]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBWSInboundService {-interactive}
  • Using Jython:
    AdminTask.createSIBWSInboundService ('[-interactive]')
createSIBWSOutboundService SIBWebServices group The createSIBWSOutboundService command creates a new outbound service object that represents a protocol attachment to a service provider. This command requires the identification of a single service element within a WSDL document. The object name of the messaging bus within which the service is created.
  • Parameters:
    name
    The administrative name of the outbound service. (required)
    wsdlLocation
    The location of the WSDL of the service provider. It can be a URL or a UDDI service key (UUID). (required)
    wsdlServiceName
    The name of the service in the WSDL. You must specify the wsdlServiceName parameter or the wsdlServiceNamespsace parameter. (conditional)
    wsdlServiceNamespace
    The namespace of the service in the WSDL. You must specify the wsdlServiceName parameter or the wsdlServiceNamespsace parameter. (conditional)
    uddiReference
    The reference of the UDDI registry for the WSDL. (optional)
    destination
    The name of the service destination. (optional)
    userId
    The user ID to use to retrieve the WSDL. (optional)
    password
    The password to use to retrieve the WSDL. (optional)
  • Returns: The object name of the outbound service object that was created.

Batch mode example usage:

  • Using Jacl:
    set outService [$AdminTask createSIBWSOutboundService $bus {-name "MyService" -wsdlLocation "http://myserver.com/MyService.wsdl"}]
  • Using Jython:
    outService =  AdminTask.createSIBWSOutboundService(bus, '[-name MyService -wsdlLocation http://myserver.com/MyService.wsdl]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBWSOutboundService {-interactive}
  • Using Jython:
    AdminTask.createSIBWSOutboundService ('[-interactive]')
createSIBus SIBAdminCommands Use this command to create a new bus on the current node. None
  • Parameters:
    bus
    name of bus to create, which must be unique in the cell (String, required)
    description
    descriptive information about the bus (String, required)
    secure
    enable or disable bus security (Boolean, optional, default = False)
    interEngineAuthAlias
    name of the authentication alias used to authorize communication between messaging engines on the bus (String, optional)
    mediationsAuthAlias
    name of the authentication alias used to authorize mediations to access the bus (String, optional)
    protocol
    the protocol used to send and receive messages between messaging engines, and between API clients and messaging engines (String, optional)
    discardOnDelete
    indicate whether or not any messages left in the data store of a queue should be discarded when the queue is deleted (Boolean, optional, default = False)
    destinationHighMsgs
    the maximum number of messages that any queue on the bus can hold (Long, optional)
    configurationReloadEnabled
    indicate whether configuration files should be dynamically reloaded for this bus (Boolean, optional, default = True)
  • Returns: A new SIB bus.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createSIBus {-bus busname -description text -secure True -mediationsAuthAlias name -protocol protocol -discardOnDelete False}
  • Using Jython:
    AdminTask.createSIBus('[-bus busname -description "text" -secure True -mediationsAuthAlias name -protocol protocol -discardOnDelete False]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createSIBus {-interactive}
  • Using Jython:
    AdminTask.createSIBus ('[-interactive]')
createServerType None

Use the createServerType command to define a server type.

None
  • Parameters:
    -version
    (String, required)
    -serverType
    (String, required)
    -createTemplateCommand
    (String, required)
    -createCommand
    (String, required)
    -defaultTemplateName
    The default value is: default. (String, optional)
    -configValidator
    (String, optional)
  • Returns: The identification of the server type that you created, javax.management.ObjectName.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createServerType {-version version -serverType serverType -createTemplateCommand name -createCommand name}
  • Using Jython:
    AdminTask.createServerType('[-version version -serverType serverType -createTemplateCommand name -createCommand name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createServerType {-interactive}
  • Using Jython:
    AdminTask.createServerType ('[-interactive]')
createTCPEndPoint None The createTCPEndPoint command creates a new named end point that you can associate with a TCP inbound channel. Parent instance of the TransportChannelService that contains the TCPInboundChannel. (ObjectName, required)
  • Parameters:
    -name
    Name for the new NamedEndPoint. (String, required)
    - host
    Host for the new NamedEndPoint. (String, required)
    - port
    Port for the new NamedEndPoint. (String, required)
  • Returns: Object name of the created NamedEndPoint.

Batch mode example usage:

  • Using Jacl:
    $AdminTask createTCPEndPoint (cells/rohitbuildCell01/nodes/
    rohitbuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1) 
    {-name Sample_End_Pt_Name -host rohitbuild.raleigh.ibm.com -port 8978}
  • Using Jython:
    AdminTask.createTCPEndPoint('cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1', '[-name Sample_End_Pt_Name -host rohitbuild.raleigh.ibm.com -port 8978]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createTCPEndPoint {-interactive}
  • Using Jython:
    AdminTask.createTCPEndPoint ('[-interactive]')
createUnmanagedNode UnmanagedNodeCommands group Use the createUnmanagedNode command to create a new unmanaged node in the configuration. An unmanaged node is a node that does not have a node agent or a deployment manager. Unmanaged nodes can contain Web servers, such as IBM HTTP Server. None
  • Parameters:
    - nodeName
    The name that will represent the node in the configuration repository. (String, required)
    - hostName
    The host name of the system associated with this node. (String, required)
    - nodeOperatingSystem
    The operating system in use on the system associated with this node. Valid entries include the following: os400, aix, hpux, linux, solaris, windows, and os390.(String required)
  • Returns: null

Batch mode example usage:

  • Using Jacl:
    $AdminTask createUnmanagedNode {-nodeName myNode
    -hostName myHost
    -nodeOperatingSystem linux}
  • Using Jython:
    AdminTask.createUnmanagedNode('[-nodeName jjNode -hostName jjHost -nodeOperatingSystem linux]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createUnmanagedNode {-interactive}
  • Using Jython:
    AdminTask.createUnmanagedNode  ('[-interactive]')
createWSGWGatewayService WSGateway group The createWSGWGatewayService command creates a new GatewayService with associated InboundService and TargetService objects. Configuration of the InboundPort and OutboundService/Port that is associated with these objects is done using separate commands. ObjectName of the gateway instance which the gateway service is created
  • Parameters:
    -name
    Administrative name of the Gateway Service. (required)
    -wsdlLocation
    Location of the template WSDL. May be a URL or a UDDI business key (UUID). (conditional)
    -wsdlServiceName
    The name of the service in the WSDL. (conditional)
    -wsdlServiceNamespace
    The namespace of the service in the WSDL. (conditional)
    -targetDestination
    The name of the target destination. (conditional)
    -targetService
    The name of the target outbound service. (conditional)
    -requestDestination
    The name of the gateway destination. (optional)
    -replyDestination
    The name of the gateway reply destination. (optional)
    -targetBus
    The name of the WPM bus containing the target. (optional)
    -uddiReference
    The reference of the UDDI registry for the WSDL. (optional)
    -userId
    The user id to use to retrieve the WSDL. (optional)
    -password
    The password to use to retrieve the WSDL. (optional)
  • Returns: ObjectName of the created GatewayService object

Batch mode example usage:

  • Using Jacl:
    set gwService [$AdminTask createWSGWGatewayService $wsgw {-name MyGatewayService -targetService MyService}]
  • Using Jython:
    gwService = AdminTask.createWSGWGatewayService(wsgw, '[-name MyGatewayService -targetService MyService]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createWSGWGatewayService  {-interactive}
  • Using Jython:
    $AdminTask createWSGWGatewayService  ('[-interactive]')
createWSGWProxyService WSGateway group The createWSGWProxyService command creates a new proxy service with an associated inbound service and a target service object with an associated outbound service. Configuration of the inbound port objects that are associated with the inbound service is done using separate commands. The object name of the gateway instance within which the proxy service is created.
  • Parameters:
    name
    The administrative name of the proxy service. (required)
    node
    The node where the destinations will be localized. (conditional)
    server
    The server where the destinations will be localized. (conditional)
    cluster
    Cluster where the destinations will be localized. (conditional)
    -requestDestination
    The name of the proxy request destination. (optional)
    -replyDestination
    The name of the proxy reply destination. (optional)
    -wsdlLocation
    The location of the proxy WSDL (URL). (optional)
  • Returns: The object name of the proxy service object that you created.

Batch mode example usage:

  • Using Jacl:
    set proxyService [$AdminTask createWSGWProxyService $wsgw {-name MyProxyService -node MyNode -server server1}]
  • Using Jython:
    proxyService = AdminTask.createWSGWProxyService(wsgw, '[-name MyProxyService -node MyNode -server server1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createWSGWProxyService  {-interactive}
  • Using Jython:
    AdminTask.createWSGWProxyService  ('[-interactive]')
createWebServer ServerManagement group Use the createWebServer command to create a Web server definition. This command is a two-step process. The first step creates a Web server definition using a template. The parameters of the second step configure the Web server definition properties. Web server definitions generate and propagate the plugin-config.xml file for each Web server. For IBM HTTP Server only, you can use the Web server definitions allow you to administer and configure IBM HTTP Server Web servers using the administrative console. These functions include: Start, Stop, View logs, View and Edit configuration files. None
  • Parameters for step one:
    nodeName
    The name of the node. (String, required)
    name
    The name of the server. (String, required)
    templateName
    The name of the template that you want to use. Templates include the following: IHS, iPlanet, IIS, DOMINO, APACHE. The default template is IHS. (String, required)
    genUniquePorts
    Indicates that you want to generate unique ports. (optional)
  • Parameters for step two:
    serverConfig
    Create the Web server. (String, required)
    webPort
    The port for the Web server. (String, required)
    configurationFile
    The configuration file. The default is the path relative to the installation root, for example, conf/httpd.conf. (String, optional)
    webInstallRoot
    The installation path for the Web server. (String, required)
    pluginInstallRoot
    The plug-in installation path. (String, required)
    serviceName
    The service name. (String, optional)
    errorLogfile
    The error log for viewing. The default is the path relative to the installation root, for example, logs/error_log. (String, optional)
    accessLogfile
    The access log for viewing. The default is the path relative to the installation root, for example, logs/access_log. (String, optional)
    webProtocol
    Parameters for the IBM HTTP Server administration server running with an unmanaged or remote Web server. Options include HTTP or HTTPS. The default is HTTP. (String, required)
    adminPort
    The port of the IBM HTTP Server administrative server. (String, required)
    adminUserID
    The user ID. This value should match the one for authentication in the admin.conf. (String, required)
    adminPasswrd
    The administrative password. (String, required)
    adminProtocol
    The administrative protocol title. Options include HTTP or HTTPS. The default is HTTP. (String, required)
  • Parameters for step three:

    Parameters for IBM HTTP Server administration server running with an unmanaged or remote Web server (installed on machine different from WebSphere Application Server)

    adminPortTitle (adminPort)
    Port of IBM HTTP Server administration
    adminUserIDTitle (adminUserID)
    The user ID. This value should match the authentication in the admin.conf file.
    adminPasswdTitle (adminPasswd)
    password
    AdminProtocolTitle (adminProtocol)
    This parameter is required. The value is either HTTP or HTTPS. The default value is HTTP.
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask createWebServer  {-name web1
    -serverConfig {{webPort WebserverInstallRoot PluginInstallRoot 
    Configuration_file_name Windows_Server_Name errorLogPath 
    accessLogPath WebProtocol}}
    -remoteServerConfig {{AdminPort UserID Password AdminProtocol}}
  • Using Jython:
    AdminTask.createWebServer('[-name web1 -serverConfig [[webPort WebserverInstallRoot PluginInstallRoot Configuration_file_name Windows_Server_Name errorLogPath accessLogPath WebProtocol]] -remoteServerConfig [[AdminPort UserID Password AdminProtocol]]]')
    
    where -serverConfig is second step of the command.
    • WebPort - is the port for the Webserver (required for all webservers)
    • WebserverInstallRoot - is the install path (directory) for webserver. necessary for IBM HTTP Server Admin Function.
    • Plugin Install Root - is install root where the plugin for the webserver is installed. Necessary for all webservers.
    • Configuration file name - is the file path for the IBM HTTP Server. This is necessary for View and edit of the IBM HTTP Server Configuration file only.
    • Windows Service Name - The windows service name on which IBM HTTP Server is to be started. This is necessary for Start and stop of the IBM HTTP Server Web server only.
    • ErrorLogPath - This is the path for the IBM HTTP Server error log (error.log)
    • AccessLogPath - This is the path for the IBM HTTP Server access log (access.log)
    • WebServerProtocol - HTTP or HTTPS

    where -remoteServerConfig is 3rd step of the command

    These parameters are only necessary if the IBM HTTP Server Web server is installed on a machine remote from WebSphere.
    • Admin Server Port - This is the port for the ADministration server. The administration server is installed on the same machine as the IBM HTTP Server. The administrative server handles administrative requests to the IBM HTTP Server Web server.
    • UserID - This is the userID for authentication, if authentication is activated on the Administration server in the admin configuration file (admin.conf).
    • Passwd - This is the password for the specified authentication UserID. The password is generated by htpasswd utility in the admin.passwd file.
    • Admin ServerProtocol - HTTP or HTTPS

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createWebServer -interactive
  • Using Jython:
    AdminTask.createWebServer ('[-interactive]')
deleteChain ChannelFrameworkManagement group The deleteChain command deletes an existing chain and, optionally, the transport channels in the chain. The chain to be deleted. (ObjectName,required)
  • Parameters:
    - deleteChannels
    If the value of this attribute is true, non-shared transport channels used by the specified chain will be deleted. (Boolean, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteChain trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#Chain_1093554462922)
    $AdminTask deleteChain trialChain(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#Chain_1093554378078) {-deleteChannels true}
  • Using Jython:
      AdminTask.deleteChain('trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1)')
    AdminTask.deleteChain('trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1)', '[-deleteChannels true]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteChain {-interactive}
  • Using Jython:
    AdminTask.deleteChain ('[-interactive]')
deleteCluster ClusterConfigCommands The deleteCluster command deletes the configuration of a server cluster. A server cluster consists of a group of application servers that are referred to as cluster members. When a server cluster is deleted, all of its members are deleted.

Use the deleteClusterMember command to delete the configuration of an individual cluster member.

clusterObjectID - The configuration object ID of the cluster to be deleted. If the cluster’s object ID is not specified, then the clusterName parameter must be specified. The object name can be obtained programmatically through Java using the WebSphere ConfigService API, or through wsadmin scripting using the AdminConfig object.
  • Parameters:
    -clusterName
    The name of the cluster to be deleted. If this parameter is not specified, then the cluster object ID must be specified in the command target.
  • Parameters for step one:
    -replicationDomain
    Specifies the removal of the replication domain for this cluster. This command step is optional. The following parameters can be specified for this step:
    deleteDomain
    Deletes the replication domain for this cluster. This parameter is optional. The value is true or false which indicates whether the domain will be deleted. The default value is false. . Deleting the replication domain deletes all replicator entries defined in the domain.
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteCluster { -clusterName cluster1 }
    $AdminTask deleteCluster { -clusterName cluster1 -replicationDomain {{true}}}
  • Using Jython:
    AdminTask.deleteCluster('[-clusterName cluster1]')
    AdminTask.deleteCluster('[-clusterName cluster1 -replicationDomain [[true]]]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteCluster -interactive
  • Using Jython:
    AdminTask.deleteCluster ('[-interactive]')
deleteClusterMember ClusterConfigCommands The deleteClusterMember command deletes the configuration of a cluster member. A cluster member is an application server that belongs to a server cluster.

Use the deleteCluster command to delete the configuration of a cluster.

memberObjectID - The configuration object ID of the cluster member to be deleted. If this is not specified, then the clusterName, memberNode and memberName parameters must be specified. The object name can be obtained programmatically via Java using the WebSphere ConfigService API, or via wsadmin scripting using the AdminConfig command.
  • Parameters:
    -clusterName
    The name of the cluster which the member to be deleted belongs to. If this parameter is specified, then the memberName and memberNode parameters must also be specified. If this is not specified, then the member object ID must be specified in the command target.
    -memberName
    The server name of the member to be deleted from the cluster. If this parameter is specified, then the clusterName and memberNode parameters must also be specified. If this is not specified, then the member object ID must be specified in the command target.
    -memberNode
    The name of the node having the cluster member to be deleted. If this parameter is specified, then the memberName and clusterName parameters must also be specified. If this is not specified, then the cluster member object ID must be specified in the command target.
  • Parameters for step one:
    -replicatorEntry
    Specifies the removal of a replicator entry for this cluster member. This command step is optional. The following parameters can be specified for this step:
    deleteEntry
    Delete the replicator entry having this cluster member’s name from the cluster’s replication domain. This parameter is optional. The value is true or false which indicates whether to delete the replicator entry. The default value is false.
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteClusterMember {-clusterName cluster1 -memberNode node1 -memberName member1}
    $AdminTask deleteClusterMember {-clusterName cluster1 -memberNode node1 -memberName member2 -replicationEntry {{true}}}
  • Using Jython:
    AdminTask.deleteClusterMember('[-clusterName cluster1 -memberNode node1 -memberName member1]')
    AdminTask.deleteClusterMember('[-clusterName cluster1 -memberNode node1 -memberName member2 -replicationEntry [[true]]]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteClusterMember -interactive
  • Using Jython:
    AdminTask.deleteClusterMember ('[-interactive]')
deleteCoreGroup CoreGroupManagement group The deleteCoreGroup command deletes an existing core group. The core group that you specify must not contain any members. You cannot delete the default core group. None
  • Parameters:
    - coreGroupName
    The name of the existing core group that will be deleted. (String required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteCoreGroup {-coreGroupName MyCoreGroup} 
  • Using Jython:
    AdminTask.deleteCoreGroup('[-coreGroupName MyCoreGroup]') 

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteCoreGroup {-interactive}
  • Using Jython:
    AdminTask.deleteCoreGroup ('[-interactive]')
deleteCoreGroupAccessPoints CoreGroupBridgeManagement group The deleteCoreGroupAccessPoints command deletes all the core group access points that are associated with a group that you specify. Core group bridge settings object for the cell. (ObjectName, required)
  • Parameters:
    - coreGroupName
    The name of the core group whose core group access points will be deleted. (String required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteCoreGroupAccessPoints (cells/
    rohitbuildCell01|coregroupbridge.xml#
    CoreGroupBridgeSettings_1) "-coreGroupName DefaultCoreGroup"
  • Using Jython:
    AdminTask.deleteCoreGroupAccessPoints('(cells/rohitbuildCell01|coregroupbridge.xml#CoreGroupBridgeSettings_1)', '[-coreGroupName DefaultCoreGroup]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteCoreGroupAccessPoints {-interactive}
  • Using Jython:
    AdminTask.deleteCoreGroupAccessPoints ('[-interactive]')
deleteSIBDestination SIBAdminCommands Use the deleteSIBDestination command to delete a bus destination. This command deletes the named destination of the named bus and deletes all related message points. None
  • Parameters:
    bus
    name of the bus on which the destination to be deleted exists (String, required)
    name
    name of the destination to be deleted (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBDestination {-bus busname -name destname}
  • Using Jython:
    AdminTask.deleteSIBDestination('[-bus busname -name destname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBDestination {-interactive}
  • Using Jython:
    AdminTask.deleteSIBDestination ('[-interactive]')
deleteSIBEngine SIBAdminCommands Use the deleteSIBEngine command to delete the default or named bus messaging engine from the named SIB bus. A server can have one messaging engine only. When you use this command to delete a messaging engine from a server, the engine name is not required. A cluster can have more than one messaging engine so the name of the engine must be supplied. None
  • Parameters:
    *bus
    name of the bus to which the messaging engine to be deleted belongs (String, required)
    node
    to delete a messaging engine on a server, supply node and server name, but not cluster name (String, optional)
    server
    to delete a messaging engine on a server, supply node and server name, but not cluster name (String, optional)
    cluster
    to delete a messaging engine on a cluster, supply cluster name, but not node and server name (String, optional)
    engine
    name of the messaging engine to delete. This is optional, and is only required when deleting a messaging engine from a cluster (String, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBEngine {-bus busname -node nodeName -server severname}
  • Using Jython:
    AdminTask.deleteSIBEngine('[-bus busname -node nodeName -server severname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBEngine {-interactive}
  • Using Jython:
    AdminTask.deleteSIBEngine ('[-interactive]')
deleteSIBJMSActivationSpec SIBJMSAdminCommands Use the deleteSIBJMSActivationSpec command to delete an activation specification. None
  • Parameters:
    name
    The name of the activation specification that you want to delete. (String, (required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBJMSActivationSpec {-name specname}
  • Using Jython:
    AdminTask.deleteSIBJMSActivationSpec('[-name specname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBJMSActivationSpec {-interactive}
  • Using Jython:
    AdminTask.deleteSIBJMSActivationSpec ('[-interactive]')
deleteSIBJMSConnectionFactory SIBJMSAdminCommands Use the deleteSIBJMSConnectionFactory command to delete SIB JMS connection factories. None
  • Parameters:
    name
    The name of the SIB JMS connection factory (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBJMSConnectionFactory {-name factory_name}
  • Using Jython:
    AdminTask.deleteSIBJMSConnectionFactory('[-name factory_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBJMSConnectionFactory {-interactive}
  • Using Jython:
    AdminTask.deleteSIBJMSConnectionFactory ('[-interactive]')
deleteSIBJMSQueue SIBJMSAdminCommands Use the deleteSIBJMSQueue command to delete a JMS queue. None
  • Parameters:
    name
    The name of the SIB JMS queue. (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBJMSQueue {-name queue_name}
  • Using Jython:
    AdminTask.deleteSIBJMSQueue('[-name queue_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBJMSQueue {-interactive}
  • Using Jython:
    AdminTask.deleteSIBJMSQueue ('[-interactive]')
deleteSIBJMSTopic SIBJMSAdminCommands Use the deleteSIBJMSTopic command to delete a JMS topic. None
  • Parameters:
    name
    The name of the SIB JMS topic (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBJMSTopic {-name topic_name}
  • Using Jython:
    AdminTask.deleteSIBJMSTopic('[-name topic_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBJMSTopic {-interactive}
  • Using Jython:
    AdminTask.deleteSIBJMSTopic ('[-interactive]')
deleteSIBMediation SIBAdminCommands Use this command to delete the named mediation from the named bus. None
  • Parameters:
    bus
    name of the bus that owns the mediation (String, required)
    mediationName
    name of the mediation to be deleted (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
  • Using Jython:

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBMediation {-interactive}
  • Using Jython:
    AdminTask.deleteSIBMediation ('[-interactive]')
deleteSIBWSEndpointListener SIBWebServices group The deleteSIBWSEndpointListener command deletes the configuration of a an end point listener. This command fails if inbound port objects are associated with the end point listener. Object name of the end point listener that you want to delete.
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBWSEndpointListener $epl
  • Using Jython:
    AdminTask.deleteSIBWSEndpointListener(epl)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBWSEndpointListener {-interactive}
  • Using Jython:
    AdminTask.deleteSIBWSEndpointListener ('[-interactive]')
deleteSIBWSInboundService SIBWebServices group The deleteSIBWSInboundService command deletes an inbound service object and any associated inbound port objects. The object name of the inbound service object that you want to delete.
  • Parameters:
    userId
    The user ID to use to interact with UDDI registries. (optional)
    password
    The password to use to interact with UDDI registries. (optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBWSInboundService $inService
  • Using Jython:
    AdminTask.deleteSIBWSInboundService(inService)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBWSInboundService {-interactive}
  • Using Jython:
    AdminTask.deleteSIBWSInboundService ('[-interactive]')
deleteSIBWSOutboundService SIBWebServices group The deleteSIBWSOutboundService command deletes an outbound service object and any associated outbound port objects. Resources that are associated with the outbound service or outbound ports, for example, WS-Security configuration, are disassociated from the outbound service but the outbound ports are not deleted. Object name of the outbound service object that you want to delete.
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBWSOutboundService $outService
  • Using Jython:
    AdminTask.deleteSIBWSOutboundService(outService)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBWSOutboundService {-interactive}
  • Using Jython:
    AdminTask.deleteSIBWSOutboundService ('[-interactive]')
deleteSIBus SIBAdminCommands The deleteSIBus command deletes the named SIB bus, all SIB mediations and all SIB destinations that are owned by the bus. None
  • Parameters:
    bus
    name of bus to be deleted from the current cell (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBus {-bus bus_name}
  • Using Jython:
    AdminTask.deleteSIBus('[-bus bus_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteSIBus {-interactive}
  • Using Jython:
    AdminTask.deleteSIBus ('[-interactive]')
deleteServer ServerManagement group

Use the deleteServer command to delete a server.

None
  • Parameters:
    -serverName
    The name of the server to delete. (String, required)
    -nodeName
    The name of the node for the server that you want to delete. (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteServer {-serverName server_name -nodeName node_name}
  • Using Jython:
    AdminTask.deleteServer('[-serverName server_name -nodeName node_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteServer {-interactive}
  • Using Jython:
    AdminTask.deleteServer ('[-interactive]')
deleteServerTemplate ServerManagement

Use the deleteServerTemplate command to delete a server template. You cannot delete templates that are defined by the system. You can only delete server templates that you created. This command deletes the directory that hosts the server template.

The name of the template to delete. (ObjectName, required)

  • Parameters:
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteServerTemplate template_name(templates/serverTypes/APPLICATION_SERVER/servers/newTemplate|server.xml#Server_1105015708079)
  • Using Jython:
    AdminTask.deleteServerTemplate(template_name(templates/serverTypes/APPLICATION_SERVER/servers/newTemplate|server.xml#Server_1105015708079))

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteServerTemplate {-interactive}
  • Using Jython:
    AdminTask.deleteServerTemplate ('[-interactive]')
deleteWSGWGatewayService WSGateway group The deleteWSGWGatewayService command deletes a gateway service. It deletes the gateway destination, the corresponding reply destination, the inbound service, the inbound port enablement objects, and all of the associated target service objects. This command does not delete the destinations that are associated with the target services. Object name of the gateway service object
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteWSGWGatewayService $gwService
  • Using Jython:
    AdminTask.deleteWSGWGatewayService(gwService)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteWSGWGatewayService {-interactive}
  • Using Jython:
    AdminTask.deleteWSGWGatewayService ('[-interactive]')
deleteWSGWProxyService WSGateway group The deleteWSGWProxyService command deletes a proxy service that includes the proxy destinations, outbound service, outbound ports, inbound service, and inbound port enablement objects. Object name of the ProxyService object
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteWSGWProxyService $proxyService
  • Using Jython:
    AdminTask.deleteWSGWProxyService(proxyService)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteWSGWProxyService {-interactive}
  • Using Jython:
    AdminTask.deleteWSGWProxyService ('[-interactive]')
disconnectSIBWSEndpointListener SIBWebServices group The disconnectSIBWSEndpointListener command disconnects an end point listener from a bus. Object name of the end point listener to be disconnected.
  • Parameters:
    bus
    The name of the bus from which to be disconnected. (required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask disconnectSIBWSEndpointListener $epl {-bus "MyBus"}
  • Using Jython:
    AdminTask.disconnectSIBWSEndpointListener(epl,'[-bus MyBus]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask disconnectSIBWSEndpointListener {-interactive}
  • Using Jython:
    AdminTask.disconnectSIBWSEndpointListener ('[-interactive]')
doesCoreGroupExist CoreGroupManagement group The doesCoreGroupExist command returns a boolean value that indicates if the core group that you specify exists. None
  • Parameters:
    coreGroupName
    The name of the core group. (String, required)
  • Returns: A boolean value.

Batch mode example usage:

  • Using Jacl:
    $AdminTask doesCoreGroupExist {-coreGroupName MyCoreGroup}
  • Using Jython:
    AdminTask.doesCoreGroupExist('[-coreGroupName MyCoreGroup]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask doesCoreGroupExist {-interactive}
  • Using Jython:
    AdminTask.doesCoreGroupExist ('[-interactive]')
exportServer Configuration archiveOperations group

Use the exportServer command to export the server configuration to a node that is defined in the configuration archive.

The exportServer command virtualizes the server configuration and exports a server to a configuration archive. This process breaks any existing associations between the server configurations in the configuration archive and the configurations in the system. This process also removes applications from the server that you specify, breaks the relationship between the server that you specify and the core group of the server, cluster, or SIBus membership. The exportServer command exports the metadata file of the node where the server resides. You can use this information later when you import the configuration archive to verify that the target node is compatible to the node from which you are exporting the server.

None
  • Parameters:
    -archive
    The fully qualified path of the exported configuration archive. (String, required)
    -nodeName
    The node name of the server. This parameter is only required when the server name is not unique across the cell. (String, optional)
    -serverName
    The server name. (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask exportServer {-archive c:\myServer.ear -nodeName node1 -serverName server1}
  • Using Jython:
    AdminTask.exportServer('[-archive c:\myServer.ear -nodeName node1 -serverName server1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask exportServer {-interactive}
  • Using Jython:
    AdminTask.exportServer ('[-interactive]')
exportWasprofile configuration archiveOperations group Use the exportWasprofile command to export the entire cell configuration to a configuration archive. None
  • Parameters:
    archive
    The fully qualified file path of the exported configuration archive. (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask exportWasprofile {-archive c:\myCell.ear}
  • Using Jython:
    AdminTask.exportWasprofile('[-archive c:\myCell.ear]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask exportWasprofile {-interactive}
  • Using Jython:
    AdminTask.exportWasprofile ('[-interactive]')
getAllCoreGroupNames CoreGroupManagement group The getAllCoreGroupNames command returns a string that contains the names of all of the existing core groups None
  • Parameters: None
  • Returns: String array (String[ ])

Batch mode example usage:

  • Using Jacl:
    $AdminTask getAllCoreGroupNames
  • Using Jython:
    AdminTask.getAllCoreGroupNames()

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getAllCoreGroupNames {-interactive}
  • Using Jython:
    AdminTask.getAllCoreGroupNames ('[-interactive]')
getCoreGroupNameForServer CoreGroupManagement group The getCoreGroupNameForServer command returns the name of the core group in which the server that you specify is currently a member. None
  • Parameters:
    - nodeName
    The name of the node that contains the server. (String, required)
    - serverName
    The name of the server. (String, required)
  • Returns: The name of the core group that currently contains the server that you specified. (String)

Batch mode example usage:

  • Using Jacl:
    $AdminTask getCoreGroupNameForServer  {-nodeName myNode -serverName myServer}
  • Using Jython:
    AdminTask.getCoreGroupNameForServer('[-nodeName myNode -serverName myServer]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getCoreGroupNameForServer {-interactive}
  • Using Jython:
    AdminTask.getCoreGroupNameForServer ('[-interactive]')
getDefaultCoreGroupName CoreGroupManagement group The getDefaultCoreGroupName command returns the name of the default core group. None
  • Parameters: None
  • Returns: String

Batch mode example usage:

  • Using Jacl:
    $AdminTask getDefaultCoreGroupName
  • Using Jython:
    AdminTask.getDefaultCoreGroupName()

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getDefaultCoreGroupName {-interactive}
    
  • Using Jython:
    AdminTask.getDefaultCoreGroupName ('[-interactive]')
getMetadataProperties ManagedObjectMetadata group The getMetadataProperties command obtains all metadata for the node that you specify. None
  • Parameters:
    - nodeName
    The name of the node associated with the metadata you want this command to return.
  • Returns: The list of metadata properties.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getMetadataProperties {-nodeName node1}
  • Using Jython:
    AdminTask.getMetadataProperties('[-nodeName node1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getMetadataProperties {-interactive}
  • Using Jython:
    AdminTask.getMetadataProperties ('[-interactive]')
getMetadataProperty ManagedObjectMetadata group The getMetadataProperty command obtains metadata with the specified key for the node that you specify. None
  • Parameters:
    - nodeName
    The name of the node associated with the metadata you want this command to return.
    - propertyName
    Metadata property key.
  • Returns: The requested property for the node that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getMetadataProperty {-nodeName node1 -propertyName com.ibm.websphere.baseProductVersion}
  • Using Jython:
    AdminTask.getMetadataProperty ('[-nodeName node1 -propertyName com.ibm.websphere.baseProductVersion]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getMetadataProperty {-interactive}
  • Using Jython:
    AdminTask.getMetadataProperty ('[-interactive]')
getNamedTCPEndPoint CoreGroupBridgeManagement group The getNamedTCPEndPoint command returns the port associated with the bridge interface that you specify. The port that is returned is the one that is specified on the TCP inbound channel of the transport channel chain for bridge interface that you specify. The bridge interface object for which the port will be listed. (ObjectName, required)
  • Parameters: None
  • Returns: The port (named end point) object name of the TCP inbound channel instance which resides on the DCS transport channel chain of the bridge interface.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getNamedTCPEndPoint (cells/rohitbuildCell01|
    coregroupbridge.xml#BridgeInterface_2)
  • Using Jython:
    AdminTask.getNamedTCPEndPoint('(cells/rohitbuildCell01|coregroupbridge.xml#BridgeInterface_2)')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getNamedTCPEndPoint {-interactive}
  • Using Jython:
    AdminTask.getNamedTCPEndPoint ('[-interactive]')
getNodeBaseProductVersion ManagedObjectMetadata group The getNodeBaseProductVersion command returns the version of the WebSphere Application Server for a node that you specify. None
  • Parameters:
    - nodeName
    The name of the node associated with the metadata you want this command to return.
  • Returns: WebSphere Application Server version for the node that you specify.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getNodeBaseProductVersion {-nodeName node1}
  • Using Jython:
    AdminTask.getNodeBaseProductVersion('[-nodeName node1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getNodeBaseProductVersion {-interactive}
  • Using Jython:
    AdminTask.getNodeBaseProductVersion ('[-interactive]')
getNodeMajorVersion ManagedObjectMetadata group The getNodeMajorVersion command returns the major version of the WebSphere Application Server for a node that you specify. None
  • Parameters:
    nodeName
    The name of the node associated with the metadata you want this command to return.
  • Returns: WebSphere Application Server major version for the node that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getNodeMajorVersion {-nodeName node1}
  • Using Jython:
    AdminTask.getNodeMajorVersion('[-nodeName node1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getNodeMajorVersion {-interactive}
  • Using Jython:
    AdminTask.getNodeMajorVersion ('[-interactive]')
getNodeMinorVersion ManagedObjectMetadata group The getNodeMinorVersion command returns the minor version of the WebSphere Application Server for a node that you specify. None
  • Parameters:
    - nodeName
    The name of the node associated with the metadata you want this command to return.
  • Returns: WebSphere Application Server minor version for the node that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getNodeMinorVersion {-nodeName node1}
  • Using Jython:
    AdminTask.getNodeMinorVersion('[-nodeName node1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getNodeMinorVersion {-interactive}
  • Using Jython:
    AdminTask.getNodeMinorVersion ('[-interactive]')
getNodePlatformOS ManagedObjectMetadata group The getNodePlatformOS command returns the operating system name for a node that you specify. None
  • Parameters:
    - nodeName
    The name of the node associated with the metadata you want this command to return.
  • Returns: The operating system name of the node that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getNodePlatformOS {-nodeName node1}
  • Using Jython:
    AdminTask.getNodePlatformOS('[-nodeName node1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getNodePlatformOS {-interactive}
  • Using Jython:
    AdminTask.getNodePlatformOS ('[-interactive]')
getNodeSysplexName ManagedObjectMetadata group The getNodeSysplexName command returns the sysplex name for a node that you specify. None
  • Parameters:
    - nodeName
    The name of the node associated with the metadata you want this command to return.
  • Returns: The sysplex name of the given node.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getNodeSysplexName {-nodeName node1}
  • Using Jython:
    AdminTask.getNodeSysplexName('[-nodeName node1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getNodeSysplexName {-interactive}
  • Using Jython:
    AdminTask.getNodeSysplexName ('[-interactive]')
getServerType ServerManagement group The getServerType command returns the type of the server that you specify. None
  • Parameters:
    - serverName
    The name of the server. (String)
    - nodeName
    The name of the node. (String)
  • Returns: The type of the server.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getServerType {-serverName test2 -nodeName ndnode1}
  • Using Jython:
    AdminTask.getServerType('[-serverName test2 -nodeName ndnode1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getServerType {-interactive}
  • Using Jython:
    AdminTask.getServerType ('[-interactive]')
getTCPEndPoint None The getTCPEndPoint command obtains the named end point that is associated with either a TCP inbound channel or a chain that contains a TCP inbound channel. TCPInboundChannel, or containing chain, instance that is associated with a NamedEndPoint. (ObjectName, required)
  • Parameters: None
  • Returns: Object name of an existing named end point that is associated with the TCP inbound channel instance or a channel chain.

Batch mode example usage:

  • Using Jacl:
    $AdminTask getTCPEndPoint TCP_1(cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)
    $AdminTask getTCPEndPoint DCS(cells/rohitbuildCell01/nodes/
    rohitbuildCellManager01/servers/dmgr|server.xml#Chain_3)
  • Using Jython:
    AdminTask.getTCPEndPoint('TCP_1(cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)')
    AdminTask.getTCPEndPoint('DCS(cells/rohitbuildCell01/nodes/
    rohitbuildCellManager01/servers/dmgr|server.xml#Chain_3)')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask getTCPEndPoint {-interactive}
  • Using Jython:
    AdminTask.getTCPEndPoint ('[-interactive]')
importServer Configuration archiveOperations group

Use the importServer command to import a server that resides in a configuration archive to the system. This command imports all the server scope configurations defined in the configuration archive to system configuration.

None
  • Parameters:
    -archive
    The fully qualified path of the configuration archive. (String, required)
    -nodeInArchive
    The node name of the server defined in the configuration archive. (String, optional if there is only one node defined in the configuration archive, required if there are multiple nodes defined in the configuration archive)
    -serverInArchive
    The name of the server defined in the configuration archive. (String, optional if there is only one server defined on the specified nodeInConfiguration archive, required if there are multiple servers defined under the specified nodeInConfiguration archive)
    -nodeName
    The node name where the server is imported. (String, optional if there is only one node)
    -serverName
    The server name where the server is imported. If the server name that you specify matches an existing server name under the node, an exception is thrown. (String, optional, default:serverInArchive)
    -coreGroup
    The core group name to which the server should belong. (String, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask importServer {-archive c:\myServer.ear -nodeInArchive node1 -serverInArchive server1}
  • Using Jython:
    AdminTask.importServer('[-archive c:\myServer.ear -nodeInArchive node1 -serverInArchive server1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask importServer {-interactive}
  • Using Jython:
    AdminTask.importServer ('[-interactive]')
help None The help command provides a summary of the help commands and ways to invoke an administrative command. None
  • Parameters: None
  • Returns: A general help description
  • Using Jacl:
    $AdminTask help
  • Using Jython:
    print AdminTask.help()
help None The help command provides a list of available administrative commands if the option string is -commands or administrative command groups if the option string is -commandGroups. Valid options include -commands and -commandGroups. None
  • Parameters:
    - options
  • Returns: A summary of all available administrative commands.
  • Using Jacl:
    $AdminTask help -commands
  • Using Jython:
    AdminTask.help('-commands')
help None If you provide the step name, this command provides help information for a given step of an administrative command. Otherwise, it provides help information for a given admin command or administrative command group. The stepName parameter is optional. None
  • Parameters:
    - commandName
    - stepName
  • Returns: A summary of the specified command group, administrative command, or step.
  • Using Jacl:
    $AdminTask help createJ2CConnectionFactory
  • Using Jython:
    AdminTask.help('createJ2CConnectionFactory')
importWasprofile configuration archiveOperations group Use the importWasprofile command to import a cell configuration in the configuration archive to the system. Only a base single server configuration is supported for this command. None
  • Parameters:
    archive
    The fully qualified file path of the configuration archive. (String, required)
  • Returns: Void

Batch mode example usage:

  • Using Jacl:
    $AdminTask importWasprofile {-archive c:\myCell.ear}
  • Using Jython:
    AdminTask.importWasprofile('[-archive c:\myCell.ear]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask importWasprofile {-interactive}
  • Using Jython:
    AdminTask.importWasprofile ('[-interactive]')
isNodeZOS MangedObjectMetadata group The isNodeZOS command tests if a node that you specify is running on the z/OS platform. This command does not apply to distributed platforms or to WebSphere Application Server-Express. None
  • Parameters:
    - nodeName
    The name of the node associated with the metadata you want this command to return.
  • Returns: A true value if the node operating system is z/OS. A false value if the node operating system is not z/OS.

Batch mode example usage:

  • Using Jacl:
    $AdminTask isNodeZOS {-nodeName node1}
  • Using Jython:
    AdminTask.isNodeZOS('[-nodeName node1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask isNodeZOS {-interactive}
  • Using Jython:
    AdminTask.isNodeZOS ('[-interactive]')
listAdminObjectInterfaces JCA management group

Use the listAdminObjectInterfaces command to list the administrative object interfaces that are defined under the resource adapter that you specify.

J2CResouce adapter object ID
  • Parameters: None
  • Returns: A list of administrative object interfaces.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listAdminObjectInterfaces $ra
  • Using Jython:
    AdminTask.listAdminObjectInterfaces(ra)
listChainTemplates ChannelFrameworkManagement group The listChainTemplates command displays a list of templates that you can use to create chains in this configuration. All templates have a certain type of transport channel as the last transport channel in the chain. None
  • Parameters:
    - acceptorFilter
    The templates returned by this method all have a transport channel instance of the specified type as the last transport channel in the chain. (String, optional)
  • Returns: A list of all the chain template object names. If you specify the acceptorFilter parameter, the list that returns is filtered to match the filter that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listChainTemplates {}
    $AdminTask listChainTemplates "-acceptorFilter WebContainerInboundChannel"
  • Using Jython:
    AdminTask.listChainTemplates()
    AdminTask.listChainTemplates('[-acceptorFilter WebContainerInboundChannel]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listChainTemplates {-interactive}
  • Using Jython:
    AdminTask.listChainTemplates ('[-interactive]')
listChains ChannelFrameworkManagement group The listChains command lists all the chains that are configured under a particular instance of the transport channel service. The instance of the transport channel service under which the the chains are configured. (ObjectName, required)
  • Parameters:
    - acceptorFilter
    The chains that are returned by this parameter will have a transport channel instance of the type that you specify as the last transport channel in the chain. (String, optional)
    - endPointFilter:
    The chains returned by this parameter will have a TCP inbound channel using an end point with the name that you specify.(String, optional)
  • Returns: A list of all the channel chain object names that match the specified filters. If no you do not specify any parameters, all of the channel chains that are configured under the particular instance of transport channel service are returned.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listChains (cells/rohitbuildCell01/nodes/
    rohitbuildNode01/servers/server2|server.xml#
    TransportChannelService_1093445762328)
    $AdminTask listChains (cells/rohitbuildCell01/nodes/
    rohitbuildNode01/servers/server2|server.xml#
    TransportChannelService_1093445762328) {-acceptorFilter 
    WebContainerInboundChannel}
    $AdminTask listChains (cells/rohitbuildCell01/nodes/
    rohitbuildNode01/servers/server2|server.xml#
    TransportChannelService_1093445762328) 
    {-endPointFilter WC_adminhost}
  • Using Jython:
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml#TransportChannelService_1093445762328)')
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml#TransportChannelService_1093445762328)', '[-acceptorFilter WebContainerInboundChannel]')
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml#TransportChannelService_1093445762328)', '[-endPointFilter WC_adminhost]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listChains {-interactive}
  • Using Jython:
    AdminTask.listChains ('[-interactive]')
listConnectionFactoryInterfaces JCA management group

Use the listConnectionFactoryInterfaces command to list all of the connection factory interfaces that are defined under the Java 2 connector resource adapter that you specify.

J2CResourceAdapter object ID
  • Parameters: None
  • Returns: A list of connection factory interfaces.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listConnectionFactoryInterfaces $ra
  • Using Jython:
    AdminTask.listConnectionFactoryInterfaces(ra)
listCoreGroups CoreGroupBridgeManagement group The listCoreGroups command returns a collection of core groups that are related to the core group that you specify. The name of the core group for which the related core groups will be listed. (String, required)
  • Parameters:
    - cgBridgeSettings
    The group bridge settings object for the cell. (ObjectName, required)
  • Returns: A set of core group names.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listCoreGroups DefaultCoreGroup "-cgBridgeSettings
     (cells/rohitbuildCell01|coregroupbridge.xml#
    CoreGroupBridgeSettings_1)"
  • Using Jython:
    AdminTask.listCoreGroups('DefaultCoreGroup', '[-cgBridgeSetting (cells/rohitbuildCell01|coregroupbridge.xml#CoreGroupBridgeSettings_1)]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listCoreGroups {-interactive}
  • Using Jython:
    AdminTask.listCoreGroups ('[-interactive]')
listEligibleBridgeInterfaces CoreGroupBridgeManagement group The listEligibleBridgeInterfaces command returns a collection of node, server, and transport channel chain combinations that are eligible to become bridge interfaces for the specified core group access point. The core group access point object for which bridge interfaces will be listed. (ObjectName, required)
  • Parameters: None
  • Returns: A set of bridge interfaces. (Set of String) Each bridge interface is represented by a combination of a node, a server and a DCS channel chain: <node name>, <server name>, <DCS Channel Chain objectName. For example, an element of the set returned by this command may look like the following: rohitbuild dmgr DCS-Secure(cells/rohitbuildCell/nodes/rohitbuild/servers/dmgr|server.xml#Chain_4)

Batch mode example usage:

  • Using Jacl:
    $AdminTask listEligibleBridgeInterfaces CGAP_DCG_2
    (cells/rohitbuildCell01|coregroupbridge.xml#
    CoreGroupAccessPoint_1089636614062)
  • Using Jython:
    AdminTask.listEligibleBridgeInterfaces('CGAP_DCG_2(cells/rohitbuildCell01|coregroupbridge.xml#
    CoreGroupAccessPoint_1089636614062)')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listEligibleBridgeInterfaces {-interactive}
  • Using Jython:
    AdminTask.listEligibleBridgeInterfaces ('[-interactive]')
listJ2CActivationSpecs JCA management group

Use the listJ2CActivationSpecs command to list the activation specifications that are contained under the resource adapter and message listener type that you specify.

J2CResourceAdapter object ID
  • Parameters:
    -messageListenerType
    Specifies the message listener type for the resource adapter for which you are making a list. This parameter is required.
  • Returns: A list of activation specs that has specified messageListener type.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listJ2CActivationSpecs $ra {-messageListenerType javax.jms.MessageListener}
  • Using Jython:
    AdminTask.listJ2CActivationSpecs(ra, '[-messageListenerType javax.jms.MessageListener]')
listJ2CAdminObjects JCA Management group

Use the listJ2CAdminObjects command to list administrative objects that contain the administrative object interface that you specify.

J2C ResourceAdapter object ID
  • Parameters:
    -adminObjectInterface
    Specifies the administrative object interface for which you want to list. This parameter is required.
  • Returns: A list of administrative objects that has specified adminObjectInterface.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listJ2CAdminObjects $ra {-adminObjectInterface fvt.adaptor.message.FVTMessageProvider}
  • Using Jython:
    AdminTask.listJ2CAdminObjects(ra, '[-adminObjectInterface fvt.adaptor.message.FVTMessageProvider]')
listJ2CConnectionFactories JCA management group

Use the listJ2CConnectionFactories command to list the Java 2 connector connection factories under the resource adapter and connection factory interface that you specify.

J2C ResourceAdapter object ID
  • Parameters:
    -connectionFactoryInterface
    Indicates the name of the connection factory that you want to list. This parameter is required.
  • Returns: A list of J2C connectionFactory that has the specified connectionFactoryInterface.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listJ2CConnectionFactories $ra {-connectionFactoryInterface javax.sql.DataSource}
  • Using Jython:
    AdminTask.listJ2CConnectionFactories(ra, '[-connectionFactoryInterface javax.sql.DataSource]')
listManagedNodes UnmanagedNodeCommands group Use the listManagedNodes command to list the managed nodes, nodes that have a node agent defined, in a configuration. None
  • Parameters: None
  • Returns: List

Batch mode example usage:

  • Using Jacl:
    $AdminTask listManagedNodes
  • Using Jython:
    AdminTask.listManagedNodes()
listMessageListenerTypes JCA Management group

Use the listMessageListenerTypes command to list the message listener types that are defined under the resource adapter that you specify.

J2C ResourceAdapter object ID
  • Parameters: None
  • Returns: A list of message listener types.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listMessageListenerTypes $ra
  • Using Jython:
    AdminTask.listMessageListenerTypes(ra)
listNodeGroupProperties NodeGroupCommands group The listNodeGroupProperties command displays all of the custom properties of a node group. The target object is name of the node group. This target object is required.
  • Parameters: None
  • Returns: A list of all of the custom properties of a node group.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listNodeGroupProperties WBINodeGroup
  • Using Jython:
    AdminTask.listNodeGroupProperties('WBINodeGroup')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listNodeGroupProperties {-interactive}
  • Using Jython:
    AdminTask.listNodeGroupProperties ('[-interactive]')
listNodeGroups NodeGroupCommands group The listNodeGroups command returns the list of node groups from the configuration repository. You can pass an optional node name to the command that returns the list of node groups where the node resides. The target object is name of the node. This target object is optional.
  • Parameters: None
  • Returns: A list of the node groups in the cell.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listNodeGroups
    
    $AdminTask listNodeGroups nodeName
  • Using Jython:
    AdminTask.listNodeGroups 
    
    AdminTask.listNodeGroups('nodeName')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listNodeGroups {-interactive}
  • Using Jython:
    AdminTask.listNodeGroups ('[-interactive]')
listNodes NodeGroupCommands group The listNodes command displays all of the nodes in the cell. The target object is name of the node group. This target object is optional.
  • Parameters: None
  • Returns: A list of all the nodes in the cell

Batch mode example usage:

  • Using Jacl:
    $AdminTask listNodes
  • Using Jython:
    AdminTask.listNodes()

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listNodes {-interactive}
  • Using Jython:
    AdminTask.listNodes ('[-interactive]')
listSIBDestinations SIBAdminCommands Use the listSIBDestinations command to get a list of SIB destinations of the named type that is owned by a named SIB bus. If no type is named, all the destinations that are owned by the named bus are listed. None
  • Parameters:
    bus
    Bus name (String, required)
    name
    Destination name (String, required)
    type
    type of destination to list - Queue, TopicSpace, WebService or Port (String, optional)
  • Returns: List of SIB destinations.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSIBDestinations {-bus busname -name destname -type Queue}
  • Using Jython:
    AdminTask.listSIBDestinations('[-bus busname -name destname -type Queue]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listSIBDestinations {-interactive}
  • Using Jython:
    AdminTask.listSIBDestinations ('[-interactive]')
listSIBEngines SIBAdminCommands Use the listSIBEngines command to get a list of bus messaging engines. Supplying only the bus parameter will results in a list of all the engines that are associated with the named bus. Supplying only the node and server parameters results in a list of all the engines owned by the named node and server. Supplying only the cluster parameter results in a list of all the engines that are owned by the named cluster. All other parameter combinations are illegal. None
  • Parameters:
    bus
    name of the bus whose engines are to be listed (String, optional)
    node
    node name. To list messaging engines on a server, supply node and server name, but not cluster name (String, optional)
    server
    server name. To list messaging engines on a server, supply node and server name, but not cluster name (String, optional)
    cluster
    cluster name. To list messaging engines on a cluster, supply cluster name, but not node and server name (String, optional)
  • Returns: A list of SIB messaging engines.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSIBEngines {-bus busname -node nodeName -server severname}
  • Using Jython:
    AdminTask.listSIBEngines('[-bus busname -node nodeName -server severname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listSIBEngines {-interactive}
  • Using Jython:
    AdminTask.listSIBEngines ('[-interactive]')
listSIBJMSActivationSpecs SIBJMSAdminCommands      

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listSIBJMSActivationSpecs {-interactive}
  • Using Jython:
    AdminTask.listSIBJMSActivationSpecs ('[-interactive]')
listSIBJMSConnectionFactories SIBJMSAdminCommands Use the listSIBJMSConnectionFactories command to list all of the JMS connection factories for the default messaging provider at the scope that you specify. None
  • Parameters:
    type
    Filters the list of connection factories. Valid values include:
    • all - Lists all the JMS connection factories (unified, queue, and topic) at the scope that you specify.
    • queue - Lists all of the JMS queue connection factories at the scope that you specify.
    • topic - Lists all of the JMS topic connection factories at the scope that you specify.
    If you do no specify the type option, this command will return only the unified JMS connection factories at the scope that you specified.
  • Returns: A list of connection factories at the scope that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSIBJMSConnectionFactories {-type queue}
  • Using Jython:
    AdminTask.listSIBJMSConnectionFactories('[-type queue]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listSIBJMSConnectionFactories {-interactive}
  • Using Jython:
    AdminTask.listSIBJMSConnectionFactories ('[-interactive]')
listSIBJMSQueues SIBJMSAdminCommands Use the listSIBJMSQueues command to list all the JMS queues for the default messaging provider at the specified scope. None
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSIBJMSQueues
  • Using Jython:
    AdminTask.listSIBJMSQueues()
listSIBJMSTopics SIBJMSAdminCommands The listSIBJMSTopics command lists all the JMS topics for the default messaging provider at the specified scope. None
  • Parameters: None
  • Returns: A list of JMS topics.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSIBJMSTopics
  • Using Jython:
    AdminTask.listSIBJMSTopics()
listSIBMediations SIBAdminCommands The listSIBMediations command lists the mediations on a named SIB bus. None
  • Parameters:
    bus
    name of the SIB bus where the mediations to be listed are to be found (String, required)
  • Returns: A list of SIB mediations.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSIBMediations {-bus bus_name}
  • Using Jython:
    AdminTask.listSIBMediations('[-bus bus_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listSIBMediations {-interactive}
  • Using Jython:
    AdminTask.listSIBMediations ('[-interactive]')
listSIBusMembers SIBAdminCommands The listSIBusMember command lists all of the servers and the clusters that are members of the named SIB bus. None
  • Parameters:
    bus
    name of the SIB bus whose members are to be listed (String, required)
  • Returns: List containing the IDs of bus members – servers and clusters.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSIBusMembers {-bus bus_name}
  • Using Jython:
    AdminTask.listSIBusMembers('[-bus bus_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listSIBusMembers {-interactive}
  • Using Jython:
    AdminTask.listSIBusMembers ('[-interactive]')
listSIBuses SIBAdminCommands The listSIBuses command lists all the SIB buses in the cell. None
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSIBuses
  • Using Jython:
    AdminTask.listSIBuses()
listSSLRepertoires None The listSSLRepertoires command lists all of the Secure Sockets Layer (SSL) configuration instances that you can associate with an SSL inbound channel. SSLInboundChannel instance for which the SSLConfig candidates are listed.
  • Parameters: None
  • Returns: A list of eligible SSL configuration object names.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listSSLRepertoires SSL_3(cells/rohitbuildCell01/
    nodes/rohitbuildNode01/servers/server2|server.xml#SSLInbound
    Channel_1093445762330)
  • Using Jython:
    AdminTask.listSSLRepertoires('SSL_3(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml#SSLInboundChannel_1093445762330)')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listSSLRepertoires {-interactive}
  • Using Jython:
    AdminTask.listSSLRepertoires ('[-interactive]')
listServers ServerManagement group The listServers command returns a list of servers. None
  • Parameters:
    serverType
    The type of the server. Used to filter the results. (String)
    nodeName
    The name of the node. Used to filter the results. (String)
  • Returns: A list of configuration IDs for the servers that match the criteria that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listServers {-serverType APPLICATION_SERVER -nodeName ndnode1}
  • Using Jython:
    AdminTask.listServers('[-serverType APPLICATION_SERVER -nodeName ndnode1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listServers {-interactive}
  • Using Jython:
    AdminTask.listServers ('[-interactive]')
listServerTemplates ServerManagement group

Use the listServerTemplates command to list server templates.

None
  • Parameters:
    - version
    The version of the template that you want to list. (String, optional)
    - serverType
    Specify this option if you want to list templates for a specific server type. (String, optional)
    - name
    Specify this option to look for a specific template. (String, optional)
    - queryExp
    A key/value pair that you can use to find templates by properties. For example, com.ibm.websphere.nodeOperatingSystem=os390. (String[], optional)
  • Returns: A list of server template identifications that match with the criteria that you specify with the command parameters. If you do no specify any parameters, all server templates are returned.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listServerTemplates {-version 6.0.0.0 -serverType APPLICATION_SERVER}
  • Using Jython:
    AdminTask.listServerTemplates('[-version 6.0.0.0 -serverType APPLICATION_SERVER]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listServerTemplates {-interactive}
  • Using Jython:
    AdminTask.listServerTemplates ('[-interactive]')
listServerTypes ServerManagement group

Use the listServerTypes command to display all the current server types. For example, APPLICATION_SERVER, WEB_SERVER, GENERIC_SERVER.

The node name for which you want to list the valid types. For example, the types that are only valid on z/OS will appear on a z/OS node. (String, optional)

  • Parameters: None
  • Returns: A list of server types that you can define on a node. If you do not specify the target object, this command returns all of the server types defined in the entire cell.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listServerTypes ndnode1
  • Using Jython:
    AdminTask.listServerTypes(ndnode1)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listServerTypes {-interactive}
  • Using Jython:
    AdminTask.listServerTypes ('[-interactive]')
listTAMSettings        

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listTAMSettings {-interactive}
  • Using Jython:
    AdminTask.listTAMSettings ('[-interactive]')
listTCPEndPoints None The listTCPEndPoints command lists all the named end points that can be associated with a TCP inbound channel. TCPInboundChannel instance for which named end points candidates are listed. (ObjectName, required)
  • Parameters:
    - excludeDistinguished
    Shows only non-distinguished named end points. This parameter does not require a value. (Boolean, optional)
    - unusedOnly
    Shows the named end points not in use by other TCP inbound channel instances. This parameter does not require a value. (Boolean, optional)
  • Returns: A list of object names for the eligible named end points.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listTCPEndPoints TCP_1(cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01/servers/dmgr|server.xml#
    TCPInboundChannel_1)
    
    $AdminTask listTCPEndPoints TCP_1(cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01/servers/dmgr|server.xml#
    TCPInboundChannel_1) {-excludeDistinguished}
    $AdminTask listTCPEndPoints TCP_1(cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1) 
    {-excludeDistinguished -unusedOnly}
  • Using Jython:
    AdminTask.listTCPEndPoints('TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', '[-excludeDistinguished]')
    AdminTask.listTCPEndPoints('TCP_1(cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01/servers/dmgr|server.xml#
    TCPInboundChannel_1)', '[-excludeDistinguished]')
    AdminTask.listTCPEndPoints('TCP_1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', '[-excludeDistinguished -unusedOnly]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listTCPEndPoints {-interactive}
  • Using Jython:
    AdminTask.listTCPEndPoints ('[-interactive]')
listTCPThreadPools None The listTCPThreadPools command lists all of the thread pools that can be associated with a TCP inbound channel or TCP outbound channel. TCPInboundChannel or TCPOutboundChannel instance for which ThreadPool candidates are listed. (ObjectName, required)
  • Parameters: None
  • Returns: A list of eligible thread pool object names.

Batch mode example usage:

  • Using Jacl:
    $AdminTask listTCPThreadPools TCP_1(cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01/servers/dmgr|server.xml#
    TCPInboundChannel_1)
  • Using Jython:
    AdminTask.listTCPThreadPools('TCP_1(cells/rohitbuildCell01/
    nodes/rohitbuildCellManager01/servers/dmgr|server.xml#
    TCPInboundChannel_1)')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listTCPThreadPools {-interactive}
  • Using Jython:
    AdminTask.listTCPThreadPools ('[-interactive]')
listUnmanagedNodes UnmanagedNodeCommands group Use the listUnmanagedNodes command to list the unmanaged nodes in a configuration. None
  • Parameters: None
  • Returns: List

Batch mode example usage:

  • Using Jacl:
    $AdminTask listUnmanagedNodes
  • Using Jython:
    AdminTask.listUnmanagedNodes()

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listUnmanagedNodes {-interactive}
  • Using Jython:
    AdminTask.listUnmanagedNodes  ('[-interactive]')
mediateSIBDestination SIBAdminCommands Use the mediateSIBDestination command to mediate a bus destination. The bus, destination, and mediation definitions must exist prior to using this command. The destination must not be mediated already. None
  • Parameters:
    bus
    the name of the bus where the destination is to be mediated (String, required)
    destinationName
    the name of the destination to be mediated (String, required)
    mediationName
    the name to be given to the mediation (String, required)
    node
    if mediating a destination to a server, specify the node and server name, but not the cluster name (String, optional)
    server
    if mediating a destination to a server, specify the node and server name, but not the cluster name (String, optional)
    cluster
    if mediating a destination to a cluster, specify the cluster name, but not the node or server name (String, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask mediateSIBDestination {-bus busname -name destname -mediationName mediationName}
  • Using Jython:
    AdminTask.mediateSIBDestination('[-bus busname -name destname -mediationName mediationName]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask mediateSIBDestination {-interactive}
  • Using Jython:
    AdminTask.mediateSIBDestination ('[-interactive]')
modifyNodeGroup NodeGroupCommands group The modifyNodeGroup command modifies the configuration of a node group. The node group name cannot be changed. However, its short name and description are supported. Also, its node membership can be modified. The target object is the node group name. This target object is required.
  • Parameters:
    - shortName
    The short name of the node group. This parameter is optional.
    - description
    The description of the node group. This parameter is optional.
  • Returns: Node group object ID.

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifyNodeGroup WBINodeGroup {-shortName WBIGroup -description "Default node group"}
  • Using Jython:
    AdminTask.modifyNodeGroup WBINodeGroup('[-shortName WBIGroup -description "WBI" node group]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifyNodeGroup {-interactive}
  • Using Jython:
    AdminTask.modifyNodeGroup ('[-interactive]')
modifyNodeGroupProperty NodeGroupCommands group The modifyNodeGroupProperty command modifies custom properties for a node group The name of the node group. This target object is required.
  • Parameters:
    - name
    The name of the custom property to modify. This parameter is required.
    - value
    The value of the custom property. This parameter is optional.
    - description
    The description of the custom property. This parameter is optional.
  • Returns: Properties object ID

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifyNodeGroupProperty WBINodeGroup {-name Channel -value "channel1"}
  • Using Jython:
    AdminTask.modifyNodeGroupProperty('WBINodeGroup', '[-name Channel -value channel1]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifyNodeGroupProperty {-interactive}
  • Using Jython:
    AdminTask.modifyNodeGroupProperty ('[-interactive]')
modifySIBDestination SIBAdminCommands Use the modifySIBDestination command to modify the attributes of a SIB destination. The bus and name parameters are used to identify the SIB destination and cannot be modified. None
  • Parameters:
    bus
    bus name (String, required)
    name
    destination name (String, required)
    description
    description (String, optional)
    reliability
    the reliability quality of service for message flows through this destination, from BEST_EFFORT_NON-PERSISTENT to ASSURED_PERSISTENT, in order of increasing reliability. Higher levels of reliability have higher impacts on the performance (String, optional)
    maxReliability
    the maximum reliability quality of service that is accepted for values specified by producers (String, optional)
    overrideOfQOSByProducerAllowed
    controls the quality of service for message flows between producers and the destination. Select this option to use the quality of service specified by producers instead of the quality defined for the destination (String, optional)
    defaultPriority
    the default priority for message flows through this destination, in the range 0 (lowest) through 9 (highest). This default priority is used for messages that do not contain a priority value (Integer, optional)
    maxFailedDeliveries
    the maximum number of times that service tries to deliver a message to the destination before forwarding it to the exception destination (Integer, optional)
    exceptionDestination
    the name of another destination to which the system sends a message that cannot be delivered to this destination within the specified maximum number of failed deliveries (String, optional)
    sendAllowed
    clear this option (setting it to false) to stop producers from being able to send messages to this destination (String, optional)
    receiveAllowed
    clear this option (setting it to false) to prevent consumers from being able to receive messages from this destination (String, optional)
    quiesceMode
    select this option (setting it to true) to indicate that the destination is quiescing. In quiesce mode, new messages for the destination cannot be added to the bus, but any messages already in the bus can still be sent to, and processed by, the destination (Boolean, optional)
    receiveExclusive
    select this option (setting it to true) to allow only one consumer to attach to a destination (Boolean, optional)
    topicAccessCheckRequired
    topic access check required (Boolean, optional)
    replyDestination
    clear this option (setting it to false) to stop producers from being able to send messages to this destination (String, optional)
    replyDestinationBus
    clear this option (setting it to false) to prevent consumers from being able to receive messages from this destination (String, optional)
    delegateAuthorizationCheckToTarget
    indicates whether the authorization check should be delegated to the alias or target destination (Boolean, optional)
  • Parameters for step one:
    defaultForwardRoutingPath
    bus
    bus name (String, optional)
    destination
    destination name (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBDestination {-bus busname -name destname}
  • Using Jython:
    AdminTask.modifySIBDestination('[-bus busname -name destname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBDestination {-interactive}
  • Using Jython:
    AdminTask.modifySIBDestination ('[-interactive]')
modifySIBEngine SIBAdminCommands Use the modifySIBEngine command to modify the attributes of a bus messaging engine. The bus, node, server, cluster, and engine parameters are used to identify the engine and cannot be modified. A server can have one messaging engine only. When using this command to modify a messaging engine from a server, the engine name is not required. However, because a cluster can have more than one messaging engine, the engine name must be supplied. None
  • Parameters:
    bus
    the name of the bus to which the messaging engine is to belong (String, required)
    node
    to modify a messaging engine on a server, supply node and server name, but not cluster name (String, optional)
    server
    to modify a messaging engine on a server, supply node and server name, but not cluster name (String, optional)
    cluster
    to modify a messaging engine on a cluster, supply cluster name, but not node and server name (String, optional)
    engine
    the name of the engine to be modified. This is only required if the engine belongs to a cluster (String, optional)
    description
    description of the messaging engine (String, optional)
    initialState
    whether the messaging engine is started or stopped when the associated application server is first started. Until started, the messaging engine is unavailable. (Stopped | Started) (String, optional)
    destinationHighMsgs
    the maximum total number of messages that the messaging engine can place on its message points (Long, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBEngine {-bus busname -node nodeName -server severname}
  • Using Jython:
    AdminTask.modifySIBEngine('[-bus busname -node nodeName -server severname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBEngine {-interactive}
  • Using Jython:
    AdminTask.modifySIBEngine ('[-interactive]')
modifySIBJMSActivationSpec SIBJMSAdminCommands Use the modifySIBJMSActivationSpec command to modify the properties of an activation specification. None
  • Parameters:
    name
    The name of the activation specification that you want to modify. (String, (required)
    propertyList
    A list of name-value pairs. (required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBJMSActivationSpec {-name specname -propertyList propertyList}
  • Using Jython:
    AdminTask.modifySIBJMSActivationSpec('[-name specname -propertyList propertyList]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBJMSActivationSpec {-interactive}
  • Using Jython:
    AdminTask.modifySIBJMSActivationSpec ('[-interactive]')
modifySIBJMSConnectionFactory SIBJMSAdminCommands Use the modifySIBJMSConnectionFactory command to modify a unified JMS connection factory at the current scope. None
  • Parameters:
    name
    The name of the SIB JMS connection factory. (String, required)
    jndiName
    The JNDI name of the SIB JMS connection factory. (String, required)
    type
    The type of connection factory to modify. To modify a queue connection factory, set the value to Queue. To modify a topic connection factory, set the value to Topic. If you want to create a generic connection factory, do not specify this option. (String, optional)
    busName
    the SIB bus name (String, optional)
    category
    Classifies or groups the connection factory. (String, optional)
    clientID
    A user-defined string. Only required for durable subscriptions. (String, optional)
    connectionProximity
    The proximity of acceptable messaging engines. Valid values include: Bus, Host, Cluster and Server. (String, optional)
    description
    The description of the connection factory. (String, optional)
    durableSubscriptionHome
    The durable subscription home value. (String, optional)
    nonPersistentMapping
    The non-persistent mapping value. Valid values are BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestination and None. (String, optional)
    password
    The password that is used to modify connections from the connection factory. (String, optional)
    providerEndPoints
    A list of endpoint triplets separated by commas. For example: host:port:chain (String, optional)
    readAhead
    The read ahead value. Valid values include: Default, AlwaysOn, and AlwaysOff. (String, optional)
    remoteProtocol
    The name of the protocol used to connect to a remote messaging engine. (String, optional)
    remoteTargetGroup
    (String, optional)
    remoteTargetType
    (String, optional)
    tempQueueModelName
    Temporary queue model name. (String, optional)
    tempTopicModelName
    Temporary topic model name. (String, optional)
    userName
    The user name that is used to modify connections from the connection factory. (String, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBJMSConnectionFactory {-name factory_name -jndiName jndi_name}
  • Using Jython:
    AdminTask.modifySIBJMSConnectionFactory('[-name factory_name -jndiName jndi_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBJMSConnectionFactory {-interactive}
  • Using Jython:
    AdminTask.modifySIBJMSConnectionFactory ('[-interactive]')
modifySIBJMSQueue SIBJMSAdminCommands Use the modifySIBJMSQueue command to modify a unified JMS queue at the current scope. None
  • Parameters:
    name
    The name of the SIB JMS queue. (String, required)
    jndiName
    The JNDI name of the SIB JMS queue. (String, required)
    description
    A description of the SIB JMS queue (String, optional)
    queueName
    The name of the underlying SIB queue to which the queue points (String, required)
    deliveryMode
    The delivery mode for messages. Legal values are "Application", "NonPersistent" and "Persistent" (String, optional)
    timeToLive
    the time in milliseconds to be used for message expiration (Long, optional)
    priority
    the priority for messages. Whole number in the range 0 to 9 (Integer, optional)
    readAhead
    read-ahead value. Legal values are "AsConnection", "AlwaysOn" and "AlwaysOff" (String, optional)
    timeToLive
    (optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBJMSQueue {-name queue_name -jndiName jndi_name -queueName queue_name}
  • Using Jython:
    AdminTask.modifySIBJMSQueue('[-name queue_name -jndiName jndi_name -queueName queue_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBJMSQueue {-interactive}
  • Using Jython:
    AdminTask.modifySIBJMSQueue ('[-interactive]')
modifySIBJMSTopic SIBJMSAdminCommands Use the modifySIBJMSTopic command to modify the JMS topic at the current scope. None
  • Parameters:
    name
    The name of the SIB JMS topic (String, required)
    jndiName
    the SIB JMS topic's JNDI name (String, required)
    description
    a description of the SIB JMS queue (String, optional)
    topicSpace
    the name of the underlying SIB topic space to which the topic points (String, required)
    *topicName
    the topic to be used inside the topic space (for example, stock/IBM) (String, required)
    deliveryMode
    the delivery mode for messages. Legal values are "Application", "NonPersistent" and "Persistent" (String, optional)
    timeToLive
    the time in milliseconds to be used for message expiration (Long, optional)
    priority
    the priority for messages. Whole number in the range 0 to 9 (Integer, optional)
    readAhead
    read-ahead value. Legal values are "AsConnection", "AlwaysOn" and "AlwaysOff" (String, optional)
    busName
    the name of the bus on which the topic resides (String, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBJMSTopic {-name topic_name -jndiName jndi_name -topicName topic_name -topicSpace topicspace_name}
  • Using Jython:
    AdminTask.modifySIBJMSTopic('[-name topic_name -jndiName jndi_name -topicName topic_name -topicSpace topicspace_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBJMSTopic {-interactive}
  • Using Jython:
    AdminTask.modifySIBJMSTopic ('[-interactive]')
modifySIBMediation SIBAdminCommands Use this command to modify the attributes of a SIB mediation.The bus and mediationName parameters identify the mediation and cannot be modified. None
  • Parameters:
    bus
    the name of the bus that owns the mediation (String, required)
    mediationName
    name of the mediation to be modified (String, required)
    description
    description of the mediation (String, optional)
    handlerListName
    the name of the handler list that was defined when the mediation was deployed (String, optional)
    globalTransaction
    whether or not a global transaction is started for each message processed (Boolean, optional)
    allowConcurrentMediation
    whether or not to apply the mediation to multiple messages concurrently, and preserve message ordering (Boolean, optional)
    selector
    the text string that must be present in a message for the mediation to process the message (String, optional)
    discriminator
    the text string that must not be present in a message for the mediation to process the message (String, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBMediation {-bus bus_name -jndiName jndi_name}
  • Using Jython:
    AdminTask.modifySIBMediation('[-bus bus_name -mediationName mediation_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBMediation {-interactive}
  • Using Jython:
    AdminTask.modifySIBMediation ('[-interactive]')
modifySIBus SIBAdminCommands The modifySIBus command to modifies the attributes of the named bus. The bus parameter identifies the bus to modify, and is not used to change the name of the bus. None
  • Parameters:
    bus
    name of bus to modify (String, required)
    description
    description of bus modify (String, optional)
    secure
    enable or disable bus security (Boolean, optional)
    interEngineAuthAlias
    name of the authentication alias used to authorize communication between messaging engines on the bus.
    mediationsAuthAlias
    name of the authentication alias used to authorize mediations to access the bus (String, optional)
    protocol
    the protocol used to send and receive messages between messaging engines, and between API clients and messaging engines (String, optional)
    discardOnDelete
    indicate whether or not any messages left in a queue's data store should be discarded when the queue is deleted (Boolean, optional)
    destinationHighMsgs
    the maximum number of messages that any queue on the bus can hold (Long, optional)
    configurationReloadEnabled
    indicate whether configuration files should be dynamically reloaded for this bus (Boolean, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBus {-bus busname -description text -secure True -mediationsAuthAlias name -protocol protocol -discardOnDelete False}
  • Using Jython:
    AdminTask.modifySIBus('[-busbusname -description "text" -secure True -mediationsAuthAlias name -protocol protocol -discardOnDelete False]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBus {-interactive}
  • Using Jython:
    AdminTask.modifySIBus ('[-interactive]')
modifySIBusMember SIBAdminCommands The modifySIBusMember command modifies the attributes of the bus member identified by the bus, node, server, and cluster parameters. None
  • Parameters:
    bus
    The name of the bus to which the member belongs. (String, required)
    node
    To specify a server bus member, supply the node and the server name, but not the cluster name. (String, optional)
    server
    To specify a server bus member, supply the node and the server name, but not the cluster name. (String, optional)
    cluster
    To specify a cluster bus member, supply the cluster name but not the node and the server name. (String, optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask modifySIBusMember {-bus busname -node nodename -server servername -description text}
  • Using Jython:
    AdminTask.modifySIBusMember('[-bus busname -node nodename -server servername -description "text"]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask modifySIBusMember {-interactive}
  • Using Jython:
    AdminTask.modifySIBusMember ('[-interactive]')
moveClusterToCoreGroup CoreGroupManagement group The moveClusterToCoreGroup command moves all of the servers in a cluster that you specify from a core group to another core group. All of the servers in a cluster must be members of the same core group. None
  • Parameters:
    - source
    The name of the core group that contains the cluster that you want to move. The core group must exist prior to running this command. The cluster that you specify must be a member of this core group. (String, required)
    - target
    The name of the core group where you want to move the cluster. (String, required)
    - clusterName
    The name of the cluster that you want to move. (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask moveClusterToCoreGroup {-source OldCoreGroup -target NewCoreGroup -clusterName ClusterOne} 
  • Using Jython:
    AdminTask.moveClusterToCoreGroup('[-source OldCoreGroup -target NewCoreGroup -clusterName ClusterOne]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask moveClusterToCoreGroup {-interactive}
  • Using Jython:
    AdminTask.moveClusterToCoreGroup ('[-interactive]')
moveServerToCoreGroup CoreGroupManagement group The moveServerToCoreGroup command moves a server to a core group that you specify. When the server is added to the core group that you specify, it is removed from the core group where it originally resided. None
  • Parameters:
    - source
    The name of the core group that contains the server that you want to move. The core group must already exist with the server that you specify being a member of the core group. (String, required)
    - target
    The name of the core group where you want to move the server. The core group that you specify must exist prior to running the command. (String, required)
    - nodeName
    The name of the node that contains the server that you want to move. (String, required)
    - serverName
    The name of the server that you want to move. (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask moveServerToCoreGroup  {-source OldCoreGroup -target NewCoreGroup -nodeName myNode -serverName myServer}
  • Using Jython:
    AdminTask.moveServerToCoreGroup('[-source OldCoreGroup -target NewCoreGroup -nodeName myNode -serverName myServer]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask moveServerToCoreGroup {-interactive}
  • Using Jython:
    AdminTask.moveServerToCoreGroup ('[-interactive]')
publishSIBWSInboundService SIBWebServices group The publishSIBWSInboundService command publishes the WSDL document for the inbound service and the associated ports to the registry and the business that is defined by the UDDIPublication object. The object name of the inbound service object.
  • Parameters:
    uddiPublication
    The name of the UDDI publication for the service. (required)
    userId
    The user ID to use to retrieve the WSDL. (optional)
    password
    The password to use to retrieve the WSDL. (optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask publishSIBWSInboundService $inService {-uddiPublication "MyUddi"}
  • Using Jython:
    AdminTask.publishSIBWSInboundService(inService, '[-uddiPublication MyUddi]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask publishSIBWSInboundService {-interactive}
  • Using Jython:
    AdminTask.publishSIBWSInboundService ('[-interactive]')
reconfigureTAM        

Interactive mode example usage:

  • Using Jacl:
    $AdminTask reconfigureTAM {-interactive}
  • Using Jython:
    AdminTask.reconfigureTAM ('[-interactive]')
refreshSIBWSInboundServiceWSDL SIBWebServices group The refreshSIBWSInboundServiceWSDL command loads the WSDL document from the WSDLLocation parameters of the inbound service and locates the WSDLLocation-specified service element. If the service element is not present, this command fails. If the outbound ports are not a subset of the ports in the loaded WSDL document, this command fails.

If the WSDL is retrieved through a proxy, the server on which the command is running must have the system properties that identify the proxy server set correctly.

The object name of the inbound service object.
  • Parameters:
    userId
    The user ID to use to retrieve the WSDL. (optional)
    password
    The password to use to retrieve the WSDL. (optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask refreshSIBWSInboundServiceWSDL $inService
  • Using Jython:
    AdminTask.refreshSIBWSInboundServiceWSDL(inService)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask refreshSIBWSInboundServiceWSDL {-interactive}
  • Using Jython:
    AdminTask.refreshSIBWSInboundServiceWSDL ('[-interactive]')
refreshSIBWSOutboundServiceWSDL SIBWebServices group The refreshSIBWSOutboundServiceWSDL command loads the WSDL document from the WSDLLocation parameters of the outbound service and locates the WSDLLocation-specified service element. If the service element is not present, this command fails. If the outbound ports are not a subset of the ports in the loaded WSDL document, this command fails.

If the WSDL will be retrieved through a proxy, the server on which the command is running must have the system properties that identify the proxy server set correctly.

The object name of the outbound service object.
  • Parameters:
    userId
    The user ID to use to retrieve the WSDL. (optional)
    password
    The password to use to retrieve the WSDL. (optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask refreshSIBWSOutboundServiceWSDL $outService
  • Using Jython:
    AdminTask.refreshSIBWSOutboundServiceWSDL(outService)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask refreshSIBWSOutboundServiceWSDL {-interactive}
  • Using Jython:
    AdminTask.refreshSIBWSOutboundServiceWSDL ('[-interactive]')
removeNodeGroup NodeGroupCommands group The removeNodeGroup command removes the configuration of a node group. You can remove a node group if it does not contain any members. Also, the default node group cannot be removed. The name of the node group to be removed. This target object is required.
  • Parameters: None
  • Returns: The node group object ID.

Batch mode example usage:

  • Using Jacl:
    $AdminTask removeNodeGroup WBINodeGroup
  • Using Jython:
    AdminTask.removeNodeGroup('WBINodeGroup')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask removeNodeGroup {-interactive}
  • Using Jython:
    AdminTask.removeNodeGroup ('[-interactive]')
removeNodeGroupMember NodeGroupCommands group The removeNodeGroupMember command removes the configuration of a node group member.
  • A node must always be a member of at least one node group.
  • You cannot remove a node from a node group that is part of a cluster in that node group.
The target object is the node group containing the member to be removed. This target object is required.
  • Parameters:
    - nodeName
    The name of the node to remove from a node group. This parameter is required.
  • Returns: Node group member object ID.

Batch mode example usage:

  • Using Jacl:
    $AdminTask removeNodeGroupMember WBINodeGroup {-nodeName WBINode} 
  • Using Jython:
    AdminTask.removeNodeGroupMember('WBINodeGroup', '[-nodeName WBINode]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask removeNodeGroupMember {-interactive}
  • Using Jython:
    AdminTask.removeNodeGroupMember ('[-interactive]')
removeNodeGroupProperty NodeGroupCommands group The removeNodeGroupProperty command removes custom properties of a node group. The name of the node group. This target object is required.
  • Parameters:
    - name
    The name of the custom property to remove. This parameter is required.
  • Returns: Properties object ID

Batch mode example usage:

  • Using Jacl:
    $AdminTask removeNodeGroupProperty WBINodeGroup {-name Channel}
  • Using Jython:
    AdminTask.removeNodeGroupProperty('WBINodeGroup', '[-name Channel]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask removeNodeGroupProperty {-interactive}
  • Using Jython:
    AdminTask.removeNodeGroupProperty ('[-interactive]')
removeSIBWSInboundPort SIBWebServices group The removeSIBWSInboundPort command removes the configuration of an inbound port. The object name of the inbound port object that you want to remove.
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask removeSIBWSInboundPort $inPort
  • Using Jython:
    AdminTask.removeSIBWSInboundPort(inPort)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask removeSIBWSInboundPort {-interactive}
  • Using Jython:
    AdminTask.removeSIBWSInboundPort ('[-interactive]')
removeSIBWSOutboundPort SIBWebServices group The removeSIBWSOutboundPort command removes the configuration of an outbound port. If the port that you delete is the default port for the outbound service, one of the remaining ports, if any, is chosen as the new default. Resources that are associated with the outbound port, for example, WS-Security configuration, are disassociated from the outbound port, but not deleted. The object name of the outbound port object that you want to remove.
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask removeSIBWSOutboundPort $outPort
  • Using Jython:
    AdminTask.removeSIBWSOutboundPort(outPort)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask removeSIBWSOutboundPort {-interactive}
  • Using Jython:
    AdminTask.removeSIBWSOutboundPort ('[-interactive]')
removeSIBusMember SIBAdminCommands The removeSIBusMember command removes a server or a cluster from a SIB bus. This command also deletes all SIB messaging engines that are associated with the bus, all queue points and publication points that are owned by those engines, and all queue point references and publication point references that refer to the deleted queue points and publication points. None
  • Parameters:
    bus
    The name of the SIB bus from which to remove the member. (String, required)
    node
    To specify a server bus member, supply the node and the server name, but not the cluster name. (String, optional)
    server
    To specify a server bus member, supply the node and the server name, but not the cluster name. (String, optional)
    cluster
    To specify a cluster bus member, supply cluster name but not node and server name. (String, optional)
  • Returns:

Batch mode example usage:

  • Using Jacl:
    $AdminTask removeSIBusMember {-bus busname -node nodename -server servername}
  • Using Jython:
    AdminTask.removeSIBusMember('[-bus busname -node nodename -server servername]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask removeSIBusMember {-interactive}
  • Using Jython:
    AdminTask.removeSIBusMember ('[-interactive]')
removeUnmanagedNode UnmanagedNodeCommands group Use the removeUnmanagedNode command to remove an unmanaged node from the configuration. None
  • Parameters:
    - nodeName
    The name of the unmanaged node. (String, required)
  • Returns: null

Batch mode example usage:

  • Using Jacl:
    $AdminTask removeUnmanagedNode {-nodeName myNode }
  • Using Jython:
    AdminTask.removeUnmanagedNode('[-nodeName myNode]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask removeUnmanagedNode {-interactive}
  • Using Jython:
    AdminTask.createUnmanagedNode  ('[-interactive]')
removeWSGWTargetService WSGateway group The removeWSGWTargetService command removes a target service from the gateway service. The destinations that are associated with the target service are not deleted. If the target service that you remove is the default target service, the default is set to the first target service in the set or cleared if none are left. The object name of the TargetService object.
  • Parameters: None
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask removeWSGWTargetService $gwTarget
  • Using Jython:
    AdminTask.removeWSGWTargetService(gwTarget)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask removeWSGWTargetService {-interactive}
  • Using Jython:
    AdminTask.removeWSGWTargetService ('[-interactive]')
setDefaultSIBWSOutboundPort SIBWebServices group The setDefaultSIBWSOutboundPort command updates the default outbound port for an outbound service. The object name of the outbound service whose default port you want to update.
  • Parameters:
    name
    The name of the port that you want to set as the default. (required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask setDefaultSIBWSOutboundPort $outService {-name "MyServiceSoap"}
  • Using Jython:
    AdminTask.setDefaultSIBWSOutboundPort(outService, '[-name MyServiceSoap]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask setDefaultSIBWSOutboundPort {-interactive}
  • Using Jython:
    AdminTask.setDefaultSIBWSOutboundPort ('[-interactive]')
showSIBDestination SIBAdminCommands Use the showSIBDestination command to get the attribute names and values of a SIB destination. The bus and name parameter identify the SIB destination whose attributes are required. None
  • Parameters:
    bus
    The name of the bus. (String, required)
    name
    The destination name. (String, required)
  • Returns: The attribute names and values of the named SIB destination on the named bus.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBDestination {-bus busname -name destname}
  • Using Jython:
    AdminTask.showSIBDestination('[-bus busname -name destname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBDestination {-interactive}
  • Using Jython:
    AdminTask.showSIBDestination ('[-interactive]')
showSIBEngine SIBAdminCommands Use the showSIBEngine command to get the attribute names and values of a SIB messaging engine that belongs to a given bus member. If the bus member is a server, only the bus, node, and server parameters are required. A server has one engine only, so the engine parameter is not necessary. If the bus member is a cluster, the bus, cluster, and engine parameters must be supplied, because a cluster can have more than one engine. None
  • Parameters:
    bus
    The name of the bus to which the messaging engine that you wan to be show belongs. (String, required)
    node
    To show a messaging engine that belongs to a server, supply the node and the server name, but not the cluster name. (String, optional)
    server
    To show a messaging engine that belongs to a server, supply the node and the server name, but not that cluster name. (String, optional)
    cluster
    To show a messaging engine that belongs to a cluster, supply the cluster name, but not the node and the server name. (String, optional)
    engine
    The name of the engine to show. If the bus member has only one messaging engine, you do not need to specify the engine option. If the bus member has several messaging engines, you must specify the name of the engine for which you want to display details. (String, optional)
  • Returns: The attribute names and values of the identified SIB messaging engine.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBEngine {-bus busname -node nodeName -server severname}
  • Using Jython:
    AdminTask.showSIBEngine('[-bus busname -node nodeName -server severname]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBEngine {-interactive}
  • Using Jython:
    AdminTask.showSIBEngine ('[-interactive]')
showSIBJMSActivationSpec SIBAdminCommands The showSIBJMSActivationSpec command shows details about a JMS activation specification. None
  • Parameters:
    bus
    The name of the bus that owns the mediation. (String, required)
    mediationName
    The name of the mediation to show. (String, required)
  • Returns: A list

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBJMSActivationSpec {-bus bus_name -mediationName mediation_name}
  • Using Jython:
    AdminTask.showSIBJMSActivationSpec('[-bus bus_name -mediationName mediation_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBJMSActivationSpec {-interactive}
  • Using Jython:
    AdminTask.showSIBJMSActivationSpec ('[-interactive]')
showSIBJMSConnectionFactory SIBJMSAdminCommands The showSIBJMSConnectionFactory command shows details about a JMS connection factory. None
  • Parameters:
    name
    The name of the SIB JMS connection factory. (String, required)
  • Returns: A set of property value pairs for the JMS connection factory that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBJMSConnectionFactory {-name factory_name}
  • Using Jython:
    AdminTask.showSIBJMSConnectionFactory('[-name factory_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBJMSConnectionFactory {-interactive}
  • Using Jython:
    AdminTask.showSIBJMSConnectionFactory ('[-interactive]')
showSIBJMSQueue SIBJMSAdminCommands Use the showSIBJMSQueue command to show the details about a JMS queue. None
  • Parameters:
    name
    The name of the SIB JMS queue. (String, required)
  • Returns: A set of property value pairs for the JMS queue that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBJMSQueue {-name queue_name}
  • Using Jython:
    AdminTask.showSIBJMSQueue('[-name queue_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBJMSQueue {-interactive}
  • Using Jython:
    AdminTask.showSIBJMSQueue ('[-interactive]')
showSIBJMSTopic SIBJMSAdminCommands The showSIBJMSTopic command shows the details for a JMS topic. None
  • Parameters:
    - name
    The name of the SIB JMS topic. (String, required)
  • Returns: A set of property value pairs for the JMS topic that you specified.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBJMSTopic {-name topic_name}
  • Using Jython:
    AdminTask.showSIBJMSTopic('[-name topic_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBJMSTopic {-interactive}
  • Using Jython:
    AdminTask.showSIBJMSTopic ('[-interactive]')
showSIBMediation SIBAdminCommands Use the showSIBMediation command to get the attribute names and values of a SIB mediation. None
  • Parameters:
    bus
    The name of the bus that owns the mediation. (String, required)
    mediationName
    The name of the mediation to show. (String, required)
  • Returns: The attribute names and values of the identified SIB mediation.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBMediation {-bus bus_name -mediationName mediation_name}
  • Using Jython:
    AdminTask.showSIBMediation('[-bus bus_name -mediationName mediation_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBMediation {-interactive}
  • Using Jython:
    AdminTask.showSIBMediation ('[-interactive]')
showSIBus SIBAdminCommands Use the showSIBus command to get the attribute names and values of a SIB bus. None
  • Parameters:
    bus
    The name of the bus. (String, required)
  • Returns: The attribute names and values of the identified SIB bus.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBus {-bus bus_name}
  • Using Jython:
    AdminTask.showSIBus('[-bus bus_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBus {-interactive}
  • Using Jython:
    AdminTask.showSIBus ('[-interactive]')
showSIBusMember SIBAdminCommands Use the showSIBusMemeber command to get the attribute names and values of a SIB bus member. None
  • Parameters:
    bus
    The name of bus from which you want to show the member. (String, required)
    node
    To specify a server bus member, supply the node and the server name, but not the cluster name. (String, optional)
    server
    To specify a server bus member, supply the node and the server name, but not the cluster name. (String, optional)
    cluster
    To specify a cluster bus member, supply the cluster name but not the node and the server name (String, optional)
  • Returns: The attribute names and values of the identified SIB bus member.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showSIBusMember {-bus busname -node nodename -server servername}
  • Using Jython:
    AdminTask.showSIBusMember('[-bus busname -node nodename -server servername]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showSIBusMember {-interactive}
  • Using Jython:
    AdminTask.showSIBusMember ('[-interactive]')
showServerInfo ServerManagement group The showServerInfo command returns the information for a server that you specify. The configuration ID of the server. (required)
  • Parameters: None
  • Returns: A list of metadata.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showServerInfo server1(cells/WAS00Network/nodes/ndnode1/servers/server1|server.xml)
  • Using Jython:
    AdminTask.showServerInfo(server1(cells/WAS00Network/nodes/ndnode1/servers/server1|server.xml))

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showServerInfo {-interactive}
  • Using Jython:
    AdminTask.showServerInfo ('[-interactive]')
showServerTypeInfo ServerManagement group The showServerTypeInfo command displays information about a specific server type. A server type. For example, APPLICATION_SERVER. (String, required)
  • Parameters:
    - version
    Specify the version of the templates that you want to list. For example, 6.0.0.0. (String, optional)
    - serverType
    Specify this option if you want to list templates for a specific server type. (String, optional)
    - name
    Specify this option to look for a specific template. (String, optional)
    - queryExp
    A key and value pair that you can use to find templates by properties. For example, com.ibm.websphere.nodeOperatingSystem=os390. (String[], optional)
  • Returns: A list of information about the server type.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showServerTypeInfo APPLICATION_SERVER
  • Using Jython:
    AdminTask.showServerTypeInfo(APPLICATION_SERVER)

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showServerTypeInfo {-interactive}
  • Using Jython:
    AdminTask.showServerTypeInfo ('[-interactive]')
showTemplateInfo ServerManagement group

Use the showTemplateInfo command to display the metadata information for a specific server template.

The server type, for example, APPLICATION_SERVER. (String, required)

  • Parameters: None
  • Returns: The metadata information regarding a specific template.

Batch mode example usage:

  • Using Jacl:
    $AdminTask showTemplateInfo 
    default(templates/servertypes/APPLICATION_SERVER/servers/default|server.xml)
    {isSystemTemplate true} {name default} {com.ibm.websphere.baseProductVersion 6.0.0}
    {description {The WebSphere Default Server Template}} {com.ibm.websphere.baseProductMinorVersion 0.0}
    {com.ibm.websphere.baseProductMajorVersion 6} {com.ibm.websphere.nodeOperatingSystem {}} {isDefaultTemplate true}
  • Using Jython:
    AdminTask.showTemplateInfo(default(templates/serverTypes/APPLICATION_SERVER/servers/default|server.xml))
    '[[isSystemTemplate true] [com.ibm.websphere.baseProductVersion 6.0.0] [name default]
    [com.ibm.websphere.baseProductMinorVersion 0.0] [description The WebSphere Default Server Template]
    [isDefaultTemplate true] [com.ibm.websphere.nodeOperatingSystem] [com.ibm.websphere.baseProductMajorVersion 6]]'

Interactive mode example usage:

  • Using Jacl:
    $AdminTask showTemplateInfo {-interactive}
  • Using Jython:
    AdminTask.showTemplateInfo ('[-interactive]')
unconfigureTAM        

Interactive mode example usage:

  • Using Jacl:
    $AdminTask unconfigureTAM {-interactive}
  • Using Jython:
    AdminTask.unconfigureTAM ('[-interactive]')
unmediateSIBDestination SIBAdminCommands Use the unmediateSIBDestination command to unmediate the named destination on the named bus. Unmediating a destination removes the association between a SIB destination and a SIB mediation. None
  • Parameters:
    bus
    The name of the bus where the destination is currently mediated. (String, required)
    destinationName
    The name of the destination to unmediate. (String, required)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask unmediateSIBDestination {-bus bus_name -destinationName destination_name}
  • Using Jython:
    AdminTask.unmediateSIBDestination('[-bus bus_name -destinationName destination_name]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask unmediateSIBDestination {-interactive}
  • Using Jython:
    AdminTask.unmediateSIBDestination ('[-interactive]')
unpublishSIBWSInboundService SIBWebServices group The unpublishSIBWSInboundService command removes the WSDL document for the inbound service, including the ports from the registry and the business that is defined by the UDDI publication object. The object name of the inbound service object.
  • Parameters:
    uddiPublication
    The name of the UDDI publication for the service. (required)
    userId
    The user ID to use to retrieve the WSDL. (optional)
    password
    The password to use to retrieve the WSDL. (optional)
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask unpublishSIBWSInboundService $inService {-uddiPublication "MyUddi"}
  • Using Jython:
    AdminTask.unpublishSIBWSInboundService(inService, '[-uddiPublication MyUddi]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask unpublishSIBWSInboundService {-interactive}
  • Using Jython:
    AdminTask.unpublishSIBWSInboundService ('[-interactive]')
updateAppOnCluster None The updateAppOnCluster command can be used to synchronize nodes and restart cluster members for an application update that is deployed to a cluster. After an application update, this command can be used to synchronize the nodes without stopping all the cluster members on all the nodes at one time.

This command synchronizes one node at a time. Each node is synchronized by stopping the cluster members on which the application is targeted, performing a node synchronization operation, and restarting the cluster members.

This command might take more time than the default connector timeout period, depending on the number of nodes that the target cluster spans. Be sure to set proper timeout values in the soap.client.props file, when a SOAP connector is used, and in the sas.client.props file, when a RMI connector is used.

This command is not supported in local mode.

None
  • Parameters:
    -ApplicationNames
    The names of the applications that are updated.
    -timeout
    The timeout value in seconds for each node synchronization. The default is 300 seconds.
  • Returns: None

Batch mode example usage:

  • Using Jacl:
    $AdminTask updateAppOnCluster {-ApplicationNames app1}
    $AdminTask updateAppOnCluster { -ApplicationNames app1 -timeout 600}
  • Using Jython:
    AdminTask.updateAppOnCluster('[-ApplicationNames app1]')
    AdminTask.updateAppOnCluster('[-ApplicationNames app1 -timeout 600]')

Interactive mode example usage:

  • Using Jacl:
    $AdminTask updateAppOnCluster -interactive
  • Using Jython:
    AdminTask.updateAppOnCluster ('[-interactive]')



Related concepts
AdminTask object for scripted administration

Reference topic    

Terms of Use | Feedback

Last updated: Jun 8, 2005 12:45:23 PM EDT
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/index.jsp?topic=/com.ibm.websphere.express.doc/info/exp/ae/rxml_admintask.html

© Copyright IBM Corporation 2004, 2005. All Rights Reserved.
This information center is powered by Eclipse technology. (http://www.eclipse.org)