Skip to content

Commit

Permalink
UPDATED 2023-01-10-1600CST v00.60.12.100.275
Browse files Browse the repository at this point in the history
UPDATED 2023-01-10-1600CST v00.60.12.100.275
Interim Update
  • Loading branch information
mybasementcloud committed Jan 12, 2023
1 parent a55b41b commit a01ea8f
Show file tree
Hide file tree
Showing 130 changed files with 41,632 additions and 34,571 deletions.
14 changes: 7 additions & 7 deletions .environment_info.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"filetype" : "environmentment_info.api_scripts",
"fileversion" : "07.00.00",
"filerevision" : "000",
"filesubrevision" : "050",
"filedate" : "2022-10-27",
"filesubrevision" : "275",
"filedate" : "2023-01-10",
"fileinformationlevel" : "000",
"MinCMDTemplateVersion" : "07.00.00"
},
Expand All @@ -20,7 +20,7 @@
"Language" : "Windows_CMD",
"Extension" : "CMD"
},
"ScriptDate" : "2022-10-27",
"ScriptDate" : "2023-01-10",
"ScriptVersion" : "07.00.00",
"ScriptRevision" : "000",
"ScriptSubRevision" : "000",
Expand All @@ -32,15 +32,15 @@
"Language" : "bash",
"Extension" : "sh"
},
"ScriptDate" : "2022-10-27",
"ScriptDate" : "2023-01-10",
"ScriptVersion" : "00.60.12",
"ScriptRevision" : "000",
"ScriptSubRevision" : "050",
"ScriptRevision" : "100",
"ScriptSubRevision" : "275",
"ScriptTweak" : "000",
"TemplateVersion" : "00.60.12",
"APISubScriptsLevel" : "010",
"APISubScriptsVersion" : "00.60.12",
"APISubScriptsRevision" : "000"
"APISubScriptsRevision" : "100"
}

}

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions LIMITATIONS_and_CAVEATS.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# LIMITATIONS and CAVEATS

## UPDATED: 2022-10-27
## UPDATED: 2023-01-10

This document outlines limitations and caveats to the implementation of R8X API export, import, set-update, and delete scripts utilizing bash mgmt_cli commands.

## DISCLAIMER

This is a work in progress and may update irregularly.

The author is currently utilizing R81.10 with API version 1.8 and these limitations and caveats are based on current experience on this level of implementation for the R8X API.
The author is currently utilizing R81.20 with API version 1.9 and these limitations and caveats are based on current experience on this level of implementation for the R8X API.

Currently, R81.10 JHF OT 61 Take is implemented for testing
Currently, R81.20 GA T627 JHF N/A Take is implemented for testing

In some cases,

Expand Down Expand Up @@ -69,7 +69,7 @@ Basic function of tested without successful authentication, so more testing and

If the object does not provide a method to output a required key value during export, import may not provide that object's missing key value. If possible, a subsequent additional step may address the issue.

Currently RADIUS server object and RADIUS servers group object types do not exist, so details about RADIUS configuration for neither export, nor import are possible as of current implementation of API 1.7.
v00.60.12.100 - Currently RADIUS server object and RADIUS servers group object types do not exist in API versions prior to R81.20 GA API version 1.9, so details about RADIUS configuration for neither export, nor import are possible as of current implementation of API 1.8.1 [R81.20 with JHF 79] and earlier. Customers on version with API 1.9 and later have Radius Server and Radius Group objects.

### User Objects

Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ Check Point R8x Export, Import, Set/Update, Rename to new-name, and Delete mgmt_

Additional documentation and information will be provided in .md, .tsv, and potentially .xlsx files in the repository.

## UPDATED: 2022-10-27
## UPDATED: 2023-01-10

Interim update, reorganize the README.MD and add a Quick Start

## Overview

