JobManagerNode command group for the AdminTask object using wsadmin scripting (deprecated)

You can use the Jython scripting language to manage job manager settings with the wsadmin tool. Use the commands and parameters in the JobManagerNode group to register targets that do not contain an administrative agent with the job manager.

[8.5.5.14 or later]Deprecated feature: The job manager is deprecated. Instead of job manager, use Urban Code Deploy to install the product, to deploy applications, and to manage remote hosts. To manage WebSphere® Application Server installations, you also can use swinging profiles. See Swinging profiles between product installations.

Use commands that have Target in the command names: cleanupTarget, queryTargets, getTargetProperties, modifyTargetProperties, and getTargetKeys. These commands replace deprecated commands that have ManagedNode in the command names.

Deprecated feature: Commands in the JobManagerNode command group that have ManagedNode in the command names and that were deprecated in WebSphere Application Server Version 8.0 include cleanupManagedNode, queryManagedNodes, getManagedNodeProperties, modifyManagedNodeProperties, and getManagedNodeKeys. Use commands that have Target in the command names instead.
Use the following commands to administer and query managed node, target, and resource configurations:

cleanupManagedNode (deprecated)

The cleanupManagedNode command cleans up registration information for a managed node. If the system fails when removing a node from the job manager, use this command to explicitly clean up the registration information on the job manager. The command does not remove the job history for the node. Jobs in progress continue to run, but new jobs do not start for the node.

Target object

None.

Required parameters

-managedNodeName
Specifies the name of the node of interest. (String, required)

Return value

The command returns the UUID of the job manager that the system cleaned up.

Batch mode example usage

  • Using Jython string: 
    AdminTask.cleanupManagedNode('-managedNodeName Node1')
  • Using Jython list:
    AdminTask.cleanupManagedNode(['-managedNodeName', 'Node1'])

Interactive mode example usage

  • Using Jython:
    AdminTask.cleanupManagedNode('-interactive')

cleanupTarget

The cleanupTarget command cleans up registration information for a target. If the system fails when removing a target from the job manager, use this command to explicitly clean up the registration information on the job manager. The command does not remove the job history for the target. Jobs in progress continue to run, but new jobs do not start for the target.

Target object

None.

Required parameters

-targetName
Specifies the name of the target of interest. (String, required)

Return value

The command returns the UUID of the job manager that the system cleaned up.

Batch mode example usage

  • Using Jython string: 
    AdminTask.cleanupTarget('-targetName Target1')
  • Using Jython list:
    AdminTask.cleanupTarget(['-targetName', 'Target1'])

Interactive mode example usage

  • Using Jython:
    AdminTask.cleanupTarget('-interactive')

getContexts

The getContexts command displays all contexts in the management model, including nodes and servers.

Target object

None.

Required parameters

None.

Return value

The command returns a list of all context paths.

Batch mode example usage

  • Using Jython string: 
    AdminTask.getContexts()
  • Using Jython list:
    AdminTask.getContexts()

Interactive mode example usage

  • Using Jython:
    AdminTask.getContexts('-interactive')

getManagedNodeKeys (deprecated)

The getManagedNodeKeys command displays the keys to use to query for managed nodes, including the name, alias, and uuid keys.

Target object

None.

Optional parameters

-managedNodeName
Specifies the name of the node of interest. (String, optional)

Return value

The command returns a list of the keys.

Batch mode example usage

  • Using Jython string: 
    AdminTask.getManagedNodeKeys('-managedNodeName Node1')
  • Using Jython list:
    AdminTask.getManagedNodeKeys(['-managedNodeName', 'Node1'])

Interactive mode example usage

  • Using Jython:
    AdminTask.getManagedNodeKeys('-interactive')

getTargetKeys

The getTargetKeys command displays the keys to use to query for targets, including the name, alias, and uuid keys.

Target object

None.

Optional parameters

-targetName
Specifies the name of the target of interest. (String, optional)

Return value

The command returns a list of the keys.

Batch mode example usage

  • Using Jython string: 
    AdminTask.getTargetKeys('-targetName Target1')
  • Using Jython list:
    AdminTask.getTargetKeys(['-targetName', 'Target1'])

Interactive mode example usage

  • Using Jython:
    AdminTask.getTargetKeys('-interactive')

getManagedNodeProperties (deprecated)

The getManagedNodeProperties command displays the properties for one or more managed or unmanaged nodes.

Target object

None.

Optional parameters

-managedNodeNameList
Specifies a list of names of the nodes of interest. (String [], optional)

Return value

The command returns a list of properties for each node specified with the -managedNodeNameList parameter.

