The Commands Used

Owned by Jenni Wallin
Last updated: May 04, 2023 by Former user (Deleted)
1 min read

The main benefits with the vcexport/vcimport commands compared to the systemexport/systemimport commands are:

  • The exported configurations are easier to read, which also makes it easier to compare the new export with any previous export.

  • The format is more compact than the traditional export format.

vcexport

usage: vcexport [options]

This command exports configurations in a format that is adapted for version control systems. The vcexport command exports the configurations into a flat structure, i e with file extensions instead of directories. For each exported configuration, a .xsd file will be generated in which the structure of the data is stored, which will produce a more compact format than the other export commands can offer.


OptionsDescription

[-d, --directory]

Use this option to specify in which directory you want to place the exported data. If the directory does not exist, it will be created.

[es, --excludesysdata]

Use this option to exclude system data from the export. For example, you can exclude ECS related data, event categories, and workflow alarm values.

[-f, --folders]

Use this option to specify which folders you want to include in the export. For example, mzsh <user name>/<password> vcexport -d MyDirectory/ -f Default Alarms will export the configurations in the folders Default and Alarms to the directory MyFolder. If this option is not used, the configurations in all folders will be exported.

[-im, --includemeta]

Use this option to include meta data in the export. This will not be done by default, since not including meta data will make it easier to make a file compare between the exports.

[-o, --overwrite]

Use this option to enable existing exports in the stated directory to be overwritten.

vcimport

usage: vcimport [options]

This command imports exports made with the vcexport command.


OptionDescription

[-d, --directory]

This option is mandatory and is used to state from which directory you want to import data.

[-y, --dryrun]

Use this option to parse import files without importing them.

[-f, --folders]

Use this option to specify which folders you want to include in the import. For example, mzsh <user name>/<password> vcimport -d MyDirectory/ -f Default ECS will import the configurations in the folders Default and ECS. If this option is not used, configurations in all folders will be included.

[-m, --message]

Use this option to add a message to identify the import.


Note!

If a key or name conflict occur, the imported data will not overwrite existing configurations.