Function brane_cli::instance::edit

source · 
pub fn edit(
    name: Option<String>,
    hostname: Option<Hostname>,
    api_port: Option<u16>,
    drv_port: Option<u16>,
    user: Option<String>,
) -> Result<(), Error>
Expand description

Edits an existing instance to change its properties.

§Arguments

  • name: The name of the instance to edit. If omitted, should use the active instance instead.
  • hostname: Whether to change the hostname of the instance and, if so, what to change it to.
  • api_port: Whether to change the API service port of the instance and, if so, what to change it to.
  • drv_port: Whether to change the driver service port of the instance and, if so, what to change it to.
  • user: Whether to change the user name which the user presents as receiver of the final result.

§Errors

This function errors if we failed to find the instance or failed to update its file.