IBM Aspera Cargo

https://www.ibm.com/docs/en/aspera-cargo
Admin
IBM Aspera Cargo is an enterprise data transfer solution that provides high-speed file and object...
Tokens:43,615
Snippets:203
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Start Cargo Daemon

Source: https://www.ibm.com/docs/en/aspera-cargo/3_topic=uc-starting-stopping-cargo-1

Initiates the Cargo daemon process. This command requires administrative privileges and assumes Cargo is installed in the default '/Library/Aspera/Cargo/sbin/' directory. Ensure all configuration settings are complete before execution.

```bash
sudo /Library/Aspera/Cargo/sbin/cargo
```

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

### Install IBM Aspera Cargo using apt-get

Source: https://www.ibm.com/docs/en/aspera-cargo/4.2_topic=cargo-installing

This command installs the IBM Aspera Cargo package using the apt-get package manager on Debian-based Linux distributions. Verify the package name and version are appropriate for your system.

```bash
$ apt-get install ibm-aspera-cargo-version-linux-bits.deb
```

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

### Install Cargo using DEB Package Manager

Source: https://www.ibm.com/docs/en/aspera-cargo/4_topic=cargo-installing

This command installs the IBM Aspera Cargo daemon on Debian-based Linux systems using the DEB package manager. Verify that you are using the correct file name, including the version and bit architecture. This command should be run from the directory containing the downloaded package.

```bash
$ dpkg -i ibm-aspera-cargo-version-linux-bits.deb
```

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

### Install Cargo using RPM Package Manager

Source: https://www.ibm.com/docs/en/aspera-cargo/4_topic=cargo-installing

This command installs the IBM Aspera Cargo daemon on Linux systems using the RPM package manager. Ensure you have the correct version and bit architecture for your system. This command assumes the package is downloaded to the current directory.

```bash
$ rpm -i ibm-aspera-cargo-version-linux-bits.rpm
```

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

### Import Cargo Configuration File

Source: https://www.ibm.com/docs/en/aspera-cargo/4.2_topic=gsc-configuring-cargo-faspex-5

Command to import a Cargo configuration file after editing. Requires administrator privileges and specifies the path to the Cargo binary and the configuration file. The configuration file must be valid JSON.

```shell
C:\> cd \Program Files\IBM\Aspera Cargo\bin\
C:\> cargo -f path-to-config-file
```

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

### Sample IBM Aspera Cargo Faspex Configuration (JSON)

Source: https://www.ibm.com/docs/en/aspera-cargo/3_topic=cargo-configuring-faspex

This is a sample JSON configuration file for IBM Aspera Cargo when used with Faspex. It includes account details like host, authentication, and package settings. Note the escaping for backslashes in paths if used.

```json
{
    "conf": {
        "accounts": [
            {
                "authentication_type": "BASIC",
                "host": "https://sample.com",
                "name": "Sample Faspex",
                "user": "username",
                "password_cleartext": "password",
                "packages": {
                    "auto_start": true,
                    "check_interval_seconds": 900,
                    "download_dir": "/path/to/automatically/download/packages/to/",
                    "name": "Sample Faspex Inbox",
                    "passphrase_cleartext": "",
                    "passphrase_enabled": false,
                    "separate_package_folders": true,
                    "skip_owner_packages": false,
                    "version": 2,
                }
            }
        ],
        "version": 1,
    }
}
```

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

### Install IBM Aspera Cargo using yum

Source: https://www.ibm.com/docs/en/aspera-cargo/4.2_topic=cargo-installing

This command installs the IBM Aspera Cargo package using the yum package manager on RPM-based Linux distributions. Ensure you have the correct package name and version for your operating system.

```bash
$ yum install ibm-aspera-cargo-version-linux-bits.rpm
```

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

### Import Configuration File using Cargo CLI

Source: https://www.ibm.com/docs/en/aspera-cargo/3_topic=cargo-configuring-faspex

This command imports a specified configuration file into IBM Aspera Cargo. Ensure the path to the configuration file is correct. This is a Linux/Unix command.

```bash
$ sudo /opt/aspera/cargo/sbin/cargo -f  path-to-config-file
```

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

### Display Cargo Help Options (Windows)

Source: https://www.ibm.com/docs/en/aspera-cargo/4_topic=uc-cargo-options

This snippet shows the commands to navigate to the IBM Aspera Cargo bin directory and then execute the help command to display all available command-line options. This is specific to Windows environments.

```batch
C:\> cd C:\Program Files\IBM\Aspera Cargo\bin
C:\> cargo -h
```

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

### Display Cargo Help File (Windows)

Source: https://www.ibm.com/docs/en/aspera-cargo/3_topic=uc-cargo-options

This snippet demonstrates how to navigate to the Aspera Cargo bin directory and execute the command to display the help file, which lists all available command-line options. This is typically run on a Windows system.

```windows-cmd
C:\> cd C:\Program Files (x86)\Aspera\Aspera Cargo\bin
C:\> cargo -h
```

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

### Sample IBM Aspera Cargo Configuration File (JSON)

Source: https://www.ibm.com/docs/en/aspera-cargo/3_topic=cargo-configuring-aspera-cloud

This is a sample JSON configuration file for IBM Aspera Cargo, demonstrating how to set up accounts for Aspera on Cloud. It includes authentication details, host information, user credentials, and package handling settings. Note the structure and required fields for a valid configuration.

```json
{
    "conf": {
        "accounts": [
            {
                "authentication_type": "JWT",
                "client_id": "",
                "client_secret" : "",
                "host": "https://sample.ibmaspera.com",
                "name": "Sample AoC",
                "private_key": "/absolute/path/to/private_key",
                "user": "sample@domain.com",
                "packages": {
                    "auto_start": true,
                    "check_interval_seconds": 900,
                    "download_dir": "/path/to/automatically/download/packages/to/",
                    "name": "Sample AoC Inbox",
                    "passphrase_cleartext": "",
                    "passphrase_enabled": false,
                    "separate_package_folders": true,
                    "skip_owner_packages": false,
                    "version": 2,
                }
            }
        ],
        "version": 1,
    }
}
```

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

### Sample Cargo Configuration File for Aspera on Cloud (JSON)

Source: https://www.ibm.com/docs/en/aspera-cargo/4.2_topic=cargo-configuring-aspera-cloud

A sample JSON configuration file for IBM Aspera Cargo when connecting to Aspera on Cloud. It includes settings for authentication, server details, and package download preferences.

```json
{
    "conf": {
        "accounts": [
            {
                "authentication_type": "JWT",
                "client_id": "",
                "client_secret" : "",
                "sso_host_type": 2,
                "host": "https://sample.ibmaspera.com",
                "name": "Sample Aoc",
                "private_key": "/absolute/path/to/private_key",
                "user": "sample@domain.com",
                "packages": {
                    "check_interval_seconds": 900,
                    "download_dir": "/path/to/automatically/download/packages/to/",
                    "name": "Sample AoC Inbox",
                    "passphrase_cleartext": "",
                    "passphrase_enabled": false,
                    "separate_package_folders": true,
                    "skip_owner_packages": false,
                    "version": 2
                }
            }
        ],
        "version": 1
    }
}
```

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

### Sample IBM Aspera Cargo Faspex Configuration File

Source: https://www.ibm.com/docs/en/aspera-cargo/4_topic=gsc-configuring-cargo-faspex

This JSON object represents a sample configuration file for IBM Aspera Cargo when connecting to a Faspex server. It includes account details, authentication type, host, user credentials, and package download settings. Ensure to replace placeholder values with your actual server and user information.

```json
{
    "conf": {
        "accounts": [
            {
                "authentication_type": "BASIC",
                "host": "https://sample.com",
                "name": "Sample Faspex",
                "user": "username",
                "password_cleartext": "password",
                "packages": {
                    "auto_start": true,
                    "check_interval_seconds": 900,
                    "download_dir": "/path/to/automatically/download/packages/to/",
                    "name": "Sample Faspex Inbox",
                    "passphrase_cleartext": "",
                    "passphrase_enabled": false,
                    "separate_package_folders": true,
                    "skip_owner_packages": false,
                    "version": 2
                }
            }
        ],
        "version": 1
    }
}
```

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

### Uninstall Cargo Script

Source: https://www.ibm.com/docs/en/aspera-cargo/4.2_topic=gsc-uninstalling-cargo-1

This snippet shows the command to execute for uninstalling Cargo. It requires administrative privileges (sudo) and specifies the path to the uninstall script located within the Aspera Cargo installation directory. The script is a shell script designed to remove Cargo files and configurations.

```shell
sudo "/Library/Application Support/Aspera/Cargo/uninstall_cargo.sh"
```

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

### Sample IBM Aspera Cargo JWT Configuration (JSON)

Source: https://www.ibm.com/docs/en/aspera-cargo/3_topic=gsc-configuring-cargo-aspera-cloud

This JSON configuration file demonstrates the structure for setting up JWT authentication for an IBM Aspera Cargo account. It includes parameters for authentication type, client credentials, host, user details, and package management settings such as auto-start, download directory, and interval checks. Ensure sensitive information like client IDs and secrets are handled securely.

```json
{
    "conf": {
        "accounts": [
            {
                "authentication_type": "JWT",
                "client_id": "",
                "client_secret" : "",
                "host": "https://sample.ibmaspera.com",
                "name": "Sample AoC",
                "private_key": "/absolute/path/to/private_key",
                "user": "sample@domain.com",
                "packages": {
                    "auto_start": true,
                    "check_interval_seconds": 900,
                    "download_dir": "/path/to/automatically/download/packages/to/",
                    "name": "Sample AoC Inbox",
                    "passphrase_cleartext": "",
                    "passphrase_enabled": false,
                    "separate_package_folders": true,
                    "skip_owner_packages": false,
                    "version": 2,
                }
            }
        ],
        "version": 1,
    }
}

```

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

### Stop Cargo Daemon

Source: https://www.ibm.com/docs/en/aspera-cargo/3_topic=uc-starting-stopping-cargo-1

Terminates the Cargo daemon process. This involves two steps: first, finding the process ID (PID) of the running Cargo daemon using 'ps aux | grep cargo', and second, using the 'kill' command with the obtained PID to forcefully stop the process. Administrative privileges are required.

```bash
ps aux | grep cargo
```

```bash
sudo kill -9 process-ID-number
```

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

### Import Configuration File with Cargo CLI

Source: https://www.ibm.com/docs/en/aspera-cargo/4_topic=cargo-configuring-aspera-cloud

This command imports a Cargo configuration file. It requires root privileges and the path to the configuration file as an argument. Ensure the configuration file is valid JSON.

```bash
sudo /opt/aspera/cargo/sbin/cargo -f  path-to-config-file
```
Tokens:
Raw