# Check Point - Harmony Endpoint Management CLI
[](https://github.com/CheckPointSW/harmony-endpoint-management-cli/blob/release/LICENSE) [](https://github.com/CheckPointSW/harmony-endpoint-management-cli/releases) [](https://pypi.org/project/chkp-harmony-endpoint-management-cli/)
<!--
Coming soon :)
[](https://github.com/CheckPointSW/harmony-endpoint-management-cli/stargazers) -->
[](https://github.com/CheckPointSW/harmony-endpoint-management-cli/actions/workflows/build.yaml) [](https://github.com/CheckPointSW/harmony-endpoint-management-cli/actions/workflows/release.yml)
This is the Harmony Endpoint management CLI
The CLI is based on the public [Harmony Endpoint management OpenAPI](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production) specifications.
With the CLI, you do not have to manage log in, send keep alive requests, worry about session expiration or pull long processing jobs.
---
🚧🚧🚧
**Note that the CLI is in Early Availability (EA). Use with caution, as it may undergo changes and improvements. Feedback and contributions are highly encouraged.**
To report a bug, please go to [Report Bug](#-report-bug)
For feedback, please get in touch with us at [Check Point Software Technologies Ltd.](mailto:harmony-endpoint-external-api@checkpoint.com)
🚧🚧🚧
---
## ⬇️ CLI Download
To start using this CLI, install it via PIP (PyPi registry) as a global python command
```bash
pip install chkp-harmony-endpoint-management-cli
```
## 🚀 Getting started
First of all, need to create CloudInfra API credentials, to obtain it, open the Infinity Portal and create a suitable API Key. Make sure to select `Endpoint` in the `Service` field. For more information, see [Infinity Portal Administration Guide](https://sc1.checkpoint.com/documents/Infinity_Portal/WebAdminGuides/EN/Infinity-Portal-Admin-Guide/Content/Topics-Infinity-Portal/API-Keys.htm?tocpath=Global%20Settings%7C_____7#API_Keys).
Once the Client ID, Secret Key, and Authentication URL are obtained, Harmony Endpoint CLI can be used.
Before starting, run the help command to understand how to pass the operation's parameters and payload with all the available options.
```bash
chkp_harmony_endpoint_management_cli --help
```
All available operations can be shown by the command:
```bash
chkp_harmony_endpoint_management_cli --print-operations
```
The credentials are recommended to be passed to the CLI by the environment variables `CP_CI_CLIENT_ID` `CP_CI_ACCESS_KEY` `CP_CI_GATEWAY`.
But CLI also supports passing by params `--client-id` `--access-key` `--gateway` params.
To call an operation, set `--operation` with value from one of the available operations and pass the herders/query/path/body params if required
For example, the operation `get_all_rules_metadata` requires header for job, so it will look like that:
```bash
chkp_harmony_endpoint_management_cli --operation get_all_rules_metadata --header-params "{ \"x-mgmt-run-as-job\": \"off\"}"
```
In case additional payload can be sent, in this example the rule family by query param:
```bash
chkp_harmony_endpoint_management_cli --operation get_all_rules_metadata --query-params "{\"ruleFamily\" : \"Threat Prevention\"}" --header-params "{ \"x-mgmt-run-as-job\": \"off\"}"
```
All APIs and the optional/required parameters can be explored in [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production)
### ☁️ Cloud & MSSP services APIs
Harmony Endpoint also provides APIs for MSSP and Cloud service management (relevant to SaaS customers only)
The usage is similar to the management API, just need to change default target by `--target saas`
All available operations can be shown by the command:
```bash
chkp_harmony_endpoint_management_cli --print-operations --target saas
```
For example, the `public_machines_single_status` operation to get service state:
```bash
chkp_harmony_endpoint_management_cli --operation public_machines_single_status --target saas
```
Full API exploration available at [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/harmony-endpoint-cloud-api-prod)
## 🔍 Troubleshooting and logging
The full version and build info of the SDK is available by `--info` see example:
```bash
chkp_harmony_endpoint_management_cli --info
```
The output should be similar to:
```text
Check Point - Harmony Endpoint Management CLI
CLI - version: "1.1.0" build: "11905935"
Cloud SDK - sdk_build:"11902935", sdk_version:"1.1.28", spec:"web-mgmt-external-api-production", spec_version:"1.9.211", released_on:"2024-03-06T17:43:38.616492"
SaaS SDK - sdk_build:"11902935", sdk_version:"1.1.28", spec:"harmony-endpoint-cloud-api-prod", spec_version:"1.0.665", released_on:"2024-03-06T17:43:38.618196"
```
Harmony Endpoint Management CLI allows to print verbose logs.
There are 3 loggers, for general info, errors and to inspect network.
As default, they will be disabled, to enable logging, pass `--verbose` param with the following value:
```bash
chkp_harmony_endpoint_management_cli --verbos *
```
And for a specific logger set the logger name followed by a command as following:
```bash
chkp_harmony_endpoint_management_cli --verbos info
chkp_harmony_endpoint_management_cli --verbos error
chkp_harmony_endpoint_management_cli --verbos network
```
## 🐞 Report Bug
In case of an issue or a bug found in the CLI, please open an [issue](https://github.com/CheckPointSW/harmony-endpoint-management-cli/issues) or report to us [Check Point Software Technologies Ltd](mailto:harmony-endpoint-external-api@checkpoint.com).
## 🤝 Contributors
- Haim Kastner - [chkp-haimk](https://github.com/chkp-haimk)
- Yuval Pomerchik - [chkp-yuvalpo](https://github.com/chkp-yuvalpo)
Raw data
{
"_id": null,
"home_page": "https://github.com/CheckPointSW/harmony-endpoint-management-cli",
"name": "chkp-harmony-endpoint-management-cli",
"maintainer": "Haim Kastner",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "haimk@checkpoint.com",
"keywords": "harmony, endpoint, cli, checkpoint",
"author": "Haim Kastner",
"author_email": "haimk@checkpoint.com",
"download_url": "https://files.pythonhosted.org/packages/1c/97/c2f2cec36548ab1fe8059e52147aea9504050724796b5dc6d7bd71d76e47/chkp-harmony-endpoint-management-cli-1.0.19.tar.gz",
"platform": null,
"description": "# Check Point - Harmony Endpoint Management CLI\n\n[](https://github.com/CheckPointSW/harmony-endpoint-management-cli/blob/release/LICENSE) [](https://github.com/CheckPointSW/harmony-endpoint-management-cli/releases) [](https://pypi.org/project/chkp-harmony-endpoint-management-cli/)\n\n\n<!-- \nComing soon :)\n\n[](https://github.com/CheckPointSW/harmony-endpoint-management-cli/stargazers) -->\n\n[](https://github.com/CheckPointSW/harmony-endpoint-management-cli/actions/workflows/build.yaml) [](https://github.com/CheckPointSW/harmony-endpoint-management-cli/actions/workflows/release.yml)\n\nThis is the Harmony Endpoint management CLI\n\nThe CLI is based on the public [Harmony Endpoint management OpenAPI](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production) specifications.\n\nWith the CLI, you do not have to manage log in, send keep alive requests, worry about session expiration or pull long processing jobs.\n\n---\n\ud83d\udea7\ud83d\udea7\ud83d\udea7\n\n**Note that the CLI is in Early Availability (EA). Use with caution, as it may undergo changes and improvements. Feedback and contributions are highly encouraged.**\n\nTo report a bug, please go to [Report Bug](#-report-bug)\n\nFor feedback, please get in touch with us at [Check Point Software Technologies Ltd.](mailto:harmony-endpoint-external-api@checkpoint.com)\n\n\ud83d\udea7\ud83d\udea7\ud83d\udea7\n\n---\n\n## \u2b07\ufe0f CLI Download\n\nTo start using this CLI, install it via PIP (PyPi registry) as a global python command\n```bash \npip install chkp-harmony-endpoint-management-cli\n```\n\n## \ud83d\ude80 Getting started\n\nFirst of all, need to create CloudInfra API credentials, to obtain it, open the Infinity Portal and create a suitable API Key. Make sure to select `Endpoint` in the `Service` field. For more information, see [Infinity Portal Administration Guide](https://sc1.checkpoint.com/documents/Infinity_Portal/WebAdminGuides/EN/Infinity-Portal-Admin-Guide/Content/Topics-Infinity-Portal/API-Keys.htm?tocpath=Global%20Settings%7C_____7#API_Keys).\n\nOnce the Client ID, Secret Key, and Authentication URL are obtained, Harmony Endpoint CLI can be used.\n\nBefore starting, run the help command to understand how to pass the operation's parameters and payload with all the available options.\n```bash\nchkp_harmony_endpoint_management_cli --help\n```\n\nAll available operations can be shown by the command:\n```bash\nchkp_harmony_endpoint_management_cli --print-operations\n```\n\nThe credentials are recommended to be passed to the CLI by the environment variables `CP_CI_CLIENT_ID` `CP_CI_ACCESS_KEY` `CP_CI_GATEWAY`.\n\nBut CLI also supports passing by params `--client-id` `--access-key` `--gateway` params.\n\nTo call an operation, set `--operation` with value from one of the available operations and pass the herders/query/path/body params if required\n\nFor example, the operation `get_all_rules_metadata` requires header for job, so it will look like that:\n```bash\nchkp_harmony_endpoint_management_cli --operation get_all_rules_metadata --header-params \"{ \\\"x-mgmt-run-as-job\\\": \\\"off\\\"}\"\n```\n\nIn case additional payload can be sent, in this example the rule family by query param: \n```bash\nchkp_harmony_endpoint_management_cli --operation get_all_rules_metadata --query-params \"{\\\"ruleFamily\\\" : \\\"Threat Prevention\\\"}\" --header-params \"{ \\\"x-mgmt-run-as-job\\\": \\\"off\\\"}\"\n```\n\nAll APIs and the optional/required parameters can be explored in [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production)\n\n### \u2601\ufe0f Cloud & MSSP services APIs\n\nHarmony Endpoint also provides APIs for MSSP and Cloud service management (relevant to SaaS customers only)\n\n\nThe usage is similar to the management API, just need to change default target by `--target saas`\n\nAll available operations can be shown by the command:\n```bash\nchkp_harmony_endpoint_management_cli --print-operations --target saas\n```\n\nFor example, the `public_machines_single_status` operation to get service state:\n```bash\nchkp_harmony_endpoint_management_cli --operation public_machines_single_status --target saas\n```\n\nFull API exploration available at [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/harmony-endpoint-cloud-api-prod)\n\n## \ud83d\udd0d Troubleshooting and logging\n\nThe full version and build info of the SDK is available by `--info` see example:\n```bash\nchkp_harmony_endpoint_management_cli --info\n```\nThe output should be similar to:\n```text\nCheck Point - Harmony Endpoint Management CLI\n CLI - version: \"1.1.0\" build: \"11905935\"\n Cloud SDK - sdk_build:\"11902935\", sdk_version:\"1.1.28\", spec:\"web-mgmt-external-api-production\", spec_version:\"1.9.211\", released_on:\"2024-03-06T17:43:38.616492\"\n SaaS SDK - sdk_build:\"11902935\", sdk_version:\"1.1.28\", spec:\"harmony-endpoint-cloud-api-prod\", spec_version:\"1.0.665\", released_on:\"2024-03-06T17:43:38.618196\"\n```\n\nHarmony Endpoint Management CLI allows to print verbose logs.\n\nThere are 3 loggers, for general info, errors and to inspect network.\n\nAs default, they will be disabled, to enable logging, pass `--verbose` param with the following value:\n```bash\nchkp_harmony_endpoint_management_cli --verbos *\n```\n\nAnd for a specific logger set the logger name followed by a command as following:\n```bash\nchkp_harmony_endpoint_management_cli --verbos info\nchkp_harmony_endpoint_management_cli --verbos error\nchkp_harmony_endpoint_management_cli --verbos network\n```\n\n## \ud83d\udc1e Report Bug\n\nIn case of an issue or a bug found in the CLI, please open an [issue](https://github.com/CheckPointSW/harmony-endpoint-management-cli/issues) or report to us [Check Point Software Technologies Ltd](mailto:harmony-endpoint-external-api@checkpoint.com).\n\n## \ud83e\udd1d Contributors\n- Haim Kastner - [chkp-haimk](https://github.com/chkp-haimk)\n- Yuval Pomerchik - [chkp-yuvalpo](https://github.com/chkp-yuvalpo)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Harmony Endpoint Official CLI",
"version": "1.0.19",
"project_urls": {
"Homepage": "https://github.com/CheckPointSW/harmony-endpoint-management-cli"
},
"split_keywords": [
"harmony",
" endpoint",
" cli",
" checkpoint"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71ab3d5ad448c45876fb5d316f762cbf77cfe1e95629e7cfeab57e3b5944d4d6",
"md5": "fe42f1a6459e5b2da2a9e9ff029f541b",
"sha256": "755cf732a208888949d6c3c3116539d3176f983ba9497ef2539ea2e12e2104ce"
},
"downloads": -1,
"filename": "chkp_harmony_endpoint_management_cli-1.0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe42f1a6459e5b2da2a9e9ff029f541b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 9271,
"upload_time": "2024-04-09T11:07:57",
"upload_time_iso_8601": "2024-04-09T11:07:57.977378Z",
"url": "https://files.pythonhosted.org/packages/71/ab/3d5ad448c45876fb5d316f762cbf77cfe1e95629e7cfeab57e3b5944d4d6/chkp_harmony_endpoint_management_cli-1.0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c97c2f2cec36548ab1fe8059e52147aea9504050724796b5dc6d7bd71d76e47",
"md5": "6fa6cadec5eefa049cb57841b48ba246",
"sha256": "927541fd3cfa94eae9b929e7b23b7e15c55c1b9fb67f7137d58b0abadcb2a428"
},
"downloads": -1,
"filename": "chkp-harmony-endpoint-management-cli-1.0.19.tar.gz",
"has_sig": false,
"md5_digest": "6fa6cadec5eefa049cb57841b48ba246",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 10176,
"upload_time": "2024-04-09T11:07:59",
"upload_time_iso_8601": "2024-04-09T11:07:59.184400Z",
"url": "https://files.pythonhosted.org/packages/1c/97/c2f2cec36548ab1fe8059e52147aea9504050724796b5dc6d7bd71d76e47/chkp-harmony-endpoint-management-cli-1.0.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 11:07:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CheckPointSW",
"github_project": "harmony-endpoint-management-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "chkp-harmony-endpoint-management-cli"
}
JSON
