Set System Image (VI)
- Updated2023-02-21
- 7 minute(s) read
Applies a system image file or folder—a copy of the contents and software on a primary hard drive of a system. Applying the image to the system restores it to the state captured on the image.
The Set System Image VI removes existing files from the target before applying the new image.
![]() |
Note You may want to use the Install Startup VI if you only need to upgrade specific software components on your remote system. |
Set System Image (File)
Replaces the entire contents of the primary hard drive on a specified target system with an image file created with the Create System Image VI.
![]() |
Encryption Passphrase specifies the passphrase used to encrypt a portion of the image that contains sensitive information. |
||||||||||||||
![]() |
Restart Automatically restarts the system into install mode by default before the operation is performed, and restarts back to a running state after the operation is complete. If you choose not to restart automatically, the operation will fail if the system is not already in install mode. |
||||||||||||||
![]() |
Session in specifies the system refnum for the system receiving the image. |
||||||||||||||
![]() |
Source File specifies the name and location of the target disk image file on the local computer. |
||||||||||||||
![]() |
Network Settings specifies the network settings you want to apply to the target.
|
||||||||||||||
![]() |
error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. |
||||||||||||||
![]() |
Original System Only verifies that the target system has the same MAC address as the system from which the image was originally created. Selecting TRUE will allow you to restore an image from the exact same target from which the image was created only. This option is FALSE by default. |
||||||||||||||
![]() |
File and Directory Blacklist specifies the list of files and folders to exclude from the target image. Files on the blacklist will not be copied from the image to the target and they will not be removed from the target. ExampleFor this example, consider the following scenario:
Results
|
||||||||||||||
![]() |
Session out returns the refnum for the system. |
||||||||||||||
![]() |
error out returns error information. This output provides standard error out functionality. |
Set System Image (Folder)
Replaces the entire contents of the primary hard drive on a specified target system with an image folder created with the Create System Image VI.
![]() |
Encryption Passphrase specifies the passphrase used to encrypt a portion of the image that contains sensitive information. |
||||||||||||||
![]() |
Restart Automatically restarts the system into install mode by default before the operation is performed, and restarts back to a running state after the operation is complete. If you choose not to restart automatically, the operation will fail if the system is not already in install mode. |
||||||||||||||
![]() |
Session in specifies the system refnum for the system receiving the image. |
||||||||||||||
![]() |
Source Folder specifies the name and location of the target disk image folder on the local computer. |
||||||||||||||
![]() |
Network Settings specifies the network settings you want to apply to the target.
|
||||||||||||||
![]() |
error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. |
||||||||||||||
![]() |
Original System Only verifies that the target system has the same MAC address as the system from which the image was originally created. Selecting TRUE will allow you to restore an image from the exact same target from which the image was created only. This option is FALSE by default. |
||||||||||||||
![]() |
File and Directory Blacklist specifies the list of files and folders to exclude from the target image. Files on the blacklist will not be copied from the image to the target and they will not be removed from the target. ExampleFor this example, consider the following scenario:
Results
|
||||||||||||||
![]() |
Session out returns the refnum for the system. |
||||||||||||||
![]() |
error out returns error information. This output provides standard error out functionality. |