Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

Field Name

Required

Description

Endpoint Name

Yes

The name of the Endpoint.

Description

No

An optional description for the Endpoint.

Active

Yes

Whether or not the endpoint is active in the system. Defaults to "Yes".

Connection Type

Yes

The connection type used for connection to the Endpoint. Currently SSH and localhost are supported.

OS Type

Yes

The operating system of the Endpoint. Unix and Windows are the supported types.

For Microsoft Windows, must have Cygwin installed, along with the openssh package. See the Cygwin Installation Guide for more information.

Endpoint Address

Yes

The DNS name or IP address of the Endpoint.

Port

Yes

The SSH port of the Endpoint (typically port 22).

User Name

Yes

The user account on the Endpoint to connect with. All executions via this endpoint will run as this user.

Password

No

The password for the User Name. Either password or Private Key File is required.

Private Key File

No

Fully-qualified path of the SSH private key file. Either Private Key File or Password is required. ~ is not supported here.

Passphrase

No

An optional passphrase used when the private key was generated. Only valid if a Private Key File is specified.

Base Directory

Yes

A working directory on the Endpoint used by FlexDeploy. ~ is not supported here.

For example, /app/flexdeploy.

If you have two FlexDeploy installations that may connect to same Endpoint, you must use unique folders for both FlexDeploy Servers. In most cases, separate FlexDeploy is installed to perform testing of FlexDeploy patches, which may connect to same Endpoint, in which case you can use different folder like /app/flexdeploytest and /app/flexdeploy.

Group

No

An optional group identifier which can be useful when searching for Endpoints.

Subgroup

No

An optional subgroup identifier which can be useful when searching for Endpoints.

JDK Home

Yes

The JDK Home directory on the Endpoint. For example, /usr/java. FlexDeploy will look for /bin/java under specified JDK Home folder.

...

To inactivate an endpoint click the Active link on the desired Endpoint, and it will toggle to Inactive. This will hide that Endpoint after leaving the screen, until the Active checkbox is unchecked. To reactivate an Enpoint, click the Inactive link and it will toggle back to Active. This endpoint is now active in the system again and ready for use.

...

Here is the sample output (with interactive prompts) using rsa encryption.

Code Block
themeRDark
Generating public/private rsa key pair.

...


Enter file in which to save the key (/home/oracle/.ssh/id_rsa):

...


Enter passphrase (empty for no passphrase):

...


Enter same passphrase again:

...


Your identification has been saved

...

 in /home/oracle/.ssh/id_rsa.

...


Your public key has been saved

...

 in /home/oracle/.ssh/id_rsa.pub.

...


The key fingerprint is:

...


e4:dd:6d:88:e0:64:9c:3e:9d:f7:7d:6f:2e:56:dd:6b oracle@devlnx12

...


The key's randomart image is:

...



+--[ RSA 2048]----+

...

|                 |

|       . .       |

|        B        |

|       B + + o   |

|        S = + o o|

|         . . o .+|

|              ..+|

|              oE+|

|             ..+o|



|                 |

|       . .       |

|        B        |

|       B + + o   |

|        S = + o o|

|         . . o .+|

|              ..+|

|              oE+|

|             ..+o|

+-----------------+

It is typical to use the default file name and location to store the private key (which is in the .ssh subfolder of the user's home directory). You can optionally secure the private key file with a passphrase. It is an SSH requirement that the private key be readable only by its owner (e.g. oracle in the example above). So you must change the permissions accordingly (e.g. chmod 600 /home/oracle/.ssh/id_rsa). You will receive an error at connection time similar to the following if you omit this step.

Permissions 0777 for '/home/oracle/.ssh/id_rsa' are too open.

It is recommended that your private key files are NOT accessible by others otherwise private key will be ignored.

Tip

The /home/oracle/.ssh folder on the endpoint must have drw------- permissions. For example,

  • chmod -R 700 $HOME/.ssh
  • chmod 700 $HOME

...