deleteEnvironment

Delete an environment

Format

udclient [global-args...] [global-flags...]
  deleteEnvironment [parameters]

Parameters

Table 1. Parameters
Parameter Type Required Description
environment string true Name or ID of the environment
application string false Name or ID of the application; this value is required if you specify the environment name instead of ID
deleteAttachedResources boolean false Specify true to delete all resources in this environment, including all subresources. If this value and 'deleteCloudInstances' is set to true, then all agent objects in use by this environment will be deleted when the agent goes offline. (Optional)
deleteCloudInstances boolean false Specify true to delete any associated instances in the cloud provider; this parameter is valid only for environments that were created dynamically along with the environment (Optional)

Example

udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  deleteEnvironment 
  -application JPetStore 
  -environment NewEnvironment

Related REST command: Delete an environment.