Batch mode example usage

  • Using Jython string: 
    AdminTask.getManagedNodeProperties('-managedNodeNameList "[Node1 Node2]"')
  • Using Jython list:
    AdminTask.getManagedNodeProperties(['-managedNodeNameList', '[Node1 Node2]'])

Interactive mode example usage

  • Using Jython:
    AdminTask.getManagedNodeProperties('-interactive')

getTargetProperties

The getTargetProperties command displays the properties for one or more targets.

Target object

None.

Optional parameters

-targetNameList
Specifies a list of names of the targets of interest. (String [], optional)

Return value

The command returns a list of properties for each target specified with the -targetNameList parameter.

Batch mode example usage

  • Using Jython string: 
    AdminTask.getTargetProperties('-targetNameList "[Target1 Target2]"')
  • Using Jython list:
    AdminTask.getTargetProperties(['-targetNameList', '[Target1 Target2]'])

Interactive mode example usage

  • Using Jython:
    AdminTask.getTargetProperties('-interactive')

getManagedResourceProperties

The getManagedResourceProperties command displays the properties of one or more managed resources. Managed resources are instances within a node context or server context. For example, within a server context you can have the managed resources server1, server2, or server3.

Target object

None.

Required parameters

-resourceIdList
Specifies a list of unique identifiers for the resources of interest. (String, optional)

Return value

The command returns a list of properties for each managed resource.

