vrClusterManagerService

class vrClusterManagerService

(Inherits vrBaseService)

A service to control cluster manager functions.

A cluster manager allows to manage cluster resources for multple users. The cluster service provides functions to send the currently loaded project to a cluster manager for rendering.

Sending the current project to a cluster manager for offline rendering

vrClusterManagerService.login("pc1","tom","XXX")
vrClusterManagerService.sendToJobQueue(vrClusterTypes.JobType.Images,"batchQueue")
vrClusterManagerService.logoff();

Summary

Functions:

• getJobQueuesNames() → List[string]
• getSessionBookingId() → string
• isManagerConnected() → bool
• login(server, user, passwd) → bool
• logoff()
• sendToJobQueue(type, jobQueue) → bool
• startSession(bookingId) → bool

Signals:

• disconnected()
• sessionEnded()
• sessionEndWarning(seconds)
• sessionStarting(seconds)

Functions

vrClusterManagerService.getJobQueuesNames()

Returns:Returns a list cluster manager queues Return type:List[string]

vrClusterManagerService.getSessionBookingId()

Returns:Returns the current cluster session booking id Return type:string

vrClusterManagerService.isManagerConnected()

Returns:Returns true, if the user has logged in to a cluster manager Return type:bool

vrClusterManagerService.login(server, user, passwd)

Try to login to a cluster manager.

Parameters:

• server (string) – Server name or IP address
• user (string) – User name
• passwd (string) – Password

Returns:

True, if login was successful

Return type:

bool

vrClusterManagerService.logoff()

Logoff from cluster manager.

vrClusterManagerService.sendToJobQueue(type, jobQueue)

Send the current project to a cluster manager queue.

Parameters:

• type (vrClusterTypes.JobType) – Type of job to add
• jobQueue (string) – The name of the target queue

Returns:

True on success

Return type:

bool

vrClusterManagerService.startSession(bookingId)

Starts a new session booked in the cluster manager module.

Parameters:bookingId (string) – The booking id managed by the cluster manager Returns:True, if session started successfully Return type:bool

Signals

vrClusterManagerService.disconnected()

Signal emitted when a user has signed off from the cluster manager.

vrClusterManagerService.sessionEnded()

Signal indicates a cluster manager session end.

vrClusterManagerService.sessionEndWarning(seconds)

Signal indicates a cluster manager session ends soon.

Parameters:seconds (float) – Number of seconds until session end

vrClusterManagerService.sessionStarting(seconds)

Signal indicates a cluster manager session starts soon.

Parameters:seconds (float) – Number of seconds until session start