Network Deployment (Distributed operating systems), v8.0 > Reference > Commands (wsadmin scripting)
Administrative job types using wsadmin.sh
In a flexible management environment, you can use the wsadmin tool to submit administrative jobs to the job manager. This topic provides detailed information about the administrative jobs, the job parameters, and sample command syntax.
In a flexible management environment, you can configure an admin agent and job manager to submit jobs to multiple targets or target groups in the configuration. Then, you can submit administrative jobs to queue jobs across your managed environment. Each administrative job has a corresponding job type, which defines the required parameters to submit the job. We can use the commands in the AdministrativeJobs command group to submit administrative jobs to the job manager.
We can submit administrative jobs to manage the applications.
- Common parameters for all job types
- Submit a job to collect inventory
- Submit a job to collect target status
- Submit jobs to manage files
- Submit a job that runs a wsadmin script
- Submit jobs to manage applications
- Submit jobs to manage servers
- createApplicationServer
- deleteApplicationServer
- createProxyServer
- deleteProxyServer
- createCluster
- deleteCluster
- createClusterMember
- deleteClusterMember
- configureProperties
- Submit jobs to manage the server runtime
- Submit a job to run commands
- Submit a job to manage profiles
- Submit Installation Manager jobs
Common parameters for all job types
Use the submitJob command to submit administrative jobs. Job submissions consist of the following information:
Required parameters
| Parameter | Description | Type |
|---|---|---|
| jobType | Type of job to perform. Many job types exist in the flexible management environment including application management, product maintenance, configuration, and application server runtime control jobs. | String |
| targetList | Specifies one or more managed targets where the job runs. | String |
| jobParams | Specifies configuration information in addition to the job type and target in order to run the job. Job parameters are specific to each job type. | String |
| Parameter | Description | Type |
|---|---|---|
| group | Name of the group of managed targets where the job runs. | String |
| username | User name to use at the targets when the job is run. If the user name and password are not specified, and security is enabled, the user ID at the job manager is used. | String |
| password | Password for the user name to use at the targets when the job is run. If the user name and password are not specified, and security is enabled, the user ID at the job manager is used. | String |
| privateKeyFile | Fully qualified private key file to use at the targets when the job is run. Specify the full path to the keystore. | String |
| passphrase | Fully qualified passphase to use at the targets when the job is run. Specify a passphrase if the keystore requires a passphrase. | String |
| useSudo | Specifies to enable use of a substitute user to perform commands on the target host. The default is not to use sudo. The sudo option is supported on AIX, HP-UX, Linux, and Solaris
operating systems only.
Enable useSudo to change users before a job runs, and then specify the user name and password for the substitute user as needed. sudo means "substitute user do." If the target host does not require a password, leave the password fields blank. The following selection combinations are valid:
| Boolean |
| sudoUsername | User name for the substitute user. For information on when to specify a value for sudoUsername, see the useSudo description. | String |
| sudoPassword | Specifies a password for the substitute user. For information on when to specify a value for sudoPassword, see the useSudo description. | String |
| description | Specifies a description for the job. | String |
| activationDateTime | Date and time to activate the job in the format "2006-05-03T10:30:45-0000". The -0000 section of the activationDateTime parameter value represents RFC 822 format. We can specify Z as a shortcut for Greenwich Mean Time (GMT), such as "2006-05-03T10:30:45Z". If you do not specify the time zone, the system uses the time zone of the job manager. | String |
| expirationDateTime | Expiration date for the job, in the format "2006-05-03T10:30:45-0000". The -0000 section of the activationDateTime parameter value represents RFC 822 format. We can specify "Z" as a shortcut for Greenwich Mean Time (GMT), such as "2006-05-03T10:30:45Z". If you do not specify the time zone, the system uses the time zone of the job manager. | String |
| executionWindow | Recurring interval, if any, for the job. | String |
| executionWindowUnit | Unit of measure for the recurring interval. Valid values include HOURS, DAYS, WEEKS, MONTHS, CONNECT, and ONCE. The default value is HOURS. | String |
| Email address where the system sends job notifications. | String |
Enter wsadmin commands from the bin directory of the job manager profile. This topic shows examples in the Jython scripting language.
Example usage:
AdminTask.submitJob('-jobType installApplication -targetList [Target1 Target2 Target3]
-jobParams [applicationName MyApp] -email admin@company.com ')
Interactive example...:
AdminTask.submitJob('-interactive')
Job result example usage:
Run a submitJob command returns a job token such as 124231200726586682. For information on the job token, run a getJobTargetStatus command:
AdminTask.getJobTargetStatus('[-jobToken 124231200726586682]')
An administrative job logs results such as the following:
- The NOT_ATTEMPTED value specifies that the system did not attempt to complete the job.
- The DISTRIBUTED value specifies that the agent for the target received the job, but the job is not complete.
- The ASYNC_IN_PROGRESS value specifies that target is running the job concurrently with other jobs.
- The FAILED value specifies that the job failed.
- The REJECTED value specifies target rejected the job because, for example, the target does not support the job type.
- The SUCCEEDED value specifies that the job completed successfully.
- The PARTIALLY_SUCCEEDED value specifies that the job was partially completed. For example, partial success might occur when a target represents multiple servers, and only some of the servers on the target complete the job successfully.
Job status results typically progress from DISTRIBUTED to ASYNC_IN_PROGRESS to SUCCEEDED. You might need to run a getJobTargetStatus command more than once, until the result is FAILED, REJECTED, or SUCCEEDED.
By default, a job remains active for one day (24 hours).
Submit a job to collect inventory
The inventory administrative job collects inventory data from the targets. This inventory data includes the available job types and the status of the managed resources, such as applications and servers, for each target.
When a target is a host, the inventory data includes information on the host such as operating system name, version, Installation Manager, package group, packages, profiles, and other resources.
Job parameters None.
Example usage
AdminTask.submitJob('-jobType inventory -targetList [Target1 Target2 Target3]')
Submit a job to collect target status
The status administrative job collects status data from the targets. Use this job, instead of the inventory job, if you only want to refresh data on the managed resources, such as applications, and servers, for each target.
Job parameters None.
Example usage
AdminTask.submitJob('-jobType status -targetList [Target1 Target2 Target3]')
Submit jobs to manage files
We can use the file management jobs to collect, distribute, and remove files. For example, you can submit the collectFile job to transfer a file to the job manager. The distributeFile job transfers a file from the job manager to the targets for the job. The removeFile job removes a file that was previously distributed to the target:
We can use file management
jobs with remote host targets. Use distributeFile to send a file to remote hosts, collectFile to collect files from remote hosts, and removeFile to delete files from remote hosts.
collectFile
The collectFile administrative job collects a target file and transfers it to the job manager. If the source location is a directory instead of a file, the job recursively zips the directory contents and transfers the resulting compressed format file.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| source | Source location of the file or directory of interest. The system determines the file location is relative to the $PROFILE_ROOT/directory of the target. | String |
| destination | Destination location. The value is relative to a directory named PROFILE_ROOT/config/temp/JobManagerName/jobToken/targetName. | String |
| distributionProvider | Optionally specifies the name of the distribution provider. | String |
Example usage
The following example runs the collectFile job:
AdminTask.submitJob('[-jobType collectFile -targetList [Target1]
-jobParams [[source logs][destination targetLocationOfFile]]]')
distributeFile
The distributeFile administrative job transfers a file from the job manager to the targets for the job. The system stores the file at the target in preparation for subsequent jobs that will use the file. The installApplication and updateApplication administrative jobs reference the destination that provided to the distributeFile job as the location of the application content on the target. Additionally, you can use this job to distribute script files and properties-based configuration files.
The file to distribute from the job manager initially must be in the /config/temp/JobManager directory of the job manager profile. Then, the system moves the file into the downloadedContent directory of the admin agent or dmgr profile. The destination parameter is relative to the downloadedContent directory and can be a file name or a relative path name. We can use a relative path to create separate subdirectories under the downloadedContent directory to organize downloaded files.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| source | Source location of the content to distribute. | String |
| destination | Destination location on the target where the system saves the content. | String |
| distributionProvider | Optionally specifies the name of the distribution provider. | String |
Example usage
AdminTask.submitJob('-jobType distributeFile -targetList [Target1 Target2 Target3]
-jobParams [[source file:/MyApp.ear][destination MyApp.ear]]')
removeFile
The removeFile administrative job removes a file that was previously distributed to the target. The location parameter is relative to the downloadedContent directory, and it should be the same location as the location that was specified for the destination parameter when the file was distributed.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| location | Location of the file to remove from the target. Use the destination value from the distributeFile job. | String |
| distributionProvider | Optionally specifies the name of the distribution provider. | String |
Example usage
AdminTask.submitJob('-jobType removeFile -targetList [Target1 Target2 Target3]
-jobParams [location MyApp.ear]')
Submit a job that runs a wsadmin script
We can submit a job to run a wsadmin script on a managed target of the job manager. The managed target can be a dmgr or an unfederated application server. Before running a wsadmin script on a managed target, transfer the wsadmin script, and any script profile, from the job manager to the managed target using the distributeFile job. Remember any destination value specified when distributing the file. Then use the following job to run the wsadmin script. Use the destination value for the scriptFileLocation parameter. If you specified a profile destination value, optionally use the profile destination value for the profileLocation parameter.
The status result of a runWsadminScript job depends on the return code of the script. When the return code is zero, the job is marked as successful. When the return code is a value that is not zero, the job is marked as failed.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| scriptFileLocation | Location of the script file to run on the managed target. The location is the destination that was given when the file was distributed to the target. | String |
| profileLocation | Optionally specifies the location of the profile script to run with the wsadmin script. This parameter corresponds to the -profile parameter of wsadmin. The location is the destination specified when the file is distributed to the target. | String |
| scriptParameters | Optionally specifies parameters to give to the wsadmin script. | String |
Example usage
AdminTask.submitJob('[-jobType runWsadminScript -targetList [DmgrManagedNodeName]
-jobParams [ [scriptFileLocation myScript.py] [profileLocation scriptProfile.py] [scriptParameters [param1 param2]] ]]')
For wsadmin scripts that process multiple keyword-value pairs for command parameters, such as argv[] command parameters, use scriptParameters to specify the keywords and values:
AdminTask.submitJob('[-jobType runWsadminScript -targetList [node1]
-jobParams [ [scriptFileLocation myScript.py] [scriptParameters [-keyword1 value1 -keyword2 value2]] ]]')
Submit jobs to manage applications
We can use the application management jobs to distribute, install, update, remove, and control applications on the application server. For example, you can submit the distributeFile, installApplication and startApplication jobs to deploy applications in the environment.
To remove applications from the environment, submit the stopApplication, uninstallApplication, and removeFile jobs.
Use the following application management jobs to administer the application configurations:
installApplication
The installApplication administrative job installs and binds an application or application element into the target environment. We must run the distributeFile job and distribute the deployable content to the targets before you can install the application.
The installApplication job does not provide a means for providing binding information, or other deployment attributes. If you need that capability, you can use the runWsadminScript, or configureProperties jobs.
Before you can submit this job, the PROFILE_ROOT/downloadedContent directory must exist for the dmgr or admin agent. We must create this directory, if it does not already exist.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| applicationName | Specifies an application name to use to identify the application to install. Often this is the base file name of the enterprise application (for example, MyApp for MyApp.ear), but you can choose any name. | String |
| appLocation | Optionally specifies the location of the application file to install. By default, the installApplication job appends the .ear file format notation to the application name, and searches for the application in the default destination location.
Thus, if you specify MyApp for applicationName, by default the appLocation is downloadedContent/MyApp.ear of the managed target. If you specify a value for appLocation, use the destination value specified when distributing the application. | String |
| serverName | Optionally specifies the name of the server where the system installs the application. | String |
| nodeName | Optionally specifies the node of interest, which identifies the server in a WAS ND cell. | String |
| clusterName | Optionally specifies the name of the cluster in which the application is installed. | String |
Example usage
AdminTask.submitJob('-jobType installApplication -targetList [Target1 Target2 Target3]
-jobParams [[applicationName MyApp]]')
or:
AdminTask.submitJob('-jobType installApplication -targetList [Target1 Target2 Target3]
-jobParams [[applicationName MyApp][appLocation MyApp.ear][clusterName TestCluster]]')
startApplication
The startApplication administrative job starts a previously installed application on the target. The system changes the application status to active or RUNNING, loads the application in the run time, and opens the application to receive client requests. This is the last step in the application deployment process.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| applicationName | Name of the application to start. | String |
Example usage
AdminTask.submitJob('-jobType startApplication -targetList [Target1 Target2 Target3]
-jobParams [applicationName MyApp]')
stopApplication
The stopApplication administrative job stops the application on the target. The system changes the application status to stopped and no longer receives client requests. We can use the startApplication job to restart the application. This is the first step in the application removal process.
| Parameter | Description | Type |
|---|---|---|
| applicationName | Name of the application to stop. | String |
Example usage
AdminTask.submitJob('-jobType stopApplication -targetList [Target1 Target2 Target3]
-jobParams [applicationName MyApp]')
updateApplication
The updateApplication administrative job updates an application or application element in the target environment. We must run the distributeFile job and distribute the deployable content to the targets before you can update the application.
Before you can submit this job, the PROFILE_ROOT/downloadedContent directory must exist for the dmgr or admin agent. We must create this directory, if it does not already exist.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| applicationName | Specifies an application name to use to identify the application to update. Often this is the base file name of the enterprise application (for example, MyApp for MyApp.ear), but you can choose any name. | String |
| appLocation | Optionally specifies the location of the application file to install. By default, the updateApplication job appends the .ear file format notation to the application name, and searches for the application in the default destination location.
Thus, if you specify MyApp for applicationName, by default the appLocation is downloadedContent/MyApp.ear of the managed target. If you specify a value for appLocation, use the destination value specified when distributing the application. | String |
| serverName | Optionally specifies the name of the server where the system updates the application. | String |
| nodeName | Optionally specifies the node of interest, which identifies the server in a WAS ND cell. | String |
| clusterName | Optionally specifies the name of the cluster in which the application is updated. | String |
Example usage
AdminTask.submitJob('-jobType updateApplication -targetList [Target1 Target2 Target3]
-jobParams [[applicationName MyApp]]')
or:
AdminTask.submitJob('-jobType updateApplication -targetList [Target1 Target2 Target3]
-jobParams [[applicationName MyApp][appLocation MyApp.ear][clusterName TestCluster]]')
uninstallApplication
The uninstallApplication administrative job uninstalls the application from the targets.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| applicationName | Name of the application to remove. | String |
Example usage
AdminTask.submitJob('-jobType uninstallApplication -targetList [Target1 Target2 Target3]
-jobParams [applicationName MyApp]')
Submit jobs to manage servers
The system administrator can use the application server configuration jobs to modify the configuration for remote and local application servers.
createApplicationServer
The createApplicationServer administrative job creates an application server in the target environment.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| serverName | Name of the application server to create. The server name must be unique on the target node. | String |
| nodeName | When the target is a WAS ND cell, specify the node name to indicate on which node in the cell the server is to be created. You do not have to specify the node name for a base node. | String |
| templateName | Optionally specifies the server template. | String |
| templateLocation | Optionally specifies the location where the template is stored. Use the default, system defined location unless you need to specify a template location. | String |
| genUniquePorts | Optionally specifies to generate unique //publib.boulder.ibm.com/infocenter/wasinfo/v8r0/index.jsp?topic=/ ports for a server. By default, the product generates unique port numbers. | Boolean |
Example usage
AdminTask.submitJob('-jobType createApplicationServer -targetList
[Node1 Node2 Node3] -jobParams [serverName AppServer01]')
deleteApplicationServer
The deleteApplicationServer administrative job removes an application server from the target environment.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| serverName | Name of the application server to delete. | String |
| nodeName | When the target is a WAS ND cell, specify the node name to indicate from which node in the cell the server is to be deleted. You do not have to specify the node name for a base node. | String |
Example usage
AdminTask.submitJob('-jobType deleteApplicationServer -targetList
[Node1 Node2 Node3] -jobParams [serverName AppServer01]')
createProxyServer
The createProxyServer administrative job creates a proxy server in a cell of a dmgr that is a managed target of a job manager.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| serverName | Name of the proxy server to create. | String |
| nodeName | Node in which the proxy server will reside. | String |
Example usage
AdminTask.submitJob('[-jobType createProxyServer -jobParams [[serverName
testServer1][nodeName testNode1]] ]')
deleteProxyServer
The deleteProxyServer deletes a proxy server from a cell of a dmgr that is a managed target of a job manager.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| serverName | Name of the proxy server to delete. | String |
| nodeName | Node in which the proxy server resides. | String |
Example usage
AdminTask.submitJob('[-jobType deleteProxyServer -jobParams [[serverName
testServer1][nodeName testNode1]] ]')
createCluster
The createCluster administrative job creates a cluster.
To create the cluster in a cell, register the dmgr of the cell with a job manager.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| clusterConfig.clusterName | Name of the server cluster. | String |
| clusterConfig.preferLocal | Optionally enables node-scoped routing optimization for the cluster. | String |
| clusterConfig.clusterType | Optionally specifies the type of server cluster. | String |
| replicationDomain.createDomain | Optionally creates a replication domain with a name set to the name of the new cluster. | String |
| convertServer.serverNode | Optionally specifies the name of the node of the existing server to convert to the first member of the cluster. | String |
| convertServer.serverName | Optionally specifies the name of the existing server to convert to the first member of the cluster. | String |
| convertServer.memberWeight | Optionally specifies the weight value of the new cluster member. | String |
| convertServer.nodeGroup | Optionally specifies the name of the node group to which all cluster member nodes must belong. | String |
| convertServer.replicatorEntry | Optionally specifies that a replicator entry for this member is created in the cluster replication domain. The replicator entry is used for HTTP session data replication. | String |
Example usage
AdminTask.submitJob('[-jobType createCluster -targetList [DmgrManagedNodeName]
-jobParams [clusterConfig.clusterName newCluster1]]')
If you specify additional parameters on the createCluster command, use the format of [stepName.parameterName parameterValue] in the -jobParams list of parameters.
AdminTask.submitJob('[-jobType createCluster -targetList [DmgrManagedNodeName]
-jobParams [ [clusterConfig.clusterName newCluster1] [clusterConfig.clusterType PROXY_SERVER] ]]')
deleteCluster
The deleteCluster administrative job deletes a cluster.
To delete the cluster in a cell, register the dmgr of the cell with a job manager.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| clusterName | Name of the server cluster to delete. | String |
| replicationDomain.deleteRepDomain | Optionally used to indicate that the cluster replication domain is to be deleted when the cluster is deleted. | String |
Example usage
AdminTask.submitJob('[-jobType deleteCluster -targetList [DmgrManagedNodeName]
-jobParams [ [clusterName newCluster1] [replicationDomain.deleteRepDomain true] ]]')
createClusterMember
The createClusterMember administrative job creates a cluster member on a cluster, which is in a cell. We must register the dmgr of the cell with a job manager.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| clusterName | Name of the server cluster to which the new cluster member belongs. | String |
| memberConfig.memberNode | Name of node where the new cluster member is to reside. | String |
| memberConfig.memberName | Name of the new cluster member. | String |
| memberConfig.memberWeight | Optionally specifies the weight of the new cluster member. | String |
| memberConfig.memberUUID | Optionally specifies the universal unique identifier (UUID) of the new cluster member. | String |
| memberConfig.genUniquePorts | Optionally specifies to generate unique port numbers for HTTP transports defined in the server. | String |
| memberConfig.replicatorEntry | Optionally specifies that a replicator entry for this member is created in the cluster replication domain. The replicator entry is used for HTTP session data replication. | String |
| firstMember.templateName | Optionally specifies the name of the application server template to use as the model for new cluster members. | String |
| firstMember.templateServerNode | Optionally specifies the name of the node of an existing server to use as a template for new cluster members. | String |
| firstMember.templateServerName | Optionally specifies the name of the server to use as model for new cluster members. | String |
| firstMember.nodeGroup | Optionally specifies the name of the node group to which all cluster member nodes must belong. | String |
| firstMember.coreGroup | Optionally specifies the name of the core group to which all cluster members must belong. | String |
Example usage
AdminTask.submitJob('[-jobType createClusterMember -targetList
[DmgrManagedNodeName] -jobParams [ [memberConfig.memberName newCluster1mem1] [memberConfig.memberNode FederatedNode]
[clusterName newCluster1] ]]')
deleteClusterMember
The deleteClusterMember administrative job deletes a cluster member from a cluster, which is in a cell. We must register the dmgr of the cell with a job manager. The cluster must have at least one cluster member on a federated node.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| clusterName | Name of a server cluster to which the cluster member to be deleted belongs. | String |
| memberNode | Name of the node where the cluster member resides. | String |
| memberName | Server name of the cluster member to be deleted. | String |
| replicatorEntry.deleteEntry | Optionally specifies to delete the replicator entry having the server name of this cluster member from the replication domain of the cluster. | String |
Example usage
AdminTask.submitJob('[-jobType deleteClusterMember -targetList
[DmgrManagedNodeName] -jobParams [ [memberName newCluster1mem1] [memberNode FederatedNode] [clusterName newCluster1]
]]')
configureProperties
The configureProperties administrative job applies a properties file to the application server configuration. This job uses the applyConfigProperties command in the PropertiesBasedConfiguration command group for the AdminTask object to configure the properties for the target.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| propertiesFileLocation | Location of the properties file to apply to the targeted application server.
The path specified for this parameter is the relative path from the PROFILE_ROOT/downloadedContent directory for the dmgr. Create this directory, if it does not already exist, before you start the configureProperties administrative job. | String |
| variableMapLocation | Optionally specifies the location of a variable map file to include with the properties file. | String |
Example usage
AdminTask.submitJob('-jobType configureProperties -targetList
[Target1 Target2 Target3] -jobParams [propertiesFileLocation myProperties.props]')
Submit jobs to manage the server runtime
The system administrator
can use the application server runtime control jobs to start and stop
application servers.
startServer
The startServer administrative job launches and initializes the application server of interest.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| serverName | Application server to start. | String |
| nodeName | If the target of the job is a dmgr node, specify the name of the federated node where the server exists. | String |
Example usage
AdminTask.submitJob('-jobType startServer -targetList [Target1 Target2 Target3]
-jobParams [serverName AppServer01]')
stopServer
The stopServer administrative job stops the application server of interest. Use the startServer job to restart the application server.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| serverName | Application server to stop. | String |
| nodeName | If the target of the job is a dmgr node, specify the name of the federated node where the server exists. | String |
Example usage
AdminTask.submitJob('-jobType stopServer -targetList [Target1 Target2 Target3]
-jobParams [serverName AppServer01]')
startCluster
The startCluster administrative job starts a cluster.
To start a cluster in a cell, register the dmgr of the cell with a job manager.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| clusterName | Name of the cluster to start. | String |
| rippleStart | Optionally specifies whether the cluster is started in a ripple start. The default value is false. | String |
Example usage
The following example starts a cluster:
AdminTask.submitJob('[-jobType startCluster -targetList [DmgrManagedNodeName]
-jobParams [clusterName newCluster1]]')
The following example ripple starts a cluster.
AdminTask.submitJob('[-jobType createCluster -targetList [DmgrManagedNodeName]
-jobParams [ [clusterName newCluster1] [rippleStart true] ]]')
stopCluster
The stopCluster administrative job stops a cluster.
To stop a cluster in a cell, register the dmgr of the cell with a job manager.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| clusterName | Name of the cluster to stop. | String |
Example usage
AdminTask.submitJob('[-jobType stopCluster -targetList [DmgrManagedNodeName]
-jobParams [clusterName newCluster1]]')
Submit a job to run commands
New feature: The system administrator can use the runCommand job of the job manager to run a command on a remote host. The command might be a command-line utility such as startServer in a WAS_HOME/bin directory, a wsadmin command, or an operating system command.New feature:
Job parameters
| Parameter | Description | Type |
|---|---|---|
| command | Name of the command to run. | String |
| workingDir | Location of the command file on the remote host. The default value is the WAS_HOME directory on the remote host. | String |
Example usage
AdminTask.submitJob('-jobType runCommand -targetList Target1 -username user1 -password *******
-jobParams [[command ./versionInfo.sh]]')
(Windows)
AdminTask.submitJob('-jobType runCommand -targetList Target1 -username user1 -password *******
-jobParams [[command versionInfo.bat]]')
AdminTask.submitJob('-jobType runCommand -targetList Target1 -username user1 -password *******
-jobParams [[command "./java -version"][workingDir /opt/IBM/WebSphere/AppServer/java/bin]]')
(Windows)
AdminTask.submitJob('-jobType runCommand -targetList Target1 -username user1 -password *******
-jobParams [[command "java -version"][workingDir C:/WAS_v800/IBM/WebSphere/AppServer/java/bin]]')
Submit a job to manage profiles
New feature: The system administrator can use the manageprofiles job of the job manager to create, augment, or delete a WAS profile. This job runs the manageprofiles administrative command.New feature:
Job parameters
| Parameter | Description | Type |
|---|---|---|
| wasHome | Location of the WAS installation. This is the WAS_HOME path on the remote host. | String |
| responseFile | Location of the manageprofiles response file that resides in the job manager. | String |
| username | User name to use at the targets when the job is run. If the user name and password are not specified, and security is enabled, the user ID at the job manager is used. | String |
| password | Password for the user name to use at the targets when the job is run. If the user name and password are not specified, and security is enabled, the user ID at the job manager is used. | String |
Example usage
AdminTask.submitJob('-jobType manageprofiles -targetList Target1 -username user1 -password *******
-jobParams [[wasHome /WAS80GA][responseFile /temp/mp1.txt]]')
Submit Installation Manager jobs
New feature: The system administrator can use Installation Manager jobs to install Installation Manager instances, update Installation Manager with a repository, manage Installation Manager offerings, and install WAS products.New feature:
IBM Installation Manager 1.4.3 or above is required.
installIM
The installIM administrative job installs a new instance of Installation Manager by sending an installation kit from the job manager to the hosts.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| kitPath | Location of the Installation Manager kit. If not specified, the job finds the most recent IM installation kit from the default location. | String |
| dataPath | Location of the Installation Manager data. | String |
| installPath | Location to install the Installation Manager on the target host. Specify this parameter only if there are multiple installation locations that exist within the current cell on the same host. | String |
| skipPrereqCheck | When set to true, optionally
specifies that no prerequisite checking be performed when installing Installation Manager and that Installation Manager disk space checking
be disabled.
The default value is false. Prerequisite and disk space checking is performed unless the true value is specified. | Boolean |
| acceptLicense | Must be set to true, if you do not specify this parameter, the job will fail. | Boolean |
Example usage
AdminTask.submitJob('-jobType installIM -targetList [Host1 Host2 Host3]
-jobParams [acceptLicense TRUE] [kitPath /IM/agent.installer.zip] -username user1 -password pw')
If you do not specify the IBM Installation Manager installation kit path, the installIM job searches for the most recent IBM Installation Manager installation kit that is suitable for the target platform from the installation kit repository on the job manager. By default, the installation kit repository is WAS_HOME/IMKits.
We can change the location from the job manager. Click Jobs > Installation Manager installation kits, and then change Installation Manager installation kits location to a different location.
updateIM
The updateIM administrative job updates an existing Installation Manager with a repository, rather than send an installation kit from the job manager. This updateIM command requires Installation Manager v1.4 or later.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| repository | Location of the repository to update the Installation Manager. The path can be for a local file on the job manager computer, or a URL that points to a remote file. | String |
| installPath | Location of the Installation Manager installation. | String |
| keyringFile | If the offering repository specified in the response file requires log in, specifies the location of the keyring file to use . If the repository does not require log in, then do not specify this parameter. | String |
| keyringPassword | Optionally specifies the password for the keyring file. If the keyring file does not require a password, then do not specify this parameter. | String |
| acceptLicense | Must be set to true, if you do not specify this parameter, the job will fail. | Boolean |
Example usage
AdminTask.submitJob('-jobType updateIM -targetList [Host1]
-jobParams [acceptLicense TRUE][ [repository /IM/repository] [installPath /IM] ]')
manageOfferings
The manageOfferings administrative job can install, update, modify, rollback or uninstall offerings in Installation Manager. Submit a job that uses an Installation Manager response file and, optionally a keyring file, to manage an offering using a remote repository. By default, the job enforces the specified data location to be an absolute path.
- (Windows) We must begin the path with a drive letter.
- (AIX)
(Solaris) We must begin
the path with /.
To remove this restriction, set the following Java property to true: com.ibm.ws.admin.cimjm.disableDataLocationAbsolutePathCheck=true.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| responseFile | Location of the response file to update, modify, rollback, or uninstall Installation Manager offerings. The path can be for a local file on the job manager computer, or a URL that points to a remote file. | String |
| IMPath | Location of the Installation Manager installation. If this parameter is not specified, the job tries to discover and use the path of the default Installation Manager on the target host. If no Installation Manager is found or more than one Installation Manager is found, the job fails. In this situation, the submitJob manageOfferings command must specify the Installation Manager path. | String |
| keyringFile | Location of the keyring file to use if the offering repository specified in the response file requires log in. If the response file does not require log in, then do not specify this parameter. | String |
| keyringPassword | Optionally specifies the password for the keyring file. If the keyring file does not require a password, then do not specify this parameter. | String |
Example usage
AdminTask.submitJob('-jobType manageOfferings -targetList [Host1 Host2 Host3]
-jobParams [responseFile /IM/agent.installer.zip] -username user1 -password pw')
findIMDataLocation New feature:
The findIMDataLocation administrative job can add or search for Installation Manager data locations.
If a path contains a semicolon (;), enclose the path with double quotes ("). For example: "/opt/my,path";/opt/data1. The job can detect data locations recorded in the Installation Manager registry. On unix platforms, the default registry for a non-administrative installation is located in <userhome>/etc/.ibm/registry. The default registry for an administrative installation is located in /etc/.ibm/registry. You do not need to add data locations that are recorded in the default registry. The job performs the following steps:
- Validates the data locations specified in the "Additional IM data locations field" and the data locations found by the job during search (if search the system is set to true)
- Appends the valid data locations to the existing list of data location for future use
- Removes duplicate data locations
- Runs the inventory job
When the job is finished, the inventory for the target is current.
Job parameters
| Parameter | Description | Type |
|---|---|---|
| targetList | Location of the target systems of the job. | String |
| searchSystem | Specifies CIM to search the entire target system for Installation Manager data locations. | String |
| dataLocations | Location of usable Installation Manager data. The job only lists Installation Manager data locations that are usable to the current target user that is registered on the Administrative Console. | String |
Example usage
AdminTask.submitJob ('[-jobType findDataLocation -targetList targetList -jobParams [[searchSystem true]
[datalocations path_to_data_locations_separated_by_semicolon] ]]')
Administer jobs in a flexible management environment using wsadmin.sh
Register nodes with the job manager using commands
Group nodes in a flexible management environment using wsadmin.sh
Run administrative jobs using wsadmin.sh
Run administrative jobs across multiple nodes using wsadmin.sh
Schedule future administrative jobs using wsadmin.sh
Manage administrative jobs using wsadmin.sh
Related
AdministrativeJobs command group using wsadmin.sh
manageprofiles command
JobManagerNode command group using wsadmin.sh