Vector License Client » Command Line Interface » Parameter Overview

Parameter Overview

To use the commands activate, deactivate, reactivate, repair, updateLicenses and listLicenses, different parameters that correspond to your specific use case must be set. The following table gives you an overview of the possible parameters and their description. The use of the parameters is explained on the help pages of the commands.

Parameter Group

Parameter

Description

ActivationKey

Mandatory parameter for the activate command. The licenses from this key are activated.

License Carrier

  1. deviceSerial
    1. for computers: serial number from the container.
      Example: 130-3026355526,
    2. for Keyman: serial number from the container (is also written on the device).
      Example: 3-3665797
  2. local – Computer
  3. dongle

Mandatory parameters (all) for the activate and repair command.

Optional parameters (all) for the deactivate, reactivate and list command.

They must or can be used to define the license carrier on which licenses are to be activated.

Note

Note regarding the activate and repair commands:

  • The parameter dongle can only be used if a device of exactly the same type is connected.
  • If several devices are connected, the command will fail since the device cannot be clearly identified.

Note

Note regarding the deactivate/reactivate command:

  • If the device cannot be found, the command will fail.
  • If several devices have been found, the licenses of all detected devices are deactivated/reactivated.
  • If this parameter is not entered, the connected devices are scanned for licenses and the detected licenses are deactivated/reactivated.

Licenses

  1. Licenses – List of Vector License IDs,
    Separator: semicolon
    Example: 5000123;5028471;5002836

Mandatory parameter (all) for the activate and reactivate commands and optional parameter for the deactivate command.

They can be used to define which licenses from the activation key are to be activated or deactivated/reactivated.

Note

Note

  • If this parameter is not set, all detected licenses are deactivated.
  • If, for a Vector license ID (or product / product code), several licenses can be found, only one (the first one) is activated or all licenses are deactivated/reactivated
  • If specified licenses cannot be found, the command fails, i.e., no license is activated or deactivated/reactivated.

LicenseType <license type>

Available license types:

  • CITeam – Find and activate CI Team licenses.
    Example: LicenseType TestBench
  • TestBench – Find and activate Test Bench licenses.
    Example: LicenseType TestBench
  • CIAgentCount- Find and activate CI Agent Count license.
    Example: LicenseType CIAgentCount

Optional parameter for the activate command. Only licenses with the specific license type are considered.

Note

Note

If a license is assigned to a specific user, this can be entered separated by a comma.
Example: -LicenseType NamedUser,visxyz

License type (deprecated)

  1. CITeam – Find and activate CI Team licenses.
  2. TestBench – Find and activate Test Bench licenses.
  3. CIAgentCount- Find and activate CI Agent Count license.

Note

Note

This parameter is deprecated. Use the text-based license type instead: -LicenseType <Lizenztyp>.

Optional parameters (all) for the activate command. You can enter the license type.

All

Optional parameter for the activate command. All licenses corresponding to the selected parameters are activated.

Note

Note

Without this parameter, only one license is activated for each material number in the activation key.

ActivateIfNotAvailable

Optional parameters for the activate command. Only licenses are considered whose material number is not already activated on the selected license carrier.

borrowable

Optional parameter for the list command. Only borrowable network licenses are printed.

DeviceAssigned

Optional parameters for the activate command. Only licenses already assigned to the selected license carrier are considered. Unassigned licenses are ignored.

NameList

Optional parameter for commands to manage user assignments.

NameListFile

Optional parameter for commands to manage user assignments.

network

Optional parameter for the list command. This parameter is used to print network licenses found on the configured server in the customer company.

List parameters:

  1. any
  2. anyContainer
  3. anyLicense

Optional parameter for list commands.

  1. List any license found for specified activation Key. This also includes licenses which cannot be activated.
  2. List any container available.
  3. List any license available on any connected container.

Offline

Mandatory parameter for offline activate, deactivate, reactivate and repair commands. First of all, this parameter is only used to create a vlc file. For the complete procedure, further steps are required.

OutputPath

Optional parameter for

Enter the complete path where the output file (*.vlc, *.vlu or *.vlr) is to be saved.

Note

Note

  • If you do not enter this parameter, the default name of the file is stored in the temp directory of the system.
  • When uploading a receipt file, no output file is generated and therefore no OutputPath can be entered.
  • If the specified file already exists, the Overwrite parameter must be set.

Overwrite

Optional parameter for

Overwrites the already existing file.

Note

Note

  • This parameter can only be used if the parameter OutputPath is specified. If available, the specified file is overwritten.
  • An offline command fails when OutputPath is specified to an existing file without using Overwrite.

server <address>

Optional parameter for the list and checkServers commands. With this parameter the specified server is used instead of the configured server search list.

Until

Optional parameter for the borrow command. Here you can enter a date until when licenses are to be borrowed. Without this parameter, licenses will be borrowed for 2 days.

Format: YYYY-MM-DD

Note

Note

The borrowed license is usable until midnight of the selected day.

UpdateFile

Mandatory parameter for the install command in all offline actions.

As parameter, enter only the complete path to the file.

During this process, a receipt file (*.vlr) is generated that can be uploaded via the upload command.

UploadFile

Mandatory parameter for the upload command in all offline actions.

As parameter, enter only the complete path to the file.

By this, a previously generated context or Receipt file is uploaded. During this process, an update file (*.vlu) may be generated.

verbose

Optional parameter for all commands. This parameter can be used to display further detailed information on the console

Note

Note Proxy Settings:

If a proxy server is required for the Vector License Client to connect to the Vector server, this may be configured by setting the Java system properties https.proxyHost and https.proxyPort. This can be achieved by setting the environment variable JAVA_FLAGS with the following command:

export JAVA_FLAGS=“-Dhttps.proxyHost=… -Dhttps.proxyPort=…“