octopus project variables update

Update the value of a project variable in Octopus Deploy

Usage:
  octopus project variables update [flags]

Flags:
      --channel-scope strings       Assign channel scopes to the variable. Multiple scopes can be supplied.
      --environment-scope strings   Assign environment scopes to the variable. Multiple scopes can be supplied.
      --git-ref string              The GitRef for the Config-As-Code branch
      --id string                   The variable id to update
  -n, --name string                 The name of the variable
      --process-scope strings       Assign process scopes to the variable. Valid scopes are 'deployment' or a runbook name. Multiple scopes can be supplied.
  -p, --project string              The project
      --role-scope strings          Assign role scopes to the variable. Multiple scopes can be supplied.
      --step-scope strings          Assign process step scopes to the variable. Multiple scopes can be supplied.
      --tag-scope strings           Assign tag scopes to the variable. Multiple scopes can be supplied.
      --target-scope strings        Assign deployment target scopes to the variable. Multiple scopes can be supplied.
      --unscoped                    Remove all shared from the variable, cannot be used with shared
      --value string                The value to set on the variable


Global Flags:
  -h, --help                   Show help for a command
      --no-prompt              Disable prompting in interactive mode
  -f, --output-format string   Specify the output format for a command ("json", "table", or "basic") (default "table")
  -s, --space string           Specify the space for operations

Examples

Octopus Samples instance

Many of the examples we use, reference the samples instance of Octopus Deploy. If you’d like to explore the samples instance, you can log in as a guest.

$ octopus project variable update
$ octopus project variable update --name "variable name" --value "abc"
$ octopus project variable update --name "variable name" --value "password"
$ octopus project variable update --name "variable name" --unscoped
$ octopus project variable update --name "variable name" --environment-scope test
$ octopus project variable update -p "Deploy Website" --name "variable name" --value "updated" --git-ref refs/heads/main

Learn more

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Thursday, February 1, 2024

Edit on GitHub