The export, import, set-update, rename-to-new-name, and delete using CSV files scripts in this post, currently version 00.60.12.000 dated 2022-10-27, are intended to allow operations on an existing R80, R80.10, R80.20[|.M1|.M2], R80.30, R80.40, R81, R81.10 and EA R81.20 [WIP (Work-In-Progress)]] Check Point management server (SMS or MDM) from bash expert mode on the Check Point management server host or another API enabled Check Point management server host instance (Check Point Gaia OS R8X) able to authenticate and reach the target management server host. Utilization from other LINUX releases is not supported, tested, or assumed to work.
The export, import, set-update, rename-to-new-name, and delete using CSV files scripts in this post, currently version 00.60.12.100 dated 2023-01-10, are intended to allow operations on an existing R80, R80.10, R80.20[|.M1|.M2], R80.30, R80.40, R81, R81.10 and R81.20 Check Point management server (SMS or MDSM MDS) from bash expert mode on the Check Point management server host or another API enabled Check Point management server host instance (Check Point Gaia OS R8X) able to authenticate and reach the target management server host. Utilization from other LINUX releases is not supported, tested, or assumed to work.

The current set of supported objects by API version is in the supported_objects.v00.60.12.100.tsv file described by the supported_objects.version.tsv.md document

- Check Point Management API documentation is here:
<https://sc1.checkpoint.com/documents/latest/APIs/index.html#introduction>
Expand Down Expand Up @@ -83,7 +85,7 @@ To quickly start working with the scripts, do the following.

Example: ```tar -xvf devops.dev.{version}.tgz```

```tar -xvf devops.dev.v00.60.12.000.tgz```
```tar -xvf devops.dev.v00.60.12.100.tgz```

4. Goto to the export import folder

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

What's NEW in Check Point R8x Export, Import, Set/Update, Rename to new-name, and Delete mgmt_cli API scripts for bash on Check Point Gaia OS management hosts, using CSV files (v00.60.xx.yyy)

## UPDATED: 2022-10-27
## UPDATED: 2023-01-10

Interim update

Expand All @@ -14,40 +14,57 @@ As of v00.60.11 this file will document major changes and additions to the versi

- Details of object type specific capabilities are documented in the supported_objects.{version}.tsv

### v00.60.12
## v00.60.12

- Added support for export of special objects and properties to json

- Added support for basic plumbing for delete, export, import, set/update, rename, and augment CSV files for special objects and properties via CSV

- Added support for per object | special object/properties specific control of utilization of "details-level", "ignore-errors", "ignore-warnings"
### v00.60.12 New Objects Supported

- Added support for Global Properties special object/properties for json export, when exporting domain other than "System Data", or on SMS

- Added support for Policy Settings special object/properties for json export, when exporting domain other than "System Data", or on SMS

- Added support for API Settings special object/properties for json export, when exporting domain "System Data"
- Added support for API Settings special object/properties for json export, when exporting domain "System Data" (also on SMS using domain "System Data")

- Modified CSV key value sets exported by default for application-site objects
- Addes support for Radius Server and Radius Group objects for API version 1.9 and later [R81.20 GA], for all operations

- Addes support for Repository Script objects for API version 1.9 and later [R81.20 GA], for all operations

- Addes support for SmartTasks objects for API version 1.9 and later [R81.20 GA], for all operations

- Added support for application-site objects url-list and additional-categories sub-CSV files (like group members), done in special objects export script or when enabling export of Critical Performance Impacting (CPI) objects

### v00.60.12 Operational Changes

- Added Command Line Parameters to handle specific domains: "System Data" and "Global", --domain-System-Data|--dSD|--dsd and --domain-Global|--dG|--dg respectively, to handle issues with operational scripts and passing quoted parameters with spaces, as well as easier domain specific execution.
- Added support for export of special objects and properties to json

- Added support for basic plumbing for delete, export, import, set/update, rename, and augment CSV files for special objects and properties via CSV

- Added support for application-site objects url-list and additional-categories sub-CSV files (like group members), done in special objects export script
- Added support for per object | special object/properties specific control of utilization of "details-level", "ignore-errors", "ignore-warnings"

- Modified CSV key value sets exported by default for application-site objects

- Added information more detailed error handling mgmt_cli and JQ calls, to help with identification of problems and performance related limitations

- Added object_operations script files for MDSM with max object limit configuration for 100 objects

### v00.60.11
- Added CLI parameters to determine handling of Critical Performance Impacting (CPI) objects, like application-site objects with > 10,000 Check Point provided objects to handle. Default mode is to exclude CPI objects from export operations

- Addresses issue where service objects that have aggressive aging settings need to be separated between those that are set to use the defautl time out and those that do not use the default timeout, which now generates explicit CSV files for each supported import operation, but also a dedicated reference export that combines all of that service time for review
## v00.60.11

