API call setup

Create, update or inspect your setup

This is a MAINTENANCE call: Daemon will be automatically STOPPED while running, any ongoing events will be CANCELED.

Authorization: ADMIN
Optional arguments
Run Options Clear
update: Update existing instances; 'all' to update all, empty string to never update, <hash_id>,.. (see a previous run) to update selected instances

Format: Plain string
Clear
pca: Prepare, check and create instances; 'all' to pca all, empty string to never pca, <hash_id>,.. (see a previous run) to pca selected instances

Format: Plain string
Daemon Clear Paste default
identity: Instance identity (for keyring package names, dput config, ...)

Format: Plain string
Clear Paste default
ftp_endpoint: FTP (incoming) network endpoint

Format: Plain string
Generic Clear
from_origins: Set list of origins (a.k.a. vendors) (as per ``distro-info``, ``di``): <origin>[:lts|all],...

This will be used by ``--foo-from-origins`` options.

Per-origin modifiers:

n/a: No modifier (default): 'di-supported' codenames
lts: 'di-supported' plus 'di-lts' codenames (Note: adds 'lts', 'elts' for Debian and 'esm' for Ubuntu)
all: All codenames with a working setup from these origins (i.e., includes very old ones)

Format: List as comma-separated strings
Archives Clear
archives: Add arbitrary archives

Format: List as comma-separated strings
archives_from_origins: Add original (internet) archives from ``--from-origins``

Format: Checkbox
archives_from_apt_sources: Add archives guessed from your local sources.list

Format: Checkbox
archives_from_proxy: Add archives guessed from a locally running apt-cacher-ng

Format: Checkbox
Sources Clear
sources: Manually select codenames to setup sources for

Format: List as comma-separated strings
sources_from_origins: Add sources from ``--from-origins``

Format: Checkbox
Distributions Clear
distributions: Distributions to setup ``<codename>:<arch0>[+<arch1>..]``
For architectures, you may use the special key word 'native' for this host's natively supported architectures.
Please see tool ``arch-test`` for a decisive list of actually available architectures, including emulated ones.
Example: sid:native+arm64,bullseye:native


Format: List as comma-separated strings
distributions_from_sources: Auto-add distributions for all given ``sources`` codenames with native architectures

Format: Checkbox
Repositories Clear
repositories: Repositories to setup ``<id>:<layout>:<codename>[+<codename>..]``
Setup layouts available: Default|Default (no rollbacks)|Debian Developer
Example: test:Default:sid+bullseye,test2:Default:sid
Note that repository IDs 'test' and 'debdev' are special names with hardcoded taintings:
* ``test`` repo will be uploadable w/o authentication
* `debdev`` repo will be uploadable for Debian Developers (per installed ``debian-keyring``), and Layout 'Debian Developer' by default (``sid`` uploadable as ``unstable``)


Format: List as comma-separated strings
Clear
repositories_from_distributions: AutoSetup these repositories with all setup sources: '<id>[:<layout>]'

Format: List as comma-separated strings
Chroots Clear
chroots: Chroots to setup (uses same syntax as ``--distributions``).

Format: List as comma-separated strings
chroots_from_sources: Auto-add chroots for all given ``sources`` codenames with native architectures

Format: Checkbox
chroots_backend: Chroot backend to use

Format: Choice
Remotes Clear
remotes: Remotes to add. Twisted-style Network Client Endpoint

See: https://twistedmatrix.com/documents/current/core/howto/endpoints.html#clients

Notation Examples::

  'tcp:host=localhost:port=8066': Connect to localhost, unencrypted.
  'tls:host=localhost:port=8066': Connect to localhost, encrypted.
  'http://localhost:8066'       : Extra URL-style syntax (prefer twisted-style in saved configs, though).
  'localhost:8066'              : Compatibility host:port syntax (don't use -- might eventually go away).

Format: List as comma-separated strings
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice