Deadline Scripting Reference  8.0.19.4
Deadline.Scripting.RepositoryUtils Class Reference

Repository utility functions. More...

Static Public Member Functions

static void AddAuxiliaryFile (Job job, string[] newAuxFilePath)
 Adds an aux file to the specified job. More...
 
static void AddBadSlaveForJob (Job job, string slaveName)
 Adds a slave to a job's Bad Slave list. More...
 
static void AddGroup (string groupName)
 Adds a group to the repository. More...
 
static void AddGroupToSlave (string slaveName, string groupName)
 Adds a group to the given slave. More...
 
static void AddJobHistoryEntry (string jobId, string entry)
 Adds a job history entry. More...
 
static void AddPool (string poolName)
 Adds a pool to the repository. More...
 
static void AddPoolToSlave (string slaveName, string poolName)
 Adds a pool to the given slave. More...
 
static void AddRepositoryHistoryEntry (string entry)
 Adds a repository history entry. More...
 
static void AddSlaveHistoryEntry (string slaveName, string entry)
 Adds a slave history entry. More...
 
static void AddSlavesToLimitGroupList (string name, object slaveNames)
 Adds slaves to a limit group's list of slaves. More...
 
static void AddSlavesToMachineLimitList (string jobId, object slaveNames)
 Adds slaves to a job machine limit's list of slaves. More...
 
static void AddUsersToUserGroups (string[] users, string[] userGroups)
 Adds all the users given to the provided user groups. More...
 
static void AppendJobFrameRange (Job job, string frameList)
 Appends to a job's frame range without affecting the existing tasks. The only exception is if the job's chunk size is greater than one, and the last task is having frames appended to it. More...
 
static void ArchiveJob (Job job, bool deleteFromDB, string archiveFolderOverride)
 Archive a non-queued, non-rendering job. More...
 
static bool BalancerExists (string balancerName)
 Checks whether or not a Balancer with the given name exists. More...
 
static string CheckPathMapping (string path)
 Performs path mapping on the given path. Uses the path mappings in the Repository Options. More...
 
static string CheckPathMapping (string path, bool verbose)
 Performs path mapping on the given path. Uses the path mappings in the Repository Options. More...
 
static void CheckPathMappingInFile (string inFileName, string outFileName)
 Performs path mapping on the contents of the given file. Uses the path mappings in the Repository Options. More...
 
static void CheckPathMappingInFile (string inFileName, string outFileName, bool readFileAsBytes)
 Performs path mapping on the contents of the given file. Uses the path mappings in the Repository Options. More...
 
static void CheckPathMappingInFileAndReplace (string inFileName, string outFileName, string[] stringsToReplace, string[] newStrings)
 Performs path mapping on the contents of the given file, and replaces a list of given strings in any paths that are mapped. Uses the path mappings in the Repository Options. More...
 
static void CheckPathMappingInFileAndReplace (string inFileName, string outFileName, string[] stringsToReplace, string[] newStrings, bool readFileAsBytes)
 Performs path mapping on the contents of the given file, and replaces a list of given strings in any paths that are mapped. Uses the path mappings in the Repository Options. More...
 
static void CheckPathMappingInFileAndReplaceSeparator (string inFileName, string outFileName, string separatorToReplace, string newSeparator)
 Performs path mapping on the contents of the given file, and updates all path separators in any paths that are mapped. Uses the path mappings in the Repository Options. More...
 
static void CheckPathMappingInFileAndReplaceSeparator (string inFileName, string outFileName, string separatorToReplace, string newSeparator, bool readFileAsBytes)
 Performs path mapping on the contents of the given file, and updates all path separators in any paths that are mapped. Uses the path mappings in the Repository Options. More...
 
static void CompleteJob (Job job)
 Completes a job. All incomplete tasks for the job will be marked as complete. More...
 
static bool CompleteTasks (Job job, Task[] tasks, string slaveName)
 Complete tasks for a job. More...
 
static void CreateJobSubmissionFiles (Job job, string jobInfoFileName, string pluginInfoFileName)
 Creates the job info and plugin info files that were originally used to submit the given job. More...
 
static void DeleteAllBadSlavesForJob (Job job)
 Deletes all slaves from a job's Bad Slave list. More...
 
static void DeleteAllJobReports (string jobId)
 Deletes all reports for a job. More...
 
static void DeleteAllSlaveReports (string slaveName)
 Deletes all reports for a slave. More...
 
static void DeleteBadSlaveForJob (Job job, string slaveName)
 Deletes a slave from a job's Bad Slave list. More...
 
static void DeleteBadSlavesForJob (Job job, object slaveNames)
 Deletes a list of slaves from a job's Bad Slave list. More...
 
static void DeleteBalancer (string balancerName)
 Deletes a specified Balancer. More...
 
static void DeleteGroup (string groupName)
 Removes a group from the repository. More...
 
static void DeleteJob (Job job)
 Delete a job. More...
 
static void DeleteJobReport (string jobId, Report report)
 Deletes the given report for a job. More...
 
static void DeleteJobReports (string jobId, Report[] reports)
 Deletes the given reports for a job. More...
 
static void DeletePool (string poolName)
 Removes a pool from the repository. More...
 
static void DeletePostJobScript (Job job)
 Deletes the jobs post job script. More...
 
static void DeletePreJobScript (Job job)
 Deletes the jobs pre job script. More...
 
static void DeleteProxyServer (string proxyName)
 Delete the specified Proxy Server. More...
 
static void DeletePulse (string pulseName)
 Delete the specified pulse. More...
 
static void DeleteSlave (string slaveName)
 Deletes a specified slave. More...
 
static void DeleteSlaveReport (string slaveName, Report report)
 Deletes the given report for a slave. More...
 
static void DeleteSlaveReports (string slaveName, Report[] reports)
 Deletes the given reports for a slave. More...
 
static void DeleteUserGroup (string userGroupName)
 Deletes a user groups. More...
 
static void FailJob (Job job)
 Fails a job. All incomplete tasks for the job will be marked as failed. More...
 
static bool FailTasks (Job job, Task[] tasks)
 Fail tasks for a job. More...
 
static string GetAlternateAuxiliaryPath ()
 Gets the alternate auxiliary file directory based on the current operating system. More...
 
static string GetAPISyncFolder ()
 Gets the pythonsync folder. More...
 
static BalancerInfo GetBalancerInfo (string balancerName, bool invalidateCache)
 Gets a balancer info. More...
 
static BalancerInfo[] GetBalancerInfos (bool invalidateCache)
 Gets all the balancer infos. More...
 
static BalancerInfo[] GetBalancerInfos (string[] balancerNames, bool invalidateCache)
 Gets a list of balancer infos. More...
 
static BalancerInfoSettings[] GetBalancerInfoSettings (bool invalidateCache)
 Gets all the balancer info settings. More...
 
static BalancerInfoSettings[] GetBalancerInfoSettings (string[] balancerNames, bool invalidateCache)
 Gets a list of balancer info settings. More...
 
static string[] GetBalancerNames (bool invalidateCache)
 Gets all the balancer names. More...
 
static BalancerSettings GetBalancerSettings (string balancerName, bool invalidateCache)
 Gets settings for a balancer. More...
 
static BalancerSettings[] GetBalancerSettingsList (bool invalidateCache)
 Gets all the balancer settings. More...
 
static BalancerSettings[] GetBalancerSettingsList (string[] balancerNames, bool invalidateCache)
 Gets a list of balancer settings. More...
 
static string GetBinDirectory ()
 Gets the repository bin directory. More...
 
static string GetCloudPluginsDirectory ()
 Gets the repository cloud plugins directory. More...
 
static string GetCustomEventsDirectory ()
 Gets the repository custom events directory. More...
 
static string GetCustomPluginsDirectory ()
 Gets the repository custom plugins directory. More...
 
static string GetCustomScriptsDirectory ()
 Gets the repository custom scripts directory. More...
 
static string GetDatabaseConnectionString ()
 Gets the database connection string in the form of (server:port,server:port...). If there is only one server configured, it will be in the form of (server:port). More...
 
static Job GetDeletedJob (string jobId)
 Gets a deleted job. More...
 
static string[] GetDeletedJobIds ()
 Gets all the deleted job IDs. More...
 
static Job[] GetDeletedJobs ()
 Gets all the deleted jobs. More...
 
static PluginConfig GetEventPluginConfig (string eventPluginName)
 Gets the configuration settings for an event plugin. More...
 
static string GetEventPluginDirectory (string eventPluginName)
 Returns the directory in which the given event plugin is located. More...
 
static string[] GetEventPluginNames ()
 Gets the event plugin names. More...
 
static string GetEventsDirectory ()
 Gets the repository events directory. More...
 
static string[] GetGroupNames ()
 Gets the group names. More...
 
static Job GetJob (string jobId, bool invalidate)
 Gets a job. More...
 
static string GetJobAuxiliaryPath (Job job)
 Gets the auxiliary file directory for the given job. More...
 
static Dictionary< string, Dictionary< string, Dictionary< string, string > > > GetJobDetails (Job[] jobs)
 Gets a dictionary of job details for the provided jobs. More...
 
static string[] GetJobIds (bool invalidateCache)
 Gets all the job IDs. More...
 
static string[] GetJobIds ()
 Gets the job IDs. For Web Service scripts only. More...
 
static string GetJobReportLog (Report report)
 Gets the report log for a job report. More...
 
static string GetJobReportLogFileName (Report report)
 Gets the full path to the report log file for a job report. Note that the file is a bzip file. More...
 
static JobReportCollection GetJobReports (string jobId)
 Gets the reports for a job. More...
 
static Job[] GetJobs (bool invalidateCache)
 Gets all the jobs. More...
 
static Job[] GetJobs (string[] jobIds, bool invalidate)
 Gets a list of jobs. More...
 
static Job[] GetJobsInState (object states)
 Gets all the jobs in the given state(s). More...
 
static int GetJobTaskLimit ()
 Gets the job task limit. More...
 
static TaskCollection GetJobTasks (Job job, bool invalidate)
 Gets the tasks for a job. More...
 
static LimitGroup GetLimitGroup (string limitGroupName, bool invalidate)
 Gets a limit group. More...
 
static string[] GetLimitGroupNames (bool invalidateCache)
 Gets all the limit group names. More...
 
static LimitGroup[] GetLimitGroups (string[] limitGroupNames, bool invalidate)
 Gets a list of limit groups. More...
 
static LimitGroup[] GetLimitGroups (bool invalidate)
 Gets all the limit groups. More...
 
static string GetLinuxAlternateAuxiliaryPath ()
 Gets the alternate auxiliary file directory for Linux. More...
 
static string GetMacAlternateAuxiliaryPath ()
 Gets the alternate auxiliary file directory for Mac OSX. More...
 
static LimitGroup GetMachineLimit (string jobId, bool invalidate)
 Gets the machine limit for a job. More...
 
static string[] GetMachinesRenderingJob (string jobId, bool ipAddresses)
 Gets the host names of the machines rendering the specified job. More...
 
static string[] GetMachinesRenderingJob (string jobId, bool ipAddresses, bool duplicates)
 Gets the host names of the machines rendering the specified job. More...
 
static int GetMaximumPriority ()
 Gets the maximum job priority. More...
 
static IDeadlineNetworkSettings GetNetworkSettings ()
 Gets the network settings. More...
 
static string[][] GetPathMappings ()
 Gets the list of relevant path mappings as defined in Repository Options. More...
 
static PluginConfig GetPluginConfig (string pluginName)
 Gets the configuration settings for a plugin. More...
 
static PluginConfig GetPluginConfig (string pluginName, string altCustomPluginDirectory)
 Gets the configuration settings for a plugin. More...
 
static string GetPluginDirectory (string pluginName)
 Returns the directory in which the given plugin is located. More...
 
static string[] GetPluginNames ()
 Gets the plugin names. More...
 
static string GetPluginsDirectory ()
 Gets the repository plugins directory. More...
 
static string[] GetPoolNames ()
 Gets the pool names. More...
 
static PowerManagementOptions GetPowerManagementOptions ()
 Gets the power management options. More...
 
static ProxyServerInfo GetProxyServerInfo (string proxyName, bool invalidateCache)
 Gets ProxyServerInfo for a specified Proxy Server. More...
 
static ProxyServerInfo[] GetProxyServerInfos (bool invalidateCache)
 Gets ProxyServerInfo objects for all Proxy Servers. More...
 
static ProxyServerInfo[] GetProxyServerInfos (string[] proxyNames, bool invalidateCache)
 Gets ProxyServerInfo objects for all specified Proxy Servers. More...
 
static ProxyServerInfoSettings[] GetProxyServerInfoSettings (bool invalidateCache)
 Gets ProxyServerInfoSettings objects for all Proxy Servers. More...
 
static ProxyServerInfoSettings[] GetProxyServerInfoSettings (string[] proxyNames, bool invalidateCache)
 Gets ProxyServerInfoSettings objects for all specified Proxy Servers. More...
 
static string[] GetProxyServerNames (bool invalidateCache)
 Gets all the Proxy Server names. More...
 
static ProxyServerSettings GetProxyServerSettings (string proxyName, bool invalidateCache)
 Gets ProxyServerSettings for a specified Proxy Server. More...
 
static ProxyServerSettings[] GetProxyServerSettingsList (bool invalidateCache)
 Gets ProxyServerSettings objects for all Proxy Servers. More...
 
static ProxyServerSettings[] GetProxyServerSettingsList (string[] proxyNames, bool invalidateCache)
 Gets ProxyServerSettings objects for all specified Proxy Servers. More...
 
static PulseInfo GetPulseInfo (string pulseName, bool invalidateCache)
 Gets a pulse info. More...
 
static PulseInfo[] GetPulseInfos (bool invalidateCache)
 Gets all the pulse infos. More...
 
static PulseInfo[] GetPulseInfos (string[] pulseNames, bool invalidateCache)
 Gets a list of pulse infos. More...
 
static PulseInfoSettings[] GetPulseInfoSettings (bool invalidateCache)
 Gets all the pulse info settings. More...
 
static PulseInfoSettings[] GetPulseInfoSettings (string[] pulseNames, bool invalidateCache)
 Gets a list of pulse info settings. More...
 
static string[] GetPulseNames (bool invalidateCache)
 Gets all the pulse names. More...
 
static PulseSettings GetPulseSettings (string pulseName, bool invalidateCache)
 Gets settings for a pulse. More...
 
static PulseSettings[] GetPulseSettingsList (bool invalidateCache)
 Gets all the pulse settings. More...
 
static PulseSettings[] GetPulseSettingsList (string[] pulseNames, bool invalidateCache)
 Gets a list of pulse settings. More...
 
static string GetRegionNameFromId (string regionName)
 Gets the name of the Region or Cloud Region for the given region ID. More...
 
static DateTime GetRepositoryDateTime ()
 Gets the current Repository DateTime. More...
 
static string GetRootDirectory ()
 Gets the repository root directory. More...
 
static string GetRootDirectory (string subFolder)
 Gets the repository root directory with sync arguments. More...
 
static string GetScriptsDirectory ()
 Gets the repository scripts directory. More...
 
static string GetSettingsDirectory ()
 Gets the repository settings directory. More...
 
static SlaveInfo GetSlaveInfo (string slaveName, bool invalidateCache)
 Gets a slave info. More...
 
static SlaveInfo[] GetSlaveInfos (bool invalidateCache)
 Gets all the slave infos. More...
 
static SlaveInfo[] GetSlaveInfos (string[] slaveNames, bool invalidateCache)
 Gets a list of slave infos. More...
 
static SlaveInfoSettings[] GetSlaveInfoSettings (bool invalidateCache)
 Gets all the slave info settings. More...
 
static SlaveInfoSettings[] GetSlaveInfoSettings (string[] slaveNames, bool invalidateCache)
 Gets a list of slave info settings. More...
 
static string[] GetSlaveNames (bool invalidateCache)
 Gets all the slave names. More...
 
static string GetSlaveReportLog (Report report)
 Gets the log for a slave report. More...
 
static string GetSlaveReportLogFileName (Report report)
 Gets the full path to the report log file for a slave report. Note that the file is a bzip file. More...
 
static SlaveReportCollection GetSlaveReports (string slaveName)
 Gets the reports for a slave. More...
 
static SlaveSettings GetSlaveSettings (string slaveName, bool invalidateCache)
 Gets settings for a slave. More...
 
static SlaveSettings[] GetSlaveSettingsList (bool invalidateCache)
 Gets all the slave settings. More...
 
static SlaveSettings[] GetSlaveSettingsList (string[] slaveNames, bool invalidateCache)
 Gets a list of slave settings. More...
 
static string[] GetSlavesRenderingJob (string jobId)
 Gets the names of the slaves rendering the specified job. More...
 
static string[] GetUserGroup (string userGroupName)
 Gets the users for the user group with the given name. More...
 
static string[] GetUserGroupNames ()
 Gets all the user group names. More...
 
static string[] GetUserGroupsForUser (string user)
 Get the user group names for the provided user. More...
 
static IUserInfo GetUserInfo (string userName, bool invalidateCache)
 Gets a user's info. More...
 
static IUserInfo[] GetUserInfos (bool invalidateCache)
 Gets all the user infos. More...
 
static IUserInfo[] GetUserInfos (string[] userNames, bool invalidateCache)
 Gets a list of user infos. More...
 
static string[] GetUserNames (bool invalidateCache)
 Gets all the user names. More...
 
static string GetWindowsAlternateAuxiliaryPath ()
 Gets the alternate auxiliary file directory for Windows. More...
 
static Job ImportJob (string archivedJobFile, bool deleteArchive)
 Imports an archived job and returns it. More...
 
static bool JobExists (string jobId)
 Checks if a job exists. More...
 
static void NewUserGroup (string userGroupName)
 Creates a new user group with the given name if it does not already exist. More...
 
static void NewUserGroups (string[] userGroupNames)
 Creates new user groups with the given names if they do not already exist. More...
 
static bool PathMappingRequired (string path)
 Checks if the given path matches a path mapping setting in the Repository Options. More...
 
static void PendJob (Job job)
 Place a job with dependencies in the pending state. More...
 
static bool PendTasks (Job job, Task[] tasks)
 Pends tasks for a job. This is only supported if the job is frame dependent. More...
 
static bool ProxyServerExists (string proxyName)
 Checks if a specified Proxy Server exists. More...
 
static bool PulseExists (string pulseName)
 Checks whether or not a Pulse with the given name exists. More...
 
static void PurgeDeletedJobs (string jobID)
 Purge deleted job. More...
 
static void PurgeDeletedJobs (string[] jobIDs)
 Purge deleted jobs. More...
 
static void ReleasePendingJob (Job job)
 Releases a pending job. More...
 
static void ReleasePendingTasks (Job job, Task[] tasks)
 Releases pending tasks for a job. This is only supported if the job is frame dependent. More...
 
static void RemoveGroupFromSlave (string slaveName, string groupName)
 Removes a group from the given slave. More...
 
static void RemovePoolFromSlave (string slaveName, string poolName)
 Removes a pool from the given slave. More...
 
static void RemoveSlavesFromLimitGroupList (string name, object slaveNames)
 Removes slaves from a limit group's list of slaves. More...
 
static void RemoveSlavesFromMachineLimitList (string jobId, object slaveNames)
 Removes slaves from a job machine limit's list of slaves. More...
 
static void RemoveUsersFromUserGroups (string[] users, string[] userGroups)
 Removes all the users given from the provided user groups. More...
 
static void RequeueJob (Job job)
 Requeues a job. All rendering and completed tasks for the job will be requeued. More...
 
static void RequeueTasks (Job job, Task[] tasks)
 Requeue tasks for a job. More...
 
static void ResetLimitGroup (string limitGroupName)
 Resets the usage counts for a limit group. More...
 
static Job ResubmitJob (Job job, string frameList, int chunkSize, bool submitSuspended)
 Resubmits an existing job to Deadline. More...
 
static void ResumeFailedJob (Job job)
 Resume a failed job. More...
 
static void ResumeFailedTasks (Job job, Task[] tasks)
 Resumes failed tasks for a job. More...
 
static void ResumeJob (Job job)
 Resume a suspended job. More...
 
static void ResumeTasks (Job job, Task[] tasks)
 Resumes suspended tasks for a job. More...
 
static void SaveBalancerInfo (BalancerInfo balancerInfo)
 Saves a balancer info to the database. More...
 
static void SaveBalancerSettings (BalancerSettings balancerSettings)
 Saves settings for a balancer to the database. More...
 
static void SaveJob (Job job)
 Updates a job's properties in the database. More...
 
static void SaveLimitGroup (LimitGroup limitGroup)
 Updates a limit group's properties in the database. More...
 
static bool SaveNetworkSettings (IDeadlineNetworkSettings networkSettings)
 Saves the network settings to the repository. More...
 
static bool SavePowerManagementOptions (PowerManagementOptions options)
 Saves the power management options. More...
 
static void SaveProxyServerInfo (ProxyServerInfo proxyInfo)
 Save a ProxyServerInfo object to the Database. More...
 
static void SaveProxyServerSettings (ProxyServerSettings proxySettings)
 Save a ProxyServerInfo object to the Database. More...
 
static void SavePulseInfo (PulseInfo pulseInfo)
 Saves a pulse info to the database. More...
 
static void SavePulseSettings (PulseSettings pulseSettings)
 Saves settings for a pulse to the database. More...
 
static void SaveSlaveInfo (SlaveInfo slaveInfo)
 Saves a slave info to the database. More...
 
static void SaveSlaveSettings (SlaveSettings slaveSettings)
 Saves settings for a slave to the database. More...
 
static void SaveUserInfo (IUserInfo userInfo)
 Saves a user info to the database. More...
 
static void SetGroupsForSlave (string slaveName, string[] groupNames)
 Sets the list of groups for the given slave. More...
 
static void SetJobFrameRange (Job job, string frameList, int chunkSize)
 Modifies a job's frame range. If the job is currently being rendered, any rendering tasks will be requeued to perform this operation. More...
 
static void SetJobOutputDirectories (Job job, object outputDirectories)
 Sets the job's output directories. More...
 
static LimitGroup SetLimitGroup (string name, int limit, object listedSlaves, bool isWhiteList, object excludedSlaves, double releaseProgress)
 Creates a limit group if it doesn't exist, or updates its properties if it does. More...
 
static void SetLimitGroupListedSlaves (string name, object slaveNames)
 Sets the listed slaves for a limit group. More...
 
static void SetLimitGroupMaximum (string name, int limit)
 Sets the limit for a limit group. More...
 
static void SetLimitGroupReleaseProgress (string name, double releaseProgress)
 Sets the release progres for a limit group. More...
 
static void SetLimitGroupWhiteListFlag (string name, bool isWhiteList)
 Sets if the slave list for a limit group is a whitelist or a blacklist. More...
 
static LimitGroup SetMachineLimit (string jobId, int limit, object listedSlaves, bool isWhiteList, double releaseProgress)
 Creates a machine limit for a job if it doesn't exist, or updates its properties if it does. More...
 
static void SetMachineLimitListedSlaves (string jobId, object slaveNames)
 Sets the listed slaves for a job's machine limit. More...
 
static void SetMachineLimitMaximum (string jobId, int limit)
 Sets the limit for a job's machine limit. More...
 
static void SetMachineLimitReleaseProgress (string jobId, double releaseProgress)
 Sets the release progres for a job's machine limit. More...
 
static void SetMachineLimitWhiteListFlag (string jobId, bool isWhiteList)
 Sets if the slave list for a job's machine limit is a whitelist or a blacklist. More...
 
static void SetPoolsForSlave (string slaveName, string[] poolNames)
 Sets the list of pools for the given slave. More...
 
static void SetPostJobScript (Job job, string script)
 Sets a jobs post job script. More...
 
static void SetPreJobScript (Job job, string script)
 Sets a jobs pre job script. More...
 
static void SetUsersForUserGroups (string[] users, string[] userGroups)
 Sets the user list for the provided user groups to contain the provided users, overriding the old lists. More...
 
static bool SlaveExists (string slaveName)
 Checks whether or not a slave with the given name exists. More...
 
static Job SubmitJob (string[] jobFiles)
 Submits a job to Deadline. More...
 
static void SuspendJob (Job job)
 Suspend a queued, rendering, or pending job. More...
 
static void SuspendNonRenderingTasks (Job job)
 Suspend the non rendering tasks for a queued or pending job. More...
 
static bool SuspendTasks (Job job, Task[] tasks)
 Suspends tasks for a job. More...
 
static void UndeleteJob (Job job)
 Undelete a job. More...
 
static void UndeleteJobs (Job[] jobs)
 Undelete jobs. More...
 
static void UpdateJobOutputFileNames (Job job, object outputFileNames)
 Sets the job's output file names. More...
 
static void UpdateJobOutputTileFileNames (Job job, string[][] outputTileFileNames)
 Sets the job's output tile file names. More...
 
static void UpdateJobSubmissionDate (Job job)
 Sets the job's submission date to the current time. More...
 
static void UpdateTaskProperties (string jobID, Task task)
 Updates some of the task properties for the given task. Note that only the settings in the task's TaskProperties container can be updated this way. More...
 
static void UpdateTaskProperties (string jobID, Task[] tasks)
 Updates some of the task properties for the given tasks. Note that only the settings in the task's TaskProperties container can be updated this way. More...
 

Detailed Description

Repository utility functions.

Member Function Documentation

static void Deadline.Scripting.RepositoryUtils.AddAuxiliaryFile ( Job  job,
string[]  newAuxFilePath 
)
static

Adds an aux file to the specified job.

Parameters
jobThe job.
newAuxFilePathAn auxiliary data file name. This should be the full path including the file name to a data file.
static void Deadline.Scripting.RepositoryUtils.AddBadSlaveForJob ( Job  job,
string  slaveName 
)
static

Adds a slave to a job's Bad Slave list.

Parameters
jobThe job.
slaveNameThe name of the slave to add to the list.
static void Deadline.Scripting.RepositoryUtils.AddGroup ( string  groupName)
static

Adds a group to the repository.

Parameters
groupNameThe group name.
static void Deadline.Scripting.RepositoryUtils.AddGroupToSlave ( string  slaveName,
string  groupName 
)
static

Adds a group to the given slave.

Parameters
slaveNameThe slave name.
groupNameThe group name.
static void Deadline.Scripting.RepositoryUtils.AddJobHistoryEntry ( string  jobId,
string  entry 
)
static

Adds a job history entry.

Parameters
jobIdThe job's ID.
entryThe history text.
static void Deadline.Scripting.RepositoryUtils.AddPool ( string  poolName)
static

Adds a pool to the repository.

Parameters
poolNameThe pool name.
static void Deadline.Scripting.RepositoryUtils.AddPoolToSlave ( string  slaveName,
string  poolName 
)
static

Adds a pool to the given slave.

Parameters
slaveNameThe slave name.
poolNameThe pool name.
static void Deadline.Scripting.RepositoryUtils.AddRepositoryHistoryEntry ( string  entry)
static

Adds a repository history entry.

Parameters
entryThe history text.
static void Deadline.Scripting.RepositoryUtils.AddSlaveHistoryEntry ( string  slaveName,
string  entry 
)
static

Adds a slave history entry.

Parameters
slaveNameThe slave name.
entryThe history text.
static void Deadline.Scripting.RepositoryUtils.AddSlavesToLimitGroupList ( string  name,
object  slaveNames 
)
static

Adds slaves to a limit group's list of slaves.

Parameters
nameThe limit group name.
slaveNamesThe list of slaves to add.
static void Deadline.Scripting.RepositoryUtils.AddSlavesToMachineLimitList ( string  jobId,
object  slaveNames 
)
static

Adds slaves to a job machine limit's list of slaves.

Parameters
jobIdThe job ID.
slaveNamesThe list of slaves to add.
static void Deadline.Scripting.RepositoryUtils.AddUsersToUserGroups ( string[]  users,
string[]  userGroups 
)
static

Adds all the users given to the provided user groups.

Parameters
usersThe users to add.
userGroupsThe user groups to add to.
static void Deadline.Scripting.RepositoryUtils.AppendJobFrameRange ( Job  job,
string  frameList 
)
static

Appends to a job's frame range without affecting the existing tasks. The only exception is if the job's chunk size is greater than one, and the last task is having frames appended to it.

Parameters
jobThe job.
frameListThe additional frames to append.
static void Deadline.Scripting.RepositoryUtils.ArchiveJob ( Job  job,
bool  deleteFromDB,
string  archiveFolderOverride 
)
static

Archive a non-queued, non-rendering job.

Parameters
jobThe job to archive.
deleteFromDBIf True, the job will be deleted from the repository after it is archived.
archiveFolderOverrideIf not null, the archived job will be placed in this folder instead of the jobsArchived folder in the repository.
static bool Deadline.Scripting.RepositoryUtils.BalancerExists ( string  balancerName)
static

Checks whether or not a Balancer with the given name exists.

Parameters
balancerNameThe balancer name to check.
Returns
Whether or not the Balancer exists.
static string Deadline.Scripting.RepositoryUtils.CheckPathMapping ( string  path)
static

Performs path mapping on the given path. Uses the path mappings in the Repository Options.

Parameters
pathThe path.
Returns
The resulting path.
static string Deadline.Scripting.RepositoryUtils.CheckPathMapping ( string  path,
bool  verbose 
)
static

Performs path mapping on the given path. Uses the path mappings in the Repository Options.

Parameters
pathThe path.
verboseIf verbose logging should be enabled.
Returns
The resulting path.
static void Deadline.Scripting.RepositoryUtils.CheckPathMappingInFile ( string  inFileName,
string  outFileName 
)
static

Performs path mapping on the contents of the given file. Uses the path mappings in the Repository Options.

Parameters
inFileNameThe original file name.
outFileNameThe new file name where the mapped contents will be stored.
static void Deadline.Scripting.RepositoryUtils.CheckPathMappingInFile ( string  inFileName,
string  outFileName,
bool  readFileAsBytes 
)
static

Performs path mapping on the contents of the given file. Uses the path mappings in the Repository Options.

Parameters
inFileNameThe original file name.
outFileNameThe new file name where the mapped contents will be stored.
readFileAsBytesIf set to True, the input file will be processed byte-by-byte. However, this is known to have issues with UTF16 or UTF32 encoded files.
static void Deadline.Scripting.RepositoryUtils.CheckPathMappingInFileAndReplace ( string  inFileName,
string  outFileName,
string[]  stringsToReplace,
string[]  newStrings 
)
static

Performs path mapping on the contents of the given file, and replaces a list of given strings in any paths that are mapped. Uses the path mappings in the Repository Options.

Parameters
inFileNameThe original file name.
outFileNameThe new file name where the mapped contents will be stored.
stringsToReplaceThe list of strings to replace.
newStringsThe list of new strings. Must be the same number of strings as stringsToReplace.
static void Deadline.Scripting.RepositoryUtils.CheckPathMappingInFileAndReplace ( string  inFileName,
string  outFileName,
string[]  stringsToReplace,
string[]  newStrings,
bool  readFileAsBytes 
)
static

Performs path mapping on the contents of the given file, and replaces a list of given strings in any paths that are mapped. Uses the path mappings in the Repository Options.

Parameters
inFileNameThe original file name.
outFileNameThe new file name where the mapped contents will be stored.
stringsToReplaceThe list of strings to replace.
newStringsThe list of new strings. Must be the same number of strings as stringsToReplace.
readFileAsBytesIf set to True, the input file will be processed byte-by-byte. However, this is known to have issues with UTF16 or UTF32 encoded files.
static void Deadline.Scripting.RepositoryUtils.CheckPathMappingInFileAndReplaceSeparator ( string  inFileName,
string  outFileName,
string  separatorToReplace,
string  newSeparator 
)
static

Performs path mapping on the contents of the given file, and updates all path separators in any paths that are mapped. Uses the path mappings in the Repository Options.

Parameters
inFileNameThe original file name.
outFileNameThe new file name where the mapped contents will be stored.
separatorToReplaceThe path separator to replace.
newSeparatorThe new path separator.
static void Deadline.Scripting.RepositoryUtils.CheckPathMappingInFileAndReplaceSeparator ( string  inFileName,
string  outFileName,
string  separatorToReplace,
string  newSeparator,
bool  readFileAsBytes 
)
static

Performs path mapping on the contents of the given file, and updates all path separators in any paths that are mapped. Uses the path mappings in the Repository Options.

Parameters
inFileNameThe original file name.
outFileNameThe new file name where the mapped contents will be stored.
separatorToReplaceThe path separator to replace.
newSeparatorThe new path separator.
readFileAsBytesIf set to True, the input file will be processed byte-by-byte. However, this is known to have issues with UTF16 or UTF32 encoded files.
static void Deadline.Scripting.RepositoryUtils.CompleteJob ( Job  job)
static

Completes a job. All incomplete tasks for the job will be marked as complete.

Parameters
jobThe job to complete.
static bool Deadline.Scripting.RepositoryUtils.CompleteTasks ( Job  job,
Task[]  tasks,
string  slaveName 
)
static

Complete tasks for a job.

Parameters
jobThe job.
tasksThe list of tasks to complete.
slaveNameThis is the slave that will show up as completing the tasks.
Returns
Returns True if the job is now complete.
static void Deadline.Scripting.RepositoryUtils.CreateJobSubmissionFiles ( Job  job,
string  jobInfoFileName,
string  pluginInfoFileName 
)
static

Creates the job info and plugin info files that were originally used to submit the given job.

Parameters
jobThe job.
jobInfoFileNameThe file name where the job info settings will be saved.
pluginInfoFileNameThe file name where the plugin info settings will be saved.
static void Deadline.Scripting.RepositoryUtils.DeleteAllBadSlavesForJob ( Job  job)
static

Deletes all slaves from a job's Bad Slave list.

Parameters
jobThe job.
static void Deadline.Scripting.RepositoryUtils.DeleteAllJobReports ( string  jobId)
static

Deletes all reports for a job.

Parameters
jobIdThe job's ID.
static void Deadline.Scripting.RepositoryUtils.DeleteAllSlaveReports ( string  slaveName)
static

Deletes all reports for a slave.

Parameters
slaveNameThe slave's name.
static void Deadline.Scripting.RepositoryUtils.DeleteBadSlaveForJob ( Job  job,
string  slaveName 
)
static

Deletes a slave from a job's Bad Slave list.

Parameters
jobThe job.
slaveNameThe name of the slave to remove from the list.
static void Deadline.Scripting.RepositoryUtils.DeleteBadSlavesForJob ( Job  job,
object  slaveNames 
)
static

Deletes a list of slaves from a job's Bad Slave list.

Parameters
jobThe job.
slaveNamesThe list of slave names to remove from the list.
static void Deadline.Scripting.RepositoryUtils.DeleteBalancer ( string  balancerName)
static

Deletes a specified Balancer.

Parameters
balancerNameThe balancer name.
static void Deadline.Scripting.RepositoryUtils.DeleteGroup ( string  groupName)
static

Removes a group from the repository.

Parameters
groupNameThe group name.
static void Deadline.Scripting.RepositoryUtils.DeleteJob ( Job  job)
static

Delete a job.

Parameters
jobThe job to delete.
static void Deadline.Scripting.RepositoryUtils.DeleteJobReport ( string  jobId,
Report  report 
)
static

Deletes the given report for a job.

Parameters
jobIdThe job's ID.
reportThe report to delete.
static void Deadline.Scripting.RepositoryUtils.DeleteJobReports ( string  jobId,
Report[]  reports 
)
static

Deletes the given reports for a job.

Parameters
jobIdThe job's ID.
reportsThe reports to delete.
static void Deadline.Scripting.RepositoryUtils.DeletePool ( string  poolName)
static

Removes a pool from the repository.

Parameters
poolNameThe pool name.
static void Deadline.Scripting.RepositoryUtils.DeletePostJobScript ( Job  job)
static

Deletes the jobs post job script.

Parameters
jobThe job.
static void Deadline.Scripting.RepositoryUtils.DeletePreJobScript ( Job  job)
static

Deletes the jobs pre job script.

Parameters
jobThe job.
static void Deadline.Scripting.RepositoryUtils.DeleteProxyServer ( string  proxyName)
static

Delete the specified Proxy Server.

Parameters
proxyNameThe Proxy Server name.
static void Deadline.Scripting.RepositoryUtils.DeletePulse ( string  pulseName)
static

Delete the specified pulse.

Parameters
pulseNameThe pulse name.
static void Deadline.Scripting.RepositoryUtils.DeleteSlave ( string  slaveName)
static

Deletes a specified slave.

Parameters
slaveNameThe slave name.
static void Deadline.Scripting.RepositoryUtils.DeleteSlaveReport ( string  slaveName,
Report  report 
)
static

Deletes the given report for a slave.

Parameters
slaveNameThe slave's name.
reportThe report to delete.
static void Deadline.Scripting.RepositoryUtils.DeleteSlaveReports ( string  slaveName,
Report[]  reports 
)
static

Deletes the given reports for a slave.

Parameters
slaveNameThe slave's name.
reportsThe reports to delete.
static void Deadline.Scripting.RepositoryUtils.DeleteUserGroup ( string  userGroupName)
static

Deletes a user groups.

Parameters
userGroupNameThe user group name to delete.
static void Deadline.Scripting.RepositoryUtils.FailJob ( Job  job)
static

Fails a job. All incomplete tasks for the job will be marked as failed.

Parameters
jobThe job to fail.
static bool Deadline.Scripting.RepositoryUtils.FailTasks ( Job  job,
Task[]  tasks 
)
static

Fail tasks for a job.

Parameters
jobThe job.
tasksThe list of tasks to fail.
Returns
Returns True if the job is now failed.
static string Deadline.Scripting.RepositoryUtils.GetAlternateAuxiliaryPath ( )
static

Gets the alternate auxiliary file directory based on the current operating system.

Returns
The auxiliary directory.
static string Deadline.Scripting.RepositoryUtils.GetAPISyncFolder ( )
static

Gets the pythonsync folder.

Returns
The pythonsync folder.
static BalancerInfo Deadline.Scripting.RepositoryUtils.GetBalancerInfo ( string  balancerName,
bool  invalidateCache 
)
static

Gets a balancer info.

Parameters
balancerNameThe balancer name.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The balancer info.
static BalancerInfo [] Deadline.Scripting.RepositoryUtils.GetBalancerInfos ( bool  invalidateCache)
static

Gets all the balancer infos.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of balancer infos.
static BalancerInfo [] Deadline.Scripting.RepositoryUtils.GetBalancerInfos ( string[]  balancerNames,
bool  invalidateCache 
)
static

Gets a list of balancer infos.

Parameters
balancerNamesThe list of balancer names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of balancer infos.
static BalancerInfoSettings [] Deadline.Scripting.RepositoryUtils.GetBalancerInfoSettings ( bool  invalidateCache)
static

Gets all the balancer info settings.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of balancer info settings.
static BalancerInfoSettings [] Deadline.Scripting.RepositoryUtils.GetBalancerInfoSettings ( string[]  balancerNames,
bool  invalidateCache 
)
static

Gets a list of balancer info settings.

Parameters
balancerNamesThe list of balancer names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of balancer info settings.
static string [] Deadline.Scripting.RepositoryUtils.GetBalancerNames ( bool  invalidateCache)
static

Gets all the balancer names.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of balancer names.
static BalancerSettings Deadline.Scripting.RepositoryUtils.GetBalancerSettings ( string  balancerName,
bool  invalidateCache 
)
static

Gets settings for a balancer.

Parameters
balancerNameThe balancer name.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The balancer settings.
static BalancerSettings [] Deadline.Scripting.RepositoryUtils.GetBalancerSettingsList ( bool  invalidateCache)
static

Gets all the balancer settings.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of balancer settings.
static BalancerSettings [] Deadline.Scripting.RepositoryUtils.GetBalancerSettingsList ( string[]  balancerNames,
bool  invalidateCache 
)
static

Gets a list of balancer settings.

Parameters
balancerNamesThe list of balancer names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of balancer settings.
static string Deadline.Scripting.RepositoryUtils.GetBinDirectory ( )
static

Gets the repository bin directory.

Returns
The bin directory.
static string Deadline.Scripting.RepositoryUtils.GetCloudPluginsDirectory ( )
static

Gets the repository cloud plugins directory.

Returns
The cloud plugins directory.
static string Deadline.Scripting.RepositoryUtils.GetCustomEventsDirectory ( )
static

Gets the repository custom events directory.

Returns
The custom events directory.
static string Deadline.Scripting.RepositoryUtils.GetCustomPluginsDirectory ( )
static

Gets the repository custom plugins directory.

Returns
The custom plugins directory.
static string Deadline.Scripting.RepositoryUtils.GetCustomScriptsDirectory ( )
static

Gets the repository custom scripts directory.

Returns
The custom scripts directory.
static string Deadline.Scripting.RepositoryUtils.GetDatabaseConnectionString ( )
static

Gets the database connection string in the form of (server:port,server:port...). If there is only one server configured, it will be in the form of (server:port).

Returns
The database connection string.
static Job Deadline.Scripting.RepositoryUtils.GetDeletedJob ( string  jobId)
static

Gets a deleted job.

Parameters
jobIdThe deleted job ID.
Returns
The deleted job.
static string [] Deadline.Scripting.RepositoryUtils.GetDeletedJobIds ( )
static

Gets all the deleted job IDs.

Returns
The list of deleted job IDs.
static Job [] Deadline.Scripting.RepositoryUtils.GetDeletedJobs ( )
static

Gets all the deleted jobs.

Returns
The list of deleted jobs.
static PluginConfig Deadline.Scripting.RepositoryUtils.GetEventPluginConfig ( string  eventPluginName)
static

Gets the configuration settings for an event plugin.

Parameters
eventPluginNameThe event plugin name.
Returns
The event plugin configuration.
static string Deadline.Scripting.RepositoryUtils.GetEventPluginDirectory ( string  eventPluginName)
static

Returns the directory in which the given event plugin is located.

Parameters
eventPluginNameThe name of the event plugin to look for.
Returns
The event plugin directory.
static string [] Deadline.Scripting.RepositoryUtils.GetEventPluginNames ( )
static

Gets the event plugin names.

Returns
The list of event plugin names.
static string Deadline.Scripting.RepositoryUtils.GetEventsDirectory ( )
static

Gets the repository events directory.

Returns
The events directory.
static string [] Deadline.Scripting.RepositoryUtils.GetGroupNames ( )
static

Gets the group names.

Returns
The list of group names.
static Job Deadline.Scripting.RepositoryUtils.GetJob ( string  jobId,
bool  invalidate 
)
static

Gets a job.

Parameters
jobIdThe job ID.
invalidateSpecify True to update the cache, or False to use the data currently cached.
Returns
The job.
static string Deadline.Scripting.RepositoryUtils.GetJobAuxiliaryPath ( Job  job)
static

Gets the auxiliary file directory for the given job.

Parameters
jobThe job.
Returns
The auxiliary directory.
static Dictionary<string, Dictionary<string, Dictionary<string, string> > > Deadline.Scripting.RepositoryUtils.GetJobDetails ( Job[]  jobs)
static

Gets a dictionary of job details for the provided jobs.

Parameters
jobsThe list of jobs.
Returns
A dictionary containing the job details.
static string [] Deadline.Scripting.RepositoryUtils.GetJobIds ( bool  invalidateCache)
static

Gets all the job IDs.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of IDs.
static string [] Deadline.Scripting.RepositoryUtils.GetJobIds ( )
static

Gets the job IDs. For Web Service scripts only.

Returns
The list of job IDs.
static string Deadline.Scripting.RepositoryUtils.GetJobReportLog ( Report  report)
static

Gets the report log for a job report.

Parameters
reportThe report.
Returns
The report log.
static string Deadline.Scripting.RepositoryUtils.GetJobReportLogFileName ( Report  report)
static

Gets the full path to the report log file for a job report. Note that the file is a bzip file.

Parameters
reportThe report.
Returns
The report log file name. This will be an empty string if there was an error saving the report to the Repository.
static JobReportCollection Deadline.Scripting.RepositoryUtils.GetJobReports ( string  jobId)
static

Gets the reports for a job.

Parameters
jobIdThe job ID.
Returns
The collection of reports.
static Job [] Deadline.Scripting.RepositoryUtils.GetJobs ( bool  invalidateCache)
static

Gets all the jobs.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of jobs.
static Job [] Deadline.Scripting.RepositoryUtils.GetJobs ( string[]  jobIds,
bool  invalidate 
)
static

Gets a list of jobs.

Parameters
jobIdsThe list of job IDs.
invalidateSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of jobs.
static Job [] Deadline.Scripting.RepositoryUtils.GetJobsInState ( object  states)
static

Gets all the jobs in the given state(s).

Parameters
statesA list of job states, or a string containing a single state. Valid states are Active, Suspended, Completed, Failed, and Pending. Note that Active covers both Queued and Rendering jobs.
Returns
The list of jobs in the given state(s).
static int Deadline.Scripting.RepositoryUtils.GetJobTaskLimit ( )
static

Gets the job task limit.

Returns
The job task limit.
static TaskCollection Deadline.Scripting.RepositoryUtils.GetJobTasks ( Job  job,
bool  invalidate 
)
static

Gets the tasks for a job.

Parameters
jobThe job.
invalidateSpecify True to update the cache, or False to use the data currently cached.
Returns
The job's task collection.
static LimitGroup Deadline.Scripting.RepositoryUtils.GetLimitGroup ( string  limitGroupName,
bool  invalidate 
)
static

Gets a limit group.

Parameters
limitGroupNameThe limit group name.
invalidateSpecify True to update the cache, or False to use the data currently cached.
Returns
The limit group.
static string [] Deadline.Scripting.RepositoryUtils.GetLimitGroupNames ( bool  invalidateCache)
static

Gets all the limit group names.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of user group names.
static LimitGroup [] Deadline.Scripting.RepositoryUtils.GetLimitGroups ( string[]  limitGroupNames,
bool  invalidate 
)
static

Gets a list of limit groups.

Parameters
limitGroupNamesThe list of limit group names.
invalidateSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of limit groups.
static LimitGroup [] Deadline.Scripting.RepositoryUtils.GetLimitGroups ( bool  invalidate)
static

Gets all the limit groups.

Parameters
invalidateSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of limit groups.
static string Deadline.Scripting.RepositoryUtils.GetLinuxAlternateAuxiliaryPath ( )
static

Gets the alternate auxiliary file directory for Linux.

Returns
The auxiliary directory.
static string Deadline.Scripting.RepositoryUtils.GetMacAlternateAuxiliaryPath ( )
static

Gets the alternate auxiliary file directory for Mac OSX.

Returns
The auxiliary directory.
static LimitGroup Deadline.Scripting.RepositoryUtils.GetMachineLimit ( string  jobId,
bool  invalidate 
)
static

Gets the machine limit for a job.

Parameters
jobIdThe job ID.
invalidateSpecify True to update the cache, or False to use the data currently cached.
Returns
The machine limit, which is just a specialized limit group.
static string [] Deadline.Scripting.RepositoryUtils.GetMachinesRenderingJob ( string  jobId,
bool  ipAddresses 
)
static

Gets the host names of the machines rendering the specified job.

Parameters
jobIdThe job ID.
ipAddressesIf True, the machine IP addresses will be returned instead of the host names.
Returns
The list of machines.
static string [] Deadline.Scripting.RepositoryUtils.GetMachinesRenderingJob ( string  jobId,
bool  ipAddresses,
bool  duplicates 
)
static

Gets the host names of the machines rendering the specified job.

Parameters
jobIdThe job ID.
ipAddressesIf True, the machine IP addresses will be returned instead of the host names.
duplicatesIf True, duplicate IP addresses and hostnames will be returned.
Returns
The list of machines.
static int Deadline.Scripting.RepositoryUtils.GetMaximumPriority ( )
static

Gets the maximum job priority.

Returns
The maximum job priority.
static IDeadlineNetworkSettings Deadline.Scripting.RepositoryUtils.GetNetworkSettings ( )
static

Gets the network settings.

Returns
The network settings.
static string [][] Deadline.Scripting.RepositoryUtils.GetPathMappings ( )
static

Gets the list of relevant path mappings as defined in Repository Options.

Returns
List of [from] -> [to] path mappings relevant to the current operating system.
static PluginConfig Deadline.Scripting.RepositoryUtils.GetPluginConfig ( string  pluginName)
static

Gets the configuration settings for a plugin.

Parameters
pluginNameThe plugin name.
Returns
The plugin configuration.
static PluginConfig Deadline.Scripting.RepositoryUtils.GetPluginConfig ( string  pluginName,
string  altCustomPluginDirectory 
)
static

Gets the configuration settings for a plugin.

Parameters
altCustomPluginDirectoryA custom directory to get the plugin config from.
pluginNameThe plugin name.
Returns
The plugin configuration.
static string Deadline.Scripting.RepositoryUtils.GetPluginDirectory ( string  pluginName)
static

Returns the directory in which the given plugin is located.

Parameters
pluginNameThe name of the plugin to look for.
Returns
The directory for the plugin.
static string [] Deadline.Scripting.RepositoryUtils.GetPluginNames ( )
static

Gets the plugin names.

Returns
The list of plugin names.
static string Deadline.Scripting.RepositoryUtils.GetPluginsDirectory ( )
static

Gets the repository plugins directory.

Returns
The plugins directory.
static string [] Deadline.Scripting.RepositoryUtils.GetPoolNames ( )
static

Gets the pool names.

Returns
The list of pool names.
static PowerManagementOptions Deadline.Scripting.RepositoryUtils.GetPowerManagementOptions ( )
static

Gets the power management options.

Returns
The power management options.
static ProxyServerInfo Deadline.Scripting.RepositoryUtils.GetProxyServerInfo ( string  proxyName,
bool  invalidateCache 
)
static

Gets ProxyServerInfo for a specified Proxy Server.

Parameters
proxyNameThe Proxy Server name.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The requested ProxyServerInfo.
static ProxyServerInfo [] Deadline.Scripting.RepositoryUtils.GetProxyServerInfos ( bool  invalidateCache)
static

Gets ProxyServerInfo objects for all Proxy Servers.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of ProxyServerInfo objects.
static ProxyServerInfo [] Deadline.Scripting.RepositoryUtils.GetProxyServerInfos ( string[]  proxyNames,
bool  invalidateCache 
)
static

Gets ProxyServerInfo objects for all specified Proxy Servers.

Parameters
proxyNamesThe list of Proxy Server names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of pulse infos.
static ProxyServerInfoSettings [] Deadline.Scripting.RepositoryUtils.GetProxyServerInfoSettings ( bool  invalidateCache)
static

Gets ProxyServerInfoSettings objects for all Proxy Servers.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of ProxyServerInfoSettings.
static ProxyServerInfoSettings [] Deadline.Scripting.RepositoryUtils.GetProxyServerInfoSettings ( string[]  proxyNames,
bool  invalidateCache 
)
static

Gets ProxyServerInfoSettings objects for all specified Proxy Servers.

Parameters
proxyNamesThe list of Proxy Server names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of ProxyServerInfoSettings.
static string [] Deadline.Scripting.RepositoryUtils.GetProxyServerNames ( bool  invalidateCache)
static

Gets all the Proxy Server names.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of Proxy Server names.
static ProxyServerSettings Deadline.Scripting.RepositoryUtils.GetProxyServerSettings ( string  proxyName,
bool  invalidateCache 
)
static

Gets ProxyServerSettings for a specified Proxy Server.

Parameters
proxyNameName of the Proxy Server.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The requested ProxyServerSettings.
static ProxyServerSettings [] Deadline.Scripting.RepositoryUtils.GetProxyServerSettingsList ( bool  invalidateCache)
static

Gets ProxyServerSettings objects for all Proxy Servers.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of ProxyServerSettings objects.
static ProxyServerSettings [] Deadline.Scripting.RepositoryUtils.GetProxyServerSettingsList ( string[]  proxyNames,
bool  invalidateCache 
)
static

Gets ProxyServerSettings objects for all specified Proxy Servers.

Parameters
proxyNamesThe list of Proxy Server names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of ProxyServerSettings.
static PulseInfo Deadline.Scripting.RepositoryUtils.GetPulseInfo ( string  pulseName,
bool  invalidateCache 
)
static

Gets a pulse info.

Parameters
pulseNameThe pulse name.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The pulse info.
static PulseInfo [] Deadline.Scripting.RepositoryUtils.GetPulseInfos ( bool  invalidateCache)
static

Gets all the pulse infos.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of pulse infos.
static PulseInfo [] Deadline.Scripting.RepositoryUtils.GetPulseInfos ( string[]  pulseNames,
bool  invalidateCache 
)
static

Gets a list of pulse infos.

Parameters
pulseNamesThe list of pulse names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of pulse infos.
static PulseInfoSettings [] Deadline.Scripting.RepositoryUtils.GetPulseInfoSettings ( bool  invalidateCache)
static

Gets all the pulse info settings.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of pulse info settings.
static PulseInfoSettings [] Deadline.Scripting.RepositoryUtils.GetPulseInfoSettings ( string[]  pulseNames,
bool  invalidateCache 
)
static

Gets a list of pulse info settings.

Parameters
pulseNamesThe list of pulse names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of pulse info settings.
static string [] Deadline.Scripting.RepositoryUtils.GetPulseNames ( bool  invalidateCache)
static

Gets all the pulse names.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of pulse names.
static PulseSettings Deadline.Scripting.RepositoryUtils.GetPulseSettings ( string  pulseName,
bool  invalidateCache 
)
static

Gets settings for a pulse.

Parameters
pulseNameThe pulse name.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The pulse settings.
static PulseSettings [] Deadline.Scripting.RepositoryUtils.GetPulseSettingsList ( bool  invalidateCache)
static

Gets all the pulse settings.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of pulse settings.
static PulseSettings [] Deadline.Scripting.RepositoryUtils.GetPulseSettingsList ( string[]  pulseNames,
bool  invalidateCache 
)
static

Gets a list of pulse settings.

Parameters
pulseNamesThe list of pulse names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of pulse settings.
static string Deadline.Scripting.RepositoryUtils.GetRegionNameFromId ( string  regionName)
static

Gets the name of the Region or Cloud Region for the given region ID.

Parameters
regionNameThe region ID.
Returns
The region name, or an empty string if the region ID does not exist.
static DateTime Deadline.Scripting.RepositoryUtils.GetRepositoryDateTime ( )
static

Gets the current Repository DateTime.

Returns
The DateTime.
static string Deadline.Scripting.RepositoryUtils.GetRootDirectory ( )
static

Gets the repository root directory.

Returns
The root directory.
static string Deadline.Scripting.RepositoryUtils.GetRootDirectory ( string  subFolder)
static

Gets the repository root directory with sync arguments.

Parameters
subFolderThe subfolder to get the directory path for.
Returns
The root directory for the given subfolder.
static string Deadline.Scripting.RepositoryUtils.GetScriptsDirectory ( )
static

Gets the repository scripts directory.

Returns
The scripts directory.
static string Deadline.Scripting.RepositoryUtils.GetSettingsDirectory ( )
static

Gets the repository settings directory.

Returns
The settings directory.
static SlaveInfo Deadline.Scripting.RepositoryUtils.GetSlaveInfo ( string  slaveName,
bool  invalidateCache 
)
static

Gets a slave info.

Parameters
slaveNameThe slave name.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The slave info.
static SlaveInfo [] Deadline.Scripting.RepositoryUtils.GetSlaveInfos ( bool  invalidateCache)
static

Gets all the slave infos.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of slave infos.
static SlaveInfo [] Deadline.Scripting.RepositoryUtils.GetSlaveInfos ( string[]  slaveNames,
bool  invalidateCache 
)
static

Gets a list of slave infos.

Parameters
slaveNamesThe list of slave names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of slave infos.
static SlaveInfoSettings [] Deadline.Scripting.RepositoryUtils.GetSlaveInfoSettings ( bool  invalidateCache)
static

Gets all the slave info settings.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of slave info settings.
static SlaveInfoSettings [] Deadline.Scripting.RepositoryUtils.GetSlaveInfoSettings ( string[]  slaveNames,
bool  invalidateCache 
)
static

Gets a list of slave info settings.

Parameters
slaveNamesThe list of slave names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of slave info settings.
static string [] Deadline.Scripting.RepositoryUtils.GetSlaveNames ( bool  invalidateCache)
static

Gets all the slave names.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of slave names.
static string Deadline.Scripting.RepositoryUtils.GetSlaveReportLog ( Report  report)
static

Gets the log for a slave report.

Parameters
reportThe report.
Returns
The log.
static string Deadline.Scripting.RepositoryUtils.GetSlaveReportLogFileName ( Report  report)
static

Gets the full path to the report log file for a slave report. Note that the file is a bzip file.

Parameters
reportThe report.
Returns
The report log file name. This will be an empty string if there was an error saving the report to the Repository.
static SlaveReportCollection Deadline.Scripting.RepositoryUtils.GetSlaveReports ( string  slaveName)
static

Gets the reports for a slave.

Parameters
slaveNameThe slave name.
Returns
The collection of reports.
static SlaveSettings Deadline.Scripting.RepositoryUtils.GetSlaveSettings ( string  slaveName,
bool  invalidateCache 
)
static

Gets settings for a slave.

Parameters
slaveNameThe slave name.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The slave settings.
static SlaveSettings [] Deadline.Scripting.RepositoryUtils.GetSlaveSettingsList ( bool  invalidateCache)
static

Gets all the slave settings.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of slave settings.
static SlaveSettings [] Deadline.Scripting.RepositoryUtils.GetSlaveSettingsList ( string[]  slaveNames,
bool  invalidateCache 
)
static

Gets a list of slave settings.

Parameters
slaveNamesThe list of slave names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of slave settings.
static string [] Deadline.Scripting.RepositoryUtils.GetSlavesRenderingJob ( string  jobId)
static

Gets the names of the slaves rendering the specified job.

Parameters
jobIdThe job ID.
Returns
The list of slaves.
static string [] Deadline.Scripting.RepositoryUtils.GetUserGroup ( string  userGroupName)
static

Gets the users for the user group with the given name.

Parameters
userGroupNameThe user group to get the user for.
Returns
A list of user names for that user group.
static string [] Deadline.Scripting.RepositoryUtils.GetUserGroupNames ( )
static

Gets all the user group names.

Returns
The list of user group names.
static string [] Deadline.Scripting.RepositoryUtils.GetUserGroupsForUser ( string  user)
static

Get the user group names for the provided user.

Parameters
userThe user to get the user group names for.
Returns
The user groups the user belongs to.
static IUserInfo Deadline.Scripting.RepositoryUtils.GetUserInfo ( string  userName,
bool  invalidateCache 
)
static

Gets a user's info.

Parameters
userNameThe user name.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The user info.
static IUserInfo [] Deadline.Scripting.RepositoryUtils.GetUserInfos ( bool  invalidateCache)
static

Gets all the user infos.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of user infos.
static IUserInfo [] Deadline.Scripting.RepositoryUtils.GetUserInfos ( string[]  userNames,
bool  invalidateCache 
)
static

Gets a list of user infos.

Parameters
userNamesThe list of user names.
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of user infos.
static string [] Deadline.Scripting.RepositoryUtils.GetUserNames ( bool  invalidateCache)
static

Gets all the user names.

Parameters
invalidateCacheSpecify True to update the cache, or False to use the data currently cached.
Returns
The list of user names.
static string Deadline.Scripting.RepositoryUtils.GetWindowsAlternateAuxiliaryPath ( )
static

Gets the alternate auxiliary file directory for Windows.

Returns
The auxiliary directory.
static Job Deadline.Scripting.RepositoryUtils.ImportJob ( string  archivedJobFile,
bool  deleteArchive 
)
static

Imports an archived job and returns it.

Parameters
archivedJobFileThe path to the archived job file.
deleteArchiveIf True, the archived file will be deleted after the job is imported.
Returns
The imported job.
static bool Deadline.Scripting.RepositoryUtils.JobExists ( string  jobId)
static

Checks if a job exists.

Parameters
jobIdThe job ID.
Returns
True if the job exists.
static void Deadline.Scripting.RepositoryUtils.NewUserGroup ( string  userGroupName)
static

Creates a new user group with the given name if it does not already exist.

Parameters
userGroupNameThe user group name to create.
static void Deadline.Scripting.RepositoryUtils.NewUserGroups ( string[]  userGroupNames)
static

Creates new user groups with the given names if they do not already exist.

Parameters
userGroupNamesThe user group names to create.
static bool Deadline.Scripting.RepositoryUtils.PathMappingRequired ( string  path)
static

Checks if the given path matches a path mapping setting in the Repository Options.

Parameters
pathThe path.
Returns
If path mapping is required for this path.
static void Deadline.Scripting.RepositoryUtils.PendJob ( Job  job)
static

Place a job with dependencies in the pending state.

Parameters
jobThe job to pend.
static bool Deadline.Scripting.RepositoryUtils.PendTasks ( Job  job,
Task[]  tasks 
)
static

Pends tasks for a job. This is only supported if the job is frame dependent.

Parameters
jobThe job.
tasksThe list of tasks to pend.
Returns
Returns True if the job is now in the pending state.
static bool Deadline.Scripting.RepositoryUtils.ProxyServerExists ( string  proxyName)
static

Checks if a specified Proxy Server exists.

Parameters
proxyNameThe Proxy Server name to check.
Returns
True if the Proxy Server exists, false otherwise.
static bool Deadline.Scripting.RepositoryUtils.PulseExists ( string  pulseName)
static

Checks whether or not a Pulse with the given name exists.

Parameters
pulseNameThe pulse name to check.
Returns
Whether or not the Pulse exists.
static void Deadline.Scripting.RepositoryUtils.PurgeDeletedJobs ( string  jobID)
static

Purge deleted job.

Parameters
jobIDThe deleted job ID to purge.
static void Deadline.Scripting.RepositoryUtils.PurgeDeletedJobs ( string[]  jobIDs)
static

Purge deleted jobs.

Parameters
jobIDsThe deleted job IDs to purge.
static void Deadline.Scripting.RepositoryUtils.ReleasePendingJob ( Job  job)
static

Releases a pending job.

Parameters
jobThe pending job to release.
static void Deadline.Scripting.RepositoryUtils.ReleasePendingTasks ( Job  job,
Task[]  tasks 
)
static

Releases pending tasks for a job. This is only supported if the job is frame dependent.

Parameters
jobThe job.
tasksThe list of pending tasks to resume.
static void Deadline.Scripting.RepositoryUtils.RemoveGroupFromSlave ( string  slaveName,
string  groupName 
)
static

Removes a group from the given slave.

Parameters
slaveNameThe slave name.
groupNameThe group name.
static void Deadline.Scripting.RepositoryUtils.RemovePoolFromSlave ( string  slaveName,
string  poolName 
)
static

Removes a pool from the given slave.

Parameters
slaveNameThe slave name.
poolNameThe pool name.
static void Deadline.Scripting.RepositoryUtils.RemoveSlavesFromLimitGroupList ( string  name,
object  slaveNames 
)
static

Removes slaves from a limit group's list of slaves.

Parameters
nameThe limit group name.
slaveNamesThe list of slaves to remove.
static void Deadline.Scripting.RepositoryUtils.RemoveSlavesFromMachineLimitList ( string  jobId,
object  slaveNames 
)
static

Removes slaves from a job machine limit's list of slaves.

Parameters
jobIdThe job ID.
slaveNamesThe list of slaves to remove.
static void Deadline.Scripting.RepositoryUtils.RemoveUsersFromUserGroups ( string[]  users,
string[]  userGroups 
)
static

Removes all the users given from the provided user groups.

Parameters
usersThe users to remove.
userGroupsThe user groups to remove from.
static void Deadline.Scripting.RepositoryUtils.RequeueJob ( Job  job)
static

Requeues a job. All rendering and completed tasks for the job will be requeued.

Parameters
jobThe job to requeue.
static void Deadline.Scripting.RepositoryUtils.RequeueTasks ( Job  job,
Task[]  tasks 
)
static

Requeue tasks for a job.

Parameters
jobThe job.
tasksThe list of tasks to requeue.
static void Deadline.Scripting.RepositoryUtils.ResetLimitGroup ( string  limitGroupName)
static

Resets the usage counts for a limit group.

Parameters
limitGroupNameThe limit group name.
static Job Deadline.Scripting.RepositoryUtils.ResubmitJob ( Job  job,
string  frameList,
int  chunkSize,
bool  submitSuspended 
)
static

Resubmits an existing job to Deadline.

Parameters
jobThe job to resubmit.
frameListThe new list of frames.
chunkSizeThe new chunk size.
submitSuspendedIf the job should be submitted in the suspended state.
Returns
The new job object.
static void Deadline.Scripting.RepositoryUtils.ResumeFailedJob ( Job  job)
static

Resume a failed job.

Parameters
jobThe failed job to resume.
static void Deadline.Scripting.RepositoryUtils.ResumeFailedTasks ( Job  job,
Task[]  tasks 
)
static

Resumes failed tasks for a job.

Parameters
jobThe job.
tasksThe list of failed tasks to resume.
static void Deadline.Scripting.RepositoryUtils.ResumeJob ( Job  job)
static

Resume a suspended job.

Parameters
jobThe job to resume.
static void Deadline.Scripting.RepositoryUtils.ResumeTasks ( Job  job,
Task[]  tasks 
)
static

Resumes suspended tasks for a job.

Parameters
jobThe job.
tasksThe list of tasks to resume.
static void Deadline.Scripting.RepositoryUtils.SaveBalancerInfo ( BalancerInfo  balancerInfo)
static

Saves a balancer info to the database.

Parameters
balancerInfoThe balancer info.
static void Deadline.Scripting.RepositoryUtils.SaveBalancerSettings ( BalancerSettings  balancerSettings)
static

Saves settings for a balancer to the database.

Parameters
balancerSettingsThe balancer settings.
static void Deadline.Scripting.RepositoryUtils.SaveJob ( Job  job)
static

Updates a job's properties in the database.

Parameters
jobThe job.
static void Deadline.Scripting.RepositoryUtils.SaveLimitGroup ( LimitGroup  limitGroup)
static

Updates a limit group's properties in the database.

Parameters
limitGroupThe limit group.
static bool Deadline.Scripting.RepositoryUtils.SaveNetworkSettings ( IDeadlineNetworkSettings  networkSettings)
static

Saves the network settings to the repository.

Parameters
networkSettingsThe network settings to save.
Returns
True if the settings were saved.
static bool Deadline.Scripting.RepositoryUtils.SavePowerManagementOptions ( PowerManagementOptions  options)
static

Saves the power management options.

Parameters
optionsThe power management options.
Returns
True if the options were saved.
static void Deadline.Scripting.RepositoryUtils.SaveProxyServerInfo ( ProxyServerInfo  proxyInfo)
static

Save a ProxyServerInfo object to the Database.

Parameters
proxyInfoThe ProxyServerInfo.
static void Deadline.Scripting.RepositoryUtils.SaveProxyServerSettings ( ProxyServerSettings  proxySettings)
static

Save a ProxyServerInfo object to the Database.

Parameters
proxySettingsThe ProxyServerSettings.
static void Deadline.Scripting.RepositoryUtils.SavePulseInfo ( PulseInfo  pulseInfo)
static

Saves a pulse info to the database.

Parameters
pulseInfoThe pulse info.
static void Deadline.Scripting.RepositoryUtils.SavePulseSettings ( PulseSettings  pulseSettings)
static

Saves settings for a pulse to the database.

Parameters
pulseSettingsThe pulse settings.
static void Deadline.Scripting.RepositoryUtils.SaveSlaveInfo ( SlaveInfo  slaveInfo)
static

Saves a slave info to the database.

Parameters
slaveInfoThe slave info.
static void Deadline.Scripting.RepositoryUtils.SaveSlaveSettings ( SlaveSettings  slaveSettings)
static

Saves settings for a slave to the database.

Parameters
slaveSettingsThe slave settings.
static void Deadline.Scripting.RepositoryUtils.SaveUserInfo ( IUserInfo  userInfo)
static

Saves a user info to the database.

Parameters
userInfoThe user info.
static void Deadline.Scripting.RepositoryUtils.SetGroupsForSlave ( string  slaveName,
string[]  groupNames 
)
static

Sets the list of groups for the given slave.

Parameters
slaveNameThe slave name.
groupNamesThe group names.
static void Deadline.Scripting.RepositoryUtils.SetJobFrameRange ( Job  job,
string  frameList,
int  chunkSize 
)
static

Modifies a job's frame range. If the job is currently being rendered, any rendering tasks will be requeued to perform this operation.

Parameters
jobThe job.
frameListThe frame list.
chunkSizeThe chunk size.
static void Deadline.Scripting.RepositoryUtils.SetJobOutputDirectories ( Job  job,
object  outputDirectories 
)
static

Sets the job's output directories.

Parameters
jobThe job.
outputDirectoriesThe list of output directories.
static LimitGroup Deadline.Scripting.RepositoryUtils.SetLimitGroup ( string  name,
int  limit,
object  listedSlaves,
bool  isWhiteList,
object  excludedSlaves,
double  releaseProgress 
)
static

Creates a limit group if it doesn't exist, or updates its properties if it does.

Parameters
nameThe limit group name.
limitThe limit.
listedSlavesThe list of slaves.
isWhiteListTrue if the list of slaves is a whitelist.
excludedSlavesThe list of slaves that will ignore this limit group.
releaseProgressThe release percentage.
static void Deadline.Scripting.RepositoryUtils.SetLimitGroupListedSlaves ( string  name,
object  slaveNames 
)
static

Sets the listed slaves for a limit group.

Parameters
nameThe limit group name.
slaveNamesThe list of slave names.
static void Deadline.Scripting.RepositoryUtils.SetLimitGroupMaximum ( string  name,
int  limit 
)
static

Sets the limit for a limit group.

Parameters
nameThe limit group name.
limitThe limit.
static void Deadline.Scripting.RepositoryUtils.SetLimitGroupReleaseProgress ( string  name,
double  releaseProgress 
)
static

Sets the release progres for a limit group.

Parameters
nameThe limit group name.
releaseProgressThe release progress.
static void Deadline.Scripting.RepositoryUtils.SetLimitGroupWhiteListFlag ( string  name,
bool  isWhiteList 
)
static

Sets if the slave list for a limit group is a whitelist or a blacklist.

Parameters
nameThe limit group name.
isWhiteListTrue if the list should be a whitelist.
static LimitGroup Deadline.Scripting.RepositoryUtils.SetMachineLimit ( string  jobId,
int  limit,
object  listedSlaves,
bool  isWhiteList,
double  releaseProgress 
)
static

Creates a machine limit for a job if it doesn't exist, or updates its properties if it does.

Parameters
jobIdThe job ID.
limitThe machine limit.
listedSlavesThe list of slaves.
isWhiteListTrue if the list of slaves is a whitelist.
releaseProgressThe release percentage.
static void Deadline.Scripting.RepositoryUtils.SetMachineLimitListedSlaves ( string  jobId,
object  slaveNames 
)
static

Sets the listed slaves for a job's machine limit.

Parameters
jobIdThe job ID.
slaveNamesThe list of slave names.
static void Deadline.Scripting.RepositoryUtils.SetMachineLimitMaximum ( string  jobId,
int  limit 
)
static

Sets the limit for a job's machine limit.

Parameters
jobIdThe job ID.
limitThe limit.
static void Deadline.Scripting.RepositoryUtils.SetMachineLimitReleaseProgress ( string  jobId,
double  releaseProgress 
)
static

Sets the release progres for a job's machine limit.

Parameters
jobIdThe job ID.
releaseProgressThe release progress.
static void Deadline.Scripting.RepositoryUtils.SetMachineLimitWhiteListFlag ( string  jobId,
bool  isWhiteList 
)
static

Sets if the slave list for a job's machine limit is a whitelist or a blacklist.

Parameters
jobIdThe job ID.
isWhiteListTrue if the list should be a whitelist.
static void Deadline.Scripting.RepositoryUtils.SetPoolsForSlave ( string  slaveName,
string[]  poolNames 
)
static

Sets the list of pools for the given slave.

Parameters
slaveNameThe slave name.
poolNamesThe pool names.
static void Deadline.Scripting.RepositoryUtils.SetPostJobScript ( Job  job,
string  script 
)
static

Sets a jobs post job script.

Parameters
jobThe job.
scriptThe script.
static void Deadline.Scripting.RepositoryUtils.SetPreJobScript ( Job  job,
string  script 
)
static

Sets a jobs pre job script.

Parameters
jobThe job.
scriptThe script.
static void Deadline.Scripting.RepositoryUtils.SetUsersForUserGroups ( string[]  users,
string[]  userGroups 
)
static

Sets the user list for the provided user groups to contain the provided users, overriding the old lists.

Parameters
usersThe users to set.
userGroupsThe user groups to set.
static bool Deadline.Scripting.RepositoryUtils.SlaveExists ( string  slaveName)
static

Checks whether or not a slave with the given name exists.

Parameters
slaveNameThe slave name to check.
Returns
Whether or not the Slave exists.
static Job Deadline.Scripting.RepositoryUtils.SubmitJob ( string[]  jobFiles)
static

Submits a job to Deadline.

Parameters
jobFilesThe job files that build up the job (job info file, plugin info file, and then any auxiliary files).
Returns
The job object.
static void Deadline.Scripting.RepositoryUtils.SuspendJob ( Job  job)
static

Suspend a queued, rendering, or pending job.

Parameters
jobThe job to suspend.
static void Deadline.Scripting.RepositoryUtils.SuspendNonRenderingTasks ( Job  job)
static

Suspend the non rendering tasks for a queued or pending job.

Parameters
jobThe job to suspend the non rendering tasks for.
static bool Deadline.Scripting.RepositoryUtils.SuspendTasks ( Job  job,
Task[]  tasks 
)
static

Suspends tasks for a job.

Parameters
jobThe job.
tasksThe list of tasks to suspend.
Returns
Returns True if the job is now suspended.
static void Deadline.Scripting.RepositoryUtils.UndeleteJob ( Job  job)
static

Undelete a job.

Parameters
jobThe job to undelete.
static void Deadline.Scripting.RepositoryUtils.UndeleteJobs ( Job[]  jobs)
static

Undelete jobs.

Parameters
jobsThe jobs to undelete.
static void Deadline.Scripting.RepositoryUtils.UpdateJobOutputFileNames ( Job  job,
object  outputFileNames 
)
static

Sets the job's output file names.

Parameters
jobThe job.
outputFileNamesThe list of output file names. These should be full paths including the file name.
static void Deadline.Scripting.RepositoryUtils.UpdateJobOutputTileFileNames ( Job  job,
string  outputTileFileNames[][] 
)
static

Sets the job's output tile file names.

Parameters
jobThe job.
outputTileFileNamesThe 2 dimensional list of output tile file names. These should be full paths including the file name.
static void Deadline.Scripting.RepositoryUtils.UpdateJobSubmissionDate ( Job  job)
static

Sets the job's submission date to the current time.

Parameters
jobThe job.
static void Deadline.Scripting.RepositoryUtils.UpdateTaskProperties ( string  jobID,
Task  task 
)
static

Updates some of the task properties for the given task. Note that only the settings in the task's TaskProperties container can be updated this way.

Parameters
jobIDThe job ID for the task.
taskThe task to update.
static void Deadline.Scripting.RepositoryUtils.UpdateTaskProperties ( string  jobID,
Task[]  tasks 
)
static

Updates some of the task properties for the given tasks. Note that only the settings in the task's TaskProperties container can be updated this way.

Parameters
jobIDThe job ID for the tasks.
tasksThe tasks to update.