What are the vsec-tool-cli Commands?

CLI Command

Description

vsec_lic_cli –h

Displays help

vsec_lic_cli

Displays the CLI menu

vsec_lic_cli on

Enables the tool. By default the tool is disabled

vsec_lic_cli off

Disables the tool

vsec_lic_cli add <IP-address> <expiration-date> <signature-key> <license-string>

This is the CLI command for the menu option Add License

See Obtain a license from the User Center to fill in the parameters' values.

After running this CLI operation, it is necessary to run vsec_lic_cli distribute

vsec_lic_cli update <IP-address> <expiration-date> <signature-key> <license-string>

Update an existing license in case of changes in the license string. For example, when you purchase additional blades for this license.

See section Obtain a license from the User Center to fill in the parameters' values.

Note - this command is available in R81 and above.

vsec_lic_cli remove <CK>

This is the CLI command for the menu option Remove License

Specify the Certificate Key (CKClosed Certificate Keys (CKs) of Central Licenses in the License Pool.) to be deleted

vsec_lic_cli view

This is the CLI command for the menu option View License Usage

vsec_lic_cli distribute

This is the CLI command for the menu option Run License Distributing

vsec_lic_cli default <pool-name> [optional-single-CK-from-the-pool] <move-gateways-to-new-default-pool:true|false>

This is the CLI command of the menu option Change default pool

Replace <pool-name> with the a pool name as it appears when you run vsec_lic_cli view

Example: vsec_lic_cli default VE-NGTX

In case there are multiple pools with the same name, use the additional parameter < optional-single-CK-from-the-pool>

Where you can specify one CK from the desired pool.

For example:

  • pool VE-NGTP contains CK "A"

  • pool VE-NGTP contains CK "B"

To select the pool with CK "B" run:

vsec_lic_cli default VE-NGTP B

The parameter <move-gateways-to-new-default-pool> gets true/false values and lets you move all the gateways from the previous default to the new default poolClosed A pool created by the first Central License that is added with the Central License tool. The pool type is defined based on the blades package of the first added Central License. CloudGuard Security Gateways automatically receive licenses from that pool. When all licenses in the Default License Pool are removed, a random pool is set as a default. When there are multiple pools, the user can select the default license pool.. (Default is true)

In Single Management ServerClosed Check Point Single-Domain Security Management Server or a Multi-Domain Security Management Server.:

vsec_lic_cli configure <disable|enable> <gateway-name>

In Multi-Domain ServerClosed Dedicated Check Point server that runs Check Point software to host virtual Security Management Servers called Domain Management Servers. Synonym: Multi-Domain Security Management Server. Acronym: MDS.:

vsec_lic_cli configure <disable|enable> <domain> <gateway-name>

This is the CLI command for the menu option Configure Automatic License Distribution for Security Gateway

Use the parameter value enable/disable with gateway name of a CloudGuardGateway to enable/disable automatic distribution.

In Multi-Domain Server, specify the specific Domain in which the CloudGuardGateway is configured. To do this replace the argument <domain> with the Domain's name

vsec_lic_cli report <enable|disable>

This CLI command enables or disables the collection of the Gateways Core Usage information, as described in the menu option Gateways Core Usage Report

Note - It does not generate the report.

vsec_lic_cli report generate <YYYY/MM/DD> <YYYY/MM/DD>

This CLI command generates the Gateways Core Usage Report, as described in the menu option Gateways Core Usage Report.

In Single Management Server:

vsec_lic_cli select <Pool Name> [Optional CK from the pool] <gateway-name>

In Multi-Domain Server:

vsec_lic_cli select <Pool Name> [Optional CK from the pool] <domain> <gateway-name>

This CLI command lets you select a CloudGuardGateway to be in a specific Pool. After the mapping is done, the gateway gets the licenses from the selected pool.

In Multi-Domain Server, specify the specific Domain in which the CloudGuardGateway is configured. To do this replace the argument <domain> with the Domain's name.