DISNIX-SOAP-CLIENT(1)

📦 version 0.10.1, in nixos 26.05, nixpkgs unstable

💅 disnix-soap-client — DISNIX-SOAP-CLIENT(1) 💅

okay so bestie, welcome to the DISNIX-SOAP-CLIENT(1) glow-up ✨ — yes, it’s a User Commands page, and we are keeping every flag, path, default, and tiny detail exactly where it belongs. no cap 🫶

🎀 NAME 🎀

disnix-soap-client — Provides access to the disnix-service through the SOAP protocol.

🌸 SYNOPSIS 🌸

disnix-soap-client --target targetEPR operation [OPTION] paths

🦋 DESCRIPTION 🦋

The command disnix-soap-client is your remote-access plug 🔌: it provides remote access to a disnix-service instance running on a machine in the network by using a SOAP/HTTP connection. This allows the user to perform remote deployment operations on a target machine through SOAP.

okay but real talk: in most cases this command is not used directly — it’s used by specifying the --interface option for a Disnix command-line utility (such as disnix-env) or by setting the DISNIX_CLIENT_INTERFACE environment variable. By using one of those properties, the Disnix tools will use the given interface instead of the standard disnix-client which only provides loopback access. 💅

✨ OPTIONS ✨

🛠️ Operations:

  • --import — Imports a given closure into the Nix store of the target machine. Optionally, transfers the closure from this machine to the target machine. 📥
  • --export — Exports the closure of a given Nix store path of the target machine into a file, and optionally downloads it. 📤
  • --print-invalid — Prints all the paths that are not valid in the Nix store of the target machine. 🚩
  • -r, --realise — Realises the given store derivation on the target machine. 🛠️
  • --set — Creates a Disnix profile only containing the given derivation on the target machine. 🗂️
  • -q, --query-installed — Queries all the installed services on the given target machine. 🔍
  • --query-requisites — Queries all the requisites (intra-dependencies) of the given services on the target machine. 🧩
  • --collect-garbage — Collects garbage on the given target machine. 🗑️
  • --activate — Activates the given service on the target machine. ⚡
  • --deactivate — Deactivates the given service on the target machine. 🔌
  • --lock — Acquires a lock on a Disnix profile of the target machine. 🔒
  • --unlock — Release the lock on a Disnix profile of the target machine. 🔓
  • --snapshot — Snapshots the logical state of a component on the given target machine. 📸
  • --restore — Restores the logical state of a component on the given target machine. ♻️
  • --delete-state — Deletes the state of a component on the given machine. 🧹
  • --query-all-snapshots — Queries all available snapshots of a component on the given target machine. 🔎
  • --query-latest-snapshot — Queries the latest snapshot of a component on the given target machine. 🕐
  • --print-missing-snapshots — Prints the paths of all snapshots not present on the given target machine. 📋
  • --import-snapshots — Imports the specified snapshots into the remote snapshot store. 📥
  • --export-snapshots — Exports the specified snapshot to the local snapshot store. 📤
  • --resolve-snapshots — Converts the relative paths to the snapshots to absolute paths. 🧭
  • --clean-snapshots — Removes older snapshots from the snapshot store. 🧽
  • --capture-config — Captures the configuration of the machine from the Dysnomia container properties in a Nix expression. 📝
  • --shell — Spawns a Dysnomia shell to run arbitrary maintenance tasks. 🐚
  • --help — Shows the usage of this command to the user. 🙋
  • --version — Shows the version of this command to the user. 🏷️

🌐 General options:

  • -t, --target=TARGET — Specifies the hostname and optional port number of the SSH server used to connect to the target machine. 🎯

📦 Import/Export/Import snapshots/Export snapshots/Shell options:

  • --localfile — Specifies that the given paths are stored locally and must be transferred to the remote machine if needed. 💾
  • --remotefile — Specifies that the given paths are stored remotely and must be transferred from the remote machine if needed. 🌐

🐚 Shell options:

  • --command=COMMAND — Commands to execute in the shell session. 💬

🗂️ Set/Query installed/Lock/Unlock options:

  • -p, --profile=PROFILE — Name of the Disnix profile. Defaults to: default. 🏷️

🗑️ Collect garbage options:

  • -d, --delete-old — Indicates whether all older generations of Nix profiles must be removed as well. 🧹

⚡ Activation/Deactivation/Snapshot/Restore/Delete state options:

  • --type=TYPE — Specifies the activation module that should be used, such as echo or process. 🧩
  • --arguments=ARGUMENTS — Specifies the arguments passed to the Dysnomia module, which is a string with key=value pairs. 📝
  • --container=CONTAINER — Name of the container in which the component is managed. If omitted it will default to the same value as the type. 📦

🔍 Query all snapshots/Query latest snapshot options:

  • -C, --container=CONTAINER — Name of the container in which the component is managed. 📦
  • -c, --component=COMPONENT — Name of the component hosted in a container. 🧩

🧹 Clean snapshots options:

  • --keep=NUM — Amount of snapshot generations to keep. Defaults to: 1. 🔢
  • -C, --container=CONTAINER — Name of the container to filter on. 📦
  • -c, --component=COMPONENT — Name of the component to filter on. 🧩

🌈 ENVIRONMENT 🌈

  • DISNIX_PROFILE — Sets the name of the profile that stores the manifest on the coordinator machine and the deployed services per machine on each target (Defaults to: default). 🗂️
  • DYSNOMIA_STATEDIR — Specifies where the snapshots must be stored on the coordinator machine (defaults to: /var/dysnomia). 💾
  • DISNIX_SOAP_CLIENT_USERNAME — Specifies the username to use for HTTP basic authentication. 🔐
  • DISNIX_SOAP_CLIENT_PASSWORD — Specifies the password to use for HTTP basic authentication. 🔑

Copyright © 2008-2021 Sander van der Burg

okay bestie, that’s the whole page 🫶 — it’s from the DisnixWebS... source/version, stamped January 1980, and the manual name is DISNIX-SOAP-CLIENT(1). periodt 💅

📦 where this page comes from