Pools, Groups, and Limits - 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

Pools ¶

GetPoolNames ¶

Description:

Displays all Pool names.

Aliases: GetPoolNames, Pools

Syntax:

deadlinecommand -GetPoolNames

deadlinecommand -Pools

Arguments:

Argument	Description
.	No arguments

Example:

C:\>deadlinecommand -GetPoolNames
    none
    2d
    3d
    arnold
    redshift
    vray

AddPool ¶

Description:

Adds the Pool.

Syntax:

deadlinecommand -AddPool <Pool Name(s)>

Arguments:

Argument	Description
<Pool Name(s)>	The Pool name, or a list of Pool names separated by commas

Example:

C:\>deadlinecommand -AddPool Krakatoa
    Pool Krakatoa added
    Successfully added pool: Krakatoa

C:\>deadlinecommand -GetPoolNames
    none
    2d
    3d
    arnold
    krakatoa
    redshift
    vray

Note

Pool names are forced to lowercase by Deadline.

AddPoolToSlave ¶

Description:

Adds a Pool to the Worker.

Syntax:

deadlinecommand -AddPoolToSlave <Worker Name(s)> <Pool Name(s)>

Arguments:

Argument	Description
<Worker Name(s)>	The Worker name, or a list of Worker names separated by commas
<Pool Name(s)>	The Pool name, or a list of Pool names separated by commas

Example:

C:\>deadlinecommand -AddPoolToSlave RenderNode-042 Krakatoa,Renderman
    Added pool krakatoa,none

In the above example

The Pool ‘renderman’ does not exist, so it is handled as the ‘none’ Pool.

The lowercase ‘krakatoa’ Pool already exists, the capitalized name is accepted.

GetSlaveNamesInPool ¶

Description:

Displays the Worker names that have been assigned to the specified Pool.

Syntax:

deadlinecommand -GetSlaveNamesInPool <Pool Name(s)>

Arguments:

Argument	Description
<Pool Name(s)>	The Pool name, or a list of Pool names separated by commas

Example:

C:\>deadlinecommand -GetSlaveNamesInPool Krakatoa
    RenderNode-042

If the Pool does not exist, no error is thrown, and no output is generated:

C:\>deadlinecommand -GetSlaveNamesInPool Renderman

C:\>

SetPoolsForSlave ¶

Description:

Sets the list of Pools for a Worker.

If the Worker is in any Pools not listed in the second argument, it will be removed from them.

Syntax:

deadlinecommand -SetPoolsForSlave <Worker Name(s)> <Pool Name(s)>

Arguments:

Argument	Description
<Worker Name(s)>	The Worker name, or a list of Worker names separated by commas
<Pool Name(s)>	The Pool name, or a list of Pool names separated by commas

Example:

C:\>deadlinecommand -SetPoolsForSlave RenderNode-042,RenderNode-043 Krakatoa,Arnold
    Set pools to krakatoa,none

In the above example

The Pool ‘renderman’ does not exist, so it is handled as the ‘none’ Pool.

The lowercase ‘krakatoa’ Pool already exists, the capitalized name is accepted.

The order of the Pools list matters - this will set the list to projecta,projectb,none:

C:\>deadlinecommand -SetPoolsForSlave RenderNode-042 ProjectA,ProjectB
    Set pools to projecta,projectb

The order of the Pools list matters - this will set the list to none,projectb,projecta:

C:\>deadlinecommand -SetPoolsForSlave RenderNode-042 None,ProjectB,ProjectA
Set pools to none,projectb,projecta

RemovePoolFromSlave ¶

Description:

Removes a Pool from the Worker.

Syntax:

deadlinecommand -RemovePoolFromSlave <Worker Name(s)> <Pool Name(s)>

Arguments:

Argument	Description
<Worker Name(s)>	The Worker name, or a list of Worker names separated by commas
<Pool Name(s)>	The Pool name, or a list of Pool names separated by commas

Example:

C:\>deadlinecommand -RemovePoolFromSlave RenderNode-042 Krakatoa,Arnold
    Removed pool Krakatoa,Arnold

Note

No argument validation is performed - in the above example, the Worker was in neither Pool.

The result would be the same if the Worker did not exist.

DeletePool ¶

Description:

Deletes the Pool.

Syntax:

deadlinecommand -DeletePool <Pool Name>

Arguments:

Argument	Description
<Pool Name>	The Pool name

Example:

C:\>deadlinecommand -DeletePool Krakatoa
    Pool Krakatoa deleted
    Successfully deleted pool: Krakatoa

The Pool must exist, otherwise an error will be generated.

C:\>deadlinecommand -DeletePool Krakatoa
    Error: Pool 'Krakatoa' does not exist (System.ArgumentException)

PurgeObsoletePools ¶

Description:

Purges Pools that are no longer in use.

Syntax:

deadlinecommand -PurgeObsoletePools <Pool Name>

Arguments:

Argument	Description
<Pool Name>	The replacement Pool for Jobs that are using obsolete Pools (optional)

Groups ¶

