Database and Repository - Command Arguments

Command Overview

Database and Repository

Clients and Logs

Workers

Jobs

Tasks

Pools, Groups, and Limits

Users and User Groups

Path and Drive Mapping

AWS Portal and Cloud

Scripting

System Functions and Dialogs

Scans, History, and Reports

Version and Help

Database

ConfigureMongoDBDatabase

Description:

Configures (or re-configures) a Deadline database. This will connect to MongoDB using the provided information, and prints out server connection info that was used in a successful connection (might be slightly different from the input).

Syntax:

deadlinecommand -ConfigureMongoDBDatabase <Host> <Port> <DB Name> <SSL> <Client Certificate> <Certificate Password> <Authenticate> <Username> <Password> <Replica Set> <Split DB>

Arguments:

Argument

Description

<Host>

The host name or IP address of the database machine.

<Port>

The database port

<DB Name>

The name of the Deadline database.

<SSL>

True if SSL/TLS should be used when connecting to the Database server, False otherwise.

<Client Certificate>

The path to a client x.509 certificate to present when connecting using SSL/TLS. Ignored if SSL is False.

<Certificate Password>

The password to the client certificate provided. Ignored if SSL is False, or if no certificate was provided. If left empty and a password is required, you will be prompted to enter it.

<Authenticate>

True if Deadline needs to authenticate in order to interact with the Database, False otherwise.

<Username>

The username with which to authenticate. If empty, and both Authenticate and SSL are True, the client certificate will be used instead. Ignored if Authenticate is False.

<Password>

The password for the specified user. Ignored if Authenticate is False, or if no user name was provided. Passwords have four modes: 1) Empty - The password will be prompted from standard input 2) A value with the prefix pass: - The portion after pass: is the password. Note that this option is risky, since it will have your password exposed in the command line history 3) A value with the prefix env: - The portion after env: indicates the environment variable to pull the password from (e.g. env:MY_VARIABLE) 4) A value with the prefix file: - The portion after file: indicates the file path to pull the password from (e.g. file:FILE_PATH). The first line of file will be used as password.

<Replica Set>

The name of the Replica set which the Database belongs to, if applicable.

<Split DB>

Whether or not to split Deadline data across multiple databases. These databases will be prefixed by <DB Name> (Default: False).

CreateMongoDBUser

Description:

Attempts to create a Deadline User in the given database. The user will be created with ‘readWriteAnyDatabase’ and ‘clusterMonitor’ roles.

Syntax:

deadlinecommand -CreateMongoDBUser <Connection String> <Authentication Type> <Username (or Certificate)> <Password>

Arguments:

Argument

Description

<Connection String>

