AWS Portal and Cloud - 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

AWS Portal Settings

GetAWSPortalSetting

Description:

Gets the value of the specified AWS Portal setting if it exists.

Syntax:

deadlinecommand -GetAWSPortalSetting <Name>

Arguments:

Argument	Description
<Name>	The name of the AWS Portal setting.

SetAWSPortalSetting

Description:

Sets the value of the specified AWS Portal setting if it exists.

Syntax:

deadlinecommand -SetAWSPortalSetting <Name> <Value>

Arguments:

Argument	Description
<Name>	The name of the AWS Portal setting.
<Value>	The value to apply to the AWS Portal setting.

AWSPortalPrecacheJob

Description:

Precaches the AWS Portal Assets of the Jobs.

Syntax:

deadlinecommand -AWSPortalPrecacheJob <Job ID(s)>

Arguments:

Argument	Description
<Job ID(s)>	The Job ID, or a list of Job IDs separated by commas

CreateSpotFleet

Description:

Creates a spot fleet for a given infrastructure

Syntax:

deadlinecommand -CreateSpotFleet <templateJSONFile> [--no-resource-tracker]

Arguments:

Argument	Description
<templateJSONFile>	Path to a Json file with Spot fleet configuration information in the format: {“StackName”: “”, “Capacity”: 1, “InstanceTypes”: [], “SpotPrice”: 1, “AmiId”: “”, “AmiName”: “”, “KeyName”: “”, “AvailabilityZones”: [], “AWSPortalRequestType”: “”, “IdleTime”: 2, “Groups”: [], “Pools”: [], “InstanceTags”: {} }
--no-resource-tracker	Use of the Deadline Resource Tracker requires that your custom AMIs have Deadline Client 10.0.27 or later installed on them. If enabled, the Deadline Resource Tracker will help optimize your resources by terminating instances and Spot Fleet requests that don’t appear to be behaving as expected. We recommend upgrading your AMIs and enabling the Deadline Resource Tracker.

RemoveOrphanedAWSEntities

Description:

Removes AWS entities from the database that do not belong to the AWS account of the given credentials.

Syntax:

deadlinecommand -RemoveOrphanedAWSEntities

Arguments:

Argument	Description
.	No arguments

RunAWSPortalS3Setup

Description:

Creates S3 buckets and access policies/users/roles for use with AWS Portal Asset Server.

Syntax:

deadlinecommand -RunAWSPortalS3Setup <Region>

Arguments:

Argument	Description
<Region>	An AWS Region

AWS Portal Asset Server

AddAssetServerRoots

Description:

Appends new asset server root directories to the list.

Syntax:

deadlinecommand -AddAssetServerRoots <Path(s)…>

Arguments:

Argument	Description
<Path(s)…>	One or more directories to append, separated by spaces. If a path contain spaces, enclose it in quotes.

Example:

C:\>deadlinecommand -AddAssetServerRoots "D:/Assets/" "Z:/Projects/"
    Appended given paths to asset server root directories.

Warning

The Path argument after the -AddAssetServerRoots parameter will not be checked for validity.

The provided string will be added to the Database verbatim without any filtering or sanity checking.

Please make sure it is valid!

PopulateAssetServerDefaultSettings

Description:

Populate the default settings for Asset Server.

Syntax:

deadlinecommand -PopulateAssetServerDefaultSettings <Force> <Global Whitelist Patte>

Arguments:

Argument	Description
<Force>	Whether to repopulate the default settings for asset server (this may override existing settings)
<Global Whitelist Patte>	The file containing the global whitelist patterns

GetAssetServerInfo

Description:

Gets the value of the specified Asset Server Info setting if it exists.

Syntax:

deadlinecommand -GetAssetServerInfo <Name>

Arguments:

Argument	Description
<Name>	The name of the Asset Server Info setting.

GetAssetServerSetting

Description:

Gets the value of the specified Asset Server setting if it exists.

Syntax:

deadlinecommand -GetAssetServerSetting <Name>

Arguments:

Argument	Description
<Name>	The name of the Asset Server setting.

SetAssetServerInfo

Description:

Sets the value of the specified Asset Server info if it exists.

Syntax:

deadlinecommand -SetAssetServerInfo <Name> <Value>

Arguments:

Argument	Description
<Name>	The name of the Asset Server info.
<Value>	The value to apply to the AWS Portal info.

Balancer

DeleteBalancer

Description:

Deletes the Balancer.

Syntax:

deadlinecommand -DeleteBalancer <Balancer Name(s)>

