Configuration Using a Configuration Snapshot - icom Data Suite

  • Published on Sep 11, 2024
Prev Next

The Configuration Snapshot function in the Cumulocity Cloud and Telekom Cloud of Things services allows to upload update packets containing ASCII configuration files to the icom Data Suite from remote.

Situation

You have a router in the field and need to update the configuration of the icom Data Suite that is running on the router.

Solution

To upload ASCII configuration files to the icom Data Suite using the Configuration Snapshot function in the Cumulocity Cloud and Telekom Cloud of Things services the following is prerequisite:

You still need to create an update packet containing this configuration file.

Creating the update packet

  1. Open the PowerShell on a Windows computer by hitting the Windows key () and entering powershell or open a terminal window on a Linux computer.

  2. Navigate to the directory containing the ASCII configuration file.

  3. Calculate the MD5 checksum of the configuration file:
    > md5sum ascii_config_file.txt (example for an ASCII configuration file name)

  4. Copy the MD5 checksum to the clipboard.

  5. Create a text file with the name MANIFEST (without filename extension) and the following content:
    FILENAME=ascii_config_file.txt
    DESCRIPTION=ASCII config for configuration snapshot example (description of the contained configuration file)
    MD5SUM=paste_above_checksum_here
    FILETYPE=icom Data Suite - ASCII Configuration

    Please note!

    The spelling of the FILETYPE is important since it defines the usage of the update packet.

  6. Pack the MANIFEST file and the ASCII configuration file into the update packet:
    >  tar -vcf config_packet.tar MANIFEST ascii_config_file.txt

    Please note!

    This command packs the specified files (here MANIFEST and ascii_config_file.txt) into the specified tar packet (here config_packet.tar).

You have now created an update packet that can to be uploaded to the icom Data Suite using the Configuration Snapshot function.

Uploading the configuration file packet

  1. Log in to your Cumulocity Cloud account.

  2. Click on Other applications () in the top right corner and select Device management.

  3. Click on All devices and select your router in the list of all devices.

  4. Click on Configuration ()

  5. Click on Add configuration snapshot ().

  6. Click on the upload button () under CONFIGURATION SNAPSHOT FILE and select above created update packet.

  7. Enter a NAME and DESCRIPTION for the file and click on Save.

  8. Click on All devices, select your router and click on Configuration () again.

  9. In the Apply new snapshot section under Select configuration repository entry to be used, select above uploaded update packet.

  10. Click on Put new snapshot to device.

You have now uploaded the ASCII configuration file to the icom Data Suite. The configuration must still be applied to the profile.

Applying the configuration to the profile

It is possible to apply the configuration using the Command Shell function of the cloud service.

  1. Click on Other applications () in the top right corner and select Device management.

  2. Click on All devices and select your router in the list of all devices.

  3. Click on Shell ()

  4. In the >_ Command field, enter:
    IDS.administration.profiles.ascii_apply=ascii_config_file.txt

    Please note!

    This is just an example for an ASCII configuration file name; use the name of your ASCII configuration file here.

    The prefix IDS. determines that the commands are sent to the icom Data Suite. The prefix M3. would determine that the commands are sent to the router.

  5. Click on Execute.

The command issued will appear in the command history as PENDING. The command will apply the ASCII configuration file to the profile of the icom Data Suite.

Troubleshooting

  • The MANIFEST file must not have a file extension like .txt.

  • The commands entered in the Command Shell are case-sensitive.