Deleting Auto Deploy Overrides

Last updated

Octo.exe can be used to delete automatic deployment release overrides.

octo delete-autodeployoverride [<options>]

Where [<options>] is any of:

delete-autodeployoverride options

Delete auto deploy release override:                                        

      --project=VALUE        Name of the project                            
      --environment=VALUE    Name of an environment the override will apply
                             to. Specify this argument multiple times to add
                             multiple environments.                         
      --tenant=VALUE         [Optional] Name of a tenant the override will  
                             apply to. Specify this argument multiple times
                             to add multiple tenants or use `*` wildcard for
                             all tenants.                                   
      --tenanttag=VALUE      [Optional] A tenant tag used to match tenants  
                             that the override will apply to. Specify this  
                             argument multiple times to add multiple tenant
                             tags                                           

Common options:                                                             

      --help                 [Optional] Print help for a command            
      --helpOutputFormat=VALUE                                              
                             [Optional] Output format for help, only valid  
                             option is json                                 
      --outputFormat=VALUE   [Optional] Output format, only valid option is
                             json                                           
      --server=VALUE         The base URL for your Octopus Server - e.g.,   
                             http://your-octopus/                           
      --apiKey=VALUE         [Optional] Your API key. Get this from the user
                             profile page. Your must provide an apiKey or   
                             username and password. If the guest account is
                             enabled, a key of API-GUEST can be used.       
      --user=VALUE           [Optional] Username to use when authenticating
                             with the server. Your must provide an apiKey or
                             username and password.                         
      --pass=VALUE           [Optional] Password to use when authenticating
                             with the server.                               
      --configFile=VALUE     [Optional] Text file of default values, with on
                             'key = value' per line.                        
      --debug                [Optional] Enable debug logging                
      --ignoreSslErrors      [Optional] Set this flag if your Octopus Server
                             uses HTTPS but the certificate is not trusted o
                             this machine. Any certificate errors will be   
                             ignored. WARNING: this option may create a     
                             security vulnerability.                        
      --enableServiceMessages                                               
                             [Optional] Enable TeamCity or Team Foundation  
                             Build service messages when logging.           
      --timeout=VALUE        [Optional] Timeout in seconds for network      
                             operations. Default is 600.                    
      --proxy=VALUE          [Optional] The URI of the proxy to use, eg     
                             http://example.com:8080.                       
      --proxyUser=VALUE      [Optional] The username for the proxy.         
      --proxyPass=VALUE      [Optional] The password for the proxy. If both
                             the username and password are omitted and      
                             proxyAddress is specified, the default         
                             credentials are used.                          
      --logLevel=VALUE       [Optional] The log level. Valid options are    
                             verbose, debug, information, warning, error and
                             fatal. Defaults to 'debug'.                    

Basic Example

The following will delete an automatic deployment release override for the project HelloWorld to the environment Development:

Octo delete-autodeployoverride --project HelloWorld --environment Development --server http://octopus/ --apikey API-ABCDEF123456

Tenanted Example (By Name)

The following will delete an automatic deployment release override for the project HelloWorld to the environment Development for the tenant Acme:

Octo delete-autodeployoverride --project HelloWorld --environment Development --tenant Acme --server http://octopus/ --apikey API-ABCDEF123456

Tenanted Example (By Tags)

The following will delete an automatic deployment release override for the project HelloWorld to the environment Development for all tenants with the Hosting/Cloud tag:

Octo delete-autodeployoverride --project HelloWorld --environment Development --tenanttag Hosting/Cloud --server http://octopus/ --apikey API-ABCDEF123456