| Name | scm-config-clone JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A command-line tool to clone configuration objects between Palo Alto Networks Strata Cloud Manager (SCM) tenants. |
| upload_time | 2024-10-08 15:31:40 |
| maintainer | None |
| docs_url | None |
| author | Calvin Remsburg |
| requires_python | <4.0,>=3.10 |
| license | Apache 2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SCM Config Clone
[](https://github.com/cdot65/scm-config-clone/actions/workflows/ci.yml)
[](https://badge.fury.io/py/scm-config-clone)
[](https://pypi.org/project/scm-config-clone/)
[](https://github.com/cdot65/scm-config-clone/blob/main/LICENSE)
A command-line tool to clone configuration objects between Palo Alto Networks Strata Cloud Manager (SCM) tenants.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Clone Address Objects](#clone-address-objects)
- [Clone Address Groups](#clone-address-groups)
- [Create Secrets File](#create-secrets-file)
- [Contributing](#contributing)
- [License](#license)
- [Support](#support)
## Features
- **Effortless Cloning**: Seamlessly clone address objects and address groups from one SCM tenant to another.
- **User-Friendly CLI**: Built with [Typer](https://typer.tiangolo.com/) for an intuitive command-line experience.
- **Secure Authentication**: Generate a `.secrets.yaml` file to securely store your SCM credentials.
- **Customizable Folders**: Specify source and destination folders to organize your configurations.
- **Extensible Design**: Structured to allow easy addition of new commands and features in the future.
## Installation
**Requirements**:
- Python 3.10 or higher
Install the package via pip:
```bash
pip install scm-config-clone
```
## Usage
The `scm-clone` utility offers several commands:
- [`clone-address-objects`](#clone-address-objects): Clone address objects between SCM tenants.
- [`clone-address-groups`](#clone-address-groups): Clone address groups between SCM tenants.
- [`create-secrets-file`](#create-secrets-file): Generate a secrets file for authentication.
### Clone Address Objects
Clone address objects from the source SCM tenant to the destination tenant.
```bash
scm-clone clone-address-objects --settings-file <path_to_secrets_yaml>
```
**Options**:
- `--settings-file`, `-s`: Path to the YAML file containing SCM credentials (default: `.secrets.yaml`).
**Example**:
```bash
scm-clone clone-address-objects
```
**Sample Output**:
```
Starting address objects migration...
Retrieved 15 address objects from source.
Successfully created 15 address objects in destination.
Address objects migration completed successfully.
```
### Clone Address Groups
Clone address groups from the source SCM tenant to the destination tenant.
```bash
scm-clone clone-address-groups --settings-file <path_to_secrets_yaml>
```
**Options**:
- `--settings-file`, `-s`: Path to the YAML file containing SCM credentials (default: `.secrets.yaml`).
**Example**:
```bash
scm-clone clone-address-groups
```
**Sample Output**:
```
Starting address groups migration...
Retrieved 8 address groups from source.
Successfully created 8 address groups in destination.
Address groups migration completed successfully.
```
### Create Secrets File
Generate a `.secrets.yaml` file to store your SCM credentials securely.
```bash
scm-clone create-secrets-file --output-file <path_to_secrets_yaml>
```
**Options**:
- `--output-file`, `-o`: Path where the secrets YAML file will be saved (default: `.secrets.yaml`).
**Example**:
```bash
scm-clone create-secrets-file
```
**Sample Interaction**:
```
Creating authentication file...
Enter source Strata Cloud Manager credentials:
Source Client ID: <your_source_client_id>
Source Client Secret: <your_source_client_secret>
Source Tenant TSG: <your_source_tsg>
Source Folder [Prisma Access]:
Enter destination Strata Cloud Manager credentials:
Destination Client ID: <your_destination_client_id>
Destination Client Secret: <your_destination_client_secret>
Destination Tenant TSG: <your_destination_tsg>
Destination Folder [Prisma Access]:
Token URL [https://auth.apps.paloaltonetworks.com/oauth2/access_token]:
Authentication file written to .secrets.yaml
Authentication file created successfully.
```
## Contributing
We welcome contributions! To contribute:
1. Fork the repository.
2. Create a new feature branch (`git checkout -b feature/your-feature`).
3. Commit your changes (`git commit -m 'Add new feature'`).
4. Push to your branch (`git push origin feature/your-feature`).
5. Open a Pull Request.
Ensure your code adheres to the project's coding standards and includes tests where appropriate.
## License
This project is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for details.
## Support
For support and questions, please refer to the [SUPPORT.md](./SUPPORT.md) file in this repository.
---
*Detailed documentation will be provided on our GitHub Pages site soon.*
Raw data
{
"_id": null,
"home_page": null,
"name": "scm-config-clone",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Calvin Remsburg",
"author_email": "calvin@cdot.io",
"download_url": "https://files.pythonhosted.org/packages/10/a1/2c27412b30a2de9c2fb4dd9ea55f7b3b81f0f95f856a9a3a5cf9921e19fd/scm_config_clone-0.1.1.tar.gz",
"platform": null,
"description": "# SCM Config Clone\n\n\n\n[](https://github.com/cdot65/scm-config-clone/actions/workflows/ci.yml)\n[](https://badge.fury.io/py/scm-config-clone)\n[](https://pypi.org/project/scm-config-clone/)\n[](https://github.com/cdot65/scm-config-clone/blob/main/LICENSE)\n\nA command-line tool to clone configuration objects between Palo Alto Networks Strata Cloud Manager (SCM) tenants.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n - [Clone Address Objects](#clone-address-objects)\n - [Clone Address Groups](#clone-address-groups)\n - [Create Secrets File](#create-secrets-file)\n- [Contributing](#contributing)\n- [License](#license)\n- [Support](#support)\n\n## Features\n\n- **Effortless Cloning**: Seamlessly clone address objects and address groups from one SCM tenant to another.\n- **User-Friendly CLI**: Built with [Typer](https://typer.tiangolo.com/) for an intuitive command-line experience.\n- **Secure Authentication**: Generate a `.secrets.yaml` file to securely store your SCM credentials.\n- **Customizable Folders**: Specify source and destination folders to organize your configurations.\n- **Extensible Design**: Structured to allow easy addition of new commands and features in the future.\n\n## Installation\n\n**Requirements**:\n\n- Python 3.10 or higher\n\nInstall the package via pip:\n\n```bash\npip install scm-config-clone\n```\n\n## Usage\n\nThe `scm-clone` utility offers several commands:\n\n- [`clone-address-objects`](#clone-address-objects): Clone address objects between SCM tenants.\n- [`clone-address-groups`](#clone-address-groups): Clone address groups between SCM tenants.\n- [`create-secrets-file`](#create-secrets-file): Generate a secrets file for authentication.\n\n### Clone Address Objects\n\nClone address objects from the source SCM tenant to the destination tenant.\n\n```bash\nscm-clone clone-address-objects --settings-file <path_to_secrets_yaml>\n```\n\n**Options**:\n\n- `--settings-file`, `-s`: Path to the YAML file containing SCM credentials (default: `.secrets.yaml`).\n\n**Example**:\n\n```bash\nscm-clone clone-address-objects\n```\n\n**Sample Output**:\n\n```\nStarting address objects migration...\nRetrieved 15 address objects from source.\nSuccessfully created 15 address objects in destination.\nAddress objects migration completed successfully.\n```\n\n### Clone Address Groups\n\nClone address groups from the source SCM tenant to the destination tenant.\n\n```bash\nscm-clone clone-address-groups --settings-file <path_to_secrets_yaml>\n```\n\n**Options**:\n\n- `--settings-file`, `-s`: Path to the YAML file containing SCM credentials (default: `.secrets.yaml`).\n\n**Example**:\n\n```bash\nscm-clone clone-address-groups\n```\n\n**Sample Output**:\n\n```\nStarting address groups migration...\nRetrieved 8 address groups from source.\nSuccessfully created 8 address groups in destination.\nAddress groups migration completed successfully.\n```\n\n### Create Secrets File\n\nGenerate a `.secrets.yaml` file to store your SCM credentials securely.\n\n```bash\nscm-clone create-secrets-file --output-file <path_to_secrets_yaml>\n```\n\n**Options**:\n\n- `--output-file`, `-o`: Path where the secrets YAML file will be saved (default: `.secrets.yaml`).\n\n**Example**:\n\n```bash\nscm-clone create-secrets-file\n```\n\n**Sample Interaction**:\n\n```\nCreating authentication file...\nEnter source Strata Cloud Manager credentials:\nSource Client ID: <your_source_client_id>\nSource Client Secret: <your_source_client_secret>\nSource Tenant TSG: <your_source_tsg>\nSource Folder [Prisma Access]:\nEnter destination Strata Cloud Manager credentials:\nDestination Client ID: <your_destination_client_id>\nDestination Client Secret: <your_destination_client_secret>\nDestination Tenant TSG: <your_destination_tsg>\nDestination Folder [Prisma Access]:\nToken URL [https://auth.apps.paloaltonetworks.com/oauth2/access_token]:\nAuthentication file written to .secrets.yaml\nAuthentication file created successfully.\n```\n\n## Contributing\n\nWe welcome contributions! To contribute:\n\n1. Fork the repository.\n2. Create a new feature branch (`git checkout -b feature/your-feature`).\n3. Commit your changes (`git commit -m 'Add new feature'`).\n4. Push to your branch (`git push origin feature/your-feature`).\n5. Open a Pull Request.\n\nEnsure your code adheres to the project's coding standards and includes tests where appropriate.\n\n## License\n\nThis project is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for details.\n\n## Support\n\nFor support and questions, please refer to the [SUPPORT.md](./SUPPORT.md) file in this repository.\n\n---\n\n*Detailed documentation will be provided on our GitHub Pages site soon.*",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A command-line tool to clone configuration objects between Palo Alto Networks Strata Cloud Manager (SCM) tenants.",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e274de706216fc0885ff3e699c2365bbf073204e3eec2474754a49382423422a",
"md5": "0776e653e1d67c99b147e813e1374d61",
"sha256": "b7fd67ce84dfc6cf3e52acbe908e5209ec30f052287f962b64bb93dd9eb1ef0c"
},
"downloads": -1,
"filename": "scm_config_clone-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0776e653e1d67c99b147e813e1374d61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 14940,
"upload_time": "2024-10-08T15:31:39",
"upload_time_iso_8601": "2024-10-08T15:31:39.270098Z",
"url": "https://files.pythonhosted.org/packages/e2/74/de706216fc0885ff3e699c2365bbf073204e3eec2474754a49382423422a/scm_config_clone-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "10a12c27412b30a2de9c2fb4dd9ea55f7b3b81f0f95f856a9a3a5cf9921e19fd",
"md5": "9c243e765349bf2e90ed6242412afab1",
"sha256": "01377ad71f5821374bfbc3686fac293bafb2ec7b98feeb3a12d786f1abe9d9ed"
},
"downloads": -1,
"filename": "scm_config_clone-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9c243e765349bf2e90ed6242412afab1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 19275,
"upload_time": "2024-10-08T15:31:40",
"upload_time_iso_8601": "2024-10-08T15:31:40.787593Z",
"url": "https://files.pythonhosted.org/packages/10/a1/2c27412b30a2de9c2fb4dd9ea55f7b3b81f0f95f856a9a3a5cf9921e19fd/scm_config_clone-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 15:31:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "scm-config-clone"
}
