Clients and Logs - 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

Launcher

ChangeListeningPort

Description:

Changes the port that the Deadline Launcher listens on.

Syntax:

deadlinecommand -ChangeListeningPort <Port>

Arguments:

Argument	Description
<Port>	The new port number, between 1 and 65535 inclusive

InstallLauncherService

Description:

Installs the Deadline Launcher Service, and optionally starts it.

Syntax:

deadlinecommand -InstallLauncherService [<StartService>]

Arguments:

Argument	Description
<StartService>	Whether or not to start the Launcher Service after it has been installed. Optional. If not specified, defaults is False.

InstallLauncherServiceLogOn

Description:

Installs the Deadline Launcher Service with the given account, and optionally starts it.

Syntax:

deadlinecommand -InstallLauncherServiceLogOn <User Name> <Password> [<StartService>]

Arguments:

Argument	Description
<User Name>	The account user name
<Password>	The account password. If empty or not specified, the caller will be prompted to enter it via standard input.
<StartService>	Whether or not to start the Launcher Service after it has been installed. Optional. If not specified, defaults is False.

StartLauncherService

Description:

Starts the Deadline Launcher Service if it is installed.

Syntax:

deadlinecommand -StartLauncherService

Arguments:

Argument	Description
.	No arguments

StopLauncherService

Description:

Stops the Deadline Launcher Service if it is installed.

Syntax:

deadlinecommand -StopLauncherService

Arguments:

Argument	Description
.	No arguments

UninstallLauncherService

Description:

Stops and uninstalls the Deadline Launcher Service.

Syntax:

deadlinecommand -UninstallLauncherService

Arguments:

Argument	Description
.	No arguments

RemoteControl

Description:

Send the remote command to the Deadline Launcher running on the specified machine(s).

Syntax:

deadlinecommand -RemoteControl <Machine Name(s)> <Remote Command> [<Argument>]

Arguments:

Argument	Description
<Machine Name(s)>	The machine name, or a list of machine names separated by commas.
<Remote Command>	The remote command. See below for a list of available commands.
<Argument>	Some commands require an argument. See below for the list of arguments.

The following Remote Commands are supported. If an argument is required, the list of supported arguments is provided in the right column:

Remote Command	Valid Argument
LaunchAllSlaves	–none–
LaunchSlave	[WorkerName]
LaunchNewSlave	[WorkerName]
RemoveSlave	[WorkerName]
LaunchSlaveDelay	–none–
StopSlave	–none–
RelaunchSlave	–none–
ForceStopSlave	–none–
ForceRelaunchSlave	–none–
StopLauncher	–none–
OnLastTaskComplete	Continue StopSlave RestartSlave CheckForTasks CancelTask ClearFailureCache ShutdownMachine [comment] RestartMachine [comment] where [comment] is a message that can be sent to explain why the shutdown or restart machine command was executed. It will be recorded in the machines event log.
LaunchPulse	–none–
StopPulse	–none–
RestartPulse	–none–
RemotePulseCommand	HouseCleaning PendingJobScan RepositoryRepair PowerManagement
LaunchProxyServer	–none–
StopProxyServer	–none–
RestartProxyServer	–none–
LaunchBalancer	–none–
StopBalancer	–none–
RestartBalancer	–none–
RemoteBalancerCommand	Balancing
LaunchMonitor	–none–
StopMonitor	–none–
StopConfig	–none–
StartMachine	–none–
RestartMachine	–none–
ShutdownMachine	–none–
Execute	Command to execute.
ExecuteNoWait	Command to execute.

Client Configuration and Licensing

ChangeAutoConfigurationPort

Description:

Changes the port that the Auto Configuration feature uses.

Syntax:

deadlinecommand -ChangeAutoConfigurationPort <Port>

Arguments:

Argument	Description
<Port>	The new port number, between 1 and 65535 inclusive

GetLicenseMode (DEPRECATED)

Note

Starting with Deadline 10.1.23, Deadline and its components do not require a license. The newer versions of Deadline retain this command for backwards compatibility, but it will always return success without actually doing anything.

Description:

Gets the Deadline License Mode

Syntax:

deadlinecommand -GetLicenseMode

