hcibox

This command automates BOX export, import, and deployment.

hcibox {-i filepath | -e filepath | -d sitename | -c 
sitename |-s sitename | -n sitename thread
[, thread...] [[r] [m] [p]] | -r [[i | s |r] [a | d]]} BOX [-f] | [-v] | 
[-h | -help] | [-x cfgfile=configurationfilename] [-l]

The corresponding binary is found under %HCIROOT%/clgui/bin and is only for host server installations.

  • -i filepath imports a BOX into the current host.

    filepath is the full path to the imported BOX.

  • -e filepath exports an existing BOX as a file package.

    filepath is the full path to where the BOX is exported.

  • -d sitename deploys a BOX to the specified site.

    sitename is the name of the site to where the BOX is deployed.

  • -c sitename creates a new site with a BOX.

    sitename is the name of the site to be created.

  • -s sitename creates a new BOX packaging the entire site.
  • -n sitename thread,[thread...] [[r] [m] [p]] creates a new BOX .
    • sitename is the name of the destination site.
    • thread[, thread...] is the name list of the threads to be referred.
    • r automatically includes all referenced threads.
    • m includes master site/root resources when finding references.
    • p packages master site/root resources as their original location into BOX.
  • -r [[i | s | r ][a | d]] refreshes the BOX.
    • [i | s | r] indicates that when refreshing a BOX, what to do if some BOX resources do not exist on the target environment.

      i ignores the resource and continues to refresh others. This is the default.

      s stops the refresh and prompts an exception.

      r removes the resource from BOX.

    • [a | d] indicates how to deal with new referenced resources found in site/mastersite/root.

      a adds new referenced resources into BOX. This is the default.

      d discards the new referenced resources.

  • BOX is the BOX location and name. The location is the relative path to the %HCIROOT%/box folder.
  • -f forces running, skipping the query.
  • -v out verbose information.
  • -h or -help displays this help message.
  • -x cfgfile=configurationfilename chooses the protocol configuration file in the current BOX. This is only for deploying a BOX or creating a site from a BOX.
  • -l disables route level deployment when creating a BOX using the command line.