neo-java-web:close-ssh-tunnel

Full name:

com.sap.cloud:neo-java-web-maven-plugin:1.151.13:close-ssh-tunnel

Description:

Closes the ssh-tunnel to the specified virtual machine. If no virtual machine ID is specified, closes all tunnels. Maps to console client command virtual machines:close-ssh-tunnel.

Attributes:

Required Parameters

Name Type Since Description
sdkInstallPath File - Folder that contains the unpacked SDK.
User property is: sdkInstallPath.

Optional Parameters

Name Type Since Description
port String - The port on which you want to close the SSH tunnel - optional parameter. Maps to console client command argument --port.
vmId String - The ID of the virtual machine to which you want to close the SSH tunnel. Maps to console client command argument --vm-id.
consoleArguments String - Console client arguments that should be appended to the command.
User property is: consoleArguments.
consoleHttpNonProxyHosts String - Hosts that the console client should access directly, that is, not through the HTTP proxy.
User property is: consoleHttpNonProxyHosts.
consoleHttpProxyHost String - HTTP proxy host that the console client should use for calls to the cloud.
User property is: consoleHttpProxyHost.
consoleHttpProxyPassword String - Password that the console client should use to access the HTTP proxy.
User property is: consoleHttpProxyPassword.
consoleHttpProxyPort String - HTTP proxy port that the console client should use for calls to the cloud.
User property is: consoleHttpProxyPort.
consoleHttpProxyUser String - User that the console client should use to access the HTTP proxy.
User property is: consoleHttpProxyUser.
consoleHttpsProxyHost String - HTTPS proxy host that the console client should use for calls to the cloud.
User property is: consoleHttpsProxyHost.
consoleHttpsProxyPassword String - Password that the console client should use to access the HTTPS proxy.
User property is: consoleHttpsProxyPassword.
consoleHttpsProxyPort String - HTTPS proxy port that the console client should use for calls to the cloud.
User property is: consoleHttpsProxyPort.
consoleHttpsProxyUser String - User that the console client should use to access the HTTPS proxy.
User property is: consoleHttpsProxyUser.
consoleOutputPropertyDump boolean - Show detailed information of modified properties in the build log when using the consoleOutputPropertyPrefix parameter (default is true). When set to false the modifications are only logged with debug level.
Default value is: true.
User property is: consoleOutputPropertyDump.
consoleOutputPropertyPrefix String - If provided, the command will be invoked in such a way that it generates structured output (if supported by the command). This output (may be nested to hold complex data structures) will then be parsed and injected into properties that will be prepended by this prefix for further processing by this or other plugins.
User property is: consoleOutputPropertyPrefix.
consoleRetryCount int - Should the command fail, retry it the given number of times (default is 0 which will not retry at all; value must be positive). As operations may fail due to intermittent connection issues or for other reasons it is in certain cases helpful to retry a command to avoid unnecessary abortions.
Default value is: 0.
User property is: consoleRetryCount.
failOnError boolean - Fail the execution if the command fails (default is true).
Default value is: true.
User property is: failOnError.
relaxOnSdkVersion boolean - Do not abort execution if the plugin version and the SDK version do not match. If they do not match and this option is set to true, the plugin may not work properly (default is false).
Default value is: false.
User property is: relaxOnSdkVersion.
skip boolean - Skip the execution (default is false).
Default value is: false.
User property is: skip.

Parameter Details

port:

The port on which you want to close the SSH tunnel - optional parameter. Maps to console client command argument --port.
  • Type: java.lang.String
  • Required: No

vmId:

The ID of the virtual machine to which you want to close the SSH tunnel. Maps to console client command argument --vm-id.
  • Type: java.lang.String
  • Required: No

consoleArguments:

Console client arguments that should be appended to the command.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleArguments

consoleHttpNonProxyHosts:

Hosts that the console client should access directly, that is, not through the HTTP proxy.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpNonProxyHosts

consoleHttpProxyHost:

HTTP proxy host that the console client should use for calls to the cloud.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpProxyHost

consoleHttpProxyPassword:

Password that the console client should use to access the HTTP proxy.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpProxyPassword

consoleHttpProxyPort:

HTTP proxy port that the console client should use for calls to the cloud.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpProxyPort

consoleHttpProxyUser:

User that the console client should use to access the HTTP proxy.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpProxyUser

consoleHttpsProxyHost:

HTTPS proxy host that the console client should use for calls to the cloud.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpsProxyHost

consoleHttpsProxyPassword:

Password that the console client should use to access the HTTPS proxy.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpsProxyPassword

consoleHttpsProxyPort:

HTTPS proxy port that the console client should use for calls to the cloud.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpsProxyPort

consoleHttpsProxyUser:

User that the console client should use to access the HTTPS proxy.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleHttpsProxyUser

consoleOutputPropertyDump:

Show detailed information of modified properties in the build log when using the consoleOutputPropertyPrefix parameter (default is true). When set to false the modifications are only logged with debug level.
  • Type: boolean
  • Required: No
  • User Property: consoleOutputPropertyDump
  • Default: true

consoleOutputPropertyPrefix:

If provided, the command will be invoked in such a way that it generates structured output (if supported by the command). This output (may be nested to hold complex data structures) will then be parsed and injected into properties that will be prepended by this prefix for further processing by this or other plugins.
  • Type: java.lang.String
  • Required: No
  • User Property: consoleOutputPropertyPrefix

consoleRetryCount:

Should the command fail, retry it the given number of times (default is 0 which will not retry at all; value must be positive). As operations may fail due to intermittent connection issues or for other reasons it is in certain cases helpful to retry a command to avoid unnecessary abortions.
  • Type: int
  • Required: No
  • User Property: consoleRetryCount
  • Default: 0

failOnError:

Fail the execution if the command fails (default is true).
  • Type: boolean
  • Required: No
  • User Property: failOnError
  • Default: true

relaxOnSdkVersion:

Do not abort execution if the plugin version and the SDK version do not match. If they do not match and this option is set to true, the plugin may not work properly (default is false).
  • Type: boolean
  • Required: No
  • User Property: relaxOnSdkVersion
  • Default: false

sdkInstallPath:

Folder that contains the unpacked SDK.
  • Type: java.io.File
  • Required: Yes
  • User Property: sdkInstallPath

skip:

Skip the execution (default is false).
  • Type: boolean
  • Required: No
  • User Property: skip
  • Default: false