Parallel Works
View as Markdown
Share:

pw environments update

pw environments update

Update an environment

Synopsis

The pw environments update command updates an environment's configuration. Only the settings you pass are changed.

Setting --status inactive keeps the environment but stops sessions from being scheduled onto it.

Use --default to set the value a scheduling parameter takes when a session does not specify one. Run pw environments get to see which parameters an environment accepts.

pw environments update <environment> [flags]

Examples

  pw environments update --cluster my-hpc --display-name "GPU (large)" gpu-large
  
  # Stop new sessions being scheduled onto an environment
  pw environments update --cluster my-hpc --status inactive gpu-large
  
  # Raise the wall time limit
  pw environments update --cluster my-hpc --max-time 48:00:00 gpu-large
  
  # Default sessions on this environment to 2 nodes
  pw environments update --cluster my-hpc --default numNodes=2 gpu-large

Options

      --cluster string        Cluster the environment belongs to (required)
      --default stringArray   Default value for a scheduling parameter as key=value (repeatable)
      --default-time string   Default wall time, for example 01:00:00
      --description string    Description of the environment
      --display-name string   Human-readable name shown in the UI
  -h, --help                  help for update
      --max-time string       Maximum wall time, for example 24:00:00
      --status string         Environment status: active or inactive

Options inherited from parent commands

      --context string         The context to use. Overrides PW_CONTEXT environment variable and current context from config.
      --platform-host string   The Parallel Works ACTIVATE platform host to use. Will override any other platform host settings.
  -v, --verbose                Enable verbose logging

SEE ALSO