ManagedNodeAgent (AdminTask)

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

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

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

Optional parameters

-jobManagerUUID

Specifies the UUID of the job manager of interest. (String, optional)

-host

Host name to use to identify the job manager. The default value is localhost. (String, optional)

-port

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, we can omit all of these optional parameters.

Return value

Batch mode example

• Jython string...
  AdminTask.getRuntimeRegistrationProperties('-managedNodeName myJobManagedNode -jobManagerUUID myJobMgrKey')

• Jython list:
  AdminTask.getRuntimeRegistrationProperties('-managedNodeName', 'myJobManagedNode', '-jobManagerUUID', 'myJobMgrKey')

Interactive mode

• Jython:
  AdminTask.getRuntimeRegistrationProperties('-interactive')

isPollingJobManager

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

Target object: None.

Required parameters

-managedNodeName

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

Optional parameters

-jobManagerUUID

Specifies the UUID of the job manager of interest. (String, optional)

-host

Host name to use to identify the job manager. The default value is localhost. (String, optional)

-port

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, we 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

• Jython string...
  AdminTask.isPollingJobManager('-managedNodeName myJobManagedNode -jobManagerUUID myJobMgrKey')

• Jython list:
  AdminTask.isPollingJobManager('-managedNodeName', 'myJobManagedNode', '-jobManagerUUID', 'myJobMgrKey')

Interactive mode

• 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

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

Optional parameters

-jobManagerUUID

Specifies the UUID of the job manager of interest. (String, optional)

-host

Host name to use to identify the job manager. The default value is localhost. (String, optional)

-port

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, we can omit all of these optional parameters.

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

• Jython string...
  AdminTask.listJobManagers('-managedNodeName myJobManagedNode')

• Jython list:
  AdminTask.listJobManagers('-managedNodeName', 'myJobManagedNode')

Interactive mode

• 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

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

Optional parameters

-host

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

User name to log into the job manager. The user must have Administrator role for the job manager. (String, optional)

-password

Password to log into the job manager. (String, optional)

-alias

Alias of the managed node to enroll. (String, optional)

-startPolling

Whether the system polls the job manager after it enrolls the managed node. (Boolean, optional)

-autoAcceptSigner

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

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

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

Interactive mode

• Jython:
  AdminTask.registerWithJobManager('-interactive')

setRuntimeRegistrationProperties

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

Target object: None.

Optional parameters

-managedNodeName

Name of the managed node of interest. If we 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 we do not specify the jobManagerUUID parameter, the system applies the properties to each job manager. (String, optional)

-host

Host name to use to identify the job manager. The default value is localhost. (String, optional)

-port

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

Interval, in seconds, that the system waits before the managed node of interest polls the job manager. (String, optional)

-size

Maximum size of the thread pool per managed node. (String, optional)

Return value

The command does not return output.

Batch mode example usage

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

• Jython list:
  AdminTask.setRuntimeRegistrationProperties('-managedNodeName', 'myJobManagedNode', '-jobManagerUUID', 'myJobMgrKey', '-interval', '600')

Interactive mode

• Jython:
  AdminTask.setRuntimeRegistrationProperties('-interactive')

startPollingJobManager

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

Target object: None.

Required parameters

-managedNodeName

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

Optional parameters

-jobManagerUUID

Specifies the UUID of the job manager of interest. (String, optional)

-host

Host name to use to identify the job manager. The default value is localhost. (String, optional)

-port

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, we can omit all of these optional parameters.

Return value

The command does not return output.

Batch mode example usage

• Jython string...
  AdminTask.startPollingJobManager('-managedNodeName myJobManagedNode -jobManagerUUID myJobMgrKey')

• Jython list:
  AdminTask.startPollingJobManager('-managedNodeName', 'myJobManagedNode', '-jobManagerUUID', 'myJobMgrKey')

Interactive mode

• Jython:
  AdminTask.startPollingJobManager('-interactive')

stopPollingJobManager

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

Target object: None.

Required parameters

-managedNodeName

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

Optional parameters

-jobManagerUUID

Specifies the UUID of the job manager of interest. (String, optional)

-host

Host name to use to identify the job manager. The default value is localhost. (String, optional)

-port

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, we can omit all of these optional parameters.

Return value

The command does not return output.

Batch mode example usage

• Jython string...
  AdminTask.stopPollingJobManager('-managedNodeName myJobManagedNode -jobManagerUUID myJobMgrKey')

• Jython list:
  AdminTask.stopPollingJobManager('-managedNodeName', 'myJobManagedNode', '-jobManagerUUID', 'myJobMgrKey')

Interactive mode

• Jython:
  AdminTask.stopPollingJobManager('-interactive')

unregisterWithJobManager

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

Target object

None.

Required parameters

-managedNodeName

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

Optional parameters

-host

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

User name to log into the job manager. The user must have Administrator role for the job manager. (String, optional)

-password

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

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

• Jython list:
  AdminTask.unregisterWithJobManager(['-host', 'myJobMgrHostname', '-managedNodeName', 'myJobManagedNode'])

Interactive mode

• Jython:
  AdminTask.unregisterWithJobManager('-interactive')

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)

JobManagerNode (AdminTask)