Deadline Scripting Reference
10.1.23.6
|
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 Worker to a job's Bad Worker 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 Worker. More... | |
static void | AddJobHistoryEntry (string jobId, string entry) |
Adds a job history entry. More... | |
static void | AddOrUpdateEventPluginConfigSetting (string eventPluginName, string key, string value) |
Saves or updates an Event Plugin configuration value. More... | |
static void | AddOrUpdateServerData (string id, string key, string value) |
Save or updates the server data with the given ID. 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 Worker. More... | |
static void | AddRepositoryHistoryEntry (string entry) |
Adds a repository history entry. More... | |
static void | AddSlaveHistoryEntry (string slaveName, string entry) |
Adds a Worker history entry. More... | |
static void | AddSlavesToLimitGroupList (string name, object slaveNames) |
Adds Workers to a limit group's list of Workers. More... | |
static void | AddSlavesToMachineLimitList (string jobId, object slaveNames) |
Adds Workers to a job machine limit's list of Workers. 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 string | CheckPathMapping (string path, string forceSeparator) |
Performs path mapping on the given path. Uses the path mappings in the Repository Options. More... | |
static string | CheckPathMapping (string path, string forceSeparator, bool verbose) |
Performs path mapping on the given path. Uses the path mappings in the Repository Options. More... | |
static string[] | CheckPathMappingForMultiplePaths (string[] paths) |
Performs path mapping on the given paths. Uses the path mappings in the Repository Options. More... | |
static string[] | CheckPathMappingForMultiplePaths (string[] paths, bool verbose) |
Performs path mapping on the given paths. Uses the path mappings in the Repository Options. More... | |
static string[] | CheckPathMappingForMultiplePaths (string[] paths, string forceSeparator) |
Performs path mapping on the given paths. Uses the path mappings in the Repository Options. More... | |
static string[] | CheckPathMappingForMultiplePaths (string[] paths, string forceSeparator, bool verbose) |
Performs path mapping on the given paths. 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 | CheckPathMappingInFile (string inFileName, string outFileName, string forceSeparator) |
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, string forceSeparator, 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 forceSeparator, 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 forceSeparator, 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 | 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 forceSeparator, 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 forceSeparator, 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 | 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 | CreateAWSResourceTracker (string awsRegion=null, string awsProfile=null, string accessKey=null, string secretKey=null, string sessionToken=null) |
The Deadline Resource Tracker is a Cloud Formation Stack that is responsible for tracking the health of resources created in AWS by Deadline. For example, the Deadline Resource Tracker will terminate instances that are unable to connect to the Repository. This function creates the Stack if a Stack for the Deadline Resource Tracker is not already running in the specified region. 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 Workers from a job's Bad Worker list. More... | |
static void | DeleteAllJobReports (string jobId) |
Deletes all reports for a job. More... | |
static void | DeleteAllSlaveReports (string slaveName) |
Deletes all reports for a Worker. More... | |
static void | DeleteAWSResourceTracker (string awsRegion=null, string awsProfile=null, string accessKey=null, string secretKey=null, string sessionToken=null) |
Deletes the Deadline Resource Tracker Cloud Formation Stack. More... | |
static void | DeleteBadSlaveForJob (Job job, string slaveName) |
Deletes a Worker from a job's Bad Worker list. More... | |
static void | DeleteBadSlavesForJob (Job job, object slaveNames) |
Deletes a list of Workers from a job's Bad Worker list. More... | |
static void | DeleteBalancer (string balancerName) |
Deletes a specified Balancer. More... | |
static void | DeleteEventPluginConfigSetting (string eventPluginName, string key) |
Deletes an Event Plugin configuration value. 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 Remote Connection Server. More... | |
static void | DeletePulse (string pulseName) |
Delete the specified pulse. More... | |
static void | DeleteSlave (string slaveName) |
Deletes a specified Worker. More... | |
static void | DeleteSlaveReport (string slaveName, Report report) |
Deletes the given report for a Worker. More... | |
static void | DeleteSlaveReports (string slaveName, Report[] reports) |
Deletes the given reports for a Worker. More... | |
static void | DeleteUserGroup (string userGroupName) |
Deletes a user groups. More... | |
static string | DescribeAWSResourceTrackerStatus (string awsRegion=null, string awsProfile=null, string accessKey=null, string secretKey=null, string sessionToken=null) |
Checks the status of the Deadline Resource Tracker Cloud Formation Stack. More... | |
static RegionHealthStatus | DescribeRegionHealth (string region, string awsProfile, string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken) |
Fetch Fleet health data from AWS(DynamoDB) and update it in the repository if allowed and return it to the caller. Credentials provisioning chain: 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) |
Changes the given list of Tasks to the Failed status. More... | |
static bool | FailTasks (Job job, Task[] tasks, string slaveName) |
Changes the given list of Tasks to the Failed status. 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 DashFleetRequest | GetAWSPortalFleetRequest (string requestId) |
Returns a DashFleetRequest with the given id. More... | |
static DashFleetRequest[] | GetAWSPortalFleetRequests () |
Returns all the AWS Portal Spot Fleet Requests. More... | |
static DashFleetRequest[] | GetAWSPortalFleetRequests (string[] requestIds) |
Returns the requested set of AWS Portal Spot Fleet Requests. More... | |
static AWSPortalInfrastructure[] | GetAWSPortalInfrastructures () |
Returns all the DAWS infrastructure objects. More... | |
static DashFleetInstance | GetAWSPortalInstance (string instanceId) |
Returns the DashFleetInstance with the given instance id. More... | |
static DashFleetInstance[] | GetAWSPortalInstances () |
Returns all the AWS Portal Instance objects. More... | |
static DashFleetInstance[] | GetAWSPortalInstances (string[] instanceIds) |
Returns a set of DashFleetInstances with the given ids. More... | |
static string | GetAWSPortalRequestTypeEnumName (int value) |
Returns the string representation of the AWSPortalRequestType enum for the given value. More... | |
static int | GetAWSPortalRequestTypeEnumValue (string name) |
Returns the int representation of the AWSPortalRequestType enum with the string matching 'name'. More... | |
static AWSPortalSettings | GetAWSPortalSettings () |
Gets the DAWS settings. 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 Dictionary< string, string > | GetEventPluginConfigMetaDataDictionary (string eventPluginName) |
Get the metadata dictionary from the PluginConfigSettings for the given eventPluginName. 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 () |
Gets the job IDs. For Web Service scripts only. More... | |
static string[] | GetJobIds (bool invalidateCache) |
Gets all the job IDs. 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 (bool invalidate) |
Gets all the limit groups. More... | |
static LimitGroup[] | GetLimitGroups (string[] limitGroupNames, bool invalidate) |
Gets a list of 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[] | GetPluginLimitGroups (string pluginName) |
Retrieve PluginConfigSettings.LimitNames for a specified pluginName . 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 Remote Connection Server. More... | |
static ProxyServerInfo[] | GetProxyServerInfos (bool invalidateCache) |
Gets ProxyServerInfo objects for all Remote Connection Servers. More... | |
static ProxyServerInfo[] | GetProxyServerInfos (string[] proxyNames, bool invalidateCache) |
Gets ProxyServerInfo objects for all specified Remote Connection Servers. More... | |
static ProxyServerInfoSettings[] | GetProxyServerInfoSettings (bool invalidateCache) |
Gets ProxyServerInfoSettings objects for all Remote Connection Servers. More... | |
static ProxyServerInfoSettings[] | GetProxyServerInfoSettings (string[] proxyNames, bool invalidateCache) |
Gets ProxyServerInfoSettings objects for all specified Remote Connection Servers. More... | |
static string[] | GetProxyServerNames (bool invalidateCache) |
Gets all the Remote Connection Server names. More... | |
static ProxyServerSettings | GetProxyServerSettings (string proxyName, bool invalidateCache) |
Gets ProxyServerSettings for a specified Remote Connection Server. More... | |
static ProxyServerSettings[] | GetProxyServerSettingsList (bool invalidateCache) |
Gets ProxyServerSettings objects for all Remote Connection Servers. More... | |
static ProxyServerSettings[] | GetProxyServerSettingsList (string[] proxyNames, bool invalidateCache) |
Gets ProxyServerSettings objects for all specified Remote Connection 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 | GetRepositoryFilePath (string filePath, bool checkCustom) |
Returns the appropriate full path to the given file in the Repository. More... | |
static string | GetRepositoryPath (string subFolder, bool checkCustom) |
Returns the appropriate full path to the given subdirectory of the Repository. 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 Dictionary< string, string > | GetServerData (string id) |
Gets the server data with the given ID. More... | |
static string | GetSettingsDirectory () |
Gets the repository settings directory. More... | |
static SlaveInfo | GetSlaveInfo (string slaveName, bool invalidateCache) |
Gets a Worker info. More... | |
static SlaveInfo[] | GetSlaveInfos (bool invalidateCache) |
Gets all the Worker infos. More... | |
static SlaveInfo[] | GetSlaveInfos (string[] slaveNames, bool invalidateCache) |
Gets a list of Worker infos. More... | |
static SlaveInfoSettings[] | GetSlaveInfoSettings (bool invalidateCache) |
Gets all the Worker info settings. More... | |
static SlaveInfoSettings[] | GetSlaveInfoSettings (string[] slaveNames, bool invalidateCache) |
Gets a list of Worker info settings. More... | |
static string[] | GetSlaveNames (bool invalidateCache) |
Gets all the Worker names. More... | |
static string | GetSlaveReportLog (Report report) |
Gets the log for a Worker report. More... | |
static string | GetSlaveReportLogFileName (Report report) |
Gets the full path to the report log file for a Worker report. Note that the file is a bzip file. More... | |
static SlaveReportCollection | GetSlaveReports (string slaveName) |
Gets the reports for a Worker. More... | |
static SlaveSettings | GetSlaveSettings (string slaveName, bool invalidateCache) |
Gets settings for a Worker. More... | |
static SlaveSettings[] | GetSlaveSettingsList (bool invalidateCache) |
Gets all the Worker settings. More... | |
static SlaveSettings[] | GetSlaveSettingsList (string[] slaveNames, bool invalidateCache) |
Gets a list of Worker settings. More... | |
static string[] | GetSlavesRenderingJob (string jobId) |
Gets the names of the Workers rendering the specified job. More... | |
static string | GetSlaveStatusEnumName (int value) |
Gets the string representation of the SlaveStatus enum for the given value. More... | |
static int | GetSlaveStatusEnumValue (string name) |
Returns the int representation of the SlaveStatus enum with the string matching 'name'. 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 Remote Connection 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 Worker. More... | |
static void | RemovePoolFromSlave (string slaveName, string poolName) |
Removes a pool from the given Worker. More... | |
static void | RemoveSlavesFromLimitGroupList (string name, object slaveNames) |
Removes Workers from a limit group's list of Workers. More... | |
static void | RemoveSlavesFromMachineLimitList (string jobId, object slaveNames) |
Removes Workers from a job machine limit's list of Workers. 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 bool | SaveAWSPortalSettings (AWSPortalSettings settings) |
Saves the DAWS settings. 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 Worker info to the database. More... | |
static void | SaveSlaveSettings (SlaveSettings slaveSettings) |
Saves settings for a Worker 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 Worker. 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 Workers 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 Worker list for a limit group is an allow list or a deny list. 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 Workers 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 Worker list for a job's machine limit is an allow list or a deny list. More... | |
static void | SetPluginLimitGroups (string pluginName, string[] limitGroupNames) |
Set PluginConfigSettings.LimitNames property for a specified pluginName . More... | |
static void | SetPoolsForSlave (string slaveName, string[] poolNames) |
Sets the list of pools for the given Worker. 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 Worker with the given name exists. More... | |
static Job | SubmitJob (string[] jobFiles) |
Submits a job to Deadline. More... | |
static List< string > | SubmitJobs (List< RequestSubmissionJob > jobs, string username) |
Submits jobs in bulk to the RCS. More... | |
static List< string > | SubmitJobs (List< RequestSubmissionJob > jobs, string username, HttpClient httpClient, int auxFileChunkSizeInMB, string connectionString) |
Submits jobs in bulk to the RCS. 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 | TryDeletingResourceTrackerStackIfNecessary (string awsRegion=null, string awsProfile=null, string accessKey=null, string secretKey=null, string sessionToken=null) |
Deletes the Deadline Resource Tracker if it is in an unhealthy state. 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... | |
Repository utility functions.
|
static |
Adds an aux file to the specified job.
job | The job. |
newAuxFilePath | An auxiliary data file name. This should be the full path including the file name to a data file. |
|
static |
Adds a Worker to a job's Bad Worker list.
job | The job. |
slaveName | The name of the Worker to add to the list. |
|
static |
Adds a group to the repository.
groupName | The group name. |
|
static |
Adds a group to the given Worker.
slaveName | The Worker name. |
groupName | The group name. |
|
static |
Adds a job history entry.
jobId | The job's ID. |
entry | The history text. |
|
static |
Saves or updates an Event Plugin configuration value.
eventPluginName | |
key | |
value |
|
static |
Save or updates the server data with the given ID.
id | The server data ID. |
key | The key to save to Server Data. |
value | The server data value to save with the key. |
|
static |
Adds a pool to the repository.
poolName | The pool name. |
|
static |
Adds a pool to the given Worker.
slaveName | The Worker name. |
poolName | The pool name. |
|
static |
Adds a repository history entry.
entry | The history text. |
|
static |
Adds a Worker history entry.
slaveName | The Worker name. |
entry | The history text. |
|
static |
Adds Workers to a limit group's list of Workers.
name | The limit group name. |
slaveNames | The list of Workers to add. |
|
static |
Adds Workers to a job machine limit's list of Workers.
jobId | The job ID. |
slaveNames | The list of Workers to add. |
|
static |
Adds all the users given to the provided user groups.
users | The users to add. |
userGroups | The user groups to add to. |
|
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.
job | The job. |
frameList | The additional frames to append. |
|
static |
Archive a non-queued, non-rendering job.
job | The job to archive. |
deleteFromDB | If True, the job will be deleted from the repository after it is archived. |
archiveFolderOverride | If not null, the archived job will be placed in this folder instead of the jobsArchived folder in the repository. |
|
static |
|
static |
Performs path mapping on the given path. Uses the path mappings in the Repository Options.
path | The path. |
|
static |
Performs path mapping on the given path. Uses the path mappings in the Repository Options.
path | The path. |
verbose | If verbose logging should be enabled. |
|
static |
Performs path mapping on the given path. Uses the path mappings in the Repository Options.
path | The path. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
|
static |
Performs path mapping on the given path. Uses the path mappings in the Repository Options.
path | The path. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
verbose | If verbose logging should be enabled. |
|
static |
Performs path mapping on the given paths. Uses the path mappings in the Repository Options.
paths | The paths. |
|
static |
Performs path mapping on the given paths. Uses the path mappings in the Repository Options.
paths | The paths. |
verbose | If verbose logging should be enabled. |
|
static |
Performs path mapping on the given paths. Uses the path mappings in the Repository Options.
paths | The paths. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
|
static |
Performs path mapping on the given paths. Uses the path mappings in the Repository Options.
paths | The paths. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
verbose | If verbose logging should be enabled. |
|
static |
Performs path mapping on the contents of the given file. Uses the path mappings in the Repository Options.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
|
static |
Performs path mapping on the contents of the given file. Uses the path mappings in the Repository Options.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
readFileAsBytes | If 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 |
Performs path mapping on the contents of the given file. Uses the path mappings in the Repository Options.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
|
static |
Performs path mapping on the contents of the given file. Uses the path mappings in the Repository Options.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
readFileAsBytes | If set to True, the input file will be processed byte-by-byte. However, this is known to have issues with UTF16 ro UTF32 encoded files. |
|
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.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
stringsToReplace | The list of strings to replace. |
newStrings | The list of new strings. Must be the same number of strings as stringsToReplace. |
|
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.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
stringsToReplace | The list of strings to replace. |
newStrings | The list of new strings. Must be the same number of strings as stringsToReplace. |
readFileAsBytes | If set to True, the input file will be processed byte-by-byte. However, this is known to have issues with UTF16 ro UTF32 encoded files. |
|
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.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
stringsToReplace | The list of strings to replace. |
newStrings | The list of new strings. Must be the same number of strings as stringsToReplace. |
|
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.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
stringsToReplace | The list of strings to replace. |
newStrings | The list of new strings. Must be the same number of strings as stringsToReplace. |
readFileAsBytes | If 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 |
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.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
separatorToReplace | The path separator to replace. |
newSeparator | The new path separator. |
|
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.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
forceSeparator | All path separators in the replacement path will be replaced with this before the original path is mapped. For example, if this is set to "/", and "/mnt/server/" is being replaced with "Y:\", the resulting path will contain "Y:/" instead of the original "Y:\". If set to null, this will be ignored. |
separatorToReplace | The path separator to replace. |
newSeparator | The new path separator. |
readFileAsBytes | If set to True, the input file will be processed byte-by-byte. However, this is known to have issues with UTF16 ro UTF32 encoded files. |
|
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.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
separatorToReplace | The path separator to replace. |
newSeparator | The new path separator. |
|
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.
inFileName | The original file name. |
outFileName | The new file name where the mapped contents will be stored. |
separatorToReplace | The path separator to replace. |
newSeparator | The new path separator. |
readFileAsBytes | If 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 |
Completes a job. All incomplete tasks for the job will be marked as complete.
job | The job to complete. |
|
static |
Complete tasks for a job.
job | The job. |
tasks | The list of tasks to complete. |
slaveName | This is the Worker that will show up as completing the tasks. |
|
static |
The Deadline Resource Tracker is a Cloud Formation Stack that is responsible for tracking the health of resources created in AWS by Deadline. For example, the Deadline Resource Tracker will terminate instances that are unable to connect to the Repository. This function creates the Stack if a Stack for the Deadline Resource Tracker is not already running in the specified region.
awsRegion | AWS Region. |
awsProfile | AWS Profile Name. |
accessKey | AWS Access Key. |
secretKey | AWS Secret Access Key. |
sessionToken | AWS Session Token. |
|
static |
Creates the job info and plugin info files that were originally used to submit the given job.
job | The job. |
jobInfoFileName | The file name where the job info settings will be saved. |
pluginInfoFileName | The file name where the plugin info settings will be saved. |
|
static |
Deletes all Workers from a job's Bad Worker list.
job | The job. |
|
static |
Deletes all reports for a job.
jobId | The job's ID. |
|
static |
Deletes all reports for a Worker.
slaveName | The Worker's name. |
|
static |
|
static |
Deletes a Worker from a job's Bad Worker list.
job | The job. |
slaveName | The name of the Worker to remove from the list. |
|
static |
Deletes a list of Workers from a job's Bad Worker list.
job | The job. |
slaveNames | The list of Worker names to remove from the list. |
|
static |
Deletes a specified Balancer.
balancerName | The balancer name. |
|
static |
Deletes an Event Plugin configuration value.
eventPluginName | |
key |
|
static |
Removes a group from the repository.
groupName | The group name. |
|
static |
Delete a job.
job | The job to delete. |
|
static |
Deletes the given report for a job.
jobId | The job's ID. |
report | The report to delete. |
|
static |
Deletes the given reports for a job.
jobId | The job's ID. |
reports | The reports to delete. |
|
static |
Removes a pool from the repository.
poolName | The pool name. |
|
static |
Deletes the jobs post job script.
job | The job. |
|
static |
Deletes the jobs pre job script.
job | The job. |
|
static |
Delete the specified Remote Connection Server.
proxyName | The Remote Connection Server name. |
|
static |
Delete the specified pulse.
pulseName | The pulse name. |
|
static |
Deletes a specified Worker.
slaveName | The Worker name. |
|
static |
Deletes the given report for a Worker.
slaveName | The Worker's name. |
report | The report to delete. |
|
static |
Deletes the given reports for a Worker.
slaveName | The Worker's name. |
reports | The reports to delete. |
|
static |
Deletes a user groups.
userGroupName | The user group name to delete. |
|
static |
|
static |
Fetch Fleet health data from AWS(DynamoDB) and update it in the repository if allowed and return it to the caller. Credentials provisioning chain:
region | AWS Region for the Fleets to fetch and update the health for. |
awsProfile | AWS profile with the authentication params. |
awsAccessKeyId | AWS access key ID. |
awsSecretAccessKey | AWS secret access key. |
awsSessionToken | AWS session token that must be provided if using AWS temporary security credentials with AWS STS. |
ArgumentException | If invalid arguments are provided. |
AmazonDynamoDBException | If there is an issue accessing DynamoDB. |
|
static |
Fails a job. All incomplete tasks for the job will be marked as failed.
job | The job to fail. |
Changes the given list of Tasks to the Failed status.
job | The Job to which the Tasks belong. |
tasks | The list of tasks to fail. |
|
static |
Changes the given list of Tasks to the Failed status.
job | The Job to which the Tasks belong. |
tasks | The list of tasks to fail. |
slaveName | The name of the Worker to list as having failed the Tasks. |
|
static |
Gets the alternate auxiliary file directory based on the current operating system.
|
static |
Gets the pythonsync folder.
|
static |
Returns a DashFleetRequest with the given id.
requestId |
|
static |
Returns all the AWS Portal Spot Fleet Requests.
|
static |
Returns the requested set of AWS Portal Spot Fleet Requests.
requestIds |
|
static |
Returns all the DAWS infrastructure objects.
|
static |
Returns the DashFleetInstance with the given instance id.
instanceId |
|
static |
Returns all the AWS Portal Instance objects.
|
static |
Returns a set of DashFleetInstances with the given ids.
instanceIds |
|
static |
Returns the string representation of the AWSPortalRequestType enum for the given value.
value |
|
static |
Returns the int representation of the AWSPortalRequestType enum with the string matching 'name'.
name |
|
static |
Gets the DAWS settings.
|
static |
Gets a balancer info.
balancerName | The balancer name. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the balancer infos.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of balancer infos.
balancerNames | The list of balancer names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the balancer info settings.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of balancer info settings.
balancerNames | The list of balancer names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the balancer names.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets settings for a balancer.
balancerName | The balancer name. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the balancer settings.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of balancer settings.
balancerNames | The list of balancer names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the repository bin directory.
|
static |
Gets the repository cloud plugins directory.
|
static |
Gets the repository custom events directory.
|
static |
Gets the repository custom plugins directory.
|
static |
Gets the repository custom scripts directory.
|
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).
|
static |
Gets a deleted job.
jobId | The deleted job ID. |
|
static |
Gets all the deleted job IDs.
|
static |
Gets all the deleted jobs.
|
static |
Gets the configuration settings for an event plugin.
eventPluginName | The event plugin name. |
|
static |
Get the metadata dictionary from the PluginConfigSettings for the given eventPluginName.
eventPluginName | The event plugin name. |
|
static |
Returns the directory in which the given event plugin is located.
eventPluginName | The name of the event plugin to look for. |
|
static |
Gets the event plugin names.
|
static |
Gets the repository events directory.
|
static |
Gets the group names.
|
static |
Gets a job.
jobId | The job ID. |
invalidate | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the auxiliary file directory for the given job.
job | The job. |
|
static |
Gets a dictionary of job details for the provided jobs.
jobs | The list of jobs. |
|
static |
Gets the job IDs. For Web Service scripts only.
|
static |
Gets all the job IDs.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the report log for a job report.
report | The report. |
|
static |
Gets the full path to the report log file for a job report. Note that the file is a bzip file.
report | The report. |
|
static |
Gets the reports for a job.
jobId | The job ID. |
|
static |
Gets all the jobs.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of jobs.
jobIds | The list of job IDs. |
invalidate | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the jobs in the given state(s).
states | A 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. |
|
static |
Gets the job task limit.
|
static |
Gets the tasks for a job.
job | The job. |
invalidate | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a limit group.
limitGroupName | The limit group name. |
invalidate | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the limit group names.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the limit groups.
invalidate | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of limit groups.
limitGroupNames | The list of limit group names. |
invalidate | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the alternate auxiliary file directory for Linux.
|
static |
Gets the alternate auxiliary file directory for Mac OSX.
|
static |
Gets the machine limit for a job.
jobId | The job ID. |
invalidate | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the host names of the machines rendering the specified job.
jobId | The job ID. |
ipAddresses | If True, the machine IP addresses will be returned instead of the host names. |
|
static |
Gets the host names of the machines rendering the specified job.
jobId | The job ID. |
ipAddresses | If True, the machine IP addresses will be returned instead of the host names. |
duplicates | If True, duplicate IP addresses and hostnames will be returned. |
|
static |
Gets the maximum job priority.
|
static |
Gets the network settings.
|
static |
Gets the list of relevant path mappings as defined in Repository Options.
|
static |
Gets the configuration settings for a plugin.
pluginName | The plugin name. |
|
static |
Gets the configuration settings for a plugin.
altCustomPluginDirectory | A custom directory to get the plugin config from. |
pluginName | The plugin name. |
|
static |
Returns the directory in which the given plugin is located.
pluginName | The name of the plugin to look for. |
|
static |
Retrieve PluginConfigSettings.LimitNames for a specified pluginName .
pluginName | Name of a Deadline Plugin. |
|
static |
Gets the plugin names.
|
static |
Gets the repository plugins directory.
|
static |
Gets the pool names.
|
static |
Gets the power management options.
|
static |
Gets ProxyServerInfo for a specified Remote Connection Server.
proxyName | The Remote Connection Server name. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets ProxyServerInfo objects for all Remote Connection Servers.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets ProxyServerInfo objects for all specified Remote Connection Servers.
proxyNames | The list of Remote Connection Server names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets ProxyServerInfoSettings objects for all Remote Connection Servers.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets ProxyServerInfoSettings objects for all specified Remote Connection Servers.
proxyNames | The list of Remote Connection Server names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the Remote Connection Server names.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets ProxyServerSettings for a specified Remote Connection Server.
proxyName | Name of the Remote Connection Server. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets ProxyServerSettings objects for all Remote Connection Servers.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets ProxyServerSettings objects for all specified Remote Connection Servers.
proxyNames | The list of Remote Connection Server names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a pulse info.
pulseName | The pulse name. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the pulse infos.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of pulse infos.
pulseNames | The list of pulse names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the pulse info settings.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of pulse info settings.
pulseNames | The list of pulse names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the pulse names.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets settings for a pulse.
pulseName | The pulse name. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the pulse settings.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of pulse settings.
pulseNames | The list of pulse names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the name of the Region or Cloud Region for the given region ID.
regionName | The region ID. |
|
static |
Gets the current Repository DateTime.
|
static |
Returns the appropriate full path to the given file in the Repository.
filePath | The repository's file to retrieve. |
checkCustom | Whether or not to check the Custom folder first. |
|
static |
Returns the appropriate full path to the given subdirectory of the Repository.
subFolder | The repository's sub-directory to retrieve. |
checkCustom | Whether or not to check the Custom folder first. |
|
static |
Gets the repository root directory.
|
static |
Gets the repository root directory with sync arguments.
subFolder | The subfolder to get the directory path for. |
|
static |
Gets the repository scripts directory.
|
static |
Gets the server data with the given ID.
id | The server data ID. |
|
static |
Gets the repository settings directory.
|
static |
Gets a Worker info.
slaveName | The Worker name. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the Worker infos.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of Worker infos.
slaveNames | The list of Worker names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the Worker info settings.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of Worker info settings.
slaveNames | The list of Worker names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the Worker names.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the log for a Worker report.
report | The report. |
|
static |
Gets the full path to the report log file for a Worker report. Note that the file is a bzip file.
report | The report. |
|
static |
Gets the reports for a Worker.
slaveName | The Worker name. |
|
static |
Gets settings for a Worker.
slaveName | The Worker name. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the Worker settings.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of Worker settings.
slaveNames | The list of Worker names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the names of the Workers rendering the specified job.
jobId | The job ID. |
|
static |
Gets the string representation of the SlaveStatus enum for the given value.
value |
|
static |
Returns the int representation of the SlaveStatus enum with the string matching 'name'.
name |
|
static |
Gets the users for the user group with the given name.
userGroupName | The user group to get the user for. |
|
static |
Gets all the user group names.
|
static |
Get the user group names for the provided user.
user | The user to get the user group names for. |
|
static |
Gets a user's info.
userName | The user name. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the user infos.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets a list of user infos.
userNames | The list of user names. |
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets all the user names.
invalidateCache | Specify True to update the cache, or False to use the data currently cached. |
|
static |
Gets the alternate auxiliary file directory for Windows.
|
static |
Imports an archived job and returns it.
archivedJobFile | The path to the archived job file. |
deleteArchive | If True, the archived file will be deleted after the job is imported. |
|
static |
Checks if a job exists.
jobId | The job ID. |
|
static |
Creates a new user group with the given name if it does not already exist.
userGroupName | The user group name to create. |
|
static |
Creates new user groups with the given names if they do not already exist.
userGroupNames | The user group names to create. |
|
static |
Checks if the given path matches a path mapping setting in the Repository Options.
path | The path. |
|
static |
Place a job with dependencies in the pending state.
job | The job to pend. |
Pends tasks for a job. This is only supported if the job is frame dependent.
job | The job. |
tasks | The list of tasks to pend. |
|
static |
Checks if a specified Remote Connection Server exists.
proxyName | The Remote Connection Server name to check. |
|
static |
Checks whether or not a Pulse with the given name exists.
pulseName | The pulse name to check. |
|
static |
Purge deleted job.
jobID | The deleted job ID to purge. |
|
static |
Purge deleted jobs.
jobIDs | The deleted job IDs to purge. |
|
static |
Releases a pending job.
job | The pending job to release. |
Releases pending tasks for a job. This is only supported if the job is frame dependent.
job | The job. |
tasks | The list of pending tasks to resume. |
|
static |
Removes a group from the given Worker.
slaveName | The Worker name. |
groupName | The group name. |
|
static |
Removes a pool from the given Worker.
slaveName | The Worker name. |
poolName | The pool name. |
|
static |
Removes Workers from a limit group's list of Workers.
name | The limit group name. |
slaveNames | The list of Workers to remove. |
|
static |
Removes Workers from a job machine limit's list of Workers.
jobId | The job ID. |
slaveNames | The list of Workers to remove. |
|
static |
Removes all the users given from the provided user groups.
users | The users to remove. |
userGroups | The user groups to remove from. |
|
static |
Requeues a job. All rendering and completed tasks for the job will be requeued.
job | The job to requeue. |
Requeue tasks for a job.
job | The job. |
tasks | The list of tasks to requeue. |
|
static |
Resets the usage counts for a limit group.
limitGroupName | The limit group name. |
|
static |
Resubmits an existing job to Deadline.
job | The job to resubmit. |
frameList | The new list of frames. |
chunkSize | The new chunk size. |
submitSuspended | If the job should be submitted in the suspended state. |
|
static |
Resume a failed job.
job | The failed job to resume. |
Resumes failed tasks for a job.
job | The job. |
tasks | The list of failed tasks to resume. |
|
static |
Resume a suspended job.
job | The job to resume. |
Resumes suspended tasks for a job.
job | The job. |
tasks | The list of tasks to resume. |
|
static |
Saves the DAWS settings.
settings |
|
static |
Saves a balancer info to the database.
balancerInfo | The balancer info. |
|
static |
Saves settings for a balancer to the database.
balancerSettings | The balancer settings. |
|
static |
Updates a job's properties in the database.
job | The job. |
|
static |
Updates a limit group's properties in the database.
limitGroup | The limit group. |
|
static |
Saves the network settings to the repository.
networkSettings | The network settings to save. |
|
static |
Saves the power management options.
options | The power management options. |
|
static |
Save a ProxyServerInfo object to the Database.
proxyInfo | The ProxyServerInfo. |
|
static |
Save a ProxyServerInfo object to the Database.
proxySettings | The ProxyServerSettings. |
|
static |
Saves a pulse info to the database.
pulseInfo | The pulse info. |
|
static |
Saves settings for a pulse to the database.
pulseSettings | The pulse settings. |
|
static |
Saves a Worker info to the database.
slaveInfo | The Worker info. |
|
static |
Saves settings for a Worker to the database.
slaveSettings | The Worker settings. |
|
static |
Saves a user info to the database.
userInfo | The user info. |
|
static |
Sets the list of groups for the given Worker.
slaveName | The Worker name. |
groupNames | The group names. |
|
static |
Modifies a job's frame range. If the job is currently being rendered, any rendering tasks will be requeued to perform this operation.
job | The job. |
frameList | The frame list. |
chunkSize | The chunk size. |
|
static |
Sets the job's output directories.
job | The job. |
outputDirectories | The list of output directories. |
|
static |
Creates a limit group if it doesn't exist, or updates its properties if it does.
name | The limit group name. |
limit | The limit. |
listedSlaves | The list of Workers. |
isWhiteList | True if the list of Workers is an allow list. |
excludedSlaves | The list of Workers that will ignore this limit group. |
releaseProgress | The release percentage. |
|
static |
Sets the listed Workers for a limit group.
name | The limit group name. |
slaveNames | The list of Worker names. |
|
static |
Sets the limit for a limit group.
name | The limit group name. |
limit | The limit. |
|
static |
Sets the release progres for a limit group.
name | The limit group name. |
releaseProgress | The release progress. |
|
static |
Sets if the Worker list for a limit group is an allow list or a deny list.
name | The limit group name. |
isWhiteList | True if the list should be an allow list. |
|
static |
Creates a machine limit for a job if it doesn't exist, or updates its properties if it does.
jobId | The job ID. |
limit | The machine limit. |
listedSlaves | The list of Workers. |
isWhiteList | True if the list of Workers is an allow list. |
releaseProgress | The release percentage. |
|
static |
Sets the listed Workers for a job's machine limit.
jobId | The job ID. |
slaveNames | The list of Worker names. |
|
static |
Sets the limit for a job's machine limit.
jobId | The job ID. |
limit | The limit. |
|
static |
Sets the release progres for a job's machine limit.
jobId | The job ID. |
releaseProgress | The release progress. |
|
static |
Sets if the Worker list for a job's machine limit is an allow list or a deny list.
jobId | The job ID. |
isWhiteList | True if the list should be an allow list. |
|
static |
|
static |
Sets the list of pools for the given Worker.
slaveName | The Worker name. |
poolNames | The pool names. |
|
static |
Sets a jobs post job script.
job | The job. |
script | The script. |
|
static |
Sets a jobs pre job script.
job | The job. |
script | The script. |
|
static |
Sets the user list for the provided user groups to contain the provided users, overriding the old lists.
users | The users to set. |
userGroups | The user groups to set. |
|
static |
Checks whether or not a Worker with the given name exists.
slaveName | The Worker name to check. |
|
static |
Submits a job to Deadline.
jobFiles | The job files that build up the job (job info file, plugin info file, and then any auxiliary files). |
|
static |
Submits jobs in bulk to the RCS.
jobs | List of jobs to submit in bulk. |
username | The username of a user that has property rights to submit jobs.. |
|
static |
Submits jobs in bulk to the RCS.
jobs | List of jobs to submit in bulk. |
username | The username of a user that has property rights to submit jobs. |
auxFileChunkSizeInMB | How large of a file chunk in MB to submit to the API at once. |
connectionString | "Which RCS to submit the Jobs to, if no connection string is provided, the default RCS in the settings will be used." |
|
static |
Suspend a queued, rendering, or pending job.
job | The job to suspend. |
|
static |
Suspend the non rendering tasks for a queued or pending job.
job | The job to suspend the non rendering tasks for. |
Suspends tasks for a job.
job | The job. |
tasks | The list of tasks to suspend. |
|
static |
Deletes the Deadline Resource Tracker if it is in an unhealthy state.
awsRegion | AWS Region. |
awsProfile | AWS Profile Name. |
accessKey | AWS Access Key. |
secretKey | AWS Secret Access Key. |
sessionToken | AWS Session Token. |
|
static |
Undelete a job.
job | The job to undelete. |
|
static |
Undelete jobs.
jobs | The jobs to undelete. |
|
static |
Sets the job's output file names.
job | The job. |
outputFileNames | The list of output file names. These should be full paths including the file name. |
|
static |
Sets the job's output tile file names.
job | The job. |
outputTileFileNames | The 2 dimensional list of output tile file names. These should be full paths including the file name. |
|
static |
Sets the job's submission date to the current time.
job | The job. |
|
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.
jobID | The job ID for the task. |
task | The task to update. |
|
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.
jobID | The job ID for the tasks. |
tasks | The tasks to update. |