PARAMS.md

When using Gurobi, you can specify connection information by setting parameters in the API or by using a client license file. The full list of parameters can be found in the reference manual. The following sections gives a quick guide to map license file to parameters.

Connection to Gurobi Web License Service (WLS)

Parameter	License File	Purpose
WLSAccessID	WLSACCESSID	Access ID for Gurobi Web License Service (mandatory)
WLSSecret	WLSSECRET	Secret Key for Gurobi Web License Service (mandatory)
LicenseID	LICENSEID	Type Integer, License ID for Gurobi Web License Service (mandatory)
WLSTokenDuration	WLSTOKENDURATION	Token Duration

Connection to Gurobi Cloud

Parameter	License File	Purpose
CloudAccessID	CLOUDACCESSID	Access ID for Gurobi Instant Cloud (mandatory)
CloudSecretKey	CLOUDSECRETKEY	Secret Key for Gurobi Instant Cloud (mandatory)
CloudPool	CLOUDPOOL	Cloud pool to use for Gurobi Instant Cloud instance

Connection to a self-managed cluster

Parameter	License File	Purpose
ComputeServer	COMPUTESERVER	Name of a node in the Remote Services cluster (mandatory)
ServerPassword	PASSWORD	Client password for Remote Services cluster

Connection to a self-managed cluster with a Router

Parameter	License File	Purpose
CSRouter	ROUTER	Router node for Remote Services cluster (mandatory)
ComputeServer	COMPUTESERVER	Name of a node in the Remote Services cluster (mandatory)
ServerPassword	PASSWORD	Client password for Remote Services cluster

Connection to a Cluster Manager

Parameter	License File	Purpose
CSManager	CSMANAGER	URL for the Cluster Manager (mandatory)
CSAPIAccessID	CSAPIACCESSID	Access ID for Gurobi Cluster Manager (mandatory)
CSAPISecret	CSAPISECRET	Secret key for Gurobi Cluster Manager (mandatory)
CSBatchMode	CSBATCHMODE	Controls Batch-Mode optimization

Common parameters to Gurobi Cloud and Compute Server

Parameter	License File	Purpose
ServerTimeout	SERVERTIMEOUT	Network timeout interval
CSPriority	PRIORITY	Job priority for Remote Services job
CSQueueTimeout	QUEUETIMEOUT	Queue timeout for new jobs
CSGroup	GROUP	Group placement request for cluster
CSTLSInsecure	CSTLSINSECURE	Use insecure mode in Transport Layer Security (TLS)
CSIdleTimeout	IDLETIMEOUT	Idle time before Compute Server kills a job
CSAppName	CSAPPNAME	Application name of the batches or jobs
CSClientLog	-	Turns logging on or off

Connection to a Gurobi Token Server

Parameter	License File	Purpose
TokenServer	TOKENSERVER	Name of your token server (mandatory)
ServerPassword	PASSWORD	Client password for token server
TSPort	PORT	Token server port number
ServerTimeout	SERVERTIMEOUT	Network timeout interval