Arguments:

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

GetBalancerInfo

Description:

Retrieves BalancerInfo for a specified Balancer.

Syntax:

deadlinecommand -GetBalancerInfo <Balancer Name>

Arguments:

Argument	Description
<Balancer Name>	The name of the Balancer to retrieve BalancerInfo for.

GetBalancerInfos

Description:

Get BalancerInfo for all specified (by name) Balancers.

Syntax:

deadlinecommand -GetBalancerInfos <Balancer Name(s)>

Arguments:

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

GetBalancerNames

Prints a list of all Balancer names.

GetBalancerSettings

Description:

Retrieves BalancerSettings for a specified Balancer.

Syntax:

deadlinecommand -GetBalancerSettings <Balancer Name>

Arguments:

Argument	Description
<Balancer Name>	The name of the Balancer to retrieve BalancerSettings for.

GetBalancerSettingsList

Description:

Get BalancerInfo for all specified (by name) Balancers.

Syntax:

deadlinecommand -GetBalancerSettingsList <Balancer Name(s)>

Arguments:

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

SaveBalancerInfo

Description:

Save a specified BalancerInfo object to the Database.

Syntax:

deadlinecommand -SaveBalancerInfo <BalancerInfo Object>

Arguments:

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

SaveBalancerSettings

Description:

Save a specified BalancerSettings object to the Database.

Syntax:

deadlinecommand -SaveBalancerSettings <BalancerSettings Object>

Arguments:

Argument	Description
<BalancerSettings Objec>	JSON Object representing a BalancerSettings to save.

Cloud Regions

AddGroupMapping

Description:

Add or Edit a Group Mapping.

Syntax:

deadlinecommand -AddGroupMapping <Region> <Group> <Image> <Machine Type> [<Cost>] [<Pool>]

Arguments:

Argument	Description
<Region>	The name of the Cloud Region
<Group>	Name of the Group
<Image>	Image Name
<Machine Type>	Machine Type
<Cost>	Cost, default=1
<Pool>	Name of the Pool, default=none

CreateCloudRegion

Description:

Creates a new Cloud Region.

Syntax:

deadlinecommand -CreateCloudRegion <Name> <Plugin Name> <Config File>

Arguments:

Argument	Description
<Name>	The name of the Cloud Region
<Plugin Name>	The Cloud Plugin name
<Config File>	Path to Cloud Region config file

GetCloudPluginParams

Description:

Show all the parameters for a given cloud plugin.

Syntax:

deadlinecommand -GetCloudPluginParams <Plugin Name>

Arguments:

Argument	Description
<Plugin Name>	The name of the cloud plugin

RemoveCloudRegion

Description:

Remove a Cloud Region. This will terminate any running instances that have been started in this region. Also, this will purge the region from Balancer, Pulse and User settings. Additionally, this will remove any mapped paths for this region.

Syntax:

deadlinecommand -RemoveCloudRegion <CloudRegion>

Arguments:

Argument	Description
<CloudRegion>	The name of the Cloud Region

SetAssetCrawlerEnabled

Description:

Disable/enable an Asset Crawler for a given Cloud Region.

Syntax:

deadlinecommand -SetAssetCrawlerEnabled <Name> <Enabled>

Arguments:

Argument	Description
<Name>	Name of the Cloud Region
<Enabled>	True/False

SetAssetCrawlerSettings

Description:

Change the Asset Crawler settings for a Cloud Region.

Syntax:

deadlinecommand -SetAssetCrawlerSettings <Name> <Hostname> <Port> <OS>

Arguments:

Argument	Description
<Name>	Name of the Cloud Region
<Hostname>	Host name
<Port>	Port number
<OS>	Operating System (Windows, Linux, Mac OSX)

SetRegionEnabled

Description:

Enables or Disables Balancer features for the given Cloud Region.

Syntax:

deadlinecommand -SetRegionEnabled <Name> <Enabled>

Arguments:

Argument	Description
<Name>	Name of the Cloud Region
<Enabled>	True/False

SetRegionBudget

Description:

Sets the budget of a Cloud Region.

Syntax:

deadlinecommand -SetRegionBudget <Name> <Budget>

Arguments:

Argument	Description
<Name>	Name of the Cloud Region
<Budget>	Total Budget Amount

SetCloudRegionEnabled

Description:

Enables or Disables the given Cloud Region.

Syntax:

deadlinecommand -SetCloudRegionEnabled <Name> <Enabled>

Arguments:

Argument	Description
<Name>	Name of the Cloud Region
<Enabled>	True/False