NI System Configuration API Reference

Create System Image (VI)

  • Updated2023-02-21
  • 7 minute(s) read
Installed With: NI System Configuration

Creates a system image file or folder—a copy of the file contents on a primary hard drive of a system. You may want to create a system image to restore a system to its original state or to deploy the image to other systems.

Create System Image (File)

Creates a system image file—a copy of the file contents on a primary hard drive of a system in zip format. You may want to create a system image to restore a system to its original state or to deploy the image to other systems.

Create 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, and the system is not in install mode, the resulting image may not be valid.

cio.gif

Session in specifies the system from which the image is being created.

cpath.gif

Destination File specifies the destination where the data is copied.

c1dcclst.gif

Image Metadata in specifies the metadata to add to the system image. Title is required if you specify the value of any additional cluster elements. If you specify the ID , it must be in the GUID format "{00000000-0000-0000-0000-000000000000}" where each '0' represents a hexadecimal digit.

cstr.gif

title specifies the title of the system image.

cstr.gif

description specifies the short description of the system image.

cstr.gif

ID specifies the unique identifier for the system image.

cstr.gif

version specifies the version of the system image.

cu32.gif

component type specifies the component type for the system image. NI recommends leaving the default value, image , if you are creating a new system image.

cerrcodeclst.gif

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

cbool.gif

Overwrite saves the new output file over an older file of the same name if TRUE. By default, this VI will not overwrite the file.

c1dstr.gif

File and Directory Blacklist specifies the list of files and folders to exclude when creating a system image. Files on the blacklist will not be copied from the target to the image.

iio.gif

Session out returns the refnum for the system being imaged.

i1dcclst.gif

Image Metadata out returns the metadata added to the system image.

istr.gif

title is the title of the system image.

istr.gif

description is the short description of the system image.

istr.gif

ID is the unique identifier for the system image.

istr.gif

version is the version of the system image.

iu32.gif

component type is the component type for the system image.

ierrcodeclst.gif

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

Create System Image (Folder)

Creates a system image folder—a copy of the contents and software on a primary hard drive of a system. You may want to create a system image to restore a system to its original state or to deploy the image to other systems.

Create 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, and the system is not in install mode, the resulting image may not be valid.

cio.gif

Session in specifies the system from which the image is being created.

cpath.gif

Destination Folder specifies the directory where the image is stored.

c1dcclst.gif

Image Metadata in specifies the metadata to add to the system image. Title is required if you specify the value of any additional cluster elements. If you specify the ID , it must be in the GUID format "{00000000-0000-0000-0000-000000000000}" where each '0' represents a hexadecimal digit.

cstr.gif

title specifies the title of the system image.

cstr.gif

description specifies the short description of the system image.

cstr.gif

ID specifies the unique identifier for the system image.

cstr.gif

version specifies the version of the system image.

cu32.gif

component type specifies the component type for the system image. NI recommends leaving the default value, image , if you are creating a new system image.

cerrcodeclst.gif

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

cbool.gif

Overwrite saves the new output folder over an older folder of the same name if TRUE. By default, this VI will not overwrite the folder.

c1dstr.gif

File and Directory Blacklist specifies the list of files and folders to exclude when creating a system image. Files on the blacklist will not be copied from the target to the image.

iio.gif

Session out returns the refnum for the system being imaged.

i1dcclst.gif

Image Metadata out returns the metadata added to the system image.

istr.gif

title is the title of the system image.

istr.gif

description is the short description of the system image.

istr.gif

ID is the unique identifier for the system image.

istr.gif

version is the version of the system image.

iu32.gif

component type is the component type for the system image.

ierrcodeclst.gif

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

Log in to get a better experience