Arguments:

Argument	Description
.	No arguments

Example:

C:\>deadlinecommand -GetLicenseMode
    UsageBased

ChangeLicenseMode (DEPRECATED)

Note

Starting with Deadline 10.1.23, Deadline and its components do not require a license. The newer versions of Deadline retain this command for backwards compatibility, but it will always return success without actually doing anything.

Description:

Sets the Deadline License Mode.

Syntax:

deadlinecommand -ChangeLicenseMode <License Mode>

Arguments:

Argument	Description
<License Mode>	The license mode - either Standard or UsageBased

Example:

C:\>deadlinecommand -ChangeLicenseMode UsageBased

C:\>

Note

No result is printed if the command succeeded. An error will be printed if the mode was invalid:

C:\>deadlinecommand -ChangeLicenseMode MagicalUnicorns
    Error: the mode 'MagicalUnicorns' is not valid, please specify 'Standard' or 'UsageBased'

GetLicenseServer (DEPRECATED)

Note

Starting with Deadline 10.1.23, Deadline and its components do not require a license. The newer versions of Deadline retain this command for backwards compatibility, but it will always return success without actually doing anything.

Description:

Gets the Deadline License Server.

Syntax:

deadlinecommand -GetLicenseServer

Arguments:

Argument	Description
.	No arguments

ChangeLicenseServer (DEPRECATED)

Note

Starting with Deadline 10.1.23, Deadline and its components do not require a license. The newer versions of Deadline retain this command for backwards compatibility, but it will always return success without actually doing anything.

Description:

Allows you to change the License Server the Balancer and Workers connect to.

Syntax:

deadlinecommand -ChangeLicenseServer [<License Server>]

Arguments:

Argument	Description
<License Server>	(optional) If not specified, a License Server dialog will be displayed.

ChangeRepository

Description:

Allows you to change the Repository Connection Settings that Deadline uses by default.

If no arguments are provided, the Change Repository dialog will be displayed.

Syntax:

deadlinecommand -ChangeRepository [<Connection Type>] [<Connection String>] [<Client Certificate>] [<Certificate Password>]

Arguments:

Argument	Description
<Connection Type>	Optional. Specifies the type of connection to use when connecting (either Direct or Proxy). If not specified, the type will be inferred from the connection string.
<Connection String>	Optional. When using Direct connection, this is the path to the root of the Repository. When using a Proxy connection, this is a string of format <HOST>:<PORT>.
<Client Certificate>	Optional. The path to a client certificate to use when connecting to a Proxy or Database over SSL/TLS.
<Certificate Password>	Optional. The password to the provided Client Certificate, if required.

See also

SelectRepository

ChangeRepositorySkipValidation

Description:

Allows you to change the Repository Connection Settings that Deadline uses by default and saves those setting without validating them. If no arguments are provided, the Change Repository dialog will be displayed.

Syntax:

deadlinecommand -ChangeRepositorySkipValidation [<Connection Type>] [<Connection String>] [<Client Certificate>] [<Certificate Password>]

Arguments:

Argument	Description
<Connection Type>	Optional. Specifies the type of connection to use when connecting (either Direct or Proxy). If not specified, the type will be inferred from the connection string.
<Connection String>	Optional. When using Direct connection, this is the path to the root of the Repository. When using a Proxy connection, this is a string of format <HOST>:<PORT>.
<Client Certificate>	Optional. The path to a client certificate to use when connecting to a Proxy or Database over SSL/TLS.
<Certificate Password>	Optional. The password to the provided Client Certificate, if required. Only used for Direct connections.

GetSettingsDirectory

Description:

Displays the settings directory of the Deadline Client software.

Syntax:

deadlinecommand -GetSettingsDirectory

Arguments:

Argument	Description
.	No arguments

Example:

C:\>deadlinecommand -GetSettingsDirectory
    C:\Users\SomeUser\AppData\Local\Thinkbox\Deadline10\settings

SetIniFileSetting

Description:

Sets the value for the given key in the deadline.ini configuration file.

Syntax:

deadlinecommand -SetIniFileSetting <Key> <Value> [<Set For All Users>]

Arguments:

Argument	Description
<Key>	The key to be set
<Value>	The value to set it to
<Set For All Users>	Optional. If set to True or not specified, the Key=Value pair is written to the common deadline.ini. If set to False, the Key=Value pair is written to the current user’s deadline.ini file.

Example:

The following enables the auto-start of the Remote Connection Server (if installed) when the Launcher starts:

C:\>deadlinecommand -SetIniFileSetting LaunchRemoteConnectionServerAtStartup True

C:\>

Note

This command prints no message on success because it always succeeds if both arguments are provided. It only prints a reply in the case of insufficient arguments:

C:\>deadlinecommand -SetIniFileSetting
    Error: No key and value were specified.

Warning

The key and value will not be verfieid. You can add arbitrary key/value pairs to the deadline.ini if you are not careful:

C:\>deadlinecommand -SetIniFileSetting BringDonuts True

C:\>

Note

Supplying only the Key will set the value to empty string. The following is a valid command:

C:\>deadlinecommand -SetIniFileSetting BringDonuts

C:\>

SetInstallerVersion

Description:

Sets the client installer version

Syntax:

deadlinecommand -SetInstallerVersion <Version>

Arguments:

Argument	Description
<Version>	The version string

UpdatePathVariable

Description:

Appends the Deadline bin folder to the PATH environment variable

Syntax:

deadlinecommand -UpdatePathVariable

Arguments:

Argument	Description
.	No arguments

RCS

ConfigureConnectionServer

Description:

Convenience function that serves as a single point of entry to configure (and re-configure) settings relevant to the Deadline connection server applications (RCS + Proxy).

Parameters are not positional; they are all optional and should be specified in ‘--key <value>’ form.

Syntax:

deadlinecommand -ConfigureConnectionServer [--ip <value>] [--port <value>] [--tls_port <value>] [--tls_cert <value>] [--tls_cacert <value>] [--tls_auth <value>] [--client-ssl-auth <value>] [--local_only <value>] [--log-api-calls <value>] [--log-api-caches <value>] [--tls-password-location <value>] [--incognito <value>] [–verbose <value>] [--launch-rcs-at-startup <value>] [--keep-rcs-running <value>] [--all_users]

Arguments:

Argument	Description
[--ip <value>]	Specifies the interface on which the connection server listens for incoming external connections.
[--port <value>]	Sets the Port on which the connection server listens for incoming HTTP connections.
[--tls_port <value>]	Sets the Port on which the connection server listens for incoming TLS (HTTPS) connections.
[--tls_cert <value>]	When set to a valid PKCS#12 file containing an x.509 certificate and key, the connection server will serve TLS (HTTPS) connections on the configured TLS Port.
[--tls_cacert <value>]	When set to a valid x.509 certificate (either PKCS#12 or PEM format), it will be used as an additional trusted root to validate client certificates from incoming TLS connections.
[--tls_auth <value>]	When set to True, all clients will be expected to present valid (and trusted) x.509 certificates when connecting over TLS (HTTPS).
[--client-ssl-auth <value>]	Specifies whether a client cert is required for SSL authentication on the Deadline RCS or not. Possible values are “Required” and “NotRequired”. Defaults to “Required”.
[--local_only <value>]	Specifies that the server should only accept connections coming from the local loopback interface (127.0.0.1). 403 errors will be returned for requests coming from any other source.
[--log-api-calls <value>]	Specifies whether to enable detailed logging of API requests.
[--log-api-caches <value>]	Specifies whether to enable periodic logging of API caches.
[--tls-password-location <value>]	Specifies the password environmental variable to use with the TLS cert, do not enter the actual password into the CLI, please insert the password into an environmental variable and enter the variable name here in the following format “env:variablename”. If left blank, the TLS cert is assumed to not require a password.
[--incognito <value>]	Specifies whether to prevent the RCS from saving its settings to the repository.
[--verbose <value>]	Specifies whether to enable verbose logging.
[--launch-rcs-at-startup <value>]	If set to True whether the Launcher start the RCS when it starts up.
[--keep-rcs-running <value>]	If set to True the Launcher restart the RCS whenever it identifies it’s not running.
[--all_users]	If this flag is present, the settings will be configured for all users. Otherwise, only the current user’s settings will be affected.

Pulse

DeletePulse

Description:

Deletes one or more Pulses.

Syntax:

deadlinecommand -DeletePulse <Pulse Name(s)>

Arguments:

Argument	Description
<Pulse Name(s)>	The Pulse name, or a comma-separated list of Pulse names

GetPulseInfo

Description:

Gets the Pulse information.

Syntax:

deadlinecommand -GetPulseInfo <Pulse Name>

Arguments:

Argument	Description
<Pulse Name>	The Pulse name from which to get info

GetPulseInfos

Description:

Gets the Pulse information for the specified Pulses or all Pulses.

Syntax:

deadlinecommand -GetPulseInfos [<Pulse Name(s)>]

Arguments:

Argument	Description
<Pulse Name(s)>	The Pulse name, or a comma-separated list of Pulse names. If not specified, retrieves all Pulse infos

GetPulseNames

Description:

Get Pulse names.

Syntax:

deadlinecommand -GetPulseNames

Arguments:

Argument	Description
.	No arguments

Example:

C:\>deadlinecommand -GetPulseNames
    stack057409b23f554c3d859cfecfd58b70dd
    stack104c3b15d5514fab873897836e0c9ea9
    stack1a2389b361244f35946638a7882dd666
    HPZ-1234567890

GetPulseSettings

Description:

Gets the Pulse settings for a specified Pulse.

Syntax:

deadlinecommand -GetPulseSettings <Pulse Name>

Arguments:

Argument	Description
<Pulse Name>	The Pulse name

Example:

C:\>deadlinecommand -GetPulseSettings HPZ-1234567890
    PulseName: HPZ-1234567890
    PrimaryPulse: True
    OverridePort: False
    Port: 5046
    OverrideListeningPort: False
    ListeningPort: 5056
    MacAddressOverride:
    HostMachineIPAddressOverride:
    PulseIsPrimary: True
    PulseOverridePort: False
    PulsePort: 5046
    PulseOverrideListeningPort: False
    PulseListeningPort: 5056
    PulseMacAddressOverride:
    PulseHostMachineIPAddressOverride:
    LastWriteTime: 08/13/2018 16:30:52
    ID: hpz-1234567890
    ExtraElements:

GetPulseSettingsList

Description:

Gets the Pulse settings for specified or all Pulses.

Syntax:

deadlinecommand -GetPulseSettingsList [<Pulse Name(s) or none>]

Arguments:

Argument	Description
<Pulse Name(s)>	The Pulse name, or a comma-separated list of Pulse names. If not specified, retrieves all Pulse settings

Example:

C:\>deadlinecommand -GetPulseSettingsList
    PulseName: HPZ-1234567890
    PrimaryPulse: True
    OverridePort: False
    Port: 5046
    OverrideListeningPort: False
    ListeningPort: 5056
    MacAddressOverride:
    HostMachineIPAddressOverride:
    PulseIsPrimary: True
    PulseOverridePort: False
    PulsePort: 5046
    PulseOverrideListeningPort: False
    PulseListeningPort: 5056
    PulseMacAddressOverride:
    PulseHostMachineIPAddressOverride:
    LastWriteTime: 08/13/2018 16:30:52
    ID: hpz-1234567890
    ExtraElements:

C:\>

SavePulseInfo

Description:

Saves a specified PulseInfo object.

Syntax:

deadlinecommand -SavePulseInfo <PulseInfo object>

Arguments:

Argument	Description
<PulseInfo object>	The PulseInfo object

SavePulseSettings

Description:

Saves the Pulse settings.

Syntax:

deadlinecommand -SavePulseSettings <Pulse Settings object>

Arguments:

Argument	Description
<Pulse Settings object>	The Pulse settings object

Proxy Server

GetProxyServerInfo

Description:

Get ProxyServerInfo for a specified (by name) Proxy Server.

Syntax:

deadlinecommand -GetProxyServerInfo <Proxy Server Name>

Arguments:

Argument	Description
<Proxy Server Name>	Name of the Proxy Server to query.

GetProxyServerInfos

Description:

Get ProxyServerInfo for all specified (by name) Proxy Servers.

Syntax:

deadlinecommand -GetProxyServerInfos [<Proxy Server Name(s)>]

Arguments:

Argument	Description
<Proxy Server Name(s)>	Comma-separated list of Proxy Server names to query. Leave blank to query all Proxy Servers.

Example:

C:\>deadlinecommand -GetProxyServerInfos
    ProxyServerName: HPZ-1234567890
    ProxyServerStatus: Running
    Type: Remote
    HTTPPort: 8080
    TLSPort: 4433
    StateDateTime: 06/13/2020 23:17:32
    UpdateDateTime: 06/19/2020 16:11:07
    LastReadTime: 01/01/0001 00:00:00
    LastReadRepoTime: 01/01/0001 00:00:00
    FreeMemory: 17659691008
    DiskSpace: 18782691328
    DiskSpaceString: 17.493 GB
    ProcessorSpeed: 2592
    CPUUsage: 28
    NetworkSent: 8677
    NetworkReceived: 3000
    SwapUsage: 536870912
    DiskReads: 0
    DiskWrites: 130613
    UpTimeSeconds: 492824
    HostName: HPZ-1234567890
    UserName: SomeUser
    IPAddress: 192.168.10.1
    MACAddress: 01:23:45:67:89:AB
    CPUs: 8
    Memory: 34234511360
    ProcessorArchitecture: x64
    OSShortName: Windows 10 Enterprise
    Version: v10.1.2.2 Release (d9f8db73b)
    VideoCard: Intel(R) HD Graphics 530
    IsAWSPortalInstance: False
    AWSInfo: System.Collections.Generic.Dictionary`2[System.String,System.Object]
    MachineRealName: HPZ-1234567890
    MachineUserName: SomeUser
    MachineIPAddress: 192.168.10.1
    MachineMACAddress: 01:23:45:67:89:AB
    MachineCPUs: 8
    MachineMemory: 34234511360
    MachineFreeMemory: 17659691008
    MachineDiskSpace: 18782691328
    MachineProcessorSpeed: 2592
    MachineArchitecture: x64
    MachineCPUUsage: 28
    MachineOperatingSystem: Windows 10 Enterprise
    MachineVideoCard: Intel(R) HD Graphics 530
    LastWriteTime: 06/19/2020 16:11:07
    ID: hpz-1234567890
    ExtraElements:

C:\>

GetProxyServerNames

Description:

Display all Proxy Server names.

Syntax:

deadlinecommand -GetProxyServerNames

Arguments:

Argument	Description
.	No arguments

Example:

C:\>deadlinecommand -GetProxyServerNames
    HPZ-1234567890

GetProxyServerSettings

Description:

Get ProxyServerInfo for a specified (by name) Proxy Server.

Syntax:

deadlinecommand -GetProxyServerSettings <Proxy Server Name>

Arguments:

Argument	Description
<Proxy Server Name>	Name of the Proxy Server to query.

GetProxyServerSettingsList

Description:

Get ProxyServerSettings for all specified (by name) Proxy Servers.

Syntax:

deadlinecommand -GetProxyServerSettingsList [<Proxy Server Name(s)>]

Arguments:

Argument	Description
<Proxy Server Name(s)>	Comma-separated list of Proxy Server names to query. Leave blank to query all Proxy Servers.

SaveProxyServerInfo

Description:

Save a specified ProxyServerInfo object to the Database.

Syntax:

deadlinecommand -SaveProxyServerInfo <ProxyServerInfo Object>

Arguments:

Argument	Description
<ProxyServerInfo Object>	JSON Object representing a ProxyServerInfo to save.

SaveProxyServerSettings

Description:

Save a specified ProxyServerSettings object to the Database.

Syntax:

deadlinecommand -SaveProxyServerSettings <ProxyServerSettingsObj>

Arguments:

Argument	Description
<ProxyServerSettingsObj>	JSON Object representing a ProxyServerSettings to save.

DeleteProxyServer

Description:

Deletes specified Proxy Server(s).

Syntax:

deadlinecommand -DeleteProxyServer <Proxy Server Name(s)>

Arguments:

Argument	Description
<Proxy Server Name(s)>	The Proxy Server name, or list of comma-separated Proxy Server names.

Web Service

ConfigureWebService

Description:

Convenience function that serves as a single point of entry to configure (and re-configure) settings relevant to the Deadline Web Service.

Parameters are not positional; they are all optional and should be specified in ‘--key <value>’ form.

Syntax:

deadlinecommand -ConfigureWebService [--ip <value>] [--port <value>] [--tls_port <value>] [--tls_cert <value>] [--tls_cacert <value>] [--tls_auth <value>] [--client-ssl-auth <value>] [--local_only <value>] [--log-api-calls <value>] [--log-api-caches <value>] [--tls-password-location <value>] [--all_users]

Arguments:

Argument	Description
[--ip <value>]	Specifies the interface on which the Deadline WebService listens for incoming external connections.
[--port <value>]	Sets the Port on which the Deadline WebService listens for incoming HTTP connections.
[--tls_port <value>]	Sets the Port on which the Deadline WebService listens for incoming TLS (HTTPS) connections.
[--tls_cert <value>]	When set to a valid PKCS#12 file containing an x.509 certificate and key, the Deadline WebService will serve TLS (HTTPS) connections on the configured TLS Port.
[--tls_cacert <value>]	When set to a valid x.509 certificate (either PKCS#12 or PEM format), it will be used as an additional trusted root to validate client certificates from incoming TLS connections.
[--tls_auth <value>]	When set to True, all clients will be expected to present valid (and trusted) x.509 certificates when connecting over TLS (HTTPS).
[--client-ssl-auth <value>]	Specifies whether a client cert is required for SSL authentication on the Deadline WebService or not. Possible values are “Required” and “NotRequired”. Defaults to “Required”.
[--local_only <value>]	Specifies that the server should only accept connections coming from the local loopback interface (127.0.0.1). 403 errors will be returned for requests coming from any other source.
[--log-api-calls <value>]	Specifies whether to enable detailed logging of API requests.
[--log-api-caches <value>]	Specifies whether to enable periodic logging of API caches.
[--tls-password-location <value>]	Specifies the password environmental variable to use with the TLS cert, do not enter the actual password into the CLI, please insert the password into an environmental variable and enter the variable name here in the following format “env:variablename”. If left blank, the TLS cert is assumed to not require a password.
[--all_users]	If this flag is present, the settings will be configured for all users. Otherwise, only the current user’s settings will be affected.

Logs

ConnectToBalancerLog

Description:

Connect to Balancer to watch its log in real time. Press Enter at any time to disconnect from the Balancer.

Syntax:

deadlinecommand -ConnectToBalancerLog <BalancerName> [<ShowWindow>]

Arguments:

Argument	Description
<BalancerName>	The name of the Balancer to connect to.
<ShowWindow>	Controls whether a log window should be displayed. Optional, defaults to False.

ConnectToLicenseForwarderLog

Description:

Connect to License Forwarder to watch its log in real time. Press Enter at any time to disconnect from the License Forwarder.

Syntax:

deadlinecommand -ConnectToLicenseForwarderLog <LicenseForwarderName> [<ShowWindow>]

Arguments:

Argument	Description
<LicenseForwarderName>	The name of the License Forwarder to connect to.
<ShowWindow>	Controls whether a log window should be displayed. Optional, defaults to False.

ConnectToPulseLog

Description:

Connect to Pulse to watch its log in real time. Press Enter at any time to disconnect from the Pulse.

Syntax:

deadlinecommand -ConnectToPulseLog <PulseName> [<ShowWindow>]

Arguments:

Argument	Description
<PulseName>	The name of the Pulse to connect to.
<ShowWindow>	Controls whether a log window should be displayed. Optional, defaults to False.

ConnectToSlaveLog

Description:

Connect to a remote Worker to watch its log in real time. Press Enter at any time to disconnect from the Worker.

Syntax:

deadlinecommand -ConnectToSlaveLog <WorkerName> [<ShowWindow>]

Arguments:

Argument	Description
<WorkerName>	The Worker to connect to
<ShowWindow>	If a log window should be displayed (optional, defaults to false)