Commands for the AdminTask object
- addNodeGroupMember
- addSIBWSInboundPort
- addSIBWSOutboundPort
- addSIBusMember
- addWSGWTargetService
- compareNodeVersion
- configureTAM
- connectSIBWSEndpointListener
- copyResourceAdapter
- createApplicationServer
- createApplicationServerTemplate
- createChain
- createCluster
- createClusterMember
- createCoreGroup
- createCoreGroupAccessPoint
- createDefaultCGAP
- createGenericServer
- createGenericServerTemplate
- createJ2CActivationSpec
- createJ2CAdminObject
- createJ2CConnectionFactory
- createNodeGroup
- createNodeGroupProperty
- createSIBDestination
- createSIBEngine
- createSIBJMSActivationSpec
- createSIBJMSConnectionFactory
- createSIBJMSQueue
- createSIBJMSTopic
- createSIBMediation
- createSIBWSEndpointListener
- createSIBWSInboundService
- createSIBWSOutboundService
- createSIBus
- createServerType
- createTCPEndPoint
- createUnmanagedNode
- createWSGWGatewayService
- createWSGWProxyService
- createWebServer
- deleteChain
- deleteCluster
- deleteClusterMember
- deleteCoreGroup
- deleteCoreGroupAccessPoints
- deleteSIBDestination
- deleteSIBEngine
- deleteSIBJMSActivationSpec
- deleteSIBJMSConnectionFactory
- deleteSIBJMSQueue
- deleteSIBJMSTopic
- deleteSIBMediation
- deleteSIBWSEndpointListener
- deleteSIBWSInboundService
- deleteSIBWSOutboundService
- deleteSIBus
- deleteServer
- deleteServerTemplate
- deleteWSGWGatewayService
- deleteWSGWProxyService
- disconnectSIBWSEndpointListener
- doesCoreGroupExist
- exportServer
- exportWasprofile
- getAllCoreGroupNames
- getCoreGroupNameForServer
- getDefaultCoreGroupName
- getMetadataProperties
- getMetadataProperty
- getNamedTCPEndPoint
- getNodeBaseProductVersion
- getNodeMajorVersion
- getNodeMinorVersion
- getNodePlatformOS
- getNodeSysplexName
- getServerType
- getTCPEndPoint
- importServer
- help
- help
- help
- importWasprofile
- isNodeZOS
- listAdminObjectInterfaces
- listChainTemplates
- listChains
- listConnectionFactoryInterfaces
- listCoreGroups
- listEligibleBridgeInterfaces
- listJ2CActivationSpecs
- listJ2CAdminObjects
- listJ2CConnectionFactories
- listManagedNodes
- listMessageListenerTypes
- listNodeGroupProperties
- listNodeGroups
- listNodes
- listSIBDestinations
- listSIBEngines
- listSIBJMSActivationSpecs
- listSIBJMSConnectionFactories
- listSIBJMSQueues
- listSIBJMSTopics
- listSIBMediations
- listSIBusMembers
- listSIBuses
- listSSLRepertoires
- listServers
- listServerTemplates
- listServerTypes
- listTAMSettings
- listTCPEndPoints
- listTCPThreadPools
- listUnmanagedNodes
- mediateSIBDestination
- modifyNodeGroup
- modifyNodeGroupProperty
- modifySIBDestination
- modifySIBEngine
- modifySIBJMSActivationSpec
- modifySIBJMSConnectionFactory
- modifySIBJMSQueue
- modifySIBJMSTopic
- modifySIBMediation
- modifySIBus
- modifySIBusMember
- moveClusterToCoreGroup
- moveServerToCoreGroup
- publishSIBWSInboundService
- reconfigureTAM
- refreshSIBWSInboundServiceWSDL
- refreshSIBWSOutboundServiceWSDL
- removeNodeGroup
- removeNodeGroupMember
- removeNodeGroupProperty
- removeSIBWSInboundPort
- removeSIBWSOutboundPort
- removeSIBusMember
- removeUnmanagedNode
- removeWSGWTargetService
- setDefaultSIBWSOutboundPort
- showSIBDestination
- showSIBEngine
- showSIBJMSActivationSpec
- showSIBJMSConnectionFactory
- showSIBJMSQueue
- showSIBJMSTopic
- showSIBMediation
- showSIBus
- showSIBusMember
- showServerInfo
- showServerTypeInfo
- showTemplateInfo
- unconfigureTAM
- unmediateSIBDestination
- unpublishSIBWSInboundService
- updateAppOnCluster
Overview
Use the AdminTask object to run an administrative command, which are discovered dynamically when wsadmin is started.
We 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, one 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, one 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.
The following commands are available for the AdminTask object:
addNodeGroupMember
Group name:
NodeGroupCommands group
Examples:
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.
Target object:
The target object is the node group where the member will be created. This target object is required.
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
addSIBWSInboundPort
Group name:
SIBWebServices group
Examples:
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.
Target object:
The object name of the inbound service to which the port will be added.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
addSIBWSOutboundPort
Group name:
SIBWebServices group
Examples:
The addSIBWSOutboundPort command adds the configuration for an outbound port to an outbound service.Target object:
The object name of the outbound service for which the port will be associated.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
addSIBusMember
Group name:
SIBAdminCommands group
Examples:
Use this command to add a server or a cluster to a SIB bus.Target object:
None
Parameters and return values:
- 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:
Examples:
Batch mode example usage:
Interactive mode example usage:
addWSGWTargetService
Group name:
WSGateway group
Examples:
The addWSGWTargetService command adds a target to a gateway service. You must specify the targetService parameter or the targetDestination parameter.Target object:
Object name of the GatewayService object
Parameters and return values:
- 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, 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
compareNodeVersion
Group name:
ManagedObjectMetadata group
Examples:
The compareNodeVcommand compares the WAS version given a node that you specify and an input version.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
configureTAM
Group name:
Examples:
Target object:
Parameters and return values:
Examples:
Interactive mode example usage:
connectSIBWSEndpointListener
Group name:
SIBWebServices group
Examples:
The connectSIBWSEndpointListener command connects an end point listener to a bus.Target object:
Object name of the end point listener that you want to create.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
copyResourceAdapter
Group name:
JCA management group
Examples:
Use the copyResourceAdapter command to create a Java 2 Connector (J2C) resource adapter under the scope that you specify.Target object:
J2CResourceAdapter_object_ID
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
createApplicationServer
Group name:
ServerManagement group
Examples:
Use the createApplicationServer command to create a new application server.Target object:
Node name (optional)
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createApplicationServerTemplate
Group name:
ServerManagement group
Examples:
The createApplicationServerTemplate command creates a new application server template.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createChain
Group name:
ChannelFrameworkManagement group
Examples:
The createChain command creates a new chain of transport channels that are based on a chain template.Target object:
The instance of the transport channel service under which the new chain is created. (ObjectName, required)
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createCluster
Group name:
ClusterConfigCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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. We can specify this parameter only if the createDomain parameter was set to true in the replicationDomain command step.
- Returns: ObjectName of cluster created.
Examples:
Batch mode example usage:
Interactive mode example usage:
createClusterMember
Group name:
ClusterConfigCommands
Examples:
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, 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 serverTarget object:
clusterObjectID - The configuration object ID of the cluster to which the new member will belong. If you do not specify the configuration ID, specify the clusterName parameter. We can obtain the object name programmatically through Java using the WebSphere Application Server ConfigService API or through wsadmin scripting using the AdminConfig object.
Parameters and return values:
- Parameters:
- 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. We 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, one 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, 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, also specify the templateServerNode parameter, and one 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.
Examples:
Batch mode example usage:
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}}}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:
createCoreGroup
Group name:
CoreGroupManagement group
Examples:
The createCoreGroup command creates a new core group. The core group that you create contains no members.Target object:
None
Parameters and return values:
- Parameters:
- - coreGroupName
- The name of the core group that you are creating. (String required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
createCoreGroupAccessPoint
Group name:
CoreGroupBridgeManagement group
Examples:
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.Target object:
Core group bridge settings object for the cell. (ObjectName, required).
Parameters and return values:
- Parameters:
- - coreGroupName
- The name of the core group for which the core group access point will be created. (String required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
createDefaultCGAP
Group name:
Examples:
Target object:
Parameters and return values:
Examples:
Interactive mode example usage:
createGenericServer
Group name:
ServerManagement groupStep: ConfigProcDef
Examples:
Use the createGenericServer command to create a new generic server in the configuration. A generic server is a server that the WAS manages, but did not supply. The createGenericServer command provides an additional step, ConfigProcDef, that use to configure the parameters that are specific to generic servers.Target object:
None
Parameters and return values:
- 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
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
createGenericServerTemplate
Group name:
Examples:
Target object:
Parameters and return values:
Examples:
Interactive mode example usage:
createJ2CActivationSpec
Group name:
JCA management group
Examples:
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.Target object:
J2CResourceAdapter_object_ID
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
createJ2CAdminObject
Group name:
JCA management group
Examples:
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.
Target object:
J2CResourceAdapter_object_ID
Parameters and return values:
- 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
- Name of the Java Naming and Directory Interface (JNDI).
- -description
- Description of the created J2C admin object.
- Returns: J2CAdminObject object ID
Examples:
Batch mode example usage:
Interactive mode example usage:
createJ2CConnectionFactory
Group name:
JCA management group
Examples:
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.
Target object:
J2CConnectionFactory object ID
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createNodeGroup
Group name:
NodeGroupCommands group
Examples:
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, one can create a short name and a description for the new node group.Target object:
The node group name to be created. This target object is required.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createNodeGroupProperty
Group name:
NodeGroupCommands group
Examples:
The createNodeGroupProperty command creates custom properties for a node group.Target object:
The name of the node group. This target object is required.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBDestination
Group name:
SIBAdminCommands group
Examples:
Use this command to create a SIB destination.Target object:
None
Parameters and return values:
- 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, 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBEngine
Group name:
SIBAdminCommands group
Examples:
Use the createSIBEngine command to create a new messaging engine for a bus member.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBJMSActivationSpec
Group name:
SIBJMSAdminCommands group
Examples:
Use the createSIBJMSActivationSpec command to create a SIB JMS activation specification.Target object:
Scope of the SIB JMS resource adapter to which you want to add the activation specification.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBJMSConnectionFactory
Group name:
SIBJMSAdminCommands group
Examples:
Use the createSIBJMSConnectionFactory command to create a generic, queue or topic SIB JMS connection factory.Target object:
Scope of the SIB JMS resource adapter to which you want to add the SIB JMS connection factory.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBJMSQueue
Group name:
SIBJMSAdminCommands group
Examples:
Use the createSIBJMSQueue command to create a SIB JMS queue.Target object:
Scope of the SIB JMS resource adapter to which you want to add the SIB JMS queue.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBJMSTopic
Group name:
SIBJMSAdminCommands group
Examples:
Use this command to create a SIB JMS topic.Target object:
Scope of the SIB JMS resource adapter to which you want to add the SIB JMS topic.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBMediation
Group name:
SIBAdminCommands
Examples:
Use this command to create a SIB mediation.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBWSEndpointListener
Group name:
SIBWebServices group
Examples:
The createSIBWSEndpointListener command creates an end point listener object with no SIBWS bus connection property objects.Target object:
Object name of the server where the end point listener will be created.
Parameters and return values:
- 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 one can retrieve the WSDL associated with this end point listener. (required)
- Returns: The SIBWS end point object.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBWSInboundService
Group name:
SIBWebServices group
Examples:
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.Target object:
The object name of the messaging bus within which the service will be created.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBWSOutboundService
Group name:
SIBWebServices group
Examples:
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.Target object:
The object name of the messaging bus within which the service is created.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createSIBus
Group name:
SIBAdminCommands
Examples:
Use this command to create a new bus on the current node.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createServerType
Group name:
None
Examples:
Use the createServerType command to define a server type.
Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createTCPEndPoint
Group name:
None
Examples:
The createTCPEndPoint command creates a new named end point that one can associate with a TCP inbound channel.Target object:
Parent instance of the TransportChannelService that contains the TCPInboundChannel. (ObjectName, required)
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createUnmanagedNode
Group name:
UnmanagedNodeCommands group
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
createWSGWGatewayService
Group name:
WSGateway group
Examples:
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.Target object:
ObjectName of the gateway instance which the gateway service is created
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
createWSGWProxyService
Group name:
WSGateway group
Examples:
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.Target object:
The object name of the gateway instance within which the proxy service is created.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
createWebServer
Group name:
ServerManagement group
Examples:
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, 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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
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:
deleteChain
Group name:
ChannelFrameworkManagement group
Examples:
The deleteChain command deletes an existing chain and, optionally, the transport channels in the chain.Target object:
The chain to be deleted. (ObjectName,required)
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteCluster
Group name:
ClusterConfigCommands
Examples:
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.
Target object:
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 and return values:
- Parameters:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteClusterMember
Group name:
ClusterConfigCommands
Examples:
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.
Target object:
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 and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteCoreGroup
Group name:
CoreGroupManagement group
Examples:
The deleteCoreGroup command deletes an existing core group. The core group that you specify must not contain any members. We cannot delete the default core group.Target object:
None
Parameters and return values:
- Parameters:
- - coreGroupName
- The name of the existing core group that will be deleted. (String required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteCoreGroupAccessPoints
Group name:
CoreGroupBridgeManagement group
Examples:
The deleteCoreGroupAccessPoints command deletes all the core group access points that are associated with a group that you specify.Target object:
Core group bridge settings object for the cell. (ObjectName, required)
Parameters and return values:
- Parameters:
- - coreGroupName
- The name of the core group whose core group access points will be deleted. (String required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBDestination
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBEngine
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBJMSActivationSpec
Group name:
SIBJMSAdminCommands
Examples:
Use the deleteSIBJMSActivationSpec command to delete an activation specification.Target object:
None
Parameters and return values:
- Parameters:
- name
- The name of the activation specification that you want to delete. (String, (required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBJMSConnectionFactory
Group name:
SIBJMSAdminCommands
Examples:
Use the deleteSIBJMSConnectionFactory command to delete SIB JMS connection factories.Target object:
None
Parameters and return values:
- Parameters:
- name
- The name of the SIB JMS connection factory (String, required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBJMSQueue
Group name:
SIBJMSAdminCommands
Examples:
Use the deleteSIBJMSQueue command to delete a JMS queue.Target object:
None
Parameters and return values:
- Parameters:
- name
- The name of the SIB JMS queue. (String, required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBJMSTopic
Group name:
SIBJMSAdminCommands
Examples:
Use the deleteSIBJMSTopic command to delete a JMS topic.Target object:
None
Parameters and return values:
- Parameters:
- name
- The name of the SIB JMS topic (String, required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBMediation
Group name:
SIBAdminCommands
Examples:
Use this command to delete the named mediation from the named bus.Target object:
None
Parameters and return values:
- Parameters:
- bus
- name of the bus that owns the mediation (String, required)
- mediationName
- name of the mediation to be deleted (String, required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBWSEndpointListener
Group name:
SIBWebServices group
Examples:
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.Target object:
Object name of the end point listener that you want to delete.
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBWSInboundService
Group name:
SIBWebServices group
Examples:
The deleteSIBWSInboundService command deletes an inbound service object and any associated inbound port objects.Target object:
The object name of the inbound service object that you want to delete.
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBWSOutboundService
Group name:
SIBWebServices group
Examples:
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.Target object:
Object name of the outbound service object that you want to delete.
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteSIBus
Group name:
SIBAdminCommands
Examples:
The deleteSIBus command deletes the named SIB bus, all SIB mediations and all SIB destinations that are owned by the bus.Target object:
None
Parameters and return values:
- Parameters:
- bus
- name of bus to be deleted from the current cell (String, required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteServer
Group name:
ServerManagement group
Examples:
Use the deleteServer command to delete a server.
Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteServerTemplate
Group name:
ServerManagement
Examples:
Use the deleteServerTemplate command to delete a server template. We cannot delete templates that are defined by the system. We can only delete server templates that you created. This command deletes the directory that hosts the server template.
Target object:
The name of the template to delete. (ObjectName, required)
Parameters and return values:
- Parameters:
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteWSGWGatewayService
Group name:
WSGateway group
Examples:
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.Target object:
Object name of the gateway service object
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
deleteWSGWProxyService
Group name:
WSGateway group
Examples:
The deleteWSGWProxyService command deletes a proxy service that includes the proxy destinations, outbound service, outbound ports, inbound service, and inbound port enablement objects.Target object:
Object name of the ProxyService object
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
disconnectSIBWSEndpointListener
Group name:
SIBWebServices group
Examples:
The disconnectSIBWSEndpointListener command disconnects an end point listener from a bus.Target object:
Object name of the end point listener to be disconnected.
Parameters and return values:
- Parameters:
- bus
- The name of the bus from which to be disconnected. (required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
doesCoreGroupExist
Group name:
CoreGroupManagement group
Examples:
The doesCoreGroupExist command returns a boolean value that indicates if the core group that you specify exists.Target object:
None
Parameters and return values:
- Parameters:
- coreGroupName
- The name of the core group. (String, required)
- Returns: A boolean value.
Examples:
Batch mode example usage:
Interactive mode example usage:
exportServer
Group name:
Configuration archiveOperations group
Examples:
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. 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.
Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
exportWasprofile
Group name:
configuration archiveOperations group
Examples:
Use the exportWasprofile command to export the entire cell configuration to a configuration archive.Target object:
None
Parameters and return values:
- Parameters:
- archive
- The fully qualified file path of the exported configuration archive. (String, required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
getAllCoreGroupNames
Group name:
CoreGroupManagement group
Examples:
The getAllCoreGroupNames command returns a string that contains the names of all of the existing core groupsTarget object:
None
Parameters and return values:
- Parameters: None
- Returns: String array (String[ ])
Examples:
Batch mode example usage:
Interactive mode example usage:
getCoreGroupNameForServer
Group name:
CoreGroupManagement group
Examples:
The getCoreGroupNameForServer command returns the name of the core group in which the server that you specify is currently a member.Target object:
None
Parameters and return values:
- 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)
Examples:
Batch mode example usage:
Interactive mode example usage:
getDefaultCoreGroupName
Group name:
CoreGroupManagement group
Examples:
The getDefaultCoreGroupName command returns the name of the default core group.Target object:
None
Parameters and return values:
- Parameters: None
- Returns: String
Examples:
Batch mode example usage:
Interactive mode example usage:
getMetadataProperties
Group name:
ManagedObjectMetadata group
Examples:
The getMetadataProperties command obtains all metadata for the node that you specify.Target object:
None
Parameters and return values:
- Parameters:
- - nodeName
- The name of the node associated with the metadata you want this command to return.
- Returns: The list of metadata properties.
Examples:
Batch mode example usage:
Interactive mode example usage:
getMetadataProperty
Group name:
ManagedObjectMetadata group
Examples:
The getMetadataProperty command obtains metadata with the specified key for the node that you specify.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
getNamedTCPEndPoint
Group name:
CoreGroupBridgeManagement group
Examples:
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.Target object:
The bridge interface object for which the port will be listed. (ObjectName, required)
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
getNodeBaseProductVersion
Group name:
ManagedObjectMetadata group
Examples:
The getNodeBaseProductVcommand returns the version of the WAS for a node that you specify. This command only returns the version for a distributed installation of the product.Target object:
None
Parameters and return values:
- Parameters:
- - nodeName
- The name of the node associated with the metadata you want this command to return.
- Returns: WAS version for the node that you specify.
Examples:
Batch mode example usage:
Interactive mode example usage:
getNodeMajorVersion
Group name:
ManagedObjectMetadata group
Examples:
The getNodeMajorVcommand returns the major version of the WAS for a node that you specify. This command returns the version for a distributed installation of the product only.Target object:
None
Parameters and return values:
- Parameters:
- nodeName
- The name of the node associated with the metadata you want this command to return.
- Returns: WAS major version for the node that you specified.
Examples:
Batch mode example usage:
Interactive mode example usage:
getNodeMinorVersion
Group name:
ManagedObjectMetadata group
Examples:
The getNodeMinorVcommand returns the minor version of the WAS for a node that you specify. This command only returns the version for a distributed installation of the product only.Target object:
None
Parameters and return values:
- Parameters:
- - nodeName
- The name of the node associated with the metadata you want this command to return.
- Returns: WAS minor version for the node that you specified.
Examples:
Batch mode example usage:
Interactive mode example usage:
getNodePlatformOS
Group name:
ManagedObjectMetadata group
Examples:
The getNodePlatformOS command returns the operating system name for a node that you specify.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
getNodeSysplexName
Group name:
ManagedObjectMetadata group
Examples:
The getNodeSysplexName command returns the sysplex name for a node that you specify.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
getServerType
Group name:
ServerManagement group
Examples:
The getServerType command returns the type of the server that you specify.Target object:
None
Parameters and return values:
- Parameters:
- - serverName
- The name of the server. (String)
- - nodeName
- The name of the node. (String)
- Returns: The type of the server.
Examples:
Batch mode example usage:
Interactive mode example usage:
getTCPEndPoint
Group name:
None
Examples:
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.Target object:
TCPInboundChannel, or containing chain, instance that is associated with a NamedEndPoint. (ObjectName, required)
Parameters and return values:
- Parameters: None
- Returns: Object name of an existing named end point that is associated with the TCP inbound channel instance or a channel chain.
Examples:
Batch mode example usage:
Interactive mode example usage:
importServer
Group name:
Configuration archiveOperations group
Examples:
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.
Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
help
Group name:
None
Examples:
The help command provides a summary of the help commands and ways to invoke an administrative command.Target object:
None
Parameters and return values:
- Parameters: None
- Returns: A general help description
Examples:
help
Group name:
None
Examples:
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.Target object:
None
Parameters and return values:
- Parameters:
- - options
- Returns: A summary of all available administrative commands.
Examples:
help
Group name:
None
Examples:
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.Target object:
None
Parameters and return values:
- Parameters:
- - commandName
- - stepName
- Returns: A summary of the specified command group, administrative command, or step.
Examples:
importWasprofile
Group name:
configuration archiveOperations group
Examples:
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.Target object:
None
Parameters and return values:
- Parameters:
- archive
- The fully qualified file path of the configuration archive. (String, required)
- Returns: Void
Examples:
Batch mode example usage:
Interactive mode example usage:
isNodeZOS
Group name:
MangedObjectMetadata group
Examples:
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.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listAdminObjectInterfaces
Group name:
JCA management group
Examples:
Use the listAdminObjectInterfaces command to list the administrative object interfaces that are defined under the resource adapter that you specify.
Target object:
J2CResouce adapter object ID
Parameters and return values:
- Parameters: None
- Returns: A list of administrative object interfaces.
Examples:
Batch mode example usage:
listChainTemplates
Group name:
ChannelFrameworkManagement group
Examples:
The listChainTemplates command displays a list of templates that use to create chains in this configuration. All templates have a certain type of transport channel as the last transport channel in the chain.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listChains
Group name:
ChannelFrameworkManagement group
Examples:
The listChains command lists all the chains that are configured under a particular instance of the transport channel service.Target object:
The instance of the transport channel service under which the the chains are configured. (ObjectName, required)
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listConnectionFactoryInterfaces
Group name:
JCA management group
Examples:
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.
Target object:
J2CResourceAdapter object ID
Parameters and return values:
- Parameters: None
- Returns: A list of connection factory interfaces.
Examples:
Batch mode example usage:
listCoreGroups
Group name:
CoreGroupBridgeManagement group
Examples:
The listCoreGroups command returns a collection of core groups that are related to the core group that you specify.Target object:
The name of the core group for which the related core groups will be listed. (String, required)
Parameters and return values:
- Parameters:
- - cgBridgeSettings
- The group bridge settings object for the cell. (ObjectName, required)
- Returns: A set of core group names.
Examples:
Batch mode example usage:
Interactive mode example usage:
listEligibleBridgeInterfaces
Group name:
CoreGroupBridgeManagement group
Examples:
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.Target object:
The core group access point object for which bridge interfaces will be listed. (ObjectName, required)
Parameters and return values:
- 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)
Examples:
Batch mode example usage:
Interactive mode example usage:
listJ2CActivationSpecs
Group name:
JCA management group
Examples:
Use the listJ2CActivationSpecs command to list the activation specifications that are contained under the resource adapter and message listener type that you specify.
Target object:
J2CResourceAdapter object ID
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
listJ2CAdminObjects
Group name:
JCA Management group
Examples:
Use the listJ2CAdminObjects command to list administrative objects that contain the administrative object interface that you specify.
Target object:
J2C ResourceAdapter object ID
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
listJ2CConnectionFactories
Group name:
JCA management group
Examples:
Use the listJ2CConnectionFactories command to list the Java 2 connector connection factories under the resource adapter and connection factory interface that you specify.
Target object:
J2C ResourceAdapter object ID
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
listManagedNodes
Group name:
UnmanagedNodeCommands group
Examples:
Use the listManagedNodes command to list the managed nodes, nodes that have a node agent defined, in a configuration.Target object:
None
Parameters and return values:
- Parameters: None
- Returns: List
Examples:
Batch mode example usage:
listMessageListenerTypes
Group name:
JCA Management group
Examples:
Use the listMessageListenerTypes command to list the message listener types that are defined under the resource adapter that you specify.
Target object:
J2C ResourceAdapter object ID
Parameters and return values:
- Parameters: None
- Returns: A list of message listener types.
Examples:
Batch mode example usage:
listNodeGroupProperties
Group name:
NodeGroupCommands group
Examples:
The listNodeGroupProperties command displays all of the custom properties of a node group.Target object:
The target object is name of the node group. This target object is required.
Parameters and return values:
- Parameters: None
- Returns: A list of all of the custom properties of a node group.
Examples:
Batch mode example usage:
Interactive mode example usage:
listNodeGroups
Group name:
NodeGroupCommands group
Examples:
The listNodeGroups command returns the list of node groups from the configuration repository. We can pass an optional node name to the command that returns the list of node groups where the node resides.Target object:
The target object is name of the node. This target object is optional.
Parameters and return values:
- Parameters: None
- Returns: A list of the node groups in the cell.
Examples:
Batch mode example usage:
Interactive mode example usage:
listNodes
Group name:
NodeGroupCommands group
Examples:
The listNodes command displays all of the nodes in the cell.Target object:
The target object is name of the node group. This target object is optional.
Parameters and return values:
- Parameters: None
- Returns: A list of all the nodes in the cell
Examples:
Batch mode example usage:
Interactive mode example usage:
listSIBDestinations
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listSIBEngines
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listSIBJMSActivationSpecs
Group name:
SIBJMSAdminCommands
Examples:
Target object:
Parameters and return values:
Examples:
Interactive mode example usage:
listSIBJMSConnectionFactories
Group name:
SIBJMSAdminCommands
Examples:
Use the listSIBJMSConnectionFactories command to list all of the JMS connection factories for the default messaging provider at the scope that you specify.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listSIBJMSQueues
Group name:
SIBJMSAdminCommands
Examples:
Use the listSIBJMSQueues command to list all the JMS queues for the default messaging provider at the specified scope.Target object:
None
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
listSIBJMSTopics
Group name:
SIBJMSAdminCommands
Examples:
The listSIBJMSTopics command lists all the JMS topics for the default messaging provider at the specified scope.Target object:
None
Parameters and return values:
- Parameters: None
- Returns: A list of JMS topics.
Examples:
Batch mode example usage:
listSIBMediations
Group name:
SIBAdminCommands
Examples:
The listSIBMediations command lists the mediations on a named SIB bus.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listSIBusMembers
Group name:
SIBAdminCommands
Examples:
The listSIBusMember command lists all of the servers and the clusters that are members of the named SIB bus.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listSIBuses
Group name:
SIBAdminCommands
Examples:
The listSIBuses command lists all the SIB buses in the cell.Target object:
None
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
listSSLRepertoires
Group name:
None
Examples:
The listSSLRepertoires command lists all of the SSL configuration instances that one can associate with an SSL inbound channel.Target object:
SSLInboundChannel instance for which the SSLConfig candidates are listed.
Parameters and return values:
- Parameters: None
- Returns: A list of eligible SSL configuration object names.
Examples:
Batch mode example usage:
Interactive mode example usage:
listServers
Group name:
ServerManagement group
Examples:
The listServers command returns a list of servers.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listServerTemplates
Group name:
ServerManagement group
Examples:
Use the listServerTemplates command to list server templates.
Target object:
None
Parameters and return values:
- 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 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listServerTypes
Group name:
ServerManagement group
Examples:
Use the listServerTypes command to display all the current server types. For example, APPLICATION_SERVER, WEB_SERVER, GENERIC_SERVER.
Target object:
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 and return values:
- Parameters: None
- Returns: A list of server types that one 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listTAMSettings
Group name:
Examples:
Target object:
Parameters and return values:
Examples:
Interactive mode example usage:
listTCPEndPoints
Group name:
None
Examples:
The listTCPEndPoints command lists all the named end points that can be associated with a TCP inbound channel.Target object:
TCPInboundChannel instance for which named end points candidates are listed. (ObjectName, required)
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
listTCPThreadPools
Group name:
None
Examples:
The listTCPThreadPools command lists all of the thread pools that can be associated with a TCP inbound channel or TCP outbound channel.Target object:
TCPInboundChannel or TCPOutboundChannel instance for which ThreadPool candidates are listed. (ObjectName, required)
Parameters and return values:
- Parameters: None
- Returns: A list of eligible thread pool object names.
Examples:
Batch mode example usage:
Interactive mode example usage:
listUnmanagedNodes
Group name:
UnmanagedNodeCommands group
Examples:
Use the listUnmanagedNodes command to list the unmanaged nodes in a configuration.Target object:
None
Parameters and return values:
- Parameters: None
- Returns: List
Examples:
Batch mode example usage:
Interactive mode example usage:
mediateSIBDestination
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifyNodeGroup
Group name:
NodeGroupCommands group
Examples:
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.Target object:
The target object is the node group name. This target object is required.
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
modifyNodeGroupProperty
Group name:
NodeGroupCommands group
Examples:
The modifyNodeGroupProperty command modifies custom properties for a node groupTarget object:
The name of the node group. This target object is required.
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBDestination
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBEngine
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBJMSActivationSpec
Group name:
SIBJMSAdminCommands
Examples:
Use the modifySIBJMSActivationSpec command to modify the properties of an activation specification.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBJMSConnectionFactory
Group name:
SIBJMSAdminCommands
Examples:
Use the modifySIBJMSConnectionFactory command to modify a unified JMS connection factory at the current scope.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBJMSQueue
Group name:
SIBJMSAdminCommands
Examples:
Use the modifySIBJMSQueue command to modify a unified JMS queue at the current scope.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBJMSTopic
Group name:
SIBJMSAdminCommands
Examples:
Use the modifySIBJMSTopic command to modify the JMS topic at the current scope.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBMediation
Group name:
SIBAdminCommands
Examples:
Use this command to modify the attributes of a SIB mediation.The bus and mediationName parameters identify the mediation and cannot be modified.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBus
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
modifySIBusMember
Group name:
SIBAdminCommands
Examples:
The modifySIBusMember command modifies the attributes of the bus member identified by the bus, node, server, and cluster parameters.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
moveClusterToCoreGroup
Group name:
CoreGroupManagement group
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
moveServerToCoreGroup
Group name:
CoreGroupManagement group
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
publishSIBWSInboundService
Group name:
SIBWebServices group
Examples:
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.Target object:
The object name of the inbound service object.
Parameters and return values:
- Parameters:
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
reconfigureTAM
Group name:
Examples:
Target object:
Parameters and return values:
Examples:
Interactive mode example usage:
refreshSIBWSInboundServiceWSDL
Group name:
SIBWebServices group
Examples:
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.
Target object:
The object name of the inbound service object.
Parameters and return values:
- Parameters:
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
refreshSIBWSOutboundServiceWSDL
Group name:
SIBWebServices group
Examples:
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.
Target object:
The object name of the outbound service object.
Parameters and return values:
- Parameters:
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
removeNodeGroup
Group name:
NodeGroupCommands group
Examples:
The removeNodeGroup command removes the configuration of a node group. We can remove a node group if it does not contain any members. Also, the default node group cannot be removed.Target object:
The name of the node group to be removed. This target object is required.
Parameters and return values:
- Parameters: None
- Returns: The node group object ID.
Examples:
Batch mode example usage:
Interactive mode example usage:
removeNodeGroupMember
Group name:
NodeGroupCommands group
Examples:
The removeNodeGroupMember command removes the configuration of a node group member.
- A node must always be a member of at least one node group.
- We cannot remove a node from a node group that is part of a cluster in that node group.
Target object:
The target object is the node group containing the member to be removed. This target object is required.
Parameters and return values:
- Parameters:
- - nodeName
- The name of the node to remove from a node group. This parameter is required.
- Returns: Node group member object ID.
Examples:
Batch mode example usage:
Interactive mode example usage:
removeNodeGroupProperty
Group name:
NodeGroupCommands group
Examples:
The removeNodeGroupProperty command removes custom properties of a node group.Target object:
The name of the node group. This target object is required.
Parameters and return values:
- Parameters:
- - name
- The name of the custom property to remove. This parameter is required.
- Returns: Properties object ID
Examples:
Batch mode example usage:
Interactive mode example usage:
removeSIBWSInboundPort
Group name:
SIBWebServices group
Examples:
The removeSIBWSInboundPort command removes the configuration of an inbound port.Target object:
The object name of the inbound port object that you want to remove.
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
removeSIBWSOutboundPort
Group name:
SIBWebServices group
Examples:
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.Target object:
The object name of the outbound port object that you want to remove.
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
removeSIBusMember
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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:
Examples:
Batch mode example usage:
Interactive mode example usage:
removeUnmanagedNode
Group name:
UnmanagedNodeCommands group
Examples:
Use the removeUnmanagedNode command to remove an unmanaged node from the configuration.Target object:
None
Parameters and return values:
- Parameters:
- - nodeName
- The name of the unmanaged node. (String, required)
- Returns: null
Examples:
Batch mode example usage:
Interactive mode example usage:
removeWSGWTargetService
Group name:
WSGateway group
Examples:
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.Target object:
The object name of the TargetService object.
Parameters and return values:
- Parameters: None
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
setDefaultSIBWSOutboundPort
Group name:
SIBWebServices group
Examples:
The setDefaultSIBWSOutboundPort command updates the default outbound port for an outbound service.Target object:
The object name of the outbound service whose default port you want to update.
Parameters and return values:
- Parameters:
- name
- The name of the port that you want to set as the default. (required)
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBDestination
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBEngine
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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, 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBJMSActivationSpec
Group name:
SIBAdminCommands
Examples:
The showSIBJMSActivationSpec command shows details about a JMS activation specification.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBJMSConnectionFactory
Group name:
SIBJMSAdminCommands
Examples:
The showSIBJMSConnectionFactory command shows details about a JMS connection factory.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBJMSQueue
Group name:
SIBJMSAdminCommands
Examples:
Use the showSIBJMSQueue command to show the details about a JMS queue.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBJMSTopic
Group name:
SIBJMSAdminCommands
Examples:
The showSIBJMSTopic command shows the details for a JMS topic.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBMediation
Group name:
SIBAdminCommands
Examples:
Use the showSIBMediation command to get the attribute names and values of a SIB mediation.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBus
Group name:
SIBAdminCommands
Examples:
Use the showSIBus command to get the attribute names and values of a SIB bus.Target object:
None
Parameters and return values:
- Parameters:
- bus
- The name of the bus. (String, required)
- Returns: The attribute names and values of the identified SIB bus.
Examples:
Batch mode example usage:
Interactive mode example usage:
showSIBusMember
Group name:
SIBAdminCommands
Examples:
Use the showSIBusMemeber command to get the attribute names and values of a SIB bus member.Target object:
None
Parameters and return values:
- 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.
Examples:
Batch mode example usage:
Interactive mode example usage:
showServerInfo
Group name:
ServerManagement group
Examples:
The showServerInfo command returns the information for a server that you specify.Target object:
The configuration ID of the server. (required)
Parameters and return values:
- Parameters: None
- Returns: A list of metadata.
Examples:
Batch mode example usage:
Interactive mode example usage:
showServerTypeInfo
Group name:
ServerManagement group
Examples:
The showServerTypeInfo command displays information about a specific server type.Target object:
A server type. For example, APPLICATION_SERVER. (String, required)
Parameters and return values:
- 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 use to find templates by properties. For example, com.ibm.websphere.nodeOperatingSystem=os390. (String[], optional)
- Returns: A list of information about the server type.
Examples:
Batch mode example usage:
Interactive mode example usage:
showTemplateInfo
Group name:
ServerManagement group
Examples:
Use the showTemplateInfo command to display the metadata information for a specific server template.
Target object:
The server type, for example, APPLICATION_SERVER. (String, required)
Parameters and return values:
- Parameters: None
- Returns: The metadata information regarding a specific template.
Examples:
Batch mode example usage:
Interactive mode example usage:
unconfigureTAM
Group name:
Examples:
Target object:
Parameters and return values:
Examples:
Interactive mode example usage:
unmediateSIBDestination
Group name:
SIBAdminCommands
Examples:
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.Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
unpublishSIBWSInboundService
Group name:
SIBWebServices group
Examples:
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.Target object:
The object name of the inbound service object.
Parameters and return values:
- Parameters:
- Returns: None
Examples:
Batch mode example usage:
Interactive mode example usage:
updateAppOnCluster
Group name:
None
Examples:
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.
Target object:
None
Parameters and return values:
- 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
Examples:
Batch mode example usage:
Interactive mode example usage:
See Also
AdminTask object for scripted administration