The connection string that specifies how to connect to the database (e.g. mongodb://<host>:<port>).

<Authentication Type>

The Type of authentication mechanism to use. Only X509 is currently supported.

<Username (or Certificate)>

The client certificate (X509) in PKCS12 format.

<Password>

The password required to decrypt the client certificate (X509), if applicable. If left empty and a password is required, you will be prompted for it.

GetDatabaseSettings

Description:

Prints the given repository’s connection.ini file contents to stdout.

Syntax:

deadlinecommand -GetDatabaseSettings <Repository>

Arguments:

Argument

Description

<Repository>

The path to the repository root

Example:

C:\>deadlinecommand -GetDatabaseSettings C:\DeadlineRepository10
     Database Type: MongoDB
       Hostname(s): DESKTOP-4E76V9C;10.0.0.42
     Database Name: deadline10db
              Port: 27100
          Port Alt: 0
       SSL Enabled: True
      Authenticate: True
         User Name:
       Replica Set:
          Split DB: False
           Version: 10

UpdateEnvironmentSettings

Description:

Updates the Environment in the database.

Syntax:

deadlinecommand -UpdateEnvironmentSettings <EnvironmentFile>

Arguments:

Argument

Description

<EnvironmentFile>

The path to the environment file

UpdateMongoDBSettings

Description:

Updates the given repository’s connection.ini file with the given database settings.

Warning

This function does not perform any validation on the provided settings!
Any incorrect settings could prevent some or all Deadline Clients pointing to this Repository from connecting to the Database!

Syntax:

deadlinecommand -UpdateMongoDBSettings <Repository> <DbType> <Host> <Name> <Port> <AltPort> <SSL> <Authenticate> <Username> <Password> <Replica Set> <Split DB>

Arguments:

Argument

Description

<Repository>

The path to the repository root

<DbType>

The database type (currently only MongoDB)

<Host>

The host name or IP address of the database machine

<Name>

The database name

<Port>

The database port

<AltPort>

The alternate database port (not currently used)

<SSL>

If SSL should be used to connect (not currently used)

<Authenticate>

If authentication is required

<Username>

The username

<Password>

The password. Passwords have four modes: 1) Empty - The password will be prompted from standard input 2) A value with the prefix pass: - The portion after pass: is the password. Note that this option is risky, since it will have your password exposed in the command line history 3) A value with the prefix env: - The portion after env: indicates the environment variable to pull the password from (e.g. env:MY_VARIABLE) 4) A value with the prefix file: - The portion after file: indicates the file path to pull the password from (e.g. file:FILE_PATH). The first line of file will be used as password.

<Replica Set>

The Replica set name

<Split DB>

If Database should be split (by default, it is disabled)

Repository Options and Configuration

GetRepositoryRoot

Description:

Returns the repository network root.

Syntax:

deadlinecommand -GetRepositoryRoot

Aliases:

GetRepositoryRoot, Root

Arguments:

Argument

Description

.

No arguments

Example:

C:\>deadlinecommand -GetRepositoryRoot
    C:\DeadlineRepository10

GetRepositoryRoots

Description:

Returns all repository roots stored in the Deadline config file.

Syntax:

deadlinecommand -GetRepositoryRoots

Aliases:

GetRepositoryRoots, Networks

Arguments:

Argument

Description

.

No arguments

Example:

C:\>deadlinecommand -GetRepositoryRoots
    C:\DeadlineRepository10
    C:\DeadlineRepository10.0.2.0
    C:\DeadlineRepository_StavromulaBeta

GetRepositoryPath

Description:

Returns the appropriate full path to the given subdirectory of the Repository.

Syntax:

deadlinecommand -GetRepositoryPath [<Subdir>] [<Custom:True|False>]

Arguments:

Argument

Description

<Subdir>

The repository’s sub-directory to retrieve.

<Custom>

Whether or not to check the Custom folder first.

Examples:

If connected directly to the Repository, the result is the path on the Repository share:

C:\>deadlinecommand -GetRepositoryPath submission\3dsmax\Main\
    C:\DeadlineRepository10\submission\3dsmax\Main

If no first argument is provided, or it is an empty string, the root path is returned:

C:\>deadlinecommand -GetRepositoryPath
    C:\DeadlineRepository10

C:\>deadlinecommand -GetRepositoryPath ""
    C:\DeadlineRepository10

If connected via a Remote Connection Server, the paths are cached locally, so the local cache path is returned instead:

C:\>deadlinecommand -GetRepositoryPath submission\3dsmax\Main\
    C:\Users\SomeUser\AppData\Local\Thinkbox\Deadline10\cache\QC6Q1XV3ZclisdmBNCBAEbj6oc\submission\3dsmax\Main\

If the second argument is provided as False, the Factory path is returned. If True or not specified, the Custom path is returned:

C:\>deadlinecommand -GetRepositoryPath "submission" False
    C:\DeadlineRepository10\submission

C:\>deadlinecommand -GetRepositoryPath "submission" True
    C:\DeadlineRepository10\custom\submission

C:\>deadlinecommand -GetRepositoryPath "submission"
    C:\DeadlineRepository10\custom\submission

GetRepositoryFilePath

Description:

