Show / Hide Table of Contents

Create

Create and launch a new pool

Unix

 qarnot create pool

Windows

 qarnot.exe create pool

USAGE

Regular usage

  • qarnot pool create --instanceNodes 4 --name "Pool name" --profile docker-batch Create a pool with scaling policies defined in a file
  • qarnot pool create --name "Pool name" --profile docker-batch --scaling @scaling_file.json File config usage
  • qarnot pool create --file FileName.json Error: missing instanceNodes
  • qarnot pool create --name "Pool name" --profile docker-batch

Flags

flag description
--name, -n Name of the pool
--shortname, -s Short name of the pool
--profile, -p Name of the profile used for the pool
--instanceNodes, -i (Required if not elastic) instance count of the pool
--pool-is-elastic, -e Make the pool elastic
--file, -f File with a json configuration of the pool. (example : echo '{"Shortname": "SN","Name": "PoolName","Profile": "docker-batch","InstanceCount": 1}' > CreatePool.json)
--tags, -t Tags of the pool
--constants, -c Constants of the pool
--constraints Constraints of the pool
--labels Labels of the pool
--resources, -r Name of the buckets of the task
--min-slot Minimum slot number for the pool in elastic mode
--max-slot Maximum slot number for the pool in elastic mode
--min-idling-slot Minimum idling slot number
--resize-period Elastic resize period
--resize-factor Elastic resize factor
--min-idling-time Minimum idling time
--tasks-wait-for-synchronization Have all the pool's tasks wait for the resources to be synchronized before running if the pool resources are updated before the task submission. (set to true or false, default: false)
--ttl Default TTL for the pool resources cache (in seconds)
--max-total-retries Total number of times the pool can have its instances retried in case of failure
--max-retries-per-instance Total number of times each pool instance will be allowed to retry in case of failure
--scaling Scaling policies of the pool. Use either direct json format or a file path prefixed by '@'
--min-core-count Minimum number of cores that tasks in the pool will have access to
--max-core-count Maximum number of cores that tasks in the pool will have access to
--min-ram-core-ratio Minimum ratio of RAM per number of cores that tasks in the pool will have access to
--max-ram-core-ratio Maximum ratio of RAM per number of cores that tasks in the pool will have access to
--specific-hardware-constraints List of constraints for specific hardware, described by specification keys. Specification keys are to be separated by spaces. Make sure to quote specification keys if they contain spaces (example : qarnot pool create --name thename --profile theprofile --specific-hardware-constraints "Amd Ryzen 7" "Another hardware constraint")
--gpu-hardware Force the tasks in the pool to run on GPU powered machines
--ssd-hardware Force the tasks in the pool to run on machines that have SSDs
--no-ssd-hardware Force the tasks in the pool to run on machines that don't have SSDs
--min-ram Minimum amount of RAM (in MB) that tasks in the pool will have access to
--max-ram Maximum amount of RAM (in MB) that tasks in the pool will have access to
--cpu-model Target a specific CPU model to use when running the tasks in the pool
--secrets-access-rights-by-key Give the pool access to secrets described by their keys
--secrets-access-rights-by-prefix Give the pool access to secrets described by their prefixs
--scheduling-type Specify the type of scheduling used for the pool
--machine-target Available only for 'Reserved' scheduling. Specify the reserved machine on which the pool should run
--export-credentials-to-env Activate the exportation of the api and storage credentials to the pool environment (default is false)
--token, -t Connection API token
--unsafe-ssl Don't check the ssl certificate
--api-ca-certificate Path to your custom SSL certificate
--verbose, -v Set the max verbose messages
--quiet, -q Set no verbose messages
--no-color Remove the color on the console
--format Change the result format (one of TABLE (default) or JSON)
-h, --human-readable Print sizes in human readable format (e.g. 1K, 234M, etc.)
--version The current version
--help Show help and usage information

Version: CreateDoc-0.0.50-4af90b6-01/01/0001 00:Z-.NET6.0.36
Copyright: Copyright (C) 2025 Qarnot computing

In this article
Back to top Generated by DocFX