hvrdefinitionexport

Usage

hvrdefinitionexport [-Rurl] -C [m [-a]] hub expjsonfile
hvrdefinitionexport [-Rurl] -cchn... [-m [-a]] hub expjsonfile
hvrdefinitionexport [-Rurl] -cchn -T hub expjsonfile
hvrdefinitionexport [-Rurl] -cchn -ttbl... hub expjsonfile
hvrdefinitionexport [-Rurl] -L [-a] hub expjsonfile
hvrdefinitionexport [-Rurl] -lloc... [-a] hub expjsonfile
hvrdefinitionexport [-Rurl] -hhub expjsonfile
hvrdefinitionexport [-Rurl] -l [-u] hub expjsonfile
hvrdefinitionexport [-Rurl] -iev_id_tstamp... [-u] hub expjsonfile
hvrdefinitionexport [-Rurl] [-btstamp] | [-etstamp] [-u] hub expjsonfile

Description

Command hvrdefinitionexport exports channel, location, and table definitions from a hub into a JSON file.

Options

This section describes the options available for command hvrdefinitionexport.

Parameter	Description
`-a`	Include actions for exported locations. This requires options `-l` (export specific location loc only), `-L` or `-m`.
`-A`	Export agent location properties only. This requires `-l` (export specific location loc only) or `-L`.
`-btstamp`	Export Definition_Change events since time stamp `_tstamp_`.
`-cchn`	Export specific channel `chn` only. This cannot be combined with option `-C`.
`-C`	Export all channels. This cannot be combined with option `-c`.
`-etstamp`	Export Definition_Change events until timestamp `_tstamp_`.
`-h`	Export all hub-level actions.
`-iev_id_tstamp`	Export specific Definition_Change event `ev_id_tstamp`.
`-I`	Export all Definition_Change events.
`-lloc`	Export specific location `loc` only. This cannot be combined with `-L`.
`-L`	Export all locations. This cannot be combined with `-l`(export specific location `loc` only).
`-m`	Include locations which are members of the exported channels. This requires option `-c` or `-C` and cannot be combined with option `-t` or `-T`.
`-Rurl`	Remote hub server. Access the hub server running on a remote machine, via the REST interface. This option is required for remote CLI access. When using this option, command hvrlogin should be run first, for authentication.
`-ttbl`	Export specific table tbl only. This requires single `-cchn`. This cannot be combined with option `-T`.
`-T`	Export only tables (not a channel). This requires single `-cchn`. This cannot be combined with `-t`.
`-u`	Export the undo operation of the original Definition_Change event. This requires options `-b`, `-e`, `-i`, or `-I`(export all Definition_Change events).
`-Vaccessmeth`	Handle classified data. redact: Redact classified data. storage `default`: Save classified data as they are stored in the hub system. @outputfile: Apply transport encryption, save key to file outputfile. @print: Apply transport encryption using the transport encryption key and display the key in command terminal.

Examples

This section provides examples of using the hvrdefinitionexport command.

Example 1. Export all definitions in a hub

The following command exports all definitions in hub hvrhub:

hvrdefinitionexport hvrhub expjsonfile

Example 2. Export all channels including locations

The following command exports all channels including locations that are members of the exported channels and actions defined in the exported locations:

hvrdefinitionexport -C -m -a hvrhub expjsonfile

Example 3. Export specific channels with locations

The following command exports channels mychannel and demochannel including locations which are members of the exported channels and actions defined in the exported locations:

hvrdefinitionexport -c mychannel -c demochannel -m -a hvrhub expjsonfile

Example 4. Export tables

The following command exports all tables of channel mychannel:

hvrdefinitionexport -c mychannel -T hvrhub expjsonfile

Example 5. Export specific table

The following command exports table mytable of channel mychannel:

hvrdefinitionexport -c mychannel -t mytable hvrhub expjsonfile

Example 6. Export locations with actions

The following command exports all locations including actions:

hvrdefinitionexport -L -a hvrhub expjsonfile

Example 7. Export specific location

The following command exports location mylocation:

hvrdefinitionexport -l mylocation hvrhub expjsonfile

Example 8. Export agent properties

The following command exports agent properties of location mylocation:

hvrdefinitionexport -l mylocation -A hvrhub expjsonfile

Example 9. Export hub-level actions

The following command exports hub-level actions of hub hvrhub:

hvrdefinitionexport -h hvrhub expjsonfile

Example 10. Export definition changes

The following command exports all Definition_Change events:

hvrdefinitionexport -I hvrhub expjsonfile

Example 11. Export specific definition change

The following command exports a specific Definition_Change event with ID 2019-05-17T11:45:49+02:00:

hvrdefinitionexport -i 2019-05-17T11:45:49+02:00 hvrhub expjsonfile

Example 12. Export definition changes performed during specific time range

The following command exports the Definition_Change events for the time range between October 9, 2020 and October 29, 2020

hvrdefinitionexport -b 2020-10-09 -e 2020-10-29 hvrhub expjsonfile