NI System Configuration API Reference

Generate MAX Report (VI)

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

Creates a report to document a local or remote system. Reports can be generated in three formats: XML, HTML, and technical support reports.

Both HTML and XML formats provide readable reports. The XML format makes archiving and comparing reports convenient with a configuration management tool. The technical support format generates a ZIP file containing reports that are useful if you need to contact NI Technical Support. The level of support for this VI depends on each device's driver software. This function provides a one-way export only. You cannot import the XML-based report into MAX.

Generate MAX Report

cio.gif

Session in specifies the IP address or hostname of the system on which to perform this operation. When left blank, this VI operates on the local system.

cpath.gif

Output Filename specifies the filename of the generated report. You must have the correct extension for the type of report to generate. The options are .xml, .htm, .html, and .zip .

ci32.gif

Report Type specifies the type of report to generate.

XML (0)

(default) generates a report in XML, which stands for extensible markup language.

HTML (1)

generates a report in HTML, which stands for hypertext markup language.

Technical Support (2)

generates a report to send to NI support staff.

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.

iio.gif

Session out returns the refnum for the system.

ierrcodeclst.gif

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