Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

The Upgrade JSON file is a required component of every Smartcrypt Deployment. The file itself has important information that needs to be communicated from the Smartcrypt Manager down to the targeted system(s). The Smartcrypt Upgrade JSON will be provided for all client releases by PKWARE.

What's in the file?

SectionFieldDescriptionEditableRequired
SmartcryptUpdate The Smartcrypt Updater can be upgraded alone, without installing a new version of the Smartcrypt client. This section defines the information needed to do the operation. This whole section can be omitted if a normal client upgrade is desired.nono
SmartcryptUpdate \ 32 Section for 32 bit installationsnoyes
SmartcryptUpdate \ 32sha256This is the hash of the installer. This value is checked and if the hash of the installer does not match, the installation will not occur. This ensures the installer is not corrupted on transfer or replaced by a malicious 3rd party.noyes
SmartcryptUpdate \ 32urnThis is the URL for this installer. This can be a Web URL or a fileserver/storage location. If it is a local server, it need to be a location the targeted device can reach and transfer files to without authentication (as the Smartcrypt Update service runs without authentication as a domain user)yesyes
SmartcryptUpdate \ 64 Section for 64 bit installationsnoyes
SmartcryptUpdate \ 64sha256This is the hash of the installer. This value is checked and if the hash of the installer does not match, the installation will not occur. This ensures the installer is not corrupted on transfer or replaced by a malicious 3rd party.noyes
SmartcryptUpdate \ 64urnThis is the URL for this installer. This can be a Web URL or a fileserver/storage location. If it is a local server, it need to be a location the targeted device can reach and transfer files to without authentication (as the Smartcrypt Update service runs without authentication as a domain user)yesyes
SmartcryptUpdatefile_version_maxThis field is an instruction to the Update Service to only operation on specific versions of installed software. If the client version is higher (newer) than the defined max value, the deployment will not occur.yesyes
SmartcryptUpdatefile_version_min This field is an instruction to the Update Service to only operation on specific versions of installed software. If the client version is lower (older) than the defined min value, the deployment will not occur.yesyes
Upgrade The Smartcrypt Updater can be used to upgrade the whole Smartcrypt installation on a device (The service, the updater and all plugins). This section controls all those components together.noyes
Upgrade \ 32 Section for 32 bit installationsnoyes
Upgrade \ 32sha256This is the hash of the installer. This value is checked and if the hash of the installer does not match, the installation will not occur. This ensures the installer is not corrupted on transfer or replaced by a malicious 3rd party.noyes
Upgrade \ 32urnThis is the URL for this installer. This can be a Web URL or a fileserver/storage location. If it is a local server, it need to be a location the targeted device can reach and transfer files to without authentication (as the Smartcrypt Update service runs without authentication as a domain user)yesyes
Upgrade \ 64 Section for 64 bit installationsnoyes
Upgrade \ 64sha256This is the hash of the installer. This value is checked and if the hash of the installer does not match, the installation will not occur. This ensures the installer is not corrupted on transfer or replaced by a malicious 3rd party.noyes
Upgrade \ 64urnThis is the URL for this installer. This can be a Web URL or a fileserver/storage location. If it is a local server, it need to be a location the targeted device can reach and transfer files to without authentication (as the Smartcrypt Update service runs without authentication as a domain user)yesyes
Upgradeproduct_version_maxThis field is an instruction to the Update Service to only operation on specific versions of installed software. If the client version is higher (newer) than the defined max value, the deployment will not occur.yesyes
Upgradeproduct_version_minThis field is an instruction to the Update Service to only operation on specific versions of installed software. If the client version is lower (older) than the defined min value, the deployment will not occur.yesyes
 rebootThis field controls the behavior on the targeted device after a successful deployment. Providing true will trigger the system to reboot immediately after the upgrade completes. This might occur before the user(s) even have a chance to log into the system. Providing false will not reboot the system after a reboot, but if the installation didn't completely upgrade all the components they still might be running the old version.yesno
 forceThis field controls whether or not Smartcrypt installs immediately or after the next time the computer restarts. Providing true will begin installing Smartcrypt as soon as the deployment is received and downloaded. Providing false will cause Smartcrypt to queue the install the the next time the system boots after the deployment is received and downloaded.yesno
 data_format_versionAn internal version for the upgrade protocol.noyes
 platformThe targeted / included platforms for the deployment. As of the initial release on Smartcrypt Deployments in 17.1, only Windows is supported.noyes

Examples of Force and Reboot combinations

ForceRebootResult
true

true

When deployment has been received and downloaded, Smartcrypt immediately installs and system automatically rebooted.

truefalse

When deployment has been received and downloaded, Smartcrypt immediately installs and then skip rebooting after the installation.

falsetrue

When deployment has been received and downloaded, Smartcrypt will queue the update to install on the next boot of the system, and then reboot after the installation.

falsefalseWhen deployment has been received and downloaded, Smartcrypt will queue the update to install on the next boot of the system, and then skip rebooting after the installation.

 

 

  • No labels