view release on metacpan or  search on metacpan

docs/ssh-broker-config.txt  view on Meta::CPAN

       terminal-selection
              This element defines how the Tectia terminal behaves when the user selects text with double-clicks. The element takes one attribute: selection-type, whose value can be:

              select-words - double-clicking selects one word at a time, space and all punctuation characters are used as delimiters.  This is the default.

              select-paths - selects strings of characters between spaces, meaning a selection is extended over characters \/.-_, so that for example a path to a file can be selected by double-clicking anywhere in the path.

       terminal-bell
              This element defines whether Tectia terminal repeats audible notifications from the destination server. This option is only applied to connections with Unix servers. The element takes one attribute, bell-style, whose value can be:

              none - no audible notifications are used

              pc-speaker - the user's PC speakers beep when an audible notification is indicated by the destination server

              system-default - the Tectia terminal sounds the default alerts defined in the system on the destination server. This is the default.

       close-window-on-disconnect
              This  element  defines  that  also  the  Tectia terminal window is to be closed while disconnecting from a server session by pressing CTRL+D. The element takes one attribute, enable, whose value can be yes or no. The default is no meani...
              closes only the server connection but the Tectia terminal window remains open.

       quiet-mode
              This setting defines whether the command line clients should suppress warnings, error messages and authentication success messages.  The quiet-mode element takes attribute enable with value yes or no. The default is no, meaning that  th...
              messages are output and logged.

              The  quiet-mode  element  affects  command line tools scpg3, sshg3, and sftpg3.  Enabling the quiet mode here with setting quiet-mode enable="yes" is the same as running these clients with option -q.  Note that the -q command line param...
              priority over the quiet-mode element set in this configuration file.

       checksum
              The checksum element can be used to define a default setting for comparing checksums. This default overwrites the factory setting that checksums are not checked for files smaller than 32kB.

              The checksum element takes attribute type, whose value can be:

              yes|YES - MD5 checksums are checked on files larger than 32kB.

              no|NO - checksums are not used.

              md5|MD5 - only MD5 checksums are checked on files larger than 32kB. When the --fips parameter is set with the command line clients scpg3 and sftpg3, this hash is not used.

              sha1|SHA1 - only SHA1 checksums are checked on files larger than 32kB. When the --fips parameter is set with the command line clients scpg3 and sftpg3, this hash is used.

              md5-force|MD5-FORCE - MD5 checksums are forced, except when the --fips parameter is set with the command line tools scpg3 and sftpg3.

              sha1-force|SHA1-FORCE - SHA1 checksums are forced on all files.

              checkpoint|CHECKPOINT - checkpointing is forced on large files that are transferred one by one.
              Note

              If the Connection Broker is started in FIPS mode and the md5 attribute is defined in the configuration file, but scpg3 or sftpg3 are not started with the --fips parameter, then md5 is used.

       Note that checksums can also be defined with the command line clients scpg3 and sftpg3, or with environment variables. The order of priority of the three checksum settings (in case they are different) is as follows, the later one always overwr...
       vious value:

              · checksum setting in the configuration file

              · environment value

              · command line arguments.

       address-family
              The address-family element defines the IP address family for this profile. The broker will operate using IPv4 (inet) addressing, IPv6 (inet6), or both (any). The default is any.

THE profiles ELEMENT
       The  profiles  element defines the connection profiles for connecting to the specified servers. Element profiles can contain multiple profile elements. Each profile defines the connection rules to one server. The settings in the profile elemen...
       default connection settings.

       When a profile is used for the connection, the settings in the profile override the default settings.

       profile
              The profile element defines a connection profile. It has the following attributes: id, name, host, port, protocol, host-type, connect-on-startup, user, and gateway-profile.

              The profile id must be a unique identifier that does not change during the lifetime of the profile.

              An additional name can be given to the profile. This is a free-form text string. The name can be used for connecting with the profile on the command line, so define a unique name for each profile.

              The host attribute defines the address of the Secure Shell server host and it is a mandatory setting. The address can be either an IP address or a domain name. The value host="*" can be used to prompt the user to enter the host address ...
              the session.

              The port is a mandatory setting. It defines the port number of the Secure Shell server listener.  The default port is 22.

              The protocol is a mandatory setting. It defines the used communications protocol.  Currently the only allowed value is secsh2.

              If  you  want  to  make the connection specified by the profile automatically when the Connection Broker is started, set the value of the connect-on-startup attribute to yes. In this case, give also the user attribute (the user name the...
              made with). You also need to set up some form of non-interactive authentication for the connection.

              The host-type attribute sets the server type for ASCII file transfer. This specifies the newline convention that is used for ASCII (text) files. The default value is default. Other possible values are windows (for Windows server host) a...
              Unix server host). Define the value if you are using any other server than Tectia Server.

              For FTP-SFTP conversion, set the server type here according to your target FTP server to transfer ASCII text files with correct newline convention.

              The  user  attribute  specifies the user name for opening the connection. The value "%USERNAME%" can be used to apply the user name of the currently logged in user. The value user="*" can be used to prompt the user to enter the user nam...
              in. When the user attribute is not defined, the user name defined in the default connection settings will be used.

              An empty value user="" can be used when the profile is used with FTP-SFTP conversion and the user name is taken from the application (filter-engine/rule[@username-from-app="yes"]).  See the rule element below for details.

              hostkey
                     This element gives the path to the remote server host public key file as a value of the file attribute.

                     Alternatively, the public key can be included as a base64-encoded ASCII block.

              ciphers
                     This element defines the ciphers used with this profile.  See The default-settings Element above for details.

              macs   This element defines the MACs used with this profile.  See The default-settings Element above for details.

              kexs   This element defines the KEXs used with this profile.  See The default-settings Element above for details.

              hostkey-algorithms
                     This element defines the hostkey signature algorithms used with this profile.  See The default-settings Element above for details.

              rekey  This element defines the rekeying settings used with this profile.  See The default-settings Element above for details.

              authentication-methods
                     This element defines the authentication methods used with this profile.  See The default-settings Element above for details.

              user-identities
                     This element specifies the identities used in user public-key authentication. In contrast to the key-stores element that specifies all the keys that are available for the Connection Broker, this element can be used to control the...
                     attempted in authentication when this connection profile is used and to specify the order in which they are attempted.

                     The user-identities element can contain multiple identity elements. When multiple identity elements are used, they are tried out in the order they are listed.