CLI Reference#

A Data Safe Haven is managed using the dsh command line interface. A full guide to the commands available for managing your Data Safe Haven is provided here.

The dsh commands are the entrypoint to the Data Safe Haven command line interface. All commands begin with dsh.

dsh Usage: dsh [OPTIONS] COMMAND [ARGS]... Arguments to the main executable ╭─ Options ─────────────────────────────────────────────────────╮ --verbose-vIncrease the verbosity of     console output.               --show-level-lShow Log level. --version-VDisplay the version of this   application.                  --install-completionInstall completion for the    current shell.                --show-completionShow completion for the       current shell, to copy it or  customize the installation.   --helpShow this message and exit. ╰───────────────────────────────────────────────────────────────╯ ╭─ Commands ────────────────────────────────────────────────────╮ allowlistManage the package allowlists of a Data Safe Haven deployment.                                        users    Manage the users of a Data Safe Haven deployment.  config   Manage Data Safe Haven configuration.              context  Manage Data Safe Haven contexts.                   pulumi   (Advanced) interact directly with the Pulumi CLI.  shm      Manage Data Safe Haven SHM infrastructure.         sre      Manage Data Safe Haven SRE infrastructure.         ╰───────────────────────────────────────────────────────────────╯

The subcommands can be used to manage various aspects of a Data Safe Haven deployment. For further detail on each subcommand, navigate to the relevant page.

Allowlist

Management of the package allowlists for Tier 3 SREs

Config

Management of the configuration files used to define SHMs and SREs

Context

Manage DSH contexts, the groupings that encompass an SHM and its associated SREs

Users

Management of users in Entra ID

Pulumi

An interface to the Pulumi command line interface

shm

Management of infrastructure for DSH Safe Haven Management environments

sre

Management of infrastructure for DSH Secure Research Environments