Command Central 10.7 | Using the Command Line Interface | Landscape Commands | sagcc update landscape environments
 
sagcc update landscape environments
Updates the display name and/or description assigned to an existing environment.
Syntax
*Command Central syntax:
*To specify the updated data for the environment on the command line:
sagcc update landscape environments  env_alias  [name=name]        
[description=description]  [options]
*To specify the updated data for the environment in an input data file:
sagcc update landscape environments  env_alias    
{--input | -i} filename{.xml|.json}  [options]
     
 options:        
[{--debug | -d}]        
[{--error | -r} file]        
[{--log | -l} file]        
[{--media-type | -m} content-type]        
[{--password | -p} password]        
[{--quiet | -q}]        
[{--server | -s} url]        
[{--username | -u} user_name]
*Not applicable to Platform Manager.
Arguments and Options
Argument or Option
Description
env_alias
Required. Specifies the alias name of the environment whose description you want to update.
[name=name]
Optional. Specifies the updated display name for the environment.
If you use a value that includes spaces, place quotes around the value, for example:
name="Dev Environment"
[description=description]
Optional. Specifies the updated description for the environment.
If you use a value that includes spaces, place quotes around the value, for example:
description="A description with spaces"

[{--input | -i}
filename{.xml|.json}]
Optional. Identifies an input file that contains the updated data for the environment. For more information, see input.
Tip:
To determine how to specify the data in the input file, use sagcc get landscape environments to retrieve data for the environment you want to update. For example, if you want to use an XML input file, use sagcc get landscape environments with the --format xml option to retrieve the data in XML format.
[options]
Optional. Refer to the command syntax for a list of the options the command supports. For a description of the options, see Common Options.
Usage Notes
*You must specify at least one of the name or description arguments to indicate the item that you want to update for the environment.
Example When Executing on Command Central
To update the description of an environment with the alias name “dev1” to use the description, “Development version”, use the following command:
sagcc update landscape environments dev1 description="Development version"       
--password secret
Because the {--server | -s} and {--username | -u} options are not specified, the command uses the default server and user name. For more information, see server and username. The command specifies “secret” for the user’s password.