Using the activatemodel Command

Use the activatemodel command to deploy or redeploy a model, its event handlers, and its configuration information to a running Host Integrator Server.

About the Command

The activatemodel command references data in a model package file in determining how to deploy or redeploy a model. Any deployment target defined within the package can be activated on the specified server.

If a model that us being activated already exists on a server, a redeploy will occur automatically. Any configuration related to the existing model is deleted in favor of the configuration specified in the configuration target. New configuration information is not merged with previous configuration information. The only exception is for a model package that contains no configuration descriptors (as opposed to empty configuration descriptors) is activated. In that case, the activatemodel command will simply update the model and (if provided) its event handlers, leaving any session pools or model variable list configurations that are specific to this model untouched in the Verastream Administrative Console.

Command Requirements

Before you use the activatemodel command, you must have created a model package using the packagemodel command.

Command Syntax

Here is the syntax for the activatemodel command:

activatemodel -package input_package_file
[ -target configuration_target]
[ -server vhi_server ]
[ -user username -password, password ]
[ -passphrase encryption_passphrase ]

Option

Short
Version

Required

Description

-package -p X The file name of the model package to activate. The file name specified can either be fully qualified or relative to the current working directory. This switch is required.
-target -t The configuration target defined within the model package you wish to activate. This switch is optional. If it is not supplied, the target default is implied.
-server -s

The network name of the Host Integrator Server where the model is to be activated. This switch is optional. If it is not supplied, the network name localhost is implied.

-user and
-password
-u and -w The user credentials of the Host Integrator administrator.
-passphrase -e A pass phrase used to generate a decryption key for sensitive data contained within the model package. It must match the phrase used when the model package was created. This switch is optional.

Command Examples

Here are some examples of the activatemodel command. The first command activates the model contained within MyModel.zip using the default configuration target. The model is activated on the same machine from which the command was executed:

activatemodel -package MyModel.zip

The next command activates the model contained within MyModel.zip in the current working directory, using the Zephyr configuration target, on the machine whose network name is VHI_Server. As demonstrated by the first command, above, if no -server switch is supplied, the model is activated on the VHI server where the command is executed. To activate a model on multiple machines you would execute the command multiple times, with different -server values.

activatemodel -package MyModel.zip -target Zephyr -server VHI_Server

The next command uses the short versions of the switches instead of the long versions (for example, -s instead of -server). Also, this command assumes that security is activated on the Host Integrator installation and provides the Host Integrator administrator user name and password. Finally, assuming that the pass phrase "In sequent toil all forwards do contend" was provided when the model package was created, it is provided here so that a decryption key for sensitive data can be generated.

activatemodel -p MyModel.zip -t Zephyr -s VHI_Server -u VHIadmin -w VHIPassWord
						
-e "In sequent toil all forwards do contend"
Related Topics
Bullet Using the deactivatemodel Command
Bullet Using the packagemodel Command
Bullet About Model Packages