Edge Command Line Interface (CLI)
The Edge Command Line Interface (CLI) is a tool that allows you to set up and manage aspects of your Edge site.
As of 2024.05, the Edge CLI is included in the Edge site installer.If you need to download or update only the Edge CLI, see the commands in the table below per your Edge site installation method.
Warning If your Edge site installer is older than 2025.04, you must reinstall your Edge site to download the Edge CLI before the 2025.02 release in February, 2025.
- K3S
- Managed Kubernetes
How you can use the Edge CLI commands on k3S
Note This is not an exhaustive list of commands. If you want to see the full list of commands available via the Edge CLI, run the CLI help command.
Action | Definition | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Download a new Edge CLI |
You may need to download an Edge CLI because you do not have it available locally yet or you need a newer version of the Edge CLI.
|
||||||||||||||||||||||||||||||||||||||
Get Edge site diagnostics |
Use this command from this command and provide the results to Collibra Support when troubleshooting issues on your Edge site: Copy
|
||||||||||||||||||||||||||||||||||||||
Create an Edge site backup |
Use this command to create a backup of your Edge site. This is required when you want to reinstall your Edge site. Copy
|
||||||||||||||||||||||||||||||||||||||
Update the Edge user credentials in Collibra Data Intelligence Platform |
Use this command to update the Edge user's username or password in Collibra Data Intelligence Platform: Copy
|
||||||||||||||||||||||||||||||||||||||
Update forward proxy settings |
Use this command to update forward proxy settings for your Edge site: Copy
|
||||||||||||||||||||||||||||||||||||||
Pull list of custom certificates |
Use this command to pull a list of all custom certificates configured on your Edge site. Copy
Additional parameters:
Show me examples…
|
||||||||||||||||||||||||||||||||||||||
Add custom certificates to the Edge site truststore | Use this command to add custom certificated to the Edge truststore after an Edge site has been installed: Copy
Important Your virtual machine must be rebooted after you run this command. Additional parameter:
Show me examples…
|
||||||||||||||||||||||||||||||||||||||
Replace all existing custom certificates in the Edge site truststore |
Use this command to replace all existing custom certificates in the Edge site truststore: Copy
Important
Additional parameter:
Show me examples…
|
||||||||||||||||||||||||||||||||||||||
Setup and use Vaults with your Edge site |
Important This feature is available only in the latest UI. Vault commands are dependent on which vault and authentication method you use. Visit the dedicated pages to learn what the Edge CLI commands are to: |
||||||||||||||||||||||||||||||||||||||
Setup and manage shared files for the Shared Storage connection |
The Shared Storage connection for technical lineage allows you to access data source files from a shared folder. To setup and manage the folder and files used for the Shared Storage connection, use the following commands in the Edge CLI:
|
Access help
If you need help when using the Edge CLI tool, you can run the help command to:
- View a full list of supported Edge CLI commands:Copy
sudo ./edgecli -h
- View the specific parameters and usage of a specific Edge CLI command. For example, running the following command will return help information for the delete shared folder command for the Shared Storage connection:
sudo ./edgecli objects folder-delete -h Deletes shared folder that was uploaded, if it exists Usage: edgecli objects folder-delete [flags] Flags: --target string The folder name specified in edge (DGC) Global Flags: -h, --help
How to use Edge CLI commands on a Managed Kubernetes cluster
Note This is not an exhaustive list of commands. If you want to see the full list of commands available via the Edge CLI, run the CLI help command.
Actions | Definitions | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Install an Edge site |
You can install your Edge site on a managed Kubernetes cluster by following the steps outlined in Install an Edge site, in addition to running one of the following commands: Note
|
||||||||||||||||||||||||||||||||||||||
Uninstall an Edge site |
If you have installed your Edge site using the Edge CLI method, you can uninstall your Edge site by using one of the following commands:
Note
|
||||||||||||||||||||||||||||||||||||||
Download a new Edge CLI |
You may need to download an Edge CLI because you do not have it available locally yet or you need a newer version of the Edge CLI.
Note If your Edge site is installed on a dedicated cluster via the Edge CLI method and it does not have a custom namespace, you can remove |
||||||||||||||||||||||||||||||||||||||
Get Edge site diagnostics |
Use this command from this command and provide the results to Collibra Support when troubleshooting issues on your Edge site: Copy
Note If your Edge site is installed on a dedicated cluster via the Edge CLI method and it does not have a custom namespace, you can remove |
||||||||||||||||||||||||||||||||||||||
Create an Edge site backup |
Use this command to create a backup of your Edge site. This is required when you want to reinstall your Edge site. Copy
|
||||||||||||||||||||||||||||||||||||||
Update the Edge user credentials in Collibra Data Intelligence Platform |
Use this command to update the Edge user's username or password in Collibra Data Intelligence Platform: Copy
Note If your Edge site is installed on a dedicated cluster via the Edge CLI method and it does not have a custom namespace, you can remove |
||||||||||||||||||||||||||||||||||||||
Update forward proxy settings |
Use this command to update forward proxy settings for your Edge site: Copy
|
||||||||||||||||||||||||||||||||||||||
Pull list of custom certificates |
Use this command to pull a list of all custom certificates configured on your Edge site. Copy
Additional parameters:
Show me examples…
|
||||||||||||||||||||||||||||||||||||||
Add custom certificates to the Edge site truststore | Use this command to add custom certificated to the Edge truststore after an Edge site has been installed: Copy
Important Your virtual machine must be rebooted after you run this command. Additional parameter:
Show me examples…
|
||||||||||||||||||||||||||||||||||||||
Replace all existing custom certificates in the Edge site truststore |
Use this command to replace all existing custom certificates in the Edge site truststore: Copy
Important
Additional parameter:
Show me examples…
|
||||||||||||||||||||||||||||||||||||||
Setup and use Vaults with your Edge site |
Important This feature is available only in the latest UI. Vault commands are dependent on which vault and authentication method you use. Visit the dedicated pages to learn what the Edge CLI commands are to: |
||||||||||||||||||||||||||||||||||||||
Setup and manage shared files for the Shared Storage connection |
The Shared Storage connection for technical lineage allows you to access data source files from a shared folder. To setup and manage the folder and files used for the Shared Storage connection, use the following commands in the Edge CLI:
|
Access help
If you need help when using the Edge CLI tool, you can run the help command to:
- View a full list of supported Edge CLI commands:Copy
./edgecli -h
- View the specific parameters and usage of a specific Edge CLI command. For example, running the following command will return help information for the delete shared folder command for the Shared Storage connection:
./edgecli objects folder-delete -h Deletes shared folder that was uploaded, if it exists Usage: edgecli objects folder-delete [flags] Flags: --target string The folder name specified in edge (DGC) Global Flags: -h, --help