+

Search Tips   |   Advanced Search

JobManagerNode (AdminTask)

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

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 WAS v8.0 include cleanupManagedNode, queryManagedNodes, getManagedNodeProperties, modifyManagedNodeProperties, and getManagedNodeKeys. Use commands that have Target in the command names instead.depfeat

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

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

Interactive mode


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

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

Interactive mode


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

Interactive mode


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

Name of the node of interest. (String, optional)

Return value

The command returns a list of the keys.

Batch mode example

Interactive mode


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

Name of the target of interest. (String, optional)

Return value

The command returns a list of the keys.

Batch mode example

Interactive mode


getManagedNodeProperties (deprecated)

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

Target object: None.

Optional parameters

-managedNodeNameList

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

Interactive mode


getTargetProperties

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

Target object: None.

Optional parameters

-targetNameList

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

Interactive mode


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 we can have the managed resources server1, server2, or server3.

Target object: None.

Required parameters

-resourceIdList

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

Interactive mode


getManagedResourcePropertyKeys

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

Target object: None.

Required parameters

-resourceType

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

Interactive mode


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

Interactive mode


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

Name of the node of interest. (String, required)

-managedNodeProps

Name and value property pairs to modify for the node of interest. (Properties, required)

Optional parameters

-replace

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

Interactive mode


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

Name of the target of interest. (String, required)

-targetProps

Name and value property pairs to modify for the target of interest. (Properties, required)

Optional parameters

-replace

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

Interactive mode


queryManagedNodes (deprecated)

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

Target object: None.

Required parameters

-maxReturn

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 not specified, the command returns all managed nodes. (String, optional)

Construct the queries based on the following guidelines:

  • Each query expression consists of the key, operator, and value elements.

  • The following operators are supported:

    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

  • We can specify one value or multiple values separated by commas.

  • We can use pattern matching to specify the value.

-validate

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

Interactive mode


queryTargets

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

Target object: None.

Required parameters

-maxReturn

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 not specified, the command returns all targets. (String, optional)

Construct the queries based on the following guidelines:

  • Each query expression consists of the key, operator, and value elements.

  • The following operators are supported:

    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

  • We can specify one value or multiple values separated by commas.

  • We can use pattern matching to specify the value.

-validate

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

Interactive mode


queryManagedResources

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

Target object: None.

Required parameters

-maxReturn

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 not specified, the command returns all managed nodes. (String, optional)

Construct the queries based on the following guidelines:

  • Each query expression consists of the key, operator, and value elements.

  • The following operators are supported:

    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

  • We can specify one value or multiple values separated by commas.

  • We can use pattern matching to specify the value.

-validate

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

Interactive mode


registerHost

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

We 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

Name of the remote computer to register with the job manager. (String, required)

-hostProps

Properties of the host. We can define any properties we want. The defined properties in the table affect the behavior of the command. (String, required)

-hostProps defined properties. We can specify one or more defined properties for the registerHost 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. 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, we can specify a null String value of "".
privateKeyFile The path to the private keyfile. If we do not specify a value for password, then specify a value for privateKeyFile.
passphrase A passphrase for the privateKeyFile, if needed.
saveSecurity 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. We can enter multiple paths separated by a semicolon. This property is useful if we have non-default Installation Manager data locations on the targets. For example, if specified data locations when installing Installation Manager, CIM's inventory job might not find the non-default data locations. Therefore, we 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. We 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] ]]')

We 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

Interactive mode


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

Name of the remote computer to unregister from the job manager. (String, required)

Optional parameters

None

Return value

None

Batch mode example

Interactive mode


Related tasks

  • Administer jobs in a flexible management environment
  • Registering nodes with the job manager using commands
  • Grouping nodes in a flexible management environment
  • Running administrative jobs
  • Running administrative jobs across multiple nodes
  • Scheduling future administrative jobs
  • Manage administrative jobs

  • AdministrativeJobs (AdminTask)
  • ManagedNodeGroup (AdminTask) (deprecated)
  • ManagedNodeAgent (AdminTask)
  • TargetGroup (AdminTask)