GetGroupNames ¶

Description:

Displays all Groups.

Aliases: GetGroupNames, Groups

Syntax:

deadlinecommand -GetGroupNames

deadlinecommand -Groups

Arguments:

Argument	Description
.	No arguments

AddGroup ¶

Description:

Adds an empty Group with the specified name.

Syntax:

deadlinecommand -AddGroup <Group Name>

Arguments:

Argument	Description
<Group Name>	The Group name

Example:

C:\>deadlinecommand -AddGroup NewGroup
    Group NewGroup added
    Successfully added group: NewGroup

Note

Quotes around the Group Name are allowed, but are stripped and are not necessary because spaces are not allowed.

If the Group exists, there will be no error and the message will report the Group was added successfully.

C:\>deadlinecommand -AddGroup "NewGroup"
    Group NewGroup added
    Successfully added group: NewGroup

Warning

The Group Name will be checked for validity and cannot contain spaces or spacial characters except for - and _

C:\>deadlinecommand -AddGroup "Test Spaces"
Error: Group name 'Test Spaces' contains illegal characters. Valid characters are A-Z, a-z, 0-9, - and _ (System.Exception)

AddGroupToSlave ¶

Description:

Adds a Group to the Worker.

Syntax:

deadlinecommand -AddGroupToSlave <Worker Name(s)> <Group Name(s)>

Arguments:

Argument	Description
<Worker Name(s)>	The Worker name, or a list of Worker names separated by commas
<Group Name(s)>	The Group name, or a list of Group names separated by commas

SetGroupsForSlave ¶

Description:

Sets the Groups for a Worker.

Syntax:

deadlinecommand -SetGroupsForSlave <Worker Name(s)> <Group Name(s)>

Arguments:

Argument	Description
<Worker Name(s)>	The Worker name, or a list of Worker names separated by commas
<Group Name(s)>	The Group name, or a list of Group names separated by commas

GetSlaveNamesInGroup ¶

Description:

Displays the Worker names that have been assigned to the specified Group.

Syntax:

deadlinecommand -GetSlaveNamesInGroup <Group Name(s)>

Arguments:

Argument	Description
<Group Name(s)>	The Group name, or a list of Group names separated by commas

RemoveGroupFromSlave ¶

Description:

Removes a Group from the Worker.

Syntax:

deadlinecommand -RemoveGroupFromSlave <Worker Name(s)> <Group Name(s)>

Arguments:

Argument	Description
<Worker Name(s)>	The Worker name, or a list of Worker names separated by commas
<Group Name(s)>	The Group name, or a list of Group names separated by commas

DeleteGroup ¶

Description:

Deletes the Group.

Syntax:

deadlinecommand -DeleteGroup <Group Name>

Arguments:

Argument	Description
<Group Name>	The Group name

PurgeObsoleteGroups ¶

Description:

Purges Groups that are no longer in use.

Syntax:

deadlinecommand -PurgeObsoleteGroups [<Group Name>]

Arguments:

Argument	Description
<Group Name>	The replacement Group for Jobs that are using obsolete Groups (optional)

Limits ¶

Note

The original feature name of ‘Limits’ was ‘LimitGroups’ in earlier versions of Deadline.

Command arguments use the old name for compatibility.

GetLimitGroupNames ¶

Description:

Displays all Limit names.

Aliases: GetLimitGroupNames, LimitGroups

Syntax:

deadlinecommand -GetLimitGroupNames

deadlinecommand -LimitGroups

Arguments:

Argument	Description
.	No arguments

Example:

C:\>deadlinecommand -LimitGroups
    arnold
    krakatoa
    max
    maya
    nuke
    redshift
    vray

GetLimitGroup ¶

Description:

Displays information for the Limit.

Syntax:

deadlinecommand -GetLimitGroup <Limit Name(s)> [<Use Ini Display>]

Arguments:

Argument	Description
<Limit Name(s)>	The Limit name, or a list of names separated by commas
<Use Ini Display>	true/false (optional, default is false)

Example:

C:\>deadlinecommand -GetLimitGroup maya,vray
    ListedSlaves=RenderNode-42
    InUse=0
    Limit=0
    Name=maya
    ReleasePercentage=0
    WhitelistFlag=False

    ListedSlaves=
    InUse=0
    Limit=0
    Name=vray
    ReleasePercentage=0
    WhitelistFlag=False

Here is the same information, but displayed as INI:

C:\Users\bobo>deadlinecommand -GetLimitGroup maya,vray true
    [maya]
    ListedSlaves=RenderNode-42
    InUse=0
    Limit=0
    Name=maya
    ReleasePercentage=0
    WhitelistFlag=False

    [vray]
    ListedSlaves=
    InUse=0
    Limit=0
    Name=vray
    ReleasePercentage=0
    WhitelistFlag=False

SetLimitGroup ¶

Description:

Modifies or creates the Limit.

Syntax:

deadlinecommand -SetLimitGroup <Limit Name> <Limit> <Listed Workers> <Allow List Flag> [<Limit Progress>] [<Excluded Workers>]

