NI System Configuration API Reference

Property Node (System) Descriptions

  • Updated2023-02-21
  • 4 minute(s) read

Owning Palette: Software Management

Gets or sets properties and methods on local or remote hardware targets. Use the System property node to configure devices in your system. Use the Save Changes VI to commit the new property settings.

PropertyDescription
Device ClassSpecifies the class for the remote system or network device. Example: PXI, cRIO.
Firmware VersionSpecifies the firmware version information for a remote system or network device. This is also known as the BIOS version.
HostnameSpecifies the requested hostname for a remote system or network device. This may or may not be the same as the DNS name.
Product IDSpecifies the bus-specific product identifier code. This is not the product's sellable model number.
Product NameSpecifies the product name for a remote system or network device. This is also known as the model name.
Note Note  Use the value of this property for display purposes only and not for programmatic decisions. The value can change between implementations or revisions.
Serial NumberSpecifies the serial number for a remote system or network device.
User CommentSets a user-specified comment for a remote system or network device, as shown in MAX.
Advanced:System ResourceReturns the hardware resource node that represents the local system service.
Advanced:Auto-Restart TimeoutSpecifies the time in milliseconds that the VI waits to re-establish a connection to the system after a restart operation. The default is 90000 (90 seconds). This property applies only to VIs that automatically restart a remote system, such as before and after installation.
Advanced:Supports Factory ResetSpecifies whether the remote system supports resetting to factory defaults.
Advanced:Supports Firmware UpdateSpecifies whether the remote system supports firmware updates.
Advanced:Repository LocationSpecifies the repository folder which contains installable components.
Advanced:Installed API VersionSpecifies the version of the NI System Configuration API installed on the system.
Image Metadata:TitleSpecifies the title of the system image.
Image Metadata:DescriptionSpecifies the short description for the system image.
Image Metadata:IDSpecifies the unique identifier for the system image.
Image Metadata:VersionSpecifies the version of the system image.
Operating System:ArchitectureSpecifies the short form of the operating system running on a system, including the name and architecture. Example: PharLap or VxWorks-PPC603.
Operating System:VersionSpecifies the version of the operating system running on a system.
Operating System:DescriptionSpecifies the long form of the operating system running on a system, including the name, version and service pack (if applicable).
Primary NIC:DNS ServerSpecifies the DNS server address for a remote system or network device. If the system or device has multiple adapters, this property applies only to the primary network card.
Primary NIC:GatewaySpecifies the IP address of the gateway on the network for a remote system or network device. If the system or device has multiple adapters, this property applies only to the primary network card.
Primary NIC:IP AddressSpecifies the IP address for a remote system or network device. If the system or device has multiple adapters, this property applies only to the primary network card.
Primary NIC:IP Address Request ModeSpecifies whether the remote system or network device receives its IP address statically or dynamically. Not all adapters support all modes. Static and DHCP/Link-Local modes are most commonly supported. If the system or device has multiple adapters, this property applies only to the primary network card.
Primary NIC:MAC AddressSpecifies the unique code (MAC address) for a remote system or network device. If the system or device has multiple adapters, this property applies only to the primary network card.
Primary NIC:Subnet MaskSpecifies the subnet mask for a remote system or network device. If the system or device has multiple adapters, this property applies only to the primary network card.
Real-Time:File SystemSpecifies the file system for a remote system.
Real-Time:Is Locked Specifies whether the remote system is password protected for FTP access. This property is valid only if Supports Locking is TRUE.
Real-Time:Supports LockingSpecifies whether the remote system supports password authentication for FTP access.
Real-Time:On Local SubnetSpecifies whether the remote system or network device is on the local subnet.
Real-Time:Protect RestartsSpecifies whether the remote system requires a password to restart.
Real-Time:Halt On IP ErrorSpecifies whether the remote system or network device is set to stop working if a TCP/IP error occurs.
Real-Time:Supports RestartSpecifies whether the remote system supports programmatic restarts.
Real-Time:System StatusSpecifies the state for a remote system or network device.
System Resources:Total Physical MemorySpecifies the total amount of physical memory in KB on the system.

Windows — This value corresponds to 'TotalVisibleMemorySize' reported from WMI.
Linux — This value corresponds to 'MemTotal' reported from '/proc/meminfo'.
System Resources:Free Physical MemorySpecifies the amount of free physical memory in KB on the system.

Windows — This value corresponds to 'FreePhysicalMemory' reported from WMI.
Linux — This value corresponds to 'MemAvailable' reported from '/proc/meminfo'.
System Resources:Largest Available Memory BlockSpecifies the size of the largest block of available memory in KB on a system running VxWorks or Phar Lap ETS.
System Resources:Total Virtual MemorySpecifies the total amount of virtual memory in KB on the system, which includes physical memory and swap file space. If virtual memory is not supported or enabled, this may be the same as the total physical memory.

Windows — This value corresponds to 'CommitLimit' reported from WMI.
Linux — This value corresponds to 'CommitLimit' reported from '/proc/meminfo'.
System Resources:Free Virtual MemorySpecifies the amount of free virtual memory in KB on the system.

Windows — This value corresponds to 'CommitLimit - CommittedBytes' reported from WMI.
Linux — This value corresponds to 'CommitLimit - Committed_AS' reported from '/proc/meminfo'.
System Resources:Primary Disk CapacitySpecifies the total amount of disk space in KB on the primary drive, for example C:, on the system.
System Resources:Primary Disk FreeSpecifies the amount of free disk space in KB on the primary drive, for example C:, on the system.

Log in to get a better experience