CME Structure and Configurations
These sections explain the primary concepts of CME configuration.
CME Directories and Files
-
The CME is located in this directory on the Security Management or Multi-Domain Security Management Server:
/opt/CPcme/
-
To execute the configuration tool for autoscaling solutions (such as Azure VMSS, AWS Amazon® Web Services. Public cloud platform that offers global compute, storage, database, application and other cloud services. ASG, and GCP Google® Cloud Platform is a suite of products and services that includes hosting, cloud computing, database services and more. MIG), run this command in Expert mode:
autoprov_cfg
A more detailed description of
autoprov_cfg
is provided in Using the autoprov_cfg Command Line Configuration Tool. -
Run this command in Expert mode to execute the command line configurations menu:
cme_menu
For each CME feature that requires the CME Menu, see the specific instructions in the related chapter.
-
Configuration tool for AWS Transit Gateway:
tgw_menu
For a more detailed description of the
tgw-menu
features, see Configuring the tgw_menu.
About CME Service Commands
After a successful installation, CME runs the 'cme
' service.
Function |
Run this Command |
---|---|
Stop the service |
|
Start the service |
|
Restart the service |
|
Test the service |
|
Get the status of the service |
|
Locating the Configuration Files
CME's primary configuration file is autoprovision.json, and CME maintains backup files for it:
-
autoprovision.json.bak - when there is a configuration change.
-
autoprovision.json.bak_schema - when CME schema version is updated - See Schema section.
To find the CME configuration files, use one of these directories:
-
On a Multi-Domain Security Management Server:
$MDSDIR/conf
The configuration files are synchronized between the primary and secondary servers in a Management High Availability environment.
The CME Logs
The CME log files are:
-
Primary CME Service log:
/var/log/CPcme/cme.log*
-
CME command line menu log:
/var/log/CPcme/cme_menu.log
More logs used by Check Point Support:
-
rest_infra.log
-
cme_api.log
-
gunicorn_server.log
-
diagnostics.log
See CME Log Collector.
CME Authentication
This section describes the necessary steps for CME authentication with different public cloud platforms.
AWS
Refer to sk130372 > 3. Creating an AWS IAM User and IAM Role section.
AWS Controller (account) connects to these URLs:
-
https://ec2.<region_code>.amazonaws.com
-
https://elasticloadbalancing.<region_code>.amazonaws.com
For example https://ec2.ap-northeast-2.amazonaws.com/
Azure
Create a Microsoft Entra ID (formerly Azure AD) and Service Principal
With the Microsoft Entra ID and Service Principal, the Check Point Security Management Server Check Point Single-Domain Security Management Server or a Multi-Domain Security Management Server. monitors the creation and status of the VMSS, so it can complete the provision of these Security Gateways.
-
Connect to portal.azure.com.
-
Click Microsoft Entra ID.
-
Click +Add > App registration. The Register an application screen opens
-
Create new registration:
-
Select a meaningful Name.
-
Supported account types - Select Accounts in this organizational directory only (Single tenant).
-
Redirect URL - Select Web, and type https://localhost/vmss-name - instead of vmss-name. It can be any name.
-
Click Register. The new application is created.
-
In the new application screen, on the left menu pane click Manage > Certificates and secrets.
-
In the Client Secrets tab, click + New Client Secret.
-
Add the duration for the key.
-
Click Add.
-
Backup the key. You cannot look at the key later. Save it now.
-
After you create the application, write down these values to use in "Configure the Check Point Security Management Server" step.
-
Application ID
client_id
-
Key value
client_secret
-
Tenant ID
directory (tenant) ID
Permissions:
Give the Azure Active Directory application a minimum role of Reader to the VMSS and the VNET as explained here.
Azure Controller (account) connects to these URLs:
-
AzureCloud
-
https://login.windows.net
-
https://management.azure.com
-
-
AzureChinaCloud
-
https://login.chinacloudapi.cn
-
https://management.chinacloudapi.cn
-
-
AzureUSGovernment
-
https://login.microsoftonline.us
-
https://management.usgovcloudapi.net
-
GCP
Create a Google Cloud Platform (GCP) Service Account
The Check Point Security Management Server uses the GCP Service account to monitor the creation and status of the autoscaling Managed Instance Group. This lets the Security Management Server complete provisioning of these Security Gateways.
To create a GCP service account:
-
Go to https://cloud.google.com/iam/docs/creating-managing-service-accounts.
Use these parameters:
Name
check-point-autoprovision
Role
Compute Engine \ Compute Viewer
-
Click Create Key > JSON (as the key type). A JSON file is downloaded to your computer.
Note - This JSON file is later used as the credentials file in CME Structure and Configurations.
Permissions:
"Compute viewer"
GCP Controller (account) connects to this URL:
https://www.googleapis.com/
Using the cme_menu
Command Line Configuration Tool
-
The
cme_menu
is a command line-based menu to configure CME components and features. -
To start the menu, run
cme_menu
when logged into Expert mode on the Security Management or Multi-Domain Security Management Server. -
Use the instructions in this guide to configure the CME with the
cme_menu
as needed.
Using the autoprov_cfg
Command Line Configuration Tool
-
The
autoprov_cfg
is a command-line tool to configure autoscaling solutions, such as Azure VMSS, AWS ASG, and GCP MIG. -
Refer to the specific solutions administration guide for specific information about how to use
autoprov_cfg
. -
For instructions about how to use the
autoprov_cfg
, run:autoprov_cfg -h
-
Commands summary:
Command Description init
Initialize auto-provision with Management, a Configuration Template, and a Controller (account) configuration
show
Show all or specific configuration settings
add
-
Add a new Configuration Template or a Controller
-
Add a new configuration to the Management or to a Configuration Template or a Controller
set
Set values in an existing configuration of Management, Configuration Template or a Controller
delete
-
Remove a Configuration Template or a Controller
-
Remove a configuration from the Management or from a Configuration Template or a Controller
-v
Show the version of CME
-h
Shows specific help documentation
Important - If you have an existing configuration, running the
autoprov_cfg init
command will override it.To add one more auto-provisioned environment, use the
autoprov_cfg add
command instead ofautoprov_cfg init
. -
-
Specific help documentation is available for each option that you select.
For example, this command shows the available initialization parameters for AWS and their definition:
autoprov_cfg init AWS -h
Schema
-
Starting from CME Take 212, the CME configuration has a schema version.
-
This attribute ensures that only compatible CME runs with the given CME configuration.
-
CME does not run when the schema version in the CME configuration is not compatible.
-
Example scenarios that can cause incompatibility:
-
Revert to older CME Take.
-
Upgrade - export configuration and importing it on a machine with an older CME Take.
-
High Availability Management/Multi Domain servers where the CME on the two members is not from the same take.
-
-
CME adds/updates a schema version parameter automatically and stores a backup of the previous configuration file in the
autoprovision.json.bak_schema
file. -
To show the current schema version value, look for the schema value in the CME configuration:
autoprov_cfg show all
-
This is a read-only parameter.
-
This attribute ensures that only compatible CME runs with the given CME configuration.
Delay
-
The delay parameter sets the sleep time between CME iterations.
-
The default delay value is 30 seconds.
-
To see the current delay value, look for the delay value in the CME configuration:
autoprov_cfg show all
-
To edit the delay configuration, run:
autoprov_cfg set delay <NEW_TIME_IN_SEC>
Management
-
There is one Management configuration for CME.
-
The Management configuration applies to each controller and each template.
To see the current Management configurations, run:
autoprov_cfg show management
To edit the management configurations, run:
autoprov_cfg set management -h
Management Parameters
Parameter | Value |
Description |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
MANAGEMENT-NAME |
The name of this CME management configuration. This name must match the management name configured for each deployed scale set. Note - This name is configurable and not related to CPM management name. |
||||||||||||
|
DOMAIN: |
The domain name or the domain UID that manage CME. This parameter is mandatory for Multi-Domain Security Management Server environments when one domain manages CME. If more than one domain manages CME, you must remove this parameter and configure it in the controller part, as explained below in the controller section. |
||||||||||||
|
SCRIPT FULL PATH |
This parameter lets you set a custom script to execute on the Management Server in these scenarios:
In each of these scenarios, CME runs the script with different arguments, as listed in the table below:
Notes:
You can download an example of the Custom Management Script from here. To add parameters to the script, see |
Controllers (accounts)
-
To connect to your cloud account and automatically provision Security Gateways deployed in the account, the Security Management Server needs cloud-specific information, such as credentials and regions.
This information is related to a controller in the CME configuration.
-
To see the current controllers used by the Management Server connected to the cloud environments, run:
autoprov_cfg show controllers
-
To add a new controller to an existing CME configuration, run:
autoprov_cfg add controller {AWS,Azure,GCP,NSX,Nutanix}
-
To show the command help message, run:
autoprov_cfg add controller -h
|
|
Controllers (accounts) - General Parameters
Parameter | Value |
Description |
---|---|---|
|
CONTROLLER-NAME |
The name of the cloud environment controller. The name must be unique. |
|
DELETION-TOLERANCE |
The number of cycles until a Gateway object in SmartConsole Check Point GUI application used to manage a Check Point environment - configure Security Policies, configure devices, monitor products and events, install updates, and so on. is deleted. |
|
CONTROLLER TEMPLATES |
An optional list of templates that are linked to this specific controller. This parameter is mandatory for Multi-Domain Security Management Server environments with more than one domain configured. for example, TEMPLATE1-NAME TEMPLATE2-NAME |
|
CONTROLLER DOMAIN |
Specify the domain name or the domain UID that manages this controller. This parameter is mandatory for Multi-Domain Security Management Server environments with more than one domain configured. |
Controllers (accounts) - Parameters for AWS only
Parameter | Value |
Description |
---|---|---|
|
REGIONS |
A comma-separated list of AWS regions where the gateways are deployed. For example: eu-west-1,us-east-1,eu-central-1 |
|
AWS ACCESS KEY |
AWS Access Key ID |
|
AWS SECRET KEY |
AWS Secret Key |
|
- |
Use this flag to specify if you use an IAM role profile |
|
AWS CREDENTIALS FILE PATH |
The path to a text file with the AWS credentials |
|
STS ROLE |
The STS Role ARN of a role to assume |
|
STS EXTERNAL ID |
An optional STS External ID to use when assuming a role in the account |
|
SUB-CREDENTIALS NAME |
Sub account name. The name must be unique |
|
AWS SUB-CREDENTIALS ACCESS KEY |
AWS Access Key ID for the sub-account |
-ssk |
AWS SUB-CREDENTIALS SECRET KEY |
AWS Secret Key for a sub-account |
|
AWS SUB-CREDENTIALS FILE PATH |
The path to a text file containing AWS credentials for a sub-account |
|
- |
Use this flag to specify whether to use an IAM role profile for a sub-account |
|
AWS SUB-CREDENTIALS STS ROLE |
STS Role ARN of a role to assume for a sub-account |
|
AWS SUB-CREDENTIALS STS EXTERNAL ID |
An optional STS External ID to use when assuming a role in this sub-account |
|
COMMUNITIES |
An optional comma-separated list of communities which are allowed for VPN connections that this controller discovers. If this attribute is missing or its value is an empty list, any community may be joined by VPN connections that belong to this controller. This is useful to prevent an automatic addition of VPN connections to a community based on the customer gateway public IP address. |
|
- |
Use this flag to enable the auto-provisioning of VPN objects |
|
- |
Use this flag to enable the auto-provisioning of load balancer Access and NAT rules |
|
- |
Use this flag to enable scan subnets with Centralized GWLB solution |
Controllers (accounts) - Parameters for Azure only
Parameter | Value |
Description |
---|---|---|
|
SUBSCRIPTION ID |
The Azure subscription ID |
|
- |
An optional attribute that specifies Azure's environment type. The possible values are:
|
|
TENANT ID |
The Azure Active Directory tenant ID. |
|
CLIENT ID |
The service principal's client ID value. |
|
CLIENT SECRET |
The service principal's client secret value. |
Controllers (accounts) - Parameters for NSX only
Parameter | Value |
Description |
---|---|---|
|
NSX FINGERPRINT |
NSX-T manager fingerprint |
|
NSX MANAGER PASSWORD |
NSX-T manager password |
|
NSX MANAGER USERNAME |
NSX-T manager username |
|
NSX MANAGER HOST |
NSX-T manager host IP |
|
NSX SERVICE MANAGER PASSWORD |
NSX service manager password |
|
NSX AD AUTH |
NSX-T manager ad auth |
Controllers (accounts) - Parameters for Nutanix only
Parameter | Value |
Description |
---|---|---|
|
NUTANIX PRISM FINGERPRINT |
|
|
NUTANIX PRISM PASSWORD |
Nutanix Prism password |
|
NUTANIX PRISM USERNAME |
Nutanix Prism username |
|
NUTANIX PRISM IP |
Nutanix Prism IP |
Controllers (accounts) - Parameters for GCP only
Parameter | Value |
Description |
---|---|---|
|
GCP-PROJECT |
The GCP project ID of the project in which you deploy the CloudGuard Security Gateways. For example, " |
|
GCP-SERVICE-ACCOUNT-KEY |
Full path to GCP Service Account key file. The file must be in $FWDIR/conf and only have admin read permissions. For example, $FWDIR/conf/ACME-Production13cebb.json. |
|
GCP-SERVICE-ACCOUNT-DATA |
The content of GCP service account data encoded in base64. |
Configuration Templates (gateway-configurations)
-
Information required to automatically provision Security Gateways, such as what policy to install and which Software Blades to enable, is placed in a configuration template in the CME configuration.
-
To see the current configuration templates that you can apply on Security Gateways, run:
autoprov_cfg show templates
-
To add a new configuration template to an existing CME configuration, run the command:
autoprov_cfg add template -tn <CONFIGURATION-TEMPLATE-NAME> -otp <SIC-KEY> -ver <VERSION> -po <POLICY-NAME>
Configuring Name Prefix for Provisioned Gateways
By default, CME provisions the gateway objects using these naming conventions:
-
AWS:
<CONTROLLER-NAME>--<AUTO-SCALING-GROUP-NAME>--<REGION-NAME>
-
Azure:
<CONTROLLER-NAME>--<SCALE-SET-INSTANCE-NAME>--<RESOURCE-GROUP-NAME>
-
GCP:
<CONTROLLER-NAME>--<MANAGED-INSTANCE-GROUP-NAME>
-
Nutanix:
<CONTROLLER-NAME>--<VM-NAME>
-
NSX-T:
<CONTROLLER-NAME>--<VM-NAME>
To add the template name as a name prefix (that comes before the controller name), run:
|
To add a unique name as a name prefix (that comes before the controller name), run:
|
|
Note - Currently, the Automatic HF deployment does not support name-prefix. |
Configuring Network Group
CME automatically creates and updates a network group object with all the provisioned scale-set instances in the Security Management Server or Multi-Domain Security Management Server.
Network group object naming convention in the Security Management Server or Multi-Domain Security Management Server by cloud providers:
-
General: CME_<CONTROLLER-NAME>--<PLATFORM-UNIQUE-IDENTIFIER>
-
AWS: CME_<CONTROLLER-NAME>--<AUTO-SCALING-GROUP-NAME>--<REGION-NAME>
-
GCP: CME_<CONTROLLER-NAME>--<MANAGED-INSTANCE-GROUP-NAME>
-
Azure: CME_<CONTROLLER-NAME>--<SCALE-SET-NAME>--<RESOURCE-GROUP-NAME>
-
Nutanix: CME_<CONTROLLER-NAME>--<NETWORK-FUNCTION-PROVIDER>
-
NSX-T: CME_<CONTROLLER-NAME>--<REGISTERED-SERVICE-NAME>
|
Notes:
|
You can use the Network Group object in these policies and policy columns:
-
Access Control rule columns:
-
Source
-
Destination
-
Install On
-
-
NAT rule columns:
-
Original Source
-
Original Destination
-
|
Notes:
|
Default-features
Default-features is a section in the CME configuration. It contains Configuration Template attributes, which are enabled automatically for each new Configuration Template.
Default-features section:
-
Initializing CME with autoprov_cfg init creates/copies the Default-features section based on:
-
If there is no CME configuration on this server, the Default-features section is being created with the latest available Default features.
-
If there is a CME configuration on the server, the Default-features section is copied (if it exists) from the former configuration.
-
-
To see the existing Default-features, look for the Default-features value in the CME configuration:
autoprov_cfg show all
New template creation:
When you create a new Configuration Template, if the Default-features section exists, its attributes are automatically added to the template (without specifying its attributes in the command).
|
Note - If an attribute has version limitations, it is added automatically only if the template's versions is applicable for the attribute. |
To see the existing configuration template, run:
|
Enabling and Disabling Software Blades
See Supported Configuration Template parameters for parameter information.
Step |
Instructions |
||||
---|---|---|---|---|---|
1 |
Connect to the command line on the Security Management Server. |
||||
2 |
Log in to the Expert mode. |
||||
3 |
Enable the Software Blades: To enable one Software Blade at a time, run:
Example:
To enable multiple Software Blades at a time, run:
Example:
|
Step |
Instructions |
||||
---|---|---|---|---|---|
1 |
Connect to the command line on the Security Management Server. |
||||
2 |
Log in to the Expert mode. |
||||
3 |
Enable the Software Blades: To enable one Software Blade at a time, run:
Example:
To enable multiple Software Blades at a time, run:
Example:
|
Step |
Instructions |
---|---|
1 |
From the left navigation panel, click Gateways & Servers. |
2 |
Double-click the Security Gateway object. |
3 |
|
4 |
Click OK. |
5 |
Install the applicable policy on the Security Gateway. |
Autonomous Threat Prevention
Autonomous Threat Prevention is an innovative Threat Prevention management model. For more details, refer to the Threat Prevention Administration Guide for your version.
Auto Scaling instances do not support Threat Extraction and Zero Phishing software blades. Therefore, when enabling Autonomous Threat Prevention in CME, Zero-Phishing and Threat Extraction blades are inactivated in the Threat Prevention Global Exception rules.
CME API
With CME Management API you can configure the CME tool.
For more information, see the CME API SwaggerHub documentation.
Prerequisites:
-
CME Take 139 or higher installed on the Check Point Management Server.
-
Management API version 1.8 or higher installed on the Check Point Management Server (see the Check Point Management API Reference).
Configuring Identity Sharing
Identity Sharing lets Identity Awareness Security Gateways configured as Policy Decision Points (PDPs) retrieve identity information and share it with other Security Gateways acting as Policy Enforcement Points (PEPs). This feature reduces load on identity sources and enhances system performance.
Examples of Identity Sharing topologies:
Configuring Identity Sharing with the CME API
Starting from CME API v1.2.2, you can set up Identity Sharing for the Auto Scaling instances to let them receive identities from configured PDP Security Gateways. This feature is part of the Identity Awareness settings.
Prerequisites:
-
Set up static Identity Awareness Security Gateways as PDPs to share identities. For more information, see the Identity Sharing documentation.
-
Configure Auto Scaling instances template to receive identities from those PDP Security Gateways.
-
Make sure the PDP Security Gateways and Auto Scaling Security Gateway instances exist in the same domain for Multi-Domain Security Management deployments.
API Documentation:
-
SwaggerHub: CME API
-
Postman Collection: CME API Postman collection
To configure Identity Sharing with the CME API:
Send a POST request:
POST https://<Management_IP_address>/web_api/v1.8/cme-api/v1.2.2/gwConfigurations/<azure/gcp/aws>
Request body parameters for Identity Sharing:
Object |
Description |
||||||
---|---|---|---|---|---|---|---|
|
A container object that holds blades configuration parameters.
|
||||||
|
A container object that holds configuration parameters of the Identity Awareness blade.
|
|
Note - Enabling the Identity Awareness blade without setting the Identity Awareness Settings automatically enables the Web API identity source for the CloudGuard Controller ( |
Example:
POST request:
URL: POST https://<Management_IP_address>/web_api/v1.8/cme-api/v1.2.2/gwConfigurations/<azure/gcp/aws>
Body:
|
Configuring the tgw_menu
The Transit Gateway menu is a command-line based menu to configure the AWS Transit Gateway solution.
For more information, see the CloudGuard Network for AWS Transit Gateway R80.20 and Higher Deployment Guide.
Implied Rules and Restrictive Policy
A restrictive access policy package has only a drop-all cleanup rule. During Security Gateway provisioning cycle (scale out), CME can first install a restrictive policy package to prevent Security Gateway from answering load balancer's health probes.
-
CME Take 250 and higher:
Azure:
Gateway version
Load Balancer
Gateway Load Balancer
Application Gateway
All versions
SKIP
SKIP
INSTALL
AWS:
Gateway version
Network Load Balancer
Gateway Load Balancer
Application Load Balancer
R81.10 and higher
SKIP
SKIP
INSTALL
R81 and lower
INSTALL
SKIP
INSTALL
GCP
Gateway version
All Load Balancer types
R81.10 and higher
SKIP
R81 and lower
INSTALL
Private Cloud Vendors (NSX-T, Nutanix): CME installs restrictive policy on all solutions.
-
CME Take 250 and lower:
CME always installs restrictive policy.
For CME Takes lower than 250, if the Implied Rules are disabled, it is required to configure a custom restrictive policy package and to set it in the Configuration Template.
For more details, see:
If it is necessary to use the Multi-Domain Server 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. Global Policy together with automatic provisioning, see Global Policy on a Multi-Domain Server.