Help Center

Menu

Upgrade utility - command line usage

The upgrade utility, upgrade-v15-to-v16, is a utility for assisting in the upgrade and migration of a collection or set of collections and users from a v15 server to a v16 server.

Usage

$ $SEARCH_HOME/bin/upgrade-v15-to-v16 [-hV] [--force] [--ignore-source-ssl-certificate] --client=<clientId> [--client-human-friendly-name=<clientHumanFriendlyname>] [--license-id=<licenseId>] [--source-admin-port=<sourceAdminPort>] [--source-admin-url=<sourceAdminUrl>] [--target-admin-url=<targetAdminUrl>] [--exclude=<excluded>]... [--new-collection-mapping=<String=String>]... [--other-collection-mapping=<String=String>]... [--other-role-mapping=<String=String>]... [--other-user-mapping=<String=String>]... [--remote-collection=<remoteCollectionIds>]... [--remote-resources-prefix=<remoteResourcesPrefix>]...       [--remote-resources-suffix=<remoteResourcesSuffix>]... [--remote-role=<remoteRoleIds>]... [--remote-user=<remoteUserIds>]... <source> <targetSearchHome>
$SEARCH_HOME/bin/upgrade-v15-to-v16 is an alias for the command /opt/funnelback/linbin/java/bin/java -cp "/opt/funnelback/lib/java/all/*" com.funnelback.upgrade.wrapper.CLI

Parameters

<source>

A URI specifying the source for example:

  • file:///tmp/funnelback will set the source as the search home /tmp/funnelback/ local to the server. For windows the form is file:/c: /funnelback/.

  • webdav://fb.server.com will set the source as a remote webdav server assumed to be hosted by funnelback, by default port 8076 will be used but that can be overridden e.g. webdav://fb.server.com:1234 This will use a system user and expects the server secret of the remote Funnelback to be set in the environment SOURCE_SERVER_SECRET. WebDAV is slow, set the java option: java -Djava.util.concurrent.ForkJoinPool.common.parallelism=16 to increase the number of threads.

    This uses the mediator WebDAV sub-service of the Funnelback daemon and should not be confused with Funnelback’s WebDAV file management.

  • ssh://bob@fb.server.com/opt/funnelback/ will set the source to be via an SSH server using the user 'bob' and expects the remote funnelback search home to be the path in this case /opt/funnelback/. If the running machine has many cores (e.g. 32 or more) you may need to limit the number of threads with java option: java -Djava.util.concurrent.ForkJoinPool.common.parallelism=1

<targetSearchHome>

The searchHome into which the collection will be placed and upgraded in.

--client=<clientId>

The ID of the client, resources not under a client will end up in.

--client-human-friendly-name=<clientHumanFriendlyname>

A human friendly name for the client displayed to the user in the UI.

--exclude=<excluded>

Parts of the collection that should NOT be transferred. Valid values: CONF, REPORTS, DATA_REPORTS, ARCHIVE, DATABASES, LOG, VIEW_LIVE, VIEW_OFFLINE

--force

Whether existing collections should be clobbered in order to complete the upgrade.

-h, --help

Show this help message and exit.

--ignore-source-ssl-certificate

Whether the SSL certificate on the source server should be ignored

--license-id=<licenseId>

The ID of the already installed license to use, required if a client is created.

--new-collection-mapping=<String=String>

Some collections may have been previously split into data sources and search packages. When that occurs, roles being upgraded might end up with access to the data source but not the new search package. Providing a new collection mapping here will help solve this. Example: --new-collection-mapping=<client>~<data source>=<client>~<search package>

--other-collection-mapping=<String=String>

Other collection mappings to be aware of when upgrading collections, useful when you have already copied some collections and wish to copy more collections that reference the already downloaded collection. For the already downloaded collection(s) you can use CLI tool: com.funnelback.common.upgradeconfig.UpgradeConfUtilityCLI to fix up the references in that.

--other-role-mapping=<String=String>

Other user mappings to be aware of when upgrading collections, useful when you have already copied some roles and wish to copy more users or roles that reference the already downloaded role.

--other-user-mapping=<String=String>

Other user mappings to be aware of when upgrading collections, useful when you have already copied some users and wish to copy more users or roles that reference the already downloaded user.

--remote-collection=<remoteCollectionIds>

The ID of the remote collection you want to upgrade.

--remote-resources-prefix=<remoteResourcesPrefix>

The prefix to match against remote resources (either collection, user or role) you want to upgrade. When used with the --remote-resources-suffix option the conditions are combined so that resources will be selected if they match the --remote-resources-prefix OR the --remote-resources-suffix. For example abc will get all collections, users and roles starting with 'abc'.

--remote-resources-suffix=<remoteResourcesSuffix>

The suffix to match against remote resources (either collection, user or role) you want to upgrade. When used with the --remote-resources-suffix option the conditions are combined so that resources will be selected if they match the --remote-resources-prefix OR the --remote-resources-suffix. For example xyz will get all collections, users and roles ending with 'xyz'.

--remote-role=<remoteRoleIds>

The ID of the remote role you want to upgrade.

--remote-user=<remoteUserIds>

The ID of the remote user you want to upgrade.

--source-admin-port=<sourceAdminPort>

The administration port of the server from which the collection should be pulled.

--source-admin-url=<sourceAdminUrl>

The admin URI for the source. If the URI determined from the source is incorrect, use this to specify the scheme, hostname and port like so: https://customer.example.com:8123

--target-admin-url=<targetAdminUrl>

The admin URI for the target. Use this to override the default value of https://127.0.0.1:8443 if necessary.

-V, --version

Print version information and exit.

See also