Install Startup (VI)

Download PDF

Updated2023-02-21
6 minute(s) read

Installed With: NI System Configuration

Use the Install Startup VI to deploy a startup application to a remote system.

This VI completes the following:

Installs the startup application you specify in the startup application parameter, even if it is already installed on the target.
Installs additional required components if they are not already installed on the target.
If uninstall conflicts is TRUE, uninstalls conflicting components from the target. Components that do not conflict will not be uninstalled from the target.

You may want to use the Create System Image and Set System Image VIs if your application requires network shared variables or application web servers.

Install Startup

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 IP address or hostname of the system on which to perform this operation.

Startup Application specifies the startup application which you want to install to the target.

title is the title of the startup application. This input is optional.

description is the short description of the startup application. This input is optional.

ID is the unique identifier for the startup application.

version is the version of the startup application.

component type is the type of the component.

standard (0)	Specifies the component is a standard visible software component.
hidden (1)	Specifies the component is a hidden software component.
system (2)	Specifies the component is a required system component.
unknown (3)	Specifies the component type is unknown.
startup (4)	Specifies the component is a startup application.
image (5)	Specifies the component is a user-defined system image.
essential (6)	Specifies the component is a required visible software component.

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

Uninstall Conflicts specifies whether to uninstall conflicting software components automatically. By default, conflicting software components are uninstalled.

Version Selection specifies which version of the startup application to install.

Highest (0)	Specifies the version based on user input. If a version number is not specified, the highest installable version will be selected. If a version number is specified but is higher than any available software on the host, the installation will fail.
Exactly (1)	(default) Installs the exact specified version. If the specified version does not match the available software on the host the installation will fail.

Session out returns the refnum for the system.

Installed Components returns a list of software components installed to the target.

	title is the title of the software component.
	description is a short description of the software component.
	ID is the unique identifier for the software component.
	version is the version of the software component.
	component type is the component type. Components can be standard, hidden, system, unknown, startup, image, or essential.

Uninstalled Components returns a list of all software components removed from the target.

	title is the title of the software component.
	description is a short description of the software component.
	ID is the unique identifier for the software component.
	version is the version of the software component.
	component type is the component type. Components can be standard, hidden, system, unknown, startup, image, or essential.

Broken Dependencies returns a list of broken dependencies, which are specific software components that cannot operate without another software component installed. This array will be empty when an installation succeeds.

Depender is the software component that requires another software component (the dependee ) to install and operate correctly.

	title is the title of the software components.
	description is a short description of the software components.
	ID is the unique identifier for the software components.
	version is the version of the software components.
	component type is the component type. Components can be standard, hidden, system, unknown, startup, image, or essential.

Dependee is the software component that must be present for the depender to install and operate correctly.

	title is the title of the software components.
	description is a short description of the software components.
	ID is the unique identifier for the software components.
	version is the version of the software components.
	component type is the component type. Components can be standard, hidden, system, unknown, startup, image, or essential.

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

NI System Configuration API Reference

Table of Contents

Install Startup (VI)