illumio-py-open 1.3.3

Community-maintained REST API client for the Illumio Core Policy Compute Engine (fork of illumio/illumio-py)

illumio-py-open

Community fork. illumio-py-open is a community-maintained fork of illumio/illumio-py, updated to track current Illumio Core REST APIs. It is not an official Illumio product and is not endorsed by Illumio. It is distributed under the Apache License 2.0 (see NOTICE and LICENSE). The import package is still illumio, so existing code keeps working: from illumio import PolicyComputeEngine.

Illumio Policy Compute Engine REST client for python 3. Provides full API coverage of the Illumio PCE REST API with 56 registered CRUD endpoints and 67 custom methods for specialized operations.

Covers security policy, workloads, VENs, infrastructure, access management, authentication, reporting, settings, label mapping, vulnerability management, and traffic analysis.

Compatible with Illumio Core PCE version 21.2+.

The main entrypoint for the client is the PolicyComputeEngine class:

>>> from illumio import PolicyComputeEngine
>>> pce = PolicyComputeEngine('pce.company.com', port='8443', org_id='12')
>>> pce.set_credentials('api_key', 'api_secret')
>>> workloads = pce.workloads.get(
...     params={
...         'managed': True,
...         'enforcement_mode': 'visibility_only'
...     }
... )
>>> workloads
[
    Workload(href='/orgs/12/workloads/c754a713-2bde-4427-af1f-bff145be509b', ...),
    ...
]

For more information on the Illumio APIs, see the REST API guide and the API reference for your version of Illumio Core.

Examples

Runnable example scripts covering common tasks (labels, workloads, allow/deny rules, provisioning, traffic analysis, VENs, bulk operations, settings, pairing) live in examples/ — see examples/README.md.

Documentation

API documentation, code examples, and usage guides are published to GitHub Pages (built from docs/ on every push to main).

Installation

Once published, the fork will be available on PyPI as illumio-py-open (the import name remains illumio):

$ python -m pip install illumio-py-open

To build and install from source

$ git clone [e-mail]:alexgoller/illumio-py.git
$ cd illumio-py
$ make

Support

The illumio package is released and distributed as open source software subject to the included LICENSE. Illumio has no obligation or responsibility related to the package with respect to support, maintenance, availability, security or otherwise. Please read the entire LICENSE for additional information regarding the permissions and limitations. Support is offered on a best-effort basis through the Illumio app integrations team and project contributors.

Contributing

See the project's CONTRIBUTING document for details.

License

Copyright 2022 Illumio

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.