- Addresses issue where TACACS Server object import needs specific information for TACACS versus TACACS+ configuration. Specific CSV files for each TACACS server type are generated for input, which also addresses the limitation that the API exports a value for TACACS+ that can't import. Also generate a consolidated reference export.

- Added support for objects to have an initial object specific selection criteria based on key and value data. Future expansion is possible.
### v00.60.11 New Objects Supported

- Added support for objects type smtp-servers from API version 1.9 (R81.20) forward

- Added support for objects type network-feeds from API version 1.9 (R81.20) forward

- Added support for objects type interoperable-devices from API version 1.9 (R81.20) forward

### v00.60.11 Operational Changes

- Addresses issue where service objects that have aggressive aging settings need to be separated between those that are set to use the defautl time out and those that do not use the default timeout, which now generates explicit CSV files for each supported import operation, but also a dedicated reference export that combines all of that service time for review

- Addresses issue where TACACS Server object import needs specific information for TACACS versus TACACS+ configuration. Specific CSV files for each TACACS server type are generated for input, which also addresses the limitation that the API exports a value for TACACS+ that can't import. Also generate a consolidated reference export.

- Added support for objects to have an initial object specific selection criteria based on key and value data. Future expansion is possible.

- Reference only exports now use standard name extension of "REFERENCE_DO_NOT_IMPORT" added to the regular name.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Version Implemented CLI Parameter Type Purpose/Meaning CLI Parameter(s) Export Import Set-Update Rename Delete CLI Sub-Parameter(s) Options Default Option/Action Environmental Parameter(s) Description Notes
Version Implemented CLI Parameter Type Purpose/Meaning CLI Parameter(s) Export Import Set-Update Rename Delete CLI Sub-Parameter(s) Options Default Option/Action Environmental Parameter(s) Description Notes - Last Updated 2023-01-10
00.00.00.000 Standard x x true true true true true - - OFF - x -
00.00.00.000 Standard Show Help -? | --help true true true true true N/A N/A OFF - Show Help Information -
00.00.00.000 Standard Verbose mode -v | --verbose true true true true true N/A N/A OFF VERBOSEMODE {true|false} Show Verbose Details in Logging and Display -
Expand All @@ -11,6 +11,8 @@ Version Implemented CLI Parameter Type Purpose/Meaning CLI Parameter(s) Export I
00.60.08.000 Standard Set API Context --context <web_api|gaia_api|{MaaSGUID}/web_api> | --context=<web_api|gaia_api|{MaaSGUID}/web_api> true true true true true <api _context> <web_api|gaia_api|{MaaSGUID}/web_api> web_api - Context for API operation Management API requires either option <web_api> or <{MaaSGUID}/web_api> for Smart-1 Cloud (MaaS)
00.00.00.000 Standard Set [web ssl] Port -P <web-ssl-port> | --port <web-ssl-port> | -P=<web-ssl-port> | --port=<web-ssl-port> true true true true true <web-ssl-port> Port 1 - 65K host web ssl port - Gaia / API web ssl port used for API communication script will figure this value out when running against the local management host
00.00.00.000 Standard Set Management Server IP -m <server_IP> | --management <server_IP> | -m=<server_IP> | --management=<server_IP> true true true true true <server_IP> IP v4 Address OFF - IP Address (IP v4) of the target management host server -
00.60.12.100 Standard Set Management Domain "System Data" --domain-System-Data | --dSD | --dsd true true true true true N/A N/A OFF - MDSM Domain to operate API activity agains "System Data" Added to enable operations scripting
00.60.12.100 Standard Set Management Domain "Global" --domain-Global | --dG | --dg true true true true true N/A N/A OFF - MDSM Domain to operate API activity agains "Global" Added to enable operations scripting
00.00.00.000 Standard Set Management Domain -d <domain> | --domain <domain> | -d=<domain> | --domain=<domain> true true true true true <domain> MDSM Domain OFF - MDSM Domain to operate API activity against -
00.00.00.000 Standard Set session file path -s <session_file_filepath> | --session-file <session_file_filepath> | -s=<session_file_filepath> | --session-file=<session_file_filepath> true true true true true <session_file_filepath> FQFP to session file script local - Session file, Fully Qualified File Path, for storage of session details This is for retaining information on a session in the event of failure that prevents log-off. session_file_filepath = fully qualified file path (FQFP) for session file
00.00.00.000 Standard Set session timeout value --session-timeout <session_time_out> | --session-timeout=<session_time_out> true true true true true <session_time_out> 600 [ 10 - 3600 ] seconds 600 - Session Time Out value Default = 600 seconds, allowed range of values 10 - 3600 seconds
Expand All @@ -31,6 +33,8 @@ Version Implemented CLI Parameter Type Purpose/Meaning CLI Parameter(s) Export I
00.60.00.000 Standard Details level for json --details <all|full|standard> | --DETAILSLEVEL <all|full|standard> | --details=<all|full|standard> | --DETAILSLEVEL=<all|full|standard> true false false false false <all|full|standard> all|full|standard all - Details level for json
00.60.00.000 Standard Use devops results path --RESULTS | --DEVOPSRESULTS true true true true true - - OFF - Use devops results path
00.60.00.000 Standard Set results output path --RESULTSPATH <results_path> | --RESULTSPATH=<results_path> | --DEVOPSRESULTSPATH <results_path> | --DEVOPSRESULTSPATH=<results_path> true true true true true <results_path> FQDP to results folder OFF - Set results output path results_path = fully qualified folder path for devops results folder
00.60.12.100 Standard Override to Export of Critical Performance Impact (CPI) Objects --DO-CPI | --Override-Critical-Performance-Impact true false false false false - - OFF - Override default Critical Performance Impact (CPI) objects handling Override to execute Export of Critical Performance Impact (CPI) objects
00.60.12.100 Standard No Export or Critical Performance Impact (CPI) Objects --NO-CPI | --NO-Critical-Performance-Impact true false false false false - - ON - Critical Performance Impact (CPI) objects handling Default to not execute Export of Critical Performance Impact (CPI) objects -
00.30.00.000 Standard Export System Objects --SO | --system-objects true false false false false - - default mode - Export System Objects -
00.30.00.000 Standard NO System Objects Export --NSO | --no-system-objects true false false false false - - OFF - NO System Objects Export -
00.60.09.000 Standard ONLY System Objects Export --OSO | --only-system-objects true false false false false - - OFF - ONLY System Objects Export -
Expand Down
Binary file removed devops.dev.only.v00.60.12.000.050.tgz
Binary file not shown.
Binary file added devops.dev.only.v00.60.12.100.275.tgz
Binary file not shown.
Binary file removed devops.dev.v00.60.12.000.050.tgz
Binary file not shown.
Binary file added devops.dev.v00.60.12.100.275.tgz
Binary file not shown.
14 changes: 7 additions & 7 deletions devops.dev/.environment_info.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"filetype" : "environmentment_info.api_scripts",
"fileversion" : "07.00.00",
"filerevision" : "000",
"filesubrevision" : "050",
"filedate" : "2022-10-27",
"filesubrevision" : "275",
"filedate" : "2023-01-10",
"fileinformationlevel" : "000",
"MinCMDTemplateVersion" : "07.00.00"
},
Expand All @@ -20,7 +20,7 @@
"Language" : "Windows_CMD",
"Extension" : "CMD"
},
"ScriptDate" : "2022-10-27",
"ScriptDate" : "2023-01-10",
"ScriptVersion" : "07.00.00",
"ScriptRevision" : "000",
"ScriptSubRevision" : "000",
Expand All @@ -32,15 +32,15 @@
"Language" : "bash",
"Extension" : "sh"
},
"ScriptDate" : "2022-10-27",
"ScriptDate" : "2023-01-10",
"ScriptVersion" : "00.60.12",
"ScriptRevision" : "000",
"ScriptSubRevision" : "050",
"ScriptRevision" : "100",
"ScriptSubRevision" : "275",
"ScriptTweak" : "000",
"TemplateVersion" : "00.60.12",
"APISubScriptsLevel" : "010",
"APISubScriptsVersion" : "00.60.12",
"APISubScriptsRevision" : "000"
"APISubScriptsRevision" : "100"
}

}
Loading

0 comments on commit a01ea8f

Please sign in to comment.