Licensing

How Match licensing works, including online renewals and offline activation for QUX.

As stated in the Requirements section, a valid license is required to:

• Enable Match on a Sensor.
• Upload ruleset to the Brain.
• Assign a ruleset to a Sensor.

If an existing license expires:

• Any enabled Sensors will continue to run Match with any existing ruleset that has been assigned to them.
• Match can be disabled on an already-enabled device and existing ruleset assignments may be deleted.

Online Licensing

For Brains that are connected to Vectra (online), licensing is an automated process that requires no user intervention. When your sales contract is executed or renewed, your Vectra Match license expiration date is set, and the Vectra cloud will provide a new license key for Vectra Match to your Brain.

Offline Licensing (QUX Deployments Only)

If your Brain is offline (not connected to Vectra or air-gapped), to license Match, simply browse to the Configuration → SETUP → Licensing screen and follow the steps below. Alternatively, customers can also copy the authorization code, provide it to Vectra (support or sales team), and Vectra will provide you a new license key for entry into the UI once your entitlement is verified.

• Copy the License Request information by clicking the Copy button.

• In another browser tab or window, navigate to https://support.vectra.ai/.

  • Login at the top right.
  • If you do not have a Vectra support account, you can self-register at the login screen, but licensing will not be available until your account is validated as being associated with a Vectra customer or prospect involved in a trial.
  • Navigate to Additional Resources → License.
• Paste the license information you copied into the Enter Authorization Code section of the page and click Generate License Key. You should get a message at the top and a key in the License Key box. Copy the license key using the Copy License Key button.

• Go back to your Brain in your other tab or window, paste the license key into the window and click the Activate License button.

License (Checks, Status, and Renewal)

The validity of a Vectra Match license is checked periodically. This will occur whether the Brain is online or offline (from the perspective of connection to Vectra). Once a license is 30 days from expiration, your Brain will begin to send messages in the Audit logs with a count down until expiration. Once the license expires, a new log message is created. Examples of license audit logs are shown below:

"License Checker: Vectra Match License Expires in {days_until_expiration} days."
"License Checker: Detected Invalid/Expired License, disabling services"

• For QUX - Notifications can be configured to send audit logs via syslog or Kafka.
• For RUX - The audits API endpoint can be queried for audit log messages.

The status of your Vectra Match license can be checked at the CLI or in the UI:

• To check in the UI, navigate to Configuration → SETUP → Licensing and look in the License Summary box:

• To check at the CLI, log in as the vectra user at the CLI of your Brain and issue the show license command. An example is shown below with an obfuscated license blob:

vscli > show license
License: 
obfuscatedjogIjhFUG1ON1ZnNXNMOFVYajBDYUkzV1o3OEVKNlgxQkVvY3lleHZuTmRaZVN5WnNtcVA4ZldBUk5MQXZaRVF2TGU1Y29lWURtNnowVk1mRmlUQmZTZDVwRnZqT2QwWWUyQXMweEFMckpaTzVBNkVLcDRQbCs2a3FqMk9lR0FvQno3Tmp4MUhockdHTlRCODFoOE1ObkF4ck9FT0J5TkthTjlRhdnM1VEdLWllGS0EvMkN6bU9uSy9pRGVsTVFSUXplQjJHTVVOTFg3Wjh2bllNMmQ4MzZEQnJnaDg4bThVMUMyVU0rY0NzM3lva1AxbFdzbkowNVZwb1pqSUk1T28ycmlmRHhqd2Z1VUZLQjVqMlJHMTZrbC8rNHJBM3RBNTROaTcvUUxJOGUrQ1ZmVllqVGVTeGRuR0tVeXRoSDobfuscatedM24rRHRLNmU0ZXhqbmVvYlpoT2ZmUTgzWFhvb0pXdWdDcWtJbGlxemEydk90UWFOdko2Vk1TVmt4VTg2a2RIQmVzUTEzQnlRZml0UkJJTDF3ZWVsRTdKNTR6UFJnbXhCobfuscatedd1c3blBUcmpHRDg5Q0g3LzNMVHRZOHAwbmIzcTlUYzlibzI2VFNYMzJqV3o1ekoyS25kRXhtUWQ4c0labjR6aG1zeTN3YkJ1U1pQcz0iLCAidGFnIjogInRUZVpraldUODFBWnRPQ3obfuscatedjZSI6ICJIUi9ZaERGobfuscated=:RktApxwRifPUBSwkn2ERc9uSSQY3t5wL8wnzmWgVdW16K+obfuscatedkGAgJ0itkVxP3RE/GiuUALyi/PGSIqoGHB6puJexc/PL70MLQCxd7f8igJQRdv95KQ9fkFNF+VGGEUM/eN4lj5dWtauVGNgKGrWwxdkXzTtAMzG6pU0lO548Tf28YYwwRKXfAqIu9aCvHotp/QbbuV3KD3g/C9CFYtLOuj/obfuscated==
Offline: False
Last Modified: 2023-03-09T02:42:37.989850
Detect:
    Valid: True,
    Valid Until: 9999-12-31T00:00:00+00:00
Match:
    Valid: True,
    Valid Until: 9999-12-31T00:00:00+00:00
Recall:
    Valid: True,
    Valid Until: 9999-12-31T00:00:00+00:00
Stream:
    Valid: True,
    Valid Until: 9999-12-31T00:00:00+00:00

License renewals are handled the same way as initial licensing. For online Brains, the process is automatic. For offline Brains, follow the same Offline Licensing process as shown earlier.