Returns the appropriate full path to the given file in the Repository.

Syntax:

deadlinecommand -GetRepositoryFilePath [<Subdir>] [<Custom:True|False>]

Arguments:

Argument

Description

<FilePath>

The repository’s file path to retrieve.

<Custom>

Whether or not to check the Custom folder first.

Examples:

If connected directly to the Repository, the result is the path on the Repository share:

C:\>deadlinecommand -GetRepositoryFilePath "submission\3dsmax\Main\SubmitMaxToDeadline.ms"
    C:\DeadlineRepository10\submission\3dsmax\Main\SubmitMaxToDeadline.ms

If connected via a Remote Connection Server, the paths are cached locally, so the local cache path is returned instead:

C:\>deadlinecommand -GetRepositoryFilePath "submission\3dsmax\Main\SubmitMaxToDeadline.ms"
    C:\Users\SomeUser\AppData\Local\Thinkbox\Deadline10\cache\QC6Q1XV3ZclisdmBNCBAEbj6oc\submission\3dsmax\Main\SubmitMaxToDeadline.ms

An argument is required:

C:\>deadlinecommand -GetRepositoryFilePath
    Error: File path cannot be blank. (System.Data.NoNullAllowedException)

GetRepositoryOptions

Description:

Displays the list of all exposed Repository Options.

Syntax:

deadlinecommand -GetRepositoryOptions

Arguments:

Argument

Description

.

No arguments

Example:

C:\>deadlinecommand -GetRepositoryOptions

See below for the output of GetRepositoryOptionsWithValues which also includes the current values.

GetRepositoryOptionsWithValues

Description:

Displays the list of all exposed Repository Options and their values.

Syntax:

deadlinecommand -GetRepositoryOptionsWithValues

Arguments:

Argument

Description

.

No arguments

Example:

C:\>deadlinecommand -GetRepositoryOptionsWithValues
    PythonSearchPathString:
    JobExtraInfo0Name:Extra Info 0
    JobExtraInfo1Name:Extra Info 1
    JobExtraInfo2Name:Extra Info 2
    JobExtraInfo3Name:Extra Info 3
    JobExtraInfo4Name:Extra Info 4
    JobExtraInfo5Name:Extra Info 5
    JobExtraInfo6Name:Extra Info 6
    JobExtraInfo7Name:Extra Info 7
    JobExtraInfo8Name:Extra Info 8
    JobExtraInfo9Name:Extra Info 9
    TaskExtraInfo0Name:Extra Info 0
    TaskExtraInfo1Name:Extra Info 1
    TaskExtraInfo2Name:Extra Info 2
    TaskExtraInfo3Name:Extra Info 3
    TaskExtraInfo4Name:Extra Info 4
    TaskExtraInfo5Name:Extra Info 5
    TaskExtraInfo6Name:Extra Info 6
    TaskExtraInfo7Name:Extra Info 7
    TaskExtraInfo8Name:Extra Info 8
    TaskExtraInfo9Name:Extra Info 9
    SlaveExtraInfo0Name:Extra Info 0
    SlaveExtraInfo1Name:Extra Info 1
    SlaveExtraInfo2Name:Extra Info 2
    SlaveExtraInfo3Name:Extra Info 3
    SlaveExtraInfo4Name:Extra Info 4
    SlaveExtraInfo5Name:Extra Info 5
    SlaveExtraInfo6Name:Extra Info 6
    SlaveExtraInfo7Name:Extra Info 7
    SlaveExtraInfo8Name:Extra Info 8
    SlaveExtraInfo9Name:Extra Info 9
    UseAlternateAuxiliaryFileLocation:False
    AlternateAuxiliaryWindowsPath:
    AlternateAuxiliaryLinuxPath:
    AlternateAuxiliaryMacPath:
    AutoJobCleanupDays:30
    AutoJobCleanupEnabled:False
    AutoArchivedJobCleanupDays:120
    AutoJobCleanupHoursModified:0
    PurgeDeletedJobHours:2
    SmartJobTimeoutForce:False
    SmartJobTimeoutTaskPercentage:25
    SmartJobTimeoutTaskPercentageEnabled:False
    SmartJobTimeoutMinimumTasks:30
    SmartJobTimeoutMinimumTasksEnabled:False
    SmartJobTimeoutMultiplier:3
    EnableStatisticsGathering:True
    SlaveStatisticsGatheringInterval:30
    RepoStatisticsGatheringInterval:10
    DaysToKeepJobStatistics:1000
    DeleteJobStatistics:False
    DaysToKeepSlaveStatistics:120
    DeleteSlaveStatistics:True
    DaysToKeepRepoStatistics:120
    DeleteRepositoryStatistics:True
    MaxRepoHistoryEntries:4096
    MaxPowerManagementHistoryEntries:4096
    MaxSlaveHistoryEntries:1024
    MaxJobHistoryEntries:1024
    MaxPulseHistoryEntries:1024
    MaxBalancerHistoryEntries:1024
    EnableSlaveVerboseLogging:False
    SlaveLogHistoryLength:30
    TempFolderHistoryLength:1
    MonitorLogHistoryLength:30
    PulseLogHistoryLength:30
    BalancerLogHistoryLength:30
    LauncherLogHistoryLength:30
    ProxyLogHistoryLength:30
    WebServiceLogHistoryLength:30
    LicenseForwarderLogHistoryLength:30
    EnableLicenseForwarderVerboseLogging:False
    EnablePulseVerboseLogging:False
    EnableBalancerVerboseLogging:False
    EnableMetricsTracking:False
    MetricsTimeToLiveHours:6
    EnableRemoteAdministration:False
    EnableRemoteCommandWhitelist:True
    RemoteCommandWhitelistString:
    EnableAutomaticUpdates:True
    UseFullyQualifiedDomainNames:False
    MonitorJobUpdateInterval:1
    MonitorSlaveUpdateInterval:1
    MonitorPulseUpdateInterval:1
    MonitorBalancerUpdateInterval:1
    MonitorLimitUpdateInterval:1
    MonitorSettingsUpdateInterval:10
    MonitorProxyServerUpdateInterval:1
    MonitorLicenseForwarderUpdateInterval:1
    MonitorCloudUpdateInterval:10
    MonitorManualRefreshEnabled:False
    MonitorManualRefreshInterval:10
    MonitorEventUpgradeInterval:300
    MonitorDisableDynamicSorting:False
    MonitorRemoteControlSettings:False
    GatherResourceUsageDuringRendering:True
    SlaveStdOutLimit:5000
    SlaveStdOutLimitEnabled:True
    BetweenTaskDelay:1
    BetweenPollingDelay:1
    BetweenPollingMinimum:1
    PollingMultiplier:0.15
    SlavePowerManagementScanInterval:600
    SlaveInfoUpdateInterval:5
    DequeueBadJobPercentage:5
    AutoSlaveRemovalDays:60
    AutoSlaveRemovalDaysEnabled:False
    StalledSlaveDelay:5
    StalledProxyServerDelay:10
    StalledPulseDelay:10
    StalledBalancerDelay:10
    OverrideSlaveListeningPort:False
    SlaveListeningPort:5054
    SlaveAllowPortForwarder:False
    OverridePulseListeningPort:False
    PulseListeningPort:5056
    OverrideBalancerListeningPort:False
    BalancerListeningPort:5058
    OverrideLicenseForwarderListeningPort:False
    LicenseForwarderListeningPort:5060
    StalledLicenseForwarderDelay:10
    SlaveUseIPAddress:False
    PulseUseIPAddress:False
    LicenseForwarderUseIPAddress:False
    BalancerUseIPAddress:False
    SetBalancerPrimaryInHouseCleaning:False
    SetPulsePrimaryInHouseCleaning:False
    EmailNotificationSmtpServer:
    EmailNotificationPort:25
    EmailNotificationAuthenticate:False
    EmailNotificationAuthenticationUserName:
    EmailNotificationSender:
    EmailNotificationSSLEnabled:False
    GenerateEmailsForNewUsers:True
    EmailAddressPostfix:
    SecondaryEmailNotificationSmtpServer:
    SecondaryEmailNotificationPort:25
    SecondaryEmailNotificationAuthenticate:False
    SecondaryEmailNotificationAuthenticationUserName:
    SecondaryEmailNotificationSender:
    SecondaryEmailNotificationSSLEnabled:False
    EmailJobFailedReports:
    EmailJobWarningReports:
    EmailSlaveTimeoutReports:
    EmailJobCompletionReports:
    EmailJobTransferCompletionReports:
    EmailJobTransferFailedReports:
    EmailSystemAdministrator:
    EmailDatabaseConnections:
    AvailableConnectionThreshold:30
    EmailIdleShutdownNotifications:
    EmailMachineStartupNotifications:
    EmailThermalShutdownNotifications:
    EmailMachineRestartNotifications:
    EmailStalledSlaveNotifications:
    EmailFailedTasksNotifications:
    EmailSlaveLicenseErrorNotifications:
    AutoDeleteCorruptedJobs:False
    SlaveErrorNotificationLimit:50
    SlaveErrorNotificationEnabled:False
    JobErrorWarningLimit:50
    JobErrorWarningEnabled:False
    JobErrorLimit:100
    JobErrorEnabled:True
    TaskErrorLimit:10
    TaskErrorEnabled:False
    BadJobErrorLimit:5
    BadJobErrorEnabled:False
    PulseDataLoadingThreads:10
    PulsePowerManagementScanInterval:300
    PulseRepositoryCleanupInterval:60
    PulseRepositoryRepairInterval:60
    PulsePendingJobScanInterval:10
    PulseMaximumIncomingConnections:3000
    PulseMaxConnectionAttempts:1
    PulseMessageTimeoutMilliseconds:500
    SlaveThrottleLimit:10
    SlaveThrottleLimitEnabled:False
    SlaveThrottleWaitInterval:20
    SlaveThrottleTimeoutMultiplier:3
    WebServicePort:8082
    WebServiceTimeout:120
    WebServiceConnectionLimit:10
    WebServiceAllowNonScriptCommands:False
    WebServiceRequireAuthentication:False
    WebServiceAllowEmptyPasswords:False
    EnableWebServiceVerboseLogging:False
    JobMaximumPriority:100
    JobTaskLimit:5000
    JobErrorReportLimit:5000
    EnhancedSchedulerBalancing:False
    WeightedPriorityFloatValue:100
    WeightedSubmitTimeFloatValue:3
    WeightedErrorFloatValue:-10
    WeightedRenderingTasksFloatValue:-100
    RenderingTaskBuffer:1
    MapDrivesInServiceModeOnly:False
    CurrentBalancerLogicPlugin:DefaultAlgorithm
    CurrentBalancerInterval:60
    BalancerGroupSwitching:True
    BalancerErrorLimit:2
    DeadlineUserIsSystemUser:False
    RunJobsAsUser:False
    RunRemoteCommandsAsUser:False
    RunRemoteCommandsAsUserPreserveEnvironment:False
    PreserveEnvironment:False
    SimulateLogin:False
    SetHomeVariable:False
    EnableProxyServerVerboseLogging:False
    WakeOnLanPorts:System.Int32[]
    PendingJobScanTimeoutSeconds:1800
    PendingJobScanInSeparateProcess:False
    SeparatePendingJobScanOutput:False
    RepositoryRepairTimeoutSeconds:1800
    RunRepositoryRepairInSeparateProcess:False
    SeparateRepositoryRepairOutput:False
    HouseCleaningTimeoutSeconds:1800
    RunHouseCleaningInSeparateProcess:False
    SeparateHouseCleaningOutput:False
    HouseCleaningEnableJobArchiveMaximum:False
    HouseCleaningJobArchiveMaximum:200
    HouseCleaningEnableAuxiliaryMaximum:False
    HouseCleaningAuxiliaryMaximum:200
    HouseCleaningEnableJobReportMaximum:False
    HouseCleaningJobReportMaximum:2000
    HouseCleaningEnableDeletedJobMaximum:False
    HouseCleaningDeletedJobMaximum:200
    HouseCleaningEnableJobEventQueueEntryMaximum:False
    HouseCleaningJobEventQueueEntryMaximum:200
    AsynchronousEvents:False
    UseEventTimeout:False
    EventTimeoutSeconds:30
    NewApplicationPluginsEnabled:True
    EnableSlavePendingJobScan:True
    EnableSlaveHouseCleaning:True
    EnableSlaveRepositoryRepair:True
    UsageBasedURL:
    UsageBasedActivationCode:
    UseCloudLicenseServer:True
    DynamicLicensingMode:False
    StandardLicensingThreshold:50
    UBLUseForwarderForUBL:False
    SlaveDisableSandboxSettings:False
    SandboxRunsInJobEnvironment:False
    DisableEventSandboxing:False
    LicenseForwarderInfoUpdateInterval:5

GetRepositoryOption

Description:

Gets the value of the provided Repository Option if it exists and is exposed.

Syntax:

deadlinecommand -GetRepositoryOption <Repository Option>

Arguments:

Argument

Description

<Repository Option>

The name of the Repository Option we want to get

Example:

Get the Job Task Limit value:

C:\>deadlinecommand -GetRepositoryOption JobTaskLimit
    JobTaskLimit:5000

SetRepositoryOption

Description:

Sets the value of the provided Repository Option if it exists and is exposed.

Syntax:

deadlinecommand -SetRepositoryOption <Repository Option> <Value>

Arguments:

Argument

Description

<Repository Option>

The name of the Repository Option we want to set

<Value>

The value to set for the Repository Option

Example:

Increase the Job Task Limit to 6000 (default is 5000):

C:\>deadlinecommand -SetRepositoryOption JobTaskLimit 6000
    JobTaskLimit set to 6000

The first argument must be a valid Repository Option - see GetRepositoryOptionsWithValues above for a command to get the list of valid options and values.

C:\>deadlinecommand -SetRepositoryOption TheAnswer 42
    Error: TheAnswer is not an exposed repository option.

GetMaximumPriority

Description:

Displays the maximum priority value for Jobs.

Syntax:

deadlinecommand -GetMaximumPriority

Arguments:

Argument

Description

.

No arguments

Example:

C:\>deadlinecommand -GetMaximumPriority
    100

Alternatively, you can use general Repository options access, but it is more difficult to parse:

C:\>deadlinecommand -GetRepositoryOption JobMaximumPriority
    JobMaximumPriority:100

GetRepositoryVersion

Description:

Gets the Deadline Repository and Integration Version

Syntax:

deadlinecommand -GetRepositoryVersion

Arguments:

Argument

Description

.

No arguments

Example:

C:\>deadlinecommand -GetRepositoryVersion
    Repository Version: 10.1.2.2 (d9f8db73b)
    Integration Version: 10.1.2.2 (d9f8db73b)

SetMinimumDeadlineVersion

Description:

Sets the minimum Deadline version for the database.

Syntax:

deadlinecommand -SetMinimumDeadlineVersion <Installer Minimum> <Client Minimum>

Arguments:

Argument

Description

<Installer Minimum>

The minimum version for the installer

<Client Minimum>

The minimum version for the client

UpdateScriptMenus

Description:

Updates the script menu configuration based on the given file.

Syntax:

deadlinecommand -UpdateScriptMenus <Script Menu File>

Arguments:

Argument

Description

<Script Menu File>

The file containing the script menu configuration