12.1 Understanding vSphereUpdate Monitor Jobs

In the Orchestration Server Job Scheduler, the vSphereUpdate monitor job is located in the All jobs group. It is associated with both the vsphere provisioning adapter policy (for your vSphere VCenter system configuration information) and the vSphereUpdate policy.

The vSphereUpdate policy specifies the facts defined in Table 12-1. You can modify these facts to accommodate your environment. If you modify the default values, vSphereUpdater uses the preferred values when the job is invoked. Lock the settings to override the default value for all future vSphereUpdate jobs.

For more information about scheduling jobs for the Orchestration Server, see The Orchestration Server Job Scheduler in the Cloud Manager Administrator Reference.

Table 12-1 Cluster-Related Facts in the vSphereUpdate Policy

Fact Name

Type

Description

jobargs.readTimeout

Integer

Specifies amount of time (measured in seconds) that calls to the vSphere vCenter system) wait to read data before timing out. The default value is 0 (zero), which will wait infinitely for data.

The readTimeout option is mainly used for the WaitForUpdates call, which opens a TCP pipe that waits infinitely until an event is available from the vSphere vCenter system. If the vCenter system goes down or reboots, this call blocks infinitely unless a readTimeout fact is set.

jobargs.max.retry.amounts

Integer

Specifies the number of consecutive times to try to reconnect from the vSphereUpdater to the vSphere vCenter system if the connection goes down. It attempts to connect every 5 minutes. The default maximum is 3 retry attempts, for a total wait time of 15 minutes.

If the connection goes down, vSphereUpdater tries to reconnect to the vSphere vCenter system every five minutes up to the maximum number of attempts. After the reconnection attempts have been exhausted, vSphereUpdater exits its process and logs an error for the connection failure.

jobargs.zos.proxy.user

String

Specifies an administrative user used by the Orchestration Console to log in to the Orchestration Server in order to perform update operations there.

You must create an administrative user for this purpose, if you have not already done so.

The name of this user must contain the word “proxy,” for example, my_proxy, or proxy1. When you change the value of this fact, you must restart the Orchestration Server.

For information about configuring the vSphereUpdate Client, see Configuring the vSphereUpdate Client.

jobargs.zos.proxy.passwd_validity

Integer

Specifies the amount of time (measured in seconds) that the zos.proxy.user password is valid.

Example: 86400 (1 day). Although the default value (-1) implies that the password is valid forever, the actual validity time is limited to the uptime of the Orchestration Server.

When the password expires, the Orchestration Console is automatically restarted with a new password the next time that the monitor job runs.

jobargs.debug

Boolean

Specifies whether you want extra verbose debug logging sent to a job log.

NOTE:The client logs its output to the log.txt and err.txt files located in <agent_install_dir>/node.default/.vSphereUpdate/<host name>/<vcenterId>.

jobargs.verbose

Boolean

Specifies whether you want verbose logging sent to a job log.

This fact is implicitly set when jobargs.debug is set.

jobargs.mode

String

Specifies the type of operation to be executed. An empty string (the default) ensures that a vSphereUpdate monitoring process is running on the configured vSphere clients.

There are four other valid values for this string:

  • resetSSL: Clears the SSL certificate stored on the client for the Orchestration server. This is a convenience operation that has security implications

  • stop: Stops any running vSphereUpdate monitoring processes on the configured vSphere clients.

  • kill: Executes an OS level hard stop of the vSphereUpdate monitoring processes.

  • clear: Clears the cached Orchestration user connection information, forcing a reconnection to the Orchestration server.

jobargs.pollInterval

Integer

Specifies the amount of time (measured in seconds) to wait between each check for repository and network changes in vSphere.