IBM Aspera faspio

https://www.ibm.com/docs/en/faspio-gateway
Admin
IBM Aspera faspio is a high-performance file transfer and data movement solution designed for secure...
Tokens:12,967
Snippets:111
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Manage faspio Gateway Service on macOS using launchctl

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=gateway-starting-macos

This section details the use of `launchctl` commands to manage the IBM Aspera faspio Gateway service on macOS. These commands allow users to load, start, check the status of, stop, and unload the service. The `launchctl load` command also starts the service. Dependencies include having `launchd` installed on macOS and the faspio Gateway service plist file at the specified location.

```bash
sudo launchctl load /Library/LaunchDaemons/com.ibm.software.aspera.faspio-gateway.plist
```

```bash
sudo launchctl start com.ibm.software.aspera.faspio-gateway
```

```bash
sudo launchctl list | grep com.ibm.software.aspera.faspio-gateway
```

```bash
sudo launchctl stop com.ibm.software.aspera.faspio-gateway
```

```bash
sudo launchctl unload /Library/LaunchDaemons/com.ibm.software.aspera.faspio-gateway.plist
```

--------------------------------

### Basic Bridge Configuration Example

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML configuration defines a basic bridge setup. It specifies the local listening endpoint and the remote endpoint for forwarding. The 'protocol', 'host', and 'port' are essential for establishing connections.

```TOML
protocol = "tcp"
    host = "0.0.0.0"
    port = 12345

   [bridge.forward]
       protocol = "fasp"
           host = "GW2"
           port = 12345

[[bridge]]
   name = "Inbound"
   [bridge.local]
       protocol = "fasp"
           host = "0.0.0.0"
           port = 54321

   [bridge.forward]
       protocol = "tcp"
           host = "Server1"
           port = 54321
```

--------------------------------

### Start faspio Gateway

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=testing-gateway

This command starts the IBM Aspera faspio Gateway. It is a prerequisite for testing the gateway's functionality. No specific input or output is detailed, but it's assumed to initiate a listening service.

```bash
faspio-gateway
```

--------------------------------

### Outbound Bridge Configuration Example

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML configuration illustrates an outbound bridge setup. It defines how the gateway should connect to an external service using TCP locally and FASP for forwarding. This is useful for initiating connections to remote servers.

```TOML
[[bridge]]
   name = "Outbound"
   [bridge.local]
       protocol = "tcp"
           host = "0.0.0.0"
           port = 54321

   [bridge.forward]
       protocol = "fasp"
           host = "GW1"
           port = 54321
```

--------------------------------

### Control IBM Aspera faspio Gateway Service using systemctl (Linux)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=gateway-starting-linux

This snippet demonstrates the fundamental systemctl commands used to manage the IBM Aspera faspio Gateway service on Linux. These commands allow users to start, stop, enable the service for automatic restarts, check its current status, and view its logs using journalctl. Proper execution requires superuser privileges (sudo).

```bash
sudo systemctl start faspio-gateway
```

```bash
sudo systemctl stop faspio-gateway
```

```bash
sudo systemctl enable faspio-gateway
```

```bash
sudo systemctl status faspio-gateway
```

```bash
sudo journalctl --unit=faspio-gateway
```

--------------------------------

### Manage faspio Gateway Service on Windows (Command Line)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=gateway-starting-windows

This snippet shows how to start and stop the faspio Gateway service using the Windows command line. These commands require administrator privileges to execute.

```bash
net start faspio-gateway
```

```bash
net stop faspio-gateway
```

--------------------------------

### Inbound Bridge Configuration Example

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML configuration demonstrates an inbound bridge setup. It configures the gateway to listen for incoming FASP connections and forward them over TCP to a specified server. This is typical for receiving data from external sources.

```TOML
[[bridge]]
   name = "Inbound"
   [bridge.local]
       protocol = "fasp"
           host = "0.0.0.0"
           port = 12345

   [bridge.forward]
       protocol = "tcp"
           host = "Server2"
           port = 12345
```

--------------------------------

### Client to Server Bridge Configuration (TOML)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

Configures two Gateways (GW1 and GW2) to establish a FASP bridge between a TCP/UDP client and server. GW1 listens for local connections and forwards FASP traffic to GW2, which then forwards TCP traffic to the final server. This example shows a basic client-to-server setup.

```toml
[[bridge]]
   [bridge.local]
       protocol = "tcp"
           host = "0.0.0.0"
           port = 12345
http_proxy_enabled = true
tls_enabled = false

   [bridge.forward]
       protocol = "fasp"
           host = "GW2"
           port = 12345
```

```toml
[[bridge]]
   [bridge.local]
       protocol = "fasp"
           host = "0.0.0.0"
           port = 12345

   [bridge.forward]
       protocol = "tcp"
           host = "Server"
           port = 12345
```

--------------------------------

### faspio Gateway: No License Error Message

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=license

Displays the error message when faspio Gateway is started without any license loaded. This indicates that the gateway cannot operate in server mode due to the absence of a valid license.

```text
The current license does not allow for FASP to run in server-mode (i.e. bridge.local.protocal="fasp")
[2022-01-25 12:26:42.899] [  gateway  ] [ error ] license-checking failure - "no license loaded"
```

--------------------------------

### Listen for Connections with Netcat (Server)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=testing-gateway

This command, run on the server machine (GW2), uses netcat to listen on port 12345 for incoming connections. It's part of the echo test setup to receive data from the client.

```bash
nc -v -l 12345
```

--------------------------------

### faspio Gateway: Expired License Error Message

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=license

Shows the error message when faspio Gateway is started with a license that has expired. This prevents the gateway from running in server mode because the license is no longer valid.

```text
The current license does not allow for FASP to run in server-mode (i.e. bridge.local.protocal="fasp")
[2022-01-25 12:26:42.899] [  gateway  ] [ error ] license-checking failure - "license expired"
```

--------------------------------

### Enable Prometheus Monitoring in faspio Gateway Configuration

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML configuration snippet shows how to enable Prometheus monitoring for the faspio Gateway by setting 'prometheus_enabled' to true. It also includes example settings for the admin interface, TLS, and basic authentication, along with the parameters for Prometheus to receive monitoring data.

```toml
[admin]
               host = "127.0.0.1"
               port = "8081"
        tls_enabled = true    # Set this to false to disable TLS
         cert_chain = "tls/gw1_cert_chain.pem"

 prometheus_enabled = true
    prometheus_auth = "basic"

[admin.basic_auth]
           username = "test"
    password_digest = "$sha-512$esJ0jf7Jc4D8jvjjRauf0ExWrHXG6jvzGx4mIe6X3dh4A87bQEuLRJnY4md+l4teeMaubIK85EFUFoqdmak4Ig==$Rhhk3CrSSyemgrBP"
```

--------------------------------

### FASPio Gateway: Many to One Port Forwarding (TOML)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

Configures a FASPio Gateway to forward connections from a range of local ports to a single remote port. This is useful for consolidating multiple incoming connections onto a single destination port. The example uses TOML format.

```toml
[[bridge]]
        name = "Bridge-many2one"
        [bridge.local]
                protocol = "fasp"
                port = "4142-4144"
                host = "0.0.0.0"
                tls_enabled = false

        [bridge.forward]
                protocol = "tcp"
                port = "12346"
                host = "127.0.0.1"
                tls_enabled = false
```

--------------------------------

### Resolve 'Unit faspio-gateway.service not found' Error (Linux)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=gateway-starting-linux

This command is used to resolve the 'Unit faspio-gateway.service not found' error when managing the IBM Aspera faspio Gateway service on Linux. This error typically occurs when systemd has not yet recognized the service unit file. Running 'systemctl daemon-reload' forces systemd to rescan its service configuration, often resolving the issue.

```bash
sudo systemctl daemon-reload
```

--------------------------------

### Unload faspio Gateway Service on macOS

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=appendices-uninstalling-macos

This command unloads the faspio Gateway service from `launchd` on macOS. It requires administrator privileges (`sudo`). This is a prerequisite step before deleting the service configuration file and other installation files.

```bash
sudo launchctl unload /Library/LaunchDaemons/com.ibm.software.aspera.faspio-gateway.plist
```

--------------------------------

### Configure Log Sinks with spdlog_setup

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=file-configuring-log-path-log-levels

This snippet shows how to define log sinks (destinations for log messages) and associate them with loggers in the TOML configuration file for spdlog_setup. It covers configuring console output and file logging, including specifying the log file path. The spdlog_setup library is required.

```TOML
[[sink]]
name = "console_sink"
type = "stdout_sink_mt"  # Use stdout_sink_mt for console output

[[sink]]
name = "file_sink"
type = "basic_file_sink_mt"
filename = "log/my_log_file.log"  # Specify the log file path

[[logger]]
name = "my_logger"
sinks = ["console_sink", "file_sink"]  # Assign sinks to the logger
```

--------------------------------

### Connect to Server with Netcat (Client)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=testing-gateway

This command, run on the client machine (GW1), uses netcat to establish a connection to the server machine (GW2) on port 12345. This initiates the echo test, sending data to the server.

```bash
nc GW2_ip_addr 12345
```

--------------------------------

### Configure Log Levels with spdlog_setup

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=file-configuring-log-path-log-levels

This snippet demonstrates how to set log levels for a specific logger in the TOML configuration file for spdlog_setup. This allows filtering of log messages based on their severity. Ensure the spdlog_setup library is correctly integrated.

```TOML
[[logger]]
name = "my_logger"
level = "debug"  # Set the desired log level (e.g., debug)
```

--------------------------------

### Configure Basic Authentication Credentials for faspio Gateway

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML snippet shows how to set up basic authentication credentials for the faspio Gateway. It includes the username and the generated password digest, which should be placed under the '[admin.basic_auth]' section in the 'gateway.toml' file.

```toml
[admin.basic_auth]
           username = "test"
           password_digest = "$sha-512$BPd2kBmlW+f7pTc/pFPiSwBCOMYqpPqzyWN9VVPyY/JssqdO0J5f6Zie6+MIbv9r8ntTPUv/mWHmbiRUYnwJmg==$EcsNAKGiEWTMbQwI"
```

--------------------------------

### FASPio Gateway: Forwarding to First Available Host (TOML)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

Configures the FASPio Gateway's forward section to attempt connections to an array of specified hostnames or IP addresses. It will connect to the first host in the list that becomes available, providing fault tolerance. This configuration uses TOML.

```toml
[bridge.forward]
       protocol = "fasp"
           host = ["GW2", "10.0.0.2"]
           port = 12345
```

--------------------------------

### Binding Forwarding to Specific Interface

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML configuration demonstrates how to bind a forwarding connection to a specific network interface using the 'bind_address' option. It specifies the local protocol, bind address, and port, along with the remote forward details. This allows for granular control over network traffic routing.

```TOML
[bridge.local]
           protocol = "tcp"
       bind_address = "127.0.0.1"
               port = 12345
        tls_enabled = false
    [bridge.forward]
           protocol = "fasp"
               host = "localhost"
               port = 12345
        tls_enabled = false 
```

--------------------------------

### FASPio Gateway: Port Range to Port Range Forwarding (TOML)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

Configures a FASPio Gateway to forward connections from a range of local ports to a corresponding range of remote ports. Both the local and forward port ranges must be of the same size. The configuration is in TOML format.

```toml
[[bridge]]
        name = "Bridge-port-range"
        [bridge.local]
                protocol = "fasp"
                port = "4142-4144"
                host = "0.0.0.0"
                tls_enabled = false

        [bridge.forward]
                protocol = "tcp"
                port = "12346-12348"
                host = "127.0.0.1"
                tls_enabled = false
```

--------------------------------

### Generate Password Digest for faspio Gateway Authentication

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This command demonstrates how to generate a password digest required for basic authentication with the faspio Gateway. The output of this command should be used in the 'password_digest' field within the 'gateway.toml' configuration file.

```shell
faspio-gateway digest
```

--------------------------------

### Uninstall faspio Gateway (.deb) - Linux

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=appendices-uninstalling-linux

This command uninstalls the IBM Aspera faspio Gateway package from Debian-based Linux distributions using the apt package manager. Ensure you have administrator privileges.

```shell
sudo apt remove ibm-aspera-faspio-gateway
```

--------------------------------

### FASPio Gateway: List of Ports Forwarding (TOML)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

Configures a FASPio Gateway to forward connections from a specified list of local ports to a corresponding list of remote ports. This allows for selective port forwarding. The configuration is in TOML format.

```toml
[[bridge]]
        name = "Bridge-port-list"
        [bridge.local]
                protocol = "fasp"
                port = "4142,4144"
                host = "0.0.0.0"
                tls_enabled = false

        [bridge.forward]
                protocol = "tcp"
                port = "12346,12348"
                host = "127.0.0.1"
                tls_enabled = false
```

--------------------------------

### Uninstall faspio Gateway (.rpm) - Linux

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=appendices-uninstalling-linux

This command uninstalls the IBM Aspera faspio Gateway package from Red Hat-based Linux distributions using the yum package manager. Administrator privileges are required.

```shell
sudo yum uninstall ./ibm-aspera-faspio-gateway
```

--------------------------------

### Enable FIPS in faspio Gateway

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-securing-gateway

This TOML configuration enables FIPS compliance in faspio Gateway by setting `fips_enabled = true`. It also shows how to specify a custom path for the OpenSSL configuration file.

```toml
# /etc/faspio-gateway/gateway.toml
[general]
    fips_enabled    = true
    openssl_config  = "/tmp/openssl.cnf"
```

```toml
# /etc/faspio-gateway/gateway.toml
[general]
    fips_enabled  = true
```

```bash
$ cat /etc/faspio-gateway/gateway.toml
[general]
       ...
       fips_enabled   = true
    openssl_config  = "/tmp/openssl.cnf"
```

```bash
$ grep "^.include" /tmp/openssl.cnf
.include /tmp/fipsmodule.cnf 
```

--------------------------------

### Configure Mutual TLS (mTLS) for Gateway 1 (Client)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-securing-gateway

This configuration sets up Gateway 1 to use TLS for its local TCP bridge and when forwarding fasp traffic to Gateway 2. It specifies the paths to the certificate chain, private key, and verification key required for mTLS authentication. `host_verify_enabled` is set to true to enforce host verification.

```toml
[[bridge]]
   [bridge.local]
      protocol = "tcp"
          host = "127.0.0.1"
          port = "2000-2001"
   tls_enabled = true
    cert_chain = "tls/gw1_cert_chain.pem"
      cert_key = "tls/gw1_cert_key.pem"
        verify = "tls/verify.pem"

    [bridge.forward]
      protocol = "fasp"
          host = "Gateway2"
          port = "3000-3001"
   tls_enabled = true
    cert_chain = "tls/gw1_cert_chain.pem"
      cert_key = "tls/gw1_cert_key.pem"
        verify = "tls/verify.pem"
host_verify_enabled = true
```

--------------------------------

### MQ Inbound Bridge Configuration

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML configuration defines an inbound bridge for MQ traffic. It listens for FASP connections on port 8414 and forwards them over TCP to a specified server. This is useful for integrating with message queuing systems.

```TOML
[[bridge]]
   name = "MQ-In"
   [bridge.local]
      protocol = "fasp"
        host = "0.0.0.0"
        port = 8414

   [bridge.forward]
      protocol = "tcp"
        host = "Server1"
        port = 8414
```

--------------------------------

### Configure Mutual TLS (mTLS) for Gateway 2 (Server)

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-securing-gateway

This configuration sets up Gateway 2 to use TLS for its local fasp bridge and when forwarding TCP traffic. It specifies the paths to its certificate chain, private key, and verification key for mTLS authentication. This configuration is for the server side of the mTLS connection.

```toml
[[bridge]]
   [bridge.local]
      protocol = "fasp"
          host = "127.0.0.1"
          port = "3000-3001"
   tls_enabled = true
    cert_chain = "tls/gw2_cert_chain.pem"
      cert_key = "tls/gw2_cert_key.pem"
        verify = "tls/verify.pem"

    [bridge.forward]
       protocol = "tcp"
           host = "127.0.0.1"
           port = "4000-4001"
   tls_enabled = true
    cert_chain = "tls/gw2_cert_chain.pem"
      cert_key = "tls/gw2_cert_key.pem"
        verify = "tls/verify.pem"
```

--------------------------------

### HTTP Outbound Bridge Configuration

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML snippet configures an outbound bridge specifically for HTTP traffic. It listens on a TCP port designated for HTTP and forwards requests using the FASP protocol to a gateway. This is useful for integrating with HTTP services.

```TOML
[[bridge]]
   name = "Http-Out"
   [bridge.local]
      protocol = "tcp"
        host = "0.0.0.0"
        port = "http"

   [bridge.forward]
      protocol = "fasp"
        host = "GW2"
        port = "http"
```

--------------------------------

### SMTP Outbound Bridge Configuration

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-configuring-gateway

This TOML configuration sets up an outbound bridge for SMTP traffic. It uses TCP on port 25 for local connections and forwards the traffic via FASP to a specified gateway. This is essential for email relay services.

```TOML
[[bridge]]
   name = "Smtp-Out"
   [bridge.local]
      protocol = "tcp"
        host = "0.0.0.0"
        port = 25

   [bridge.forward]
      protocol = "fasp"
        host = "GW3"
        port = 25
```

--------------------------------

### Disable TLS in faspio Gateway Configuration

Source: https://www.ibm.com/docs/en/faspio-gateway/1.3_topic=configuration-securing-gateway

This configuration snippet shows how to disable TLS for specific bridge connections in faspio Gateway by setting `tls_enabled = false`. It is useful for securing connections within a private network.

```toml
[[bridge]]
   [bridge.local]
      protocol = "tcp"
         host = "127.0.0.1"
         port = "2000-2001"
      tls_enabled = false

      [bridge.forward]
        protocol = "fasp"
            host = "Gateway2"
            port = "3000-3001"
     tls_enabled = true
      cert_chain = "tls/gw1_cert_chain.pem"
        cert_key = "tls/gw1_cert_key.pem"
          verify = "tls/verify.pem"
host_verify_enabled = true
```

```toml
[[bridge]]
   [bridge.local]
      protocol = "fasp"
         host = "127.0.0.1"
         port = "3000-3001"
      tls_enabled = true
         cert_chain = "tls/gw2_cert_chain.pem"
           cert_key = "tls/gw2_cert_key.pem"
           verify = "tls/verify.pem"

         [bridge.forward]
            protocol = "tcp"
                host = "127.0.0.1"
                port = "4000-4001"
         tls_enabled = false
```
Tokens:
Raw