Batch mode example usage

  • Using Jython string: 
    AdminTask.getManagedResourceProperties('-resourceIdList AppSrv01-BASE-b83dc35c-69d4-40af-af60-127de7002cfb
/nodes/myNode/servers/server1')
  • Using Jython list:
    AdminTask.getManagedResourceProperties('-resourceIdList', 'AppSrv01-BASE-b83dc35c-69d4-40af-af60-127de7002cfb
/nodes/myNode/servers/server1')

Interactive mode example usage

  • Using Jython:
    AdminTask.getManagedResourceProperties('-interactive')

getManagedResourcePropertyKeys

The getManagedResourcePropertyKeys command displays the property keys for a specific type of managed resources.

Target object

None.

Required parameters

-resourceType
Specifies the type of managed resource of interest. (String, required)

Return value

The command returns a list of managed resource keys for the specific resource type.

Batch mode example usage

  • Using Jython string: 
    AdminTask.getManagedResourcePropertyKeys('-resourceType server')
  • Using Jython list:
    AdminTask.getManagedResourcePropertyKeys('-resourceType', 'server')

Interactive mode example usage

  • Using Jython:
    AdminTask.getManagedResourcePropertyKeys('-interactive')

getManagedResourceTypes

The getManagedResourceTypes command displays each of the managed resource types.

Target object

None.

Required parameters

None.

Return value

The command returns a list of managed resource types.

Batch mode example usage

  • Using Jython string: 
    AdminTask.getManagedResourceTypes()
  • Using Jython list:
    AdminTask.getManagedResourceTypes()

Interactive mode example usage

  • Using Jython:
    AdminTask.getManagedResourceTypes('-interactive')

modifyManagedNodeProperties (deprecated)

The modifyManagedNodeProperties command replaces properties in a managed node configuration. If the managed node has an administrative agent, the command only modifies the alias property. If the managed node does not have an administrative agent, the command replaces all properties.

Target object

None.

Required parameters

-managedNodeName
Specifies the name of the node of interest. (String, required)
-managedNodeProps
Specifies the name and value property pairs to modify for the node of interest. (Properties, required)

Optional parameters

-replace
Specifies whether to replace the existing properties. Specify true to replace the existing properties. Specify false to merge the properties. The default value is false. (Boolean, optional)

Return value

The command does not return output.

Batch mode example usage

  • Using Jython string: 
    AdminTask.modifyManagedNodeProperties('-managedNodeName Node1 -managedNodeProps "[alias myNewAlias]"')
  • Using Jython list:
    AdminTask.modifyManagedNodeProperties('-managedNodeName', 'Node1', '-managedNodeProps', '[alias myNewAlias]')

Interactive mode example usage

  • Using Jython:
    AdminTask.modifyManagedNodeProperties('-interactive')

modifyTargetProperties

The modifyTargetProperties command replaces properties in a target configuration. If the target has an administrative agent, the command only modifies the alias property. If the target does not have an administrative agent, the command replaces all properties.

Target object

None.

Required parameters

-targetName
Specifies the name of the target of interest. (String, required)
-targetProps
Specifies the name and value property pairs to modify for the target of interest. (Properties, required)

Optional parameters

-replace
Specifies whether to replace the existing properties. Specify true to replace the existing properties. Specify false to merge the properties. The default value is false. (Boolean, optional)

Return value

The command does not return output.

Batch mode example usage

  • Using Jython string: 
    AdminTask.modifyTargetProperties('-targetName Target1 -targetProps "[alias myNewAlias]"')
  • Using Jython list:
    AdminTask.modifyTargetProperties('-targetName', 'Target1', '-targetProps', '[alias myNewAlias]')

Interactive mode example usage

  • Using Jython:
    AdminTask.modifyTargetProperties('-interactive')

queryManagedNodes (deprecated)

The queryManagedNodes command searches for managed nodes based on a query expression. If you do not specify a query expression, the command returns all managed nodes.

Target object

None.

Required parameters

-maxReturn
Specifies the maximum number of managed nodes to return. (Integer, required)

Optional parameters

-query
Specifies a query that consists of one or more query expressions separated by spaces. If you do not specify this parameter, the command returns all managed nodes. (String, optional)
Construct your queries based on the following guidelines:
  • Each query expression consists of the key, operator, and value elements.
  • The following operators are supported:
    Table 1. queryManagedNodes -query operators . Use an operator in a query.
    Character Value
    = Equal to. Specify that the value is null by using = NULL.
    != Not equal to. Specify that the value is not null by using != NULL
    > Greater than
    < Less than
    >= Greater than or equal to
    <= Less than or equal to
  • You can specify one value or multiple values separated by commas.
  • You can use pattern matching to specify the value.
-validate
Specifies whether to validate the search query. (Boolean, optional)

Return value

The command returns the number of matches the query found. Secondly, the command returns a list of the managed nodes that met the search query criterion.

Batch mode example usage

  • Using Jython string: 
    AdminTask.queryManagedNodes('-maxReturn 20 -query "managedNodeName=Node1" -validate true')
  • Using Jython list:
    AdminTask.queryManagedNodes(['-maxReturn', '20', '-query', 'managedNodeName=Node1', '-validate', 'true'])

Interactive mode example usage

  • Using Jython:
    AdminTask.queryManagedNodes('-interactive')

queryTargets

The queryTargets command searches for targets based on a query expression. If you do not specify a query expression, the command returns all targets.

Target object

None.

Required parameters

-maxReturn
Specifies the maximum number of targets to return. (Integer, required)

Optional parameters

-query
Specifies a query that consists of one or more query expressions separated by spaces. If you do not specify this parameter, the command returns all targets. (String, optional)
Construct your queries based on the following guidelines:
  • Each query expression consists of the key, operator, and value elements.
  • The following operators are supported:
    Table 2. queryTargets -query operators . Use an operator in a query.
    Character Value
    = Equal to. Specify that the value is null by using = NULL.
    != Not equal to. Specify that the value is not null by using != NULL
    > Greater than
    < Less than
    >= Greater than or equal to
    <= Less than or equal to
  • You can specify one value or multiple values separated by commas.
  • You can use pattern matching to specify the value.
-validate
Specifies whether to validate the search query. (Boolean, optional)

Return value

The command returns the number of matches the query found. Secondly, the command returns a list of the targets that met the search query criterion.

Batch mode example usage

  • Using Jython string: 
    AdminTask.queryTargets('-maxReturn 20 -query "targetName=target1" -validate true')
  • Using Jython list:
    AdminTask.queryTargets(['-maxReturn', '20', '-query', 'targetName=target1', '-validate', 'true'])

Interactive mode example usage

  • Using Jython:
    AdminTask.queryTargets('-interactive')

queryManagedResources

The queryManagedResources command queries your managed resources for specific managed nodes based on a query expression.

Target object

None.

Required parameters

-maxReturn
Specifies the maximum number of managed resources to return. (Integer, required)

Optional parameters

-query
Specifies a query that consists of one or more query expressions separated by spaces. If you do not specify this parameter, the command returns all managed nodes. (String, optional)
Construct your queries based on the following guidelines:
  • Each query expression consists of the key, operator, and value elements.
  • The following operators are supported:
    Table 3. queryManagedResources -query operators . Use an operator in a query.
    Character Value
    = Equal to. Specify that the value is null by using = NULL.
    != Not equal to. Specify that the value is not null by using != NULL
    > Greater than
    < Less than
    >= Greater than or equal to
    <= Less than or equal to
  • You can specify one value or multiple values separated by commas.
  • You can use pattern matching to specify the value.
-validate
Specifies whether to validate the search query. (Boolean, optional)

Return value

The command returns the number of matches the query found. Secondly, the command returns a list of UUIDs of the managed nodes that met the search query criterion.

Batch mode example usage

  • Using Jython string: 
    AdminTask.queryManagedResources('-maxReturn 20 -query "alias=managedNode1"')
  • Using Jython list:
    AdminTask.queryManagedResources('-maxReturn', '20', '-query', '"alias=managedNode1"')

Interactive mode example usage

  • Using Jython:
    AdminTask.queryManagedResources('-interactive')

registerHost

The registerHost command defines a remote host target to the job manager. Use the registerHost command to:

  • Register a remote host target with the job manager. Unlike targets that are WebSphere Application Server profiles and are registered using the registerWithJobManager command at the deployment manager or administrative agent, a remote host target is not required to have any WebSphere Application Server products installed. There are no software requirements for this host beyond its operating system.
  • Collect an inventory of the remote host. Information regarding managed resources and job types is available upon successful completion of the registerHost command.

You can work with remote host targets the same as those that are registered using registerWithJobManager, but the types of jobs available to a remote host target are different.

Target object

None.

Required parameters

-host
Specifies the name of the remote computer to register with the job manager. (String, required)
-hostProps
Specifies the properties of the host. You can define any properties that you want. The defined properties in the table affect the behavior of the command. (String, required)
Table 4. registerHost -hostProps defined properties . You can specify one or more defined properties for the registerHost command, or specify undefined properties for the command.
Property name Property description
osType The operating system type. Specify osType to enable the command to complete faster. This optional property determines the means for connecting with the host. Valid values are:
  • aix
  • hpux
  • os400
  • linux
  • solaris
  • windows
  • os390
username A user with authority to log in to the host. This property is required.
password The password for the given username. A value for password or privateKeyFile must be specified. If the host does not require a password, you can specify a null String value of "".
privateKeyFile The path to the private keyfile. If you do not specify a value for password, then you must specify a value for privateKeyFile.
passphrase A passphrase for the privateKeyFile, if needed.
saveSecurity Specifies whether to store security properties (username, password, privateKeyFile, passphrase) with the host and used as default values for job submissions. If this property is given a value of true, then the security properties are stored with the host and used for subsequent job submissions to this host.

Optional parameters

-imDataLocations
Enter the fully qualified path of the Installation Manager data locations. You can enter multiple paths separated by a semicolon. This property is useful if you have non-default Installation Manager data locations on your targets. For example, if you specified data locations when installing Installation Manager, CIM's inventory job might not find the non-default data locations. Therefore, you might need to specify additional data locations when registering a host. If an invalid data location is specified, it will not be saved. If the specified data location can be detected by the inventory job, it will not be saved. You can also use the find data location job to search for data locations on the system. The find data location job automatically updates this property. For example:
AdminTask.registerHost('[-host hostname -hostProps [ [imDataLocations datalocation1; datalocation2] 
[password ****] [saveSecurity true] [username username] ]]')
You can use the registerHost command to specify paths for Liberty profile variables; for example:
AdminTask.registerHost('-host hostname -hostProps [ [username admin][password password][saveSecurity true]
 [WLP_WORKING_DIR C:/working][WLP_SHARED_DIR C:/shared][WLP_ADDITIONAL_DIRS C:/addl] ]')

Return value

The command returns an inventory of the remote host.

Batch mode example usage

  • Using Jython string: 
    AdminTask.registerHost('-host myHost.acme.com -hostProps [ [osType linux][username root]
 [privateKeyFile /root/.ssh/id_dsa] [passphrase myPassphrase] [saveSecurity true] ]')
  • Using Jython list:
    AdminTask.registerHost('-host', 'myHost.acme.com', '-hostProps', '[ [osType linux] [username root]
 [privateKeyFile /root/.ssh/id_dsa] [passphrase myPassphrase] [saveSecurity true]' ]')

Interactive mode example usage

  • Using Jython:
    AdminTask.registerHost('-interactive')

unregisterHost

The unregisterHost command removes the remote host from the job manager. Use the unregisterHost command to unregister a remote host target from the job manager. After a host is unregistered, the job manager cannot run jobs on the target.

Target object

None.

Required parameters

-host
Specifies the name of the remote computer to unregister from the job manager. (String, required)

Optional parameters

None

Return value

None

Batch mode example usage

  • Using Jython string: 
    AdminTask.unregisterHost('-host myHost.acme.com')
  • Using Jython list:
    AdminTask.unregisterHost('-host', 'myHost.acme.com')

Interactive mode example usage

  • Using Jython:
    AdminTask.unregisterHost('-interactive')