topic Re: Functionality - API vs. SmartConsole in API / CLI Discussion

Functionality - API vs. SmartConsole

Timothy_Hall — Mon, 04 Sep 2023 17:21:08 GMT

Edit: The version of this article updated for R81.20 is available here.

When teaching the Check Point Certified Automation Specialist (CCAS) class, a common question I get is what types of Management operations cannot be performed through the API and must be performed through the SmartConsole GUI instead. I have a bit of an unofficial list but would like to compile an authoritative list with the CheckMates community; various API limitations have been discussed in prior threads like this. Some ground rules:

1) Only releases that are GA like R80.40 and earlier may be discussed, so if an API limitation is resolved in an upcoming release like R81 that doesn't count

2) dbedit is not the API and doesn't really count, but feel free to discuss workarounds for the various limitations

3) This list of limitations is for the Management API, not the Threat Prevention API, Identity Awareness API, etc.

4) Features available through the API that are not available in the SmartConsole GUI (like specific Hit Count history) should not be included (that could be a separate post)

So without further ado, here is the list of Management operations that cannot be performed via the Management API and must be performed through a GUI instead, please feel free to add items to this list or provide corrections:

1) Manipulation of gateway cluster objects Edit: Added in R80.40 API (v1.6)

2) Geo Policy Edit: Geo Updatable objects can be accessed via API starting in v1.3

3) HTTPS Inspection Edit: HTTPS Inspection Policy can be configured/accessed via API in R80.40+ (v1.6)

4) Mobile Access Blade Configuration

5) Anti-spam & Mail Blade Configuration

6) DLP Blade (not Content Awareness)

7) SmartEvent Event Policy Tuning (performed in a separate GUI from SmartConsole)

8) SmartUpdate License Manipulation (performed in a separate GUI from SmartConsole) Edit: Could use run-script call to execute cplic operations as a "one-time" script, added in API 1.9. In earlier releases can do add repository-script then run-script script-name.

9) QoS Blade/Policies (not APCL/URLF Limits)

10) GUIDBedit Operations (performed in a separate GUI from SmartConsole) Edit: Could use run-script call to execute dbedit operations as a "one-time" script, added in API 1.9. In earlier releases can do add repository-script then run-script script-name from repository.

11) Performing an Install Database operation for an SMS/MDS Edit: Added in R80.40 API (v1.6)

12) Creating/Manipulating Interoperable VPN Objects (can partially be done with generic-object APIs) Edit: Added in R81.20 API (v1.9)

13) Creation and Manipulation of Account Unit Objects

14) Creation and Manipulation of Legacy User@Host Objects (not Access Roles)

15) Creation and Manipulation of Legacy UFP/CVP Objects (which are deprecated in R80.x anyway)

16) Manipulation of Geo Policy (deprecated in R81, use Geo Updatable Objects which are supported via API).

16) Endpoint Policies

17) Add/manipulate Content Awareness Data Types

18) Not all properties under Global Properties Advanced...Configure seem to be available.

19) Status & Traffic/System Counters report on Gateways & Servers tab (could use cpstat command to get this information)

20) Manipulation of Inspection Settings

21) Manage & Settings..Blades Advanced Settings

22) Smart Tasks (can only show them)

23) Create/Manipulate UserChecks

24) APCL/URLF Limit Actions

Thanks everyone!

Re: Functionality - API vs. SmartConsole

PhoneBoy — Fri, 05 Jul 2019 23:25:30 GMT

It's a good starting list.
There are a few others that don't have official APIs but may be (partially) accomplished using generic-object APIs.

1. Creating interoperable VPN objects (can partially be done with generic-object APIs)
2. LDAP objects
3. User@Host objects
4. Legacy UFP/CVP objects (which are deprecated in R80.x anyway)
5. Endpoint policies

Re: Functionality - API vs. SmartConsole

Paul_Nokel — Tue, 09 Jul 2019 06:55:41 GMT

Hi,

this list can be really useful and help planning automation tasks.

The point that I miss the most:

- Almost anything related to IPS. Including excpetions.

Best regards,

Paul

Re: Functionality - API vs. SmartConsole

JozkoMrkvicka — Sun, 18 Aug 2019 21:09:28 GMT

Not really SmartConsole related (even not for Managements), but following APIs would be also really great:

1. Complete FTW (First Time Wizard) via API
2. Add/Remove/Modify licenses via API
3. Configure RADIUS, NTP, SYSLOG, DNS, routes, VLANs, DHCP via API (partially included in Ender - Gaia REST API )

Re: Functionality - API vs. SmartConsole

PhoneBoy — Thu, 05 Sep 2019 14:38:32 GMT

IPS is part of the overall Threat Prevention policy in R80.x, which definitely has API support.

Re: Functionality - API vs. SmartConsole

PhoneBoy — Thu, 05 Sep 2019 14:43:57 GMT

We can potentially remove Cluster Objects and HTTPS Inspection from this list in R80.40, based on the current EA feature set.
Geo Policy should be done using Updatable Objects in R80.20+, which is inherently more flexible than the traditional Geo Policy.
Mobile Access Blade is partially supported by API in R80.x if you use the unified policy approach.

Re: Functionality - API vs. SmartConsole

FedericoMeiners — Thu, 05 Sep 2019 20:43:12 GMT

Associate interfaces to security zones? I couldn't find it neither in mgmt_cli or vsx_util

Re: Functionality - API vs. SmartConsole

PhoneBoy — Thu, 05 Sep 2019 21:32:08 GMT

This is definitely doable using set simple-gateway.
It's one of the parameters you pass when modifying an interface, e.g. security-zone-settings
If you have a specific question about this, I highly recommend starting a new thread.

Re: Functionality - API vs. SmartConsole

Francesco-P — Sat, 26 Oct 2019 19:23:58 GMT

Hi,

just to add the useful "Replace feature" available under "where used" in SmartConsole and not in api call.
Btw, this action is possible with some script