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

You can use the Jython scripting language to configure the job manager with the wsadmin tool. Use the commands and parameters in the ManagedNodeAgent group to configure, query, and manage your job manager configuration for managed nodes.

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 the following commands to configure managed node agents for the job manager:

getRuntimeRegistrationProperties
isPollingJobManager
listJobManagers
registerWithJobManager
setRuntimeRegistrationProperties
startPollingJobManager
stopPollingJobManager
unregisterWithJobManager

getRuntimeRegistrationProperties

The getRuntimeRegistrationProperties command displays runtime properties for a managed node and respective job manager.

Target object

None.

Required parameters

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

Optional parameters

-jobManagerUUID: Specifies the UUID of the job manager of interest. (String, optional)
-host: Specifies the host name to use to identify the job manager. The default value is localhost. (String, optional)
-port: Specifies the administrative console port number to use to identify the job manager. If security is enabled, use the secure port number. If security is disabled, use the unsecure port number. The default secure port number is 9943, and the default unsecure port number is 9960. (String, optional)

If the node is registered with more than one job manager, use either the jobManagerUUID parameter or the host and port parameters to specify the job manager. If the node is registered with one job manager only, you can omit all of these optional parameters.

Return value

Batch mode example usage

Using Jython string:

AdminTask.getRuntimeRegistrationProperties('-managedNodeName myJobManagedNode -jobManagerUUID myJobMgrKey')

Using Jython list:

AdminTask.getRuntimeRegistrationProperties('-managedNodeName', 'myJobManagedNode',
 '-jobManagerUUID', 'myJobMgrKey')

Interactive mode example usage

Using Jython:

AdminTask.getRuntimeRegistrationProperties('-interactive')

isPollingJobManager

The isPollingJobManager command determines whether a managed node is polling a job manager.

Target object

None.

Required parameters

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

Optional parameters

-jobManagerUUID: Specifies the UUID of the job manager of interest. (String, optional)
-host: Specifies the host name to use to identify the job manager. The default value is localhost. (String, optional)
-port: Specifies the administrative console port number to use to identify the job manager. If security is enabled, use the secure port number. If security is disabled, use the unsecure port number. The default secure port number is 9943, and the default unsecure port number is 9960. (String, optional)

Use either the jobManagerUUID parameter or the host and port parameters to specify the job manager. If the system is registered with one job manager only, you can omit all of these optional parameters.

Return value

The command returns true if polling is enabled or false if polling is not enabled.

Batch mode example usage

Using Jython string:

AdminTask.isPollingJobManager('-managedNodeName myJobManagedNode -jobManagerUUID myJobMgrKey')

Using Jython list:

AdminTask.isPollingJobManager('-managedNodeName', 'myJobManagedNode', '-jobManagerUUID', 'myJobMgrKey')

Interactive mode example usage

Using Jython:

AdminTask.isPollingJobManager('-interactive')

listJobManagers

The listJobManagers command lists each job manager that a specific managed is registered with.

Target object

None.

Required parameters

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

Optional parameters

-jobManagerUUID: Specifies the UUID of the job manager of interest. (String, optional)
-host: Specifies the host name to use to identify the job manager. The default value is localhost. (String, optional)
-port: Specifies the administrative console port number to use to identify the job manager. If security is enabled, use the secure port number. If security is disabled, use the unsecure port number. The default secure port number is 9943, and the default unsecure port number is 9960. (String, optional)

Return value

The command returns a list of job manager properties, including the UUID and host name for the job manager. Depending on the properties defined during managed node registration, the command also might display the port number, connection type, and user name. The value of the password property is not displayed.

Batch mode example usage

Using Jython string:

AdminTask.listJobManagers('-managedNodeName myJobManagedNode')

Using Jython list:

AdminTask.listJobManagers('-managedNodeName', 'myJobManagedNode')

Interactive mode example usage

Using Jython:

AdminTask.listJobManagers('-interactive')

registerWithJobManager

The registerWithJobManager command registers a managed node or deployment manager with the job manager.

Target object

None.

Required parameters

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

Optional parameters

-host: Specifies the host name of the job manager. The default value is localhost. (String, optional)
-port: Specifies the job manager administrative console port number. If security is enabled, use the secure port number. If security is disabled, use the unsecure port number. The default secure port number is 9943, and the default unsecure port number is 9960. (String, optional)
-user: Specifies the user name to log into the job manager. The user must have Administrator role for the job manager. (String, optional)
-password: Specifies the password to log into the job manager. (String, optional)
-alias: Specifies the alias of the managed node to enroll. (String, optional)
-startPolling: Specifies whether the system polls the job manager after it enrolls the managed node. (Boolean, optional)
-autoAcceptSigner: Specifies whether to automatically accept the signer provided by the server. Specify false to disable this option. The default value is true. (Boolean, optional)

Return value

The command returns the configuration ID of the job manager, as the following output displays:

'JobMgr-JOB_MANAGER-2f7d5a29-e601-417b-9124-7737be64dd0a'

Batch mode example usage

Using Jython string:

AdminTask.registerWithJobManager('[-host myJobMgrHostname -managedNodeName myJobManagedNode -alias endpoint1]')

Using Jython list:

AdminTask.registerWithJobManager(['-host', 'myJobMgrHostname', '-managedNodeName myJobManagedNode',
 '-alias', 'endpoint1'])

Interactive mode example usage

Using Jython:

AdminTask.registerWithJobManager('-interactive')

setRuntimeRegistrationProperties

The setRuntimeRegistrationProperties command sets runtime properties for managed nodes and job managers.

Target object

None.

Optional parameters

-managedNodeName: Specifies the name of the managed node of interest. If you do not specify the UUID, the system applies the properties to each managed node. (String, optional)
-jobManagerUUID: Specifies the UUID of the job manager of interest. If you do not specify the jobManagerUUID parameter, the system applies the properties to each job manager. (String, optional)
-host: Specifies the host name to use to identify the job manager. The default value is localhost. (String, optional)
-port: Specifies the administrative console port number to use to identify the job manager. If security is enabled, use the secure port number. If security is disabled, use the unsecure port number. The default secure port number is 9943, and the default unsecure port number is 9960. (String, optional)
-interval: Specifies the interval, in seconds, that the system waits before the managed node of interest polls the job manager. (String, optional)
-size: Specifies the maximum size of the thread pool per managed node. (String, optional)

Return value

The command does not return output.

Batch mode example usage

Using Jython string:

AdminTask.setRuntimeRegistrationProperties('-managedNodeName myJobManagedNode 
 -jobManagerUUID myJobMgrKey -interval 600')

Using Jython list:

AdminTask.setRuntimeRegistrationProperties('-managedNodeName', 'myJobManagedNode', 
 '-jobManagerUUID', 'myJobMgrKey', '-interval', '600')

Interactive mode example usage

Using Jython:

AdminTask.setRuntimeRegistrationProperties('-interactive')

startPollingJobManager

The startPollingJobManager command instructs a managed node to begin polling the job manager.

Target object

None.

Required parameters

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

Optional parameters

-jobManagerUUID: Specifies the UUID of the job manager of interest. (String, optional)
-host: Specifies the host name to use to identify the job manager. The default value is localhost. (String, optional)
-port: Specifies the administrative console port number to use to identify the job manager. If security is enabled, use the secure port number. If security is disabled, use the unsecure port number. The default secure port number is 9943, and the default unsecure port number is 9960. (String, optional)

Return value

The command does not return output.

Batch mode example usage

Using Jython string:

AdminTask.startPollingJobManager('-managedNodeName myJobManagedNode -jobManagerUUID myJobMgrKey')

Using Jython list:

AdminTask.startPollingJobManager('-managedNodeName', 'myJobManagedNode', '-jobManagerUUID', 'myJobMgrKey')

Interactive mode example usage

Using Jython:

AdminTask.startPollingJobManager('-interactive')

stopPollingJobManager

The stopPollingJobManager command instructs a managed node to stop polling the job manager.

Target object

None.

Required parameters

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

Optional parameters

-jobManagerUUID: Specifies the UUID of the job manager of interest. (String, optional)
-host: Specifies the host name to use to identify the job manager. The default value is localhost. (String, optional)
-port: Specifies the administrative console port number to use to identify the job manager. If security is enabled, use the secure port number. If security is disabled, use the unsecure port number. The default secure port number is 9943, and the default unsecure port number is 9960. (String, optional)

Return value

The command does not return output.

Batch mode example usage

Using Jython string:

AdminTask.stopPollingJobManager('-managedNodeName myJobManagedNode -jobManagerUUID myJobMgrKey')

Using Jython list:

AdminTask.stopPollingJobManager('-managedNodeName', 'myJobManagedNode', '-jobManagerUUID', 'myJobMgrKey')

Interactive mode example usage

Using Jython:

AdminTask.stopPollingJobManager('-interactive')

unregisterWithJobManager

The unregisterWithJobManager command removes the managed node registration from the job manager configuration.

Target object

None.

Required parameters

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

Optional parameters

-host: Specifies the host name of the job manager. The default value is localhost. (String, optional)
-port: Specifies the job manager administrative console port number. If security is enabled, use the secure port number. If security is disabled, use the unsecure port number. The default secure port number is 9943, and the default unsecure port number is 9960. (String, optional)
-user: Specifies the user name to log into the job manager. The user must have Administrator role for the job manager. (String, optional)
-password: Specifies the password to log into the job manager. (String, optional)

Return value

The command returns the configuration ID of the job manager, as the following output displays:

'JobMgr-JOB_MANAGER-0aa85922-bd9a-4ca6-b72c-467cd256b9b3'

Batch mode example usage

Using Jython string:

AdminTask.unregisterWithJobManager('[-host myJobMgrHostname -port 8989 -managedNodeName myJobManagedNode]')

Using Jython list:

AdminTask.unregisterWithJobManager(['-host', 'myJobMgrHostname', '-managedNodeName', 'myJobManagedNode'])

Interactive mode example usage

Using Jython:

AdminTask.unregisterWithJobManager('-interactive')