Skip to content

Commit

Permalink
bhom dev
Browse files Browse the repository at this point in the history
  • Loading branch information
vscheith committed Jul 15, 2022
1 parent 84107ee commit 1690a0e
Show file tree
Hide file tree
Showing 19 changed files with 1,107 additions and 519 deletions.
16 changes: 16 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Python: Current File",
"type": "python",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal",
"justMyCode": true
}
]
}
103 changes: 53 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
# Werkstatt Tools
Basic Python modules for Werkstatt projects

Basic Python modules for Werkstatt projects

## Core functions for integrating with solutions using Python

- Basic transform and core functions
- Encryption of credential
- Encryption of credential
- External configuration in custom json file

## Core Library and purpose

- **w3rkstatt** base python functions for project support
- **w3rkstatt** encrypt the cleartext passwords

## Dependencies

- [ ] **Basic Libraries**
- [ ] **Cryptodome**


Install dependencies, see [Setup documentation](docs/SETUP.md) for more details.

```bash
Linux
python3 -m pip install wheel requests urllib3 pyCryptodome pandas json2html jsonpath-ng jsonpath_rw_ext
python3 -m pip install git+https://github.com/dcompane/controlm_py.git
python3 -m pip install wheel requests urllib3 pyCryptodome pandas json2html jsonpath-ng jsonpath_rw_ext --user
python3 -m pip install git+https://github.com/dcompane/controlm_py.git --user
```

```bash
Expand All @@ -30,98 +33,98 @@ python -m pip install git+https://github.com/dcompane/controlm_py.git
```

## Solutions leveraging the base tools
| Solution | API | Python |
| :------------- | :---: | :---: |
| Werkstatt Tools |||
| BMC Control-M | 🔶 ||
| BMC Helix ITSM | 🔶 ||
| BMC TrueSight | 🔶 ||
| ServiceNOW | 🔶 | 🚧 |
| E-Mail | 🔶 ||
| Shell Scripts |||

| Solution | API | Python |
| :-------------- | :-: | :----: |
| Werkstatt Tools |||
| BMC Control-M | 🔶 ||
| BMC Helix ITSM | 🔶 ||
| BMC TrueSight | 🔶 ||
| ServiceNOW | 🔶 | 🚧 |
| E-Mail | 🔶 ||
| Shell Scripts |||

- ✅ — Supported
- 🔶 — Partial support
- 🚧 — Under development
- ⬜ - N/A ️

* ✅ — Supported
* 🔶 — Partial support
* 🚧 — Under development
* ⬜ - N/A ️
**ToDO**:

**ToDO**:
- [x] Initial Core Development
- [ ] update CamelCase / snake_case
- [ ] automate this process

**Info**:

- Log files are being written to [home]/werkstatt/logs
- Werkstatt main log file is [home]/werkstatt/logs/integrations.log
- Configuration files are in [home]/werkstatt/configs
- Example files are in [project]/samples
- Example files are in [project]/samples

## Documentation of Modules

**SMTP**:
Module | Method | Description
------------ | ------------- | -------------
*core_smtp* | [**prepareEmail**](docs/SMTP.md) | Prepare HTML content, based on template
*core_smtp* | [**sendEmailSmtpSSL**](docs/SMTP.md) | Send E-mail with SSL enabled
_core_smtp_ | [**prepareEmail**](docs/SMTP.md) | Prepare HTML content, based on template
_core_smtp_ | [**sendEmailSmtpSSL**](docs/SMTP.md) | Send E-mail with SSL enabled

**Helix ITSM Application**:
Module | Method | Description
------------ | ------------- | -------------
*core_itsm* | [**createChange**](docs/ITSM.md) | Create ITSM Change Request
*core_itsm* | [**getChange**](docs/ITSM.md) | Get ITSM Change Request status
*core_itsm* | [**extractChangeState**](docs/ITSM.md) | Translate ITSM Change Request details
*core_itsm* | [**createIncident**](docs/ITSM.md) | Create ITSM Incident
*core_itsm* | [**getIncident**](docs/ITSM.md) | Get ITSM Incident details
*core_itsm* | [**getIncidentStatus**](docs/ITSM.md) | Get ITSM Incident status
_core_itsm_ | [**createChange**](docs/ITSM.md) | Create ITSM Change Request
_core_itsm_ | [**getChange**](docs/ITSM.md) | Get ITSM Change Request status
_core_itsm_ | [**extractChangeState**](docs/ITSM.md) | Translate ITSM Change Request details
_core_itsm_ | [**createIncident**](docs/ITSM.md) | Create ITSM Incident
_core_itsm_ | [**getIncident**](docs/ITSM.md) | Get ITSM Incident details
_core_itsm_ | [**getIncidentStatus**](docs/ITSM.md) | Get ITSM Incident status

**Helix ITSM Core**:
Module | Method | Description
------------ | ------------- | -------------
*core_itsm* | [**authenticate**](docs/ITSM.md) | Login to Helix ITSM
*core_itsm* | [**logout**](docs/ITSM.md) | Logout of Helix ITSM
*core_itsm* | [**itsmFormGet**](docs/ITSM.md) | HTTP Get from Helix ITSM Form
*core_itsm* | [**itsmFormPost**](docs/ITSM.md) | HTTP Post to Helix ITSM Form
_core_itsm_ | [**authenticate**](docs/ITSM.md) | Login to Helix ITSM
_core_itsm_ | [**logout**](docs/ITSM.md) | Logout of Helix ITSM
_core_itsm_ | [**itsmFormGet**](docs/ITSM.md) | HTTP Get from Helix ITSM Form
_core_itsm_ | [**itsmFormPost**](docs/ITSM.md) | HTTP Post to Helix ITSM Form

**TrueSight Operations Manager Application**:
Module | Method | Description
------------ | ------------- | -------------
*core_tsim* | [**getEventID**](docs/TSIM.md)| Extract TSIM Event mc_ueid
*core_tsim* | [**createCI**](docs/TSIM.md) | Create TSIM CI
*core_tsim* | [**searchCI**](docs/TSIM.md) | Search for TSIM CI
*core_tsim* | [**searchCIAdvanced**](docs/TSIM.md) | Search for TSIM CI Advanced
_core_tsim_ | [**getEventID**](docs/TSIM.md)| Extract TSIM Event mc_ueid
_core_tsim_ | [**createCI**](docs/TSIM.md) | Create TSIM CI
_core_tsim_ | [**searchCI**](docs/TSIM.md) | Search for TSIM CI
_core_tsim_ | [**searchCIAdvanced**](docs/TSIM.md) | Search for TSIM CI Advanced

**TrueSight Operations Manager Core**:
Module | Method | Description
------------ | ------------- | -------------
*core_tsim* | [**authenticate**](docs/TSIM.md)| Login to TrueSight Presentation Server
*core_tsim* | [**createEvent**](docs/TSIM.md) | Create TSIM Event
*core_tsim* | [**updateEvent**](docs/TSIM.md) | Update TSIM Event
*core_tsim* | [**searchEvent**](docs/TSIM.md) | Search for TSIM Event
_core_tsim_ | [**authenticate**](docs/TSIM.md)| Login to TrueSight Presentation Server
_core_tsim_ | [**createEvent**](docs/TSIM.md) | Create TSIM Event
_core_tsim_ | [**updateEvent**](docs/TSIM.md) | Update TSIM Event
_core_tsim_ | [**searchEvent**](docs/TSIM.md) | Search for TSIM Event

**TrueSight Orchestrator Application**:
Module | Method | Description
------------ | ------------- | -------------
*core_tso* | [**getTsoModules**](docs/TSO.md) | Get TrueSight Orchestrator Modules
*core_tso* | [**getTsoAdapters**](docs/TSO.md) | Get TrueSight Orchestrator Adapters
*core_tso* | [**executeTsoProcess**](docs/TSO.md) | Execute TrueSight Orchestrator
_core_tso_ | [**getTsoModules**](docs/TSO.md) | Get TrueSight Orchestrator Modules
_core_tso_ | [**getTsoAdapters**](docs/TSO.md) | Get TrueSight Orchestrator Adapters
_core_tso_ | [**executeTsoProcess**](docs/TSO.md) | Execute TrueSight Orchestrator

**TrueSight Orchestrator Core**:
Module | Method | Description
------------ | ------------- | -------------
*core_tso* | [**authenticate**](docs/TSO.md) | Login to TrueSight Orchestrator
*core_tso* | [**logout**](docs/TSO.md) | Logout of TrueSight Orchestrator
*core_tso* | [**apiGet**](docs/TSO.md) | HTTP Get from TrueSight Orchestrator
*core_tso* | [**apiPost**](docs/TSO.md) | HTTP Post to TrueSight Orchestrator

_core_tso_ | [**authenticate**](docs/TSO.md) | Login to TrueSight Orchestrator
_core_tso_ | [**logout**](docs/TSO.md) | Logout of TrueSight Orchestrator
_core_tso_ | [**apiGet**](docs/TSO.md) | HTTP Get from TrueSight Orchestrator
_core_tso_ | [**apiPost**](docs/TSO.md) | HTTP Post to TrueSight Orchestrator

**Shell Scripts**:
Solution | Script | Description
------------ | ------------- | -------------
*ctm* | [**remove_ctm_env.sh**](docs/SHELL.md) | Remove Control-M environments matching a pattern for ctm aapi
_ctm_ | [**remove_ctm_env.sh**](docs/SHELL.md) | Remove Control-M environments matching a pattern for ctm aapi

**Python Scripts**:
Solution | Script | Description
------------ | ------------- | -------------
*ctm* | [**disco_ctm.py**](docs/DISCO.md) | Create inventory of Control-M environment and resources
_ctm_ | [**disco_ctm.py**](docs/DISCO.md) | Create inventory of Control-M environment and resources
Binary file added src/__pycache__/__init__.cpython-36.pyc
Binary file not shown.
Binary file added src/__pycache__/__init__.cpython-39.pyc
Binary file not shown.
Binary file added src/__pycache__/core_bhom.cpython-36.pyc
Binary file not shown.
Binary file added src/__pycache__/core_ctm.cpython-36.pyc
Binary file not shown.
Binary file added src/__pycache__/core_itsm.cpython-36.pyc
Binary file not shown.
Binary file added src/__pycache__/core_smtp.cpython-36.pyc
Binary file not shown.
Binary file added src/__pycache__/core_tsim.cpython-36.pyc
Binary file not shown.
Binary file added src/__pycache__/core_tso.cpython-36.pyc
Binary file not shown.
Binary file added src/__pycache__/w3rkstatt.cpython-36.pyc
Binary file not shown.
Binary file added src/__pycache__/w3rkstatt.cpython-39.pyc
Binary file not shown.
Loading

0 comments on commit 1690a0e

Please sign in to comment.