Arguments:

Argument	Description
<Limit Name>	The Limit name
<Limit>	The new limit value
<Listed Workers>	The listed Workers
<Allow List Flag>	true/false
<Limit Progress>	The limit progress (optional)
<Excluded Workers>	The excluded Workers (optional)

Example:

The following creates a “Yeti” Limit with a value of 12, no Workers on the Denylist.

C:\>deadlinecommand -SetLimitGroup yeti 12 "" False
    Created limit 'yeti'.

GetLimitGroups ¶

Description:

Displays information for all Limits.

The results are similar to GetLimitGroup

Syntax:

deadlinecommand -GetLimitGroups [<Use Ini Display>]

Arguments:

Argument	Description
<Use Ini Display>	true/false (optional, default is false)

GetPluginLimitGroups ¶

Description:

Displays all Limit group names assigned to a Plugin.

Syntax:

deadlinecommand -GetPluginLimitGroups <Plugin Name>

Arguments:

Argument	Description
<Plugin Name>	The name of the Plugin to retrieve Limits for.

SetPluginLimitGroups ¶

Description:

Assign one or more Limits to a Plugin.

Syntax:

deadlinecommand -SetPluginLimitGroups <Plugin Name> <Limit Names>

Arguments:

Argument	Description
<Plugin Name>	The name of the Plugin we want to modify.
<Limit Names>	A comma-separated list of Limit names to apply to the Plugin. If any Limits contain spaces, the list needs to be surrounded in double-quotes (“).

SetLimitGroupListedSlaves ¶

Description:

Sets the Limit’s listed Workers.

Syntax:

deadlinecommand -SetLimitGroupListedSlaves <Limit Name(s)> <Workers>

Arguments:

Argument	Description
<Limit Name(s)>	The Limit name, or a list of Limit names separated by commas
<Workers>	The Workers, separated by commas

Example:

C:\>deadlinecommand -SetLimitGroupListedSlaves yeti RenderNode-042,RenderNode-043

C:\>

Note

The above command does not produce any output.

The listed Workers will be added to the Deny/Allow (middle) list of the Limit.

SetLimitGroupMaximum ¶

Description:

Sets the Limit’s License Count value.

Syntax:

deadlinecommand -SetLimitGroupMaximum <Limit Name(s)> <Limit>

Arguments:

Argument	Description
<Limit Name(s)>	The Limit name, or a list of Limit names separated by commas
<Limit>	The Limit’s value

Example:

Set the Yeti Limit’s License Count value to 42:

C:\>deadlinecommand -SetLimitGroupMaximum yeti 42

SetLimitGroupReleaseProgress ¶

Description:

Sets the Limit’s progress.

Syntax:

deadlinecommand -SetLimitGroupReleaseProgress <Limit Name(s)> <Limit Progress>

Arguments:

Argument	Description
<Limit Name(s)>	The Limit name, or a list of Limit names separated by commas
<Limit Progress>	The Limit progress

SetLimitGroupWhiteListFlag ¶

Description:

Sets the Limit’s Allow List flag.

Syntax:

deadlinecommand -SetLimitGroupWhiteListFlag <Limit Name(s)> <Allow List>

Arguments:

Argument	Description
<Limit Name(s)>	The Limit name, or a list of Limit names separated by commas
<Allow List>	True for Allowlist, False for Denylist

DeleteLimitGroup ¶

Description:

Deletes one or more Limits.

Syntax:

deadlinecommand -DeleteLimitGroup <Limit Name(s)>

Arguments:

Argument	Description
<Limit Name(s)>	The Limit name, or a list of names separated by commas

Example:

C:\>deadlinecommand -DeleteLimitGroup yeti
    Deleted limits: yeti

C:\>deadlinecommand -DeleteLimitGroup yeti
    Deleted limits: yeti

Note

No validation is performed on the arguments. No error is generated if the Limit does not exist.

Pools, Groups, and Limits - Command Arguments¶

Pools ¶

GetPoolNames ¶

AddPool ¶

AddPoolToSlave ¶

GetSlaveNamesInPool ¶

SetPoolsForSlave ¶

RemovePoolFromSlave ¶

DeletePool ¶

PurgeObsoletePools ¶

Groups ¶

GetGroupNames ¶

AddGroup ¶

AddGroupToSlave ¶

SetGroupsForSlave ¶

GetSlaveNamesInGroup ¶

RemoveGroupFromSlave ¶

DeleteGroup ¶

PurgeObsoleteGroups ¶

Limits ¶

GetLimitGroupNames ¶

GetLimitGroup ¶

SetLimitGroup ¶

GetLimitGroups ¶

GetPluginLimitGroups ¶

SetPluginLimitGroups ¶

SetLimitGroupListedSlaves ¶

SetLimitGroupMaximum ¶

SetLimitGroupReleaseProgress ¶

SetLimitGroupWhiteListFlag ¶

DeleteLimitGroup ¶

Table of Contents

Previous topic

Next topic