Keywords: CommBox Edge Cloud Portal, Share Backup Configuration, Configuration Management, CM, Default Configuration
-
Overview
The Sharing Backup Configuration feature allows an organization to share a saved device configuration backup with one or more other organizations.
The receiving organizations can then:
-
Use the shared configuration during device registration
-
Upload the configuration to existing deployed devices
-
Set the configuration as a default configuration for a specific device type.
Once a configuration is shared, it cannot be deleted or revoked from the receiver’s environment.
-
Workflow – Sender Organization
-
Log in to CommBox Edge Cloud Portal.
-
Open the device’s Configurations dialog - select Inventory; on the Deployed tab, click the gear icon in the Operations column of the device whose configuration you want to share.
-
Save the configuration - select SYSTEM, click Save Configuration, enter a File Name and click Save.
-
Locate the saved backup - open the CM tab. The configuration is listed in the Backup Configuration table.
-
Open the Share dialog - click the share icon in the Actions column of the configuration.
-
Select organizations - in Shared Config Organizations, select one or more organizations to share with.
-
Set the shared name - in Config Name, enter the name the receivers will see in their CM tab (defaults to the current name).
-
Share - click Share (or Cancel to close without sharing).
The configuration is now shared with the selected organizations.
Important Notes (Sender Side)
-
Once a configuration is shared, it cannot be deleted or revoked.
-
The organization that has already received the configuration will be disabled in the dropdown list for that configuration.
-
The same configuration can still be shared with other organizations.
-
Workflow – Receiver Organization
Step 1: Login
-
Login to the platform.
Step 2: Locate the Shared Configuration
-
Go to Inventory → CM Tab.
-
Locate the configuration in the Backup Configuration Table.
How to Identify a Shared Configuration
A shared configuration can be identified by the following indicators:
-
Organization and Site Name fields will be empty
-
The configuration can also be re-shared to sub-organizations (sub-OUs) if permitted.
-
The row contains a Pencil (Edit) icon, allowing the receiver to rename the configuration.
The pencil icon allows the receiver to rename the configuration.
Re-Sharing Shared Configurations
A receiving Organization can re-share a received configuration with its sub organizations .
Rules
-
If the parent OU has not shared the configuration with a particular sub-OU:
-
The receiving OU can share the configuration with that sub-OU.
-
-
If the parent OU has already shared the configuration with that sub-OU:
-
That sub-OU will appear greyed out (disabled) in the sharing dropdown when the receiving OU attempts to share it.
-
This behavior prevents duplicate sharing of the same configuration to the same organization.
-
Using Shared Configuration During Device Registration
Step 1: Go to Warehouse
-
Navigate to Warehouse.
-
Select a device with the same product type as the shared configuration.
Step 2: Register Device
-
Click Register.
Step 3: Select Configuration
-
In the Configuration dropdown, select Other.
-
The Shared Configuration will appear in the list.
-
Select the required configuration.
The device will now be registered using the shared configuration.
-
Applying Shared Configuration to Existing Devices
For devices that are already deployed:
-
Go to Inventory.
-
Select the device.
-
Click the gear icon in the Operations column.
-
Go to System.
-
Select Upload Configuration.
-
In the Action dialog, select the shared configuration in Upload Device Configuration.
-
Click Upload.
The deployed device will now use the selected shared configuration.
-
Setting Shared Configuration as Default
To automatically apply the shared configuration when devices are registered:
Step 1: Go to Default Configuration
-
Navigate to the Default Configuration Table.
Step 2: Create Default Configuration
-
Click Create Default Config.
Create Default Config is not shown for every account. If you do not see it in the Default Configuration table, contact your administrator or KVH Support.
Step 3: Configure Default Settings
Enter the following details:
-
Default Configuration Name
-
Active Status (Enable/Disable)
-
Select the Shared Configuration Name from the dropdown.
Step 4: Save
-
Click Create.
Now whenever a device of the corresponding product type is registered, this configuration will be automatically applied.
-
Deletion Behavior
Receiver Side Deletion
If the receiver deletes the shared configuration:
Default Configuration Impact
-
If the configuration is used in Default Configuration, that row will be removed automatically.
Device Impact
-
No changes occur at the device level.
-
Devices already using the configuration will continue using it.
Deleting the configuration only prevents future usage.
Sender Side Deletion
If the sender deletes the configuration from their side:
-
The receiver organization will not be affected.
-
The configuration will remain available and usable for the receiver.
Receivers end it will be still present
-
Key Rules & Behavior Summary
|
Behavior |
Description |
|
Multi-Org Sharing |
A configuration can be shared with multiple organizations |
|
Share Irreversible |
Shared configurations cannot be revoked |
|
Receiver Rename |
Receiver can rename using pencil icon |
|
Receiver Reshare |
Receiver can reshare the config to its sub ous if not already shared |
|
Device Impact |
Deleting config does not affect devices already using it |
|
Default Config Removal |
If deleted, it is automatically removed from default config |
|
Sender Deletion Impact |
No impact on receiver organizations |