NI System Configuration API Reference

Table of Contents

Set System Image (VI)

Download PDF
Selected SectionSelected Section and Subsection(s)Entire Manual
  • Updated2023-02-21
  • 7 minute(s) read
Installed With: NI System Configuration

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.

Set System Image (File)

cstr.gif

Encryption Passphrase specifies the passphrase used to encrypt a portion of the image that contains sensitive information.

cbool.gif

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.

cio.gif

Session in specifies the system refnum for the system receiving the image.

cpath.gif

Source File specifies the name and location of the target disk image file on the local computer.

cu32.gif

Network Settings specifies the network settings you want to apply to the target.

reset all network adapters (0)

resets all network adapters to the factory default. The network settings from the image are ignored.
preserve primary, reset others (1)

preserves the existing settings on the primary network adapter and resets all other network adapters to the factory default. The network settings from the image are ignored.
preserve all network adapters (2)

preserves the settings for all network adapters. The network settings from the image are ignored.
preserve primary, apply others (3)

(default) preserves the settings for the primary network adapter on the target and applies the settings from the image to all other network adapters.
apply primary, reset others (4)

applies the settings from the image to the primary network adapter on the target and resets all other network adapters to the factory default.
apply primary, preserve others (5)

applies the settings from the image to the primary network adapter on the target and preserves the existing settings for all other network adapters.
apply all network adapters (6)

applies all network settings from the image to all network adapters.
cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

cbool.gif

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.

c1dstr.gif

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.

Example

For this example, consider the following scenario:

  • The image contains files A, B,C, D.
  • The target contains files A, B, E, F.
  • The user blacklist contains files A, C, E, G.

Results

  • File A on the target is not modified despite being in the image because it is in the blacklist.
  • File B from the image is written over the one on the target.
  • File C from the image is not written to the target because it is in the blacklist.
  • File D from the image is written to the target.
  • File E on the target is not part of the image but is not deleted because it is in the blacklist.
  • File F on the target gets deleted because it is not part of the image.
  • File G in the blacklist is ignored because it is part of neither the image nor the target.
iio.gif

Session out returns the refnum for the system.

ierrcodeclst.gif

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.

Set System Image (Folder)

cstr.gif

Encryption Passphrase specifies the passphrase used to encrypt a portion of the image that contains sensitive information.

cbool.gif

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.

cio.gif

Session in specifies the system refnum for the system receiving the image.

cpath.gif

Source Folder specifies the name and location of the target disk image folder on the local computer.

cu32.gif

Network Settings specifies the network settings you want to apply to the target.

reset all network adapters (0)

resets all network adapters to the factory default. The network settings from the image are ignored.
preserve primary, reset others (1)

preserves the existing settings on the primary network adapter and resets all other network adapters to the factory default. The network settings from the image are ignored.
preserve all network adapters (2)

preserves the settings for all network adapters. The network settings from the image are ignored.
preserve primary, apply others (3)

(default) preserves the settings for the primary network adapter on the target and applies the settings from the image to all other network adapters.
apply primary, reset others (4)

applies the settings from the image to the primary network adapter on the target and resets all other network adapters to the factory default.
apply primary, preserve others (5)

applies the settings from the image to the primary network adapter on the target and preserves the existing settings for all other network adapters.
apply all network adapters (6)

applies all network settings from the image to all network adapters.
cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

cbool.gif

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.

c1dstr.gif

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.

Example

For this example, consider the following scenario:

  • The image contains files A, B,C, D.
  • The target contains files A, B, E, F.
  • The user blacklist contains files A, C, E, G.

Results

  • File A on the target is not modified despite being in the image because it is in the blacklist.
  • File B from the image is written over the one on the target.
  • File C from the image is not written to the target because it is in the blacklist.
  • File D from the image is written to the target.
  • File E on the target is not part of the image but is not deleted because it is in the blacklist.
  • File F on the target gets deleted because it is not part of the image.
  • File G in the blacklist is ignored because it is part of neither the image nor the target.
iio.gif

Session out returns the refnum for the system.

ierrcodeclst.gif

error out returns error information. This output provides standard error out functionality.

Previous

No previous section

Next

No next section

Previous

No previous section

Next

No next section

Log in to get a better experience

Log in