illumio-pylo 0.3.7__py3-none-any.whl → 0.3.8__py3-none-any.whl

illumio_pylo/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.7"
+__version__ = "0.3.8"
 
 from typing import Callable
 

illumio_pylo/cli/commands/iplist_import_from_file.py

@@ -1,8 +1,12 @@
+from typing import List
+
 import illumio_pylo as pylo
 import argparse
 import sys
+import click
 from .utils.misc import make_filename_with_timestamp
 from . import Command
+from ...API.JsonPayloadTypes import IPListObjectCreationJsonStructure
 
 command_name = 'iplist-import'
 objects_load_filter = ['iplists']
@@ -14,20 +18,32 @@ def fill_parser(parser: argparse.ArgumentParser):
     parser.add_argument('--input-file-delimiter', type=str, required=False, default=',',
                         help='CSV field delimiter')
 
+    parser.add_argument('--output-dir', '-o', type=str, required=False, default='output',
+                        help='Directory where the output files will be saved')
+
     parser.add_argument('--ignore-if-iplist-exists', action='store_true',
                         help='If an IPList with same same exists, ignore CSV entry')
 
     parser.add_argument('--network-delimiter', type=str, required=False, default=',', nargs='?', const=True,
                         help='If an IPList with same same exists, ignore CSV entry')
 
+    parser.add_argument('--proceed', '-p', action='store_true',
+                       help='If set, the script will proceed with the creation of iplists')
 
-def __main(args, org: pylo.Organization, **kwargs):
-    input_file = args['input_file']
-    input_file_delimiter = args['input_file_delimiter']
-    ignore_if_iplist_exists = args['ignore_if_iplist_exists']
-    network_delimiter = args['network_delimiter']
+    parser.add_argument('--no-confirmation-required', '-n', action='store_true',
+                        help='If set, the script will proceed with the creation of iplists without asking for confirmation')
 
-    output_file_prefix = make_filename_with_timestamp('import-iplists-results_')
+
+def __main(args, org: pylo.Organization, **kwargs):
+    setting_input_file = args['input_file']
+    settings_input_file_delimiter = args['input_file_delimiter']
+    settings_ignore_if_iplist_exists = args['ignore_if_iplist_exists']
+    settings_network_delimiter = args['network_delimiter']
+    settings_proceed = args['proceed']
+    settings_no_confirmation_required = args['no_confirmation_required']
+    settings_output_dir: str = args['output_dir']
+
+    output_file_prefix = make_filename_with_timestamp('import-iplists-results_', settings_output_dir)
     output_file_csv = output_file_prefix + '.csv'
     output_file_excel = output_file_prefix + '.xlsx'
 
@@ -44,8 +60,8 @@ def __main(args, org: pylo.Organization, **kwargs):
     pylo.file_clean(output_file_csv)
     pylo.file_clean(output_file_excel)
 
-    print(" * Loading CSV input file '{}'...".format(input_file), flush=True, end='')
-    csv_data = pylo.CsvExcelToObject(input_file, expected_headers=csv_expected_fields, csv_delimiter=input_file_delimiter)
+    print(" * Loading CSV input file '{}'...".format(setting_input_file), flush=True, end='')
+    csv_data = pylo.CsvExcelToObject(setting_input_file, expected_headers=csv_expected_fields, csv_delimiter=settings_input_file_delimiter)
     print('OK')
     print("   - CSV has {} columns and {} lines (headers don't count)".format(csv_data.count_columns(), csv_data.count_lines()))
     # print(pylo.nice_json(csv_data._objects))
@@ -71,7 +87,7 @@ def __main(args, org: pylo.Organization, **kwargs):
                     sys.exit(1)
                 else:
                     csv_object['**not_created_reason**'] = 'Found duplicated name in PCE'
-                    if not ignore_if_iplist_exists:
+                    if not settings_ignore_if_iplist_exists:
                         pylo.log.error("PCE contains iplists with duplicates name from CSV: '{}' at line #{}. Please fix CSV or look for --options to ignore it".format(lower_name, csv_object['*line*']))
                         sys.exit(1)
                     print("  - WARNING: CSV has an entry for iplist name '{}' at line #{} but it exists already in the PCE. It will be ignored.".format(lower_name, csv_object['*line*']))
@@ -89,28 +105,28 @@ def __main(args, org: pylo.Organization, **kwargs):
             ignored_objects_count += 1
 
     print(' * Preparing Iplist JSON data...')
-    iplists_json_data = []
+    iplists_json_data: List[IPListObjectCreationJsonStructure] = []
     for data in csv_objects_to_create:
-        new_iplist = {}
+        new_iplist: IPListObjectCreationJsonStructure = {}
         iplists_json_data.append(new_iplist)
 
         if len(data['name']) < 1:
             raise pylo.PyloEx('Iplist at line #{} is missing a name in CSV'.format(data['*line*']))
-        else:
-            new_iplist['name'] = data['name']
+
+        new_iplist['name'] = str(data['name'])
 
         if len(data['description']) > 0:
-            new_iplist['description'] = data['description']
+            new_iplist['description'] = str(data['description'])
 
         if len(data['networks']) < 1:
             print('Iplist at line #{} has empty networks list'.format(data['*line*']))
             sys.exit(1)
 
-        network_delimiter = network_delimiter.replace("\\n", "\n")
+        settings_network_delimiter = settings_network_delimiter.replace("\\n", "\n")
         ip_ranges = []
         new_iplist['ip_ranges'] = ip_ranges
 
-        for network_string in data['networks'].rsplit(network_delimiter):
+        for network_string in data['networks'].rsplit(settings_network_delimiter):
             network_string = network_string.strip(" \r\n")  # cleanup trailing characters
 
             exclusion = False
@@ -155,30 +171,38 @@ def __main(args, org: pylo.Organization, **kwargs):
 
     print("  * DONE")
 
-    print(" * Creating {} IPLists".format(len(iplists_json_data)))
-    total_created_count = 0
-    total_failed_count = 0
+    if settings_proceed is False:
+        print(" * Dry-run mode, no changes will be made to the PCE. Use --proceed to actually create the iplists")
+
+    else:
+        if not settings_no_confirmation_required:
+            print(" * WARNING: You are about to create {} IPLists in the PCE. Are you sure you want to proceed?".format(len(iplists_json_data)))
+            click.confirm("Do you want to proceed with the creation of these labels?", abort=True)
+
+        print(" * Creating {} IPLists".format(len(iplists_json_data)))
+        total_created_count = 0
+        total_failed_count = 0
 
-    for index in range(0, len(iplists_json_data)):
-        json_blob = iplists_json_data[index]
-        print("  - Pushing new iplist '{}' to PCE (#{} of {})... ".format(json_blob['name'], index+1, len(iplists_json_data)), end='', flush=True)
-        result = org.connector.objects_iplist_create(json_blob)
-        print("OK")
+        for index in range(0, len(iplists_json_data)):
+            json_blob: IPListObjectCreationJsonStructure = iplists_json_data[index]
+            print("  - Pushing new iplist '{}' to PCE (#{} of {})... ".format(json_blob['name'], index+1, len(iplists_json_data)), end='', flush=True)
+            result = org.connector.objects_iplist_create(json_blob)
+            print("OK")
 
-        href = result.get('href')
-        if href is None:
-            raise pylo.PyloEx('API returned unexpected response which is missing a HREF:', result)
+            href = result.get('href')
+            if href is None:
+                raise pylo.PyloEx('API returned unexpected response which is missing a HREF:', result)
 
-        total_created_count += 1
-        csv_objects_to_create[index]['href'] = href
+            total_created_count += 1
+            csv_objects_to_create[index]['href'] = href
+
+            csv_data.save_to_csv(output_file_csv, csv_created_fields)
+            csv_data.save_to_excel(output_file_excel, csv_created_fields)
 
         csv_data.save_to_csv(output_file_csv, csv_created_fields)
         csv_data.save_to_excel(output_file_excel, csv_created_fields)
 
-    csv_data.save_to_csv(output_file_csv, csv_created_fields)
-    csv_data.save_to_excel(output_file_excel, csv_created_fields)
-
-    print("  * DONE - {} created with success, {} failures and {} ignored. A report was created in {} and {}".format(total_created_count, total_failed_count, ignored_objects_count, output_file_csv, output_file_excel))
+        print("  * DONE - {} created with success, {} failures and {} ignored. A report was created in {} and {}".format(total_created_count, total_failed_count, ignored_objects_count, output_file_csv, output_file_excel))
 
 
 command_object = Command(command_name, __main, fill_parser, load_specific_objects_only=objects_load_filter)

illumio_pylo/cli/commands/utils/misc.py

@@ -2,6 +2,8 @@ import os
 from datetime import datetime
 import illumio_pylo as pylo
 
+default_label_columns_prefix = 'label:'
+
 
 def make_filename_with_timestamp(prefix: str, output_directory: str = './') -> str:
     # if output directory starts with a dot, we assume it's a relative path. Same if not it's not starting with a slash

illumio_pylo/cli/commands/workload_import.py

@@ -8,7 +8,7 @@ import click
 import illumio_pylo as pylo
 from illumio_pylo import ArraysToExcel, ExcelHeaderSet, ExcelHeader
 from .utils.LabelCreation import generate_list_of_labels_to_create, create_labels
-from .utils.misc import make_filename_with_timestamp
+from .utils.misc import make_filename_with_timestamp, default_label_columns_prefix
 from . import Command
 
 command_name = 'workload-import'
@@ -27,7 +27,7 @@ def fill_parser(parser: argparse.ArgumentParser):
     parser.add_argument('--ignore-missing-headers', action='store_true',
                         help='Ignore missing headers in the CSV/Excel file for label types')
 
-    parser.add_argument('--label-type-header-prefix', type=str, required=False, default='label_',
+    parser.add_argument('--label-type-header-prefix', type=str, required=False, default=default_label_columns_prefix,
                         help='Prefix for the label type headers in the CSV/Excel file')
 
     parser.add_argument('--ignore-hostname-collision', action='store_true',
@@ -89,7 +89,7 @@ def __main(args, org: pylo.Organization, **kwargs):
 
     csv_report_headers = ExcelHeaderSet(['name', 'hostname', 'ip', 'description'])
     for label_type in org.LabelStore.label_types:
-        csv_report_headers.append(f'label_{label_type}')
+        csv_report_headers.append(f'{settings_header_label_prefix}{label_type}')
 
     csv_report_headers.append(ExcelHeader(name='**not_created_reason**'))
     csv_report_headers.append(ExcelHeader(name='href', max_width=15))
@@ -124,7 +124,7 @@ def __main(args, org: pylo.Organization, **kwargs):
     if len(labels_to_be_created) > 0:
         print(" * {} Labels need to created before Workloads can be imported, listing:".format(len(labels_to_be_created)))
         for label in labels_to_be_created:
-            print("   - Label: {} (type={})".format(label.name, label.type))
+            print("   - Label: {} (type={})".format(label['name'], label['type']))
         if not settings_no_confirmation_required:
             click.confirm("Do you want to proceed with the creation of these labels?", abort=True)
 

illumio_pylo/cli/commands/workload_update.py

@@ -6,7 +6,7 @@ import sys
 import illumio_pylo as pylo
 from illumio_pylo import ArraysToExcel, ExcelHeader, ExcelHeaderSet
 from .utils.LabelCreation import generate_list_of_labels_to_create, create_labels
-from .utils.misc import make_filename_with_timestamp
+from .utils.misc import make_filename_with_timestamp, default_label_columns_prefix
 from . import Command
 
 
@@ -25,7 +25,7 @@ def fill_parser(parser: argparse.ArgumentParser):
     parser.add_argument('--input-file-delimiter', type=str, required=False, default=',',
                         help='CSV field delimiter')
 
-    parser.add_argument('--label-type-header-prefix', type=str, required=False, default='label_',
+    parser.add_argument('--label-type-header-prefix', type=str, required=False, default=default_label_columns_prefix,
                         help='Prefix for the label type headers in the CSV/Excel file')
 
     parser.add_argument('--output-dir', '-o', type=str, required=False, default='output',
@@ -49,6 +49,7 @@ def fill_parser(parser: argparse.ArgumentParser):
     parser.add_argument('--batch-size', type=int, required=False, default=500,
                         help='Number of Workloads to update per API call')
 
+
 class ContextSingleton:
 
     def __init__(self, org: pylo.Organization):

{illumio_pylo-0.3.7.dist-info → illumio_pylo-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: illumio_pylo
-Version: 0.3.7
+Version: 0.3.8
 Summary: A set of tools and library for working with Illumio PCE
 Home-page: https://github.com/cpainchaud/pylo
 Author: Christophe Painchaud
@@ -187,11 +187,11 @@ Requires-Python: >=3.11
 License-File: LICENSE
 Requires-Dist: click ==8.1.7
 Requires-Dist: colorama ~=0.4.4
-Requires-Dist: cryptography ~=42.0.5
-Requires-Dist: openpyxl ~=3.1.2
+Requires-Dist: cryptography ==42.0.7
+Requires-Dist: openpyxl ~=3.1.3
 Requires-Dist: paramiko ~=3.4.0
 Requires-Dist: prettytable ~=3.10.0
-Requires-Dist: requests ~=2.31.0
+Requires-Dist: requests ~=2.32.0
 Requires-Dist: xlsxwriter ~=3.2.0
 
 README.md

{illumio_pylo-0.3.7.dist-info → illumio_pylo-0.3.8.dist-info}/RECORD

@@ -21,7 +21,7 @@ illumio_pylo/VirtualServiceStore.py,sha256=MNTwo1cvteUuID6JniWUk5oRHQHGY4OwrWvFa
 illumio_pylo/Workload.py,sha256=9kZHawayQQ_L-OBzyuuDcViWSa7HzDKEfPtcSHMsInw,19910
 illumio_pylo/WorkloadStore.py,sha256=3C6SMU0wRlet6C6UVbjkYNsTY7vkyK_ZwqM1dlCBpsQ,10989
 illumio_pylo/WorkloadStoreSubClasses.py,sha256=4GBb5sXan38Y5OE7O6aAR-IZrZJar0mYE44FbCSb3_k,6093
-illumio_pylo/__init__.py,sha256=NfjWb-G4N-kqGKvsr_N-zQZFy1bGNrUmZNfIIC21P2I,4172
+illumio_pylo/__init__.py,sha256=LOKwOb9r5Shqau4F43ZbOE8TV43Svk-TwNNBnV_9Cbs,4172
 illumio_pylo/tmp.py,sha256=DYlm07YEP6Nm5qScByfTloGi7TGaN9WtklSqeVROPik,3913
 illumio_pylo/API/APIConnector.py,sha256=pxHuaRvUU_sX_DWgE_TVMR5ktRURVMOVGhkBbuV--Sc,60725
 illumio_pylo/API/AuditLog.py,sha256=p0mfjrE5S8qoJgA5LIP_XGFBP3iL86Nl6BQEmhMVrPA,1533
@@ -40,7 +40,7 @@ illumio_pylo/cli/__main__.py,sha256=ll1gK8k1YL_kPsImI7WVlw2sCyNyhocnuCqko6mGaYI,
 illumio_pylo/cli/commands/__init__.py,sha256=yoVkXy-qBGiAAziWiayJdjcclx1WTayShXSPqHelcWA,1489
 illumio_pylo/cli/commands/credential_manager.py,sha256=sAPEvFjxHuxUexfTigy2CR5evU_j9W7rAbalsoSWrLk,9421
 illumio_pylo/cli/commands/iplist_analyzer.py,sha256=vOl6fNd0HrUKnKXtY1sj7jeyx2GtuDZENV7mF79O7yU,3714
-illumio_pylo/cli/commands/iplist_import_from_file.py,sha256=XvC-GlJyjA4dDPzfvGoBFtwelI9g_rQqGzgKgqMYcsI,8284
+illumio_pylo/cli/commands/iplist_import_from_file.py,sha256=k_EkJbjEhZqJJdWN6vG_zHu7jmnodHj8TVPKQA1R7d4,9836
 illumio_pylo/cli/commands/ruleset_export.py,sha256=KC9ifZx8gcAzti6EnTMfS075K00-ovRbLxeKMUg3w8E,5893
 illumio_pylo/cli/commands/update_pce_objects_cache.py,sha256=kNBAmPIbJyw97FRcNREy059A5FLOGm_poKJYGdTWqr4,1256
 illumio_pylo/cli/commands/ven_compatibility_report_export.py,sha256=8ZpgGQfn5zmOslgeE1imwx4-gDHfukdgoXJGZUh9q3o,8120
@@ -48,13 +48,13 @@ illumio_pylo/cli/commands/ven_duplicate_remover.py,sha256=fr9EzLlJb_cizdxTC5yOOf
 illumio_pylo/cli/commands/ven_idle_to_visibility.py,sha256=OMcQSB82Pn50TS7OL1_TPOvvN9XFR3jUxVYYizUQinI,13387
 illumio_pylo/cli/commands/ven_upgrader.py,sha256=4cLUA7HSpskJpPOtEkQh41lE4gMGJJiQiKGCd0CKYJk,7222
 illumio_pylo/cli/commands/workload_export.py,sha256=EcQR8AacJVe7rOqYH-HFxyTchwHHQ9ZTc-ALSMt9gDY,11421
-illumio_pylo/cli/commands/workload_import.py,sha256=FuUeLkauqYvKvWgWcS_xfQIxwTScp90ZdUMbUIFSadE,18923
+illumio_pylo/cli/commands/workload_import.py,sha256=LcyFQm92mnkueh6Hq2dTMgUva_Gmwla87S7H2s3pltE,19003
 illumio_pylo/cli/commands/workload_reset_names_to_null.py,sha256=GaO2Th1rx8i7_7yqb9WkGpDz3sdbYNod5fABQnhogig,3383
-illumio_pylo/cli/commands/workload_update.py,sha256=tmzTV8uh4zmJf_F5rhBChuYjfnY_JtcDjSUKhvGK3rM,28543
+illumio_pylo/cli/commands/workload_update.py,sha256=3NtFNVSL7OvYBfhX5BincwLKvYLhLHKnIRR0nL29tuY,28594
 illumio_pylo/cli/commands/workload_used_in_rule_finder.py,sha256=2MO9jjYh-mkY6rkfvDyW0Ok6El_AqDWGXiFDYq5YgTk,3361
 illumio_pylo/cli/commands/utils/LabelCreation.py,sha256=qaU7BeP4et2GJxHwgbDNRoQLCA-xWp_y1nJ-m8ANUwA,4883
 illumio_pylo/cli/commands/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-illumio_pylo/cli/commands/utils/misc.py,sha256=iV5CEEccfQ08eO0wSpTOxS9-32_GXSekShic6auuGPE,761
+illumio_pylo/cli/commands/utils/misc.py,sha256=Oy-s4n6k7uHsYWqHZ32MJiaSSft2tOOxOGZ8Jwbaa_U,802
 illumio_pylo/docs/Doxygen,sha256=AVvSIRYLHFWJ15YLGahhzhsW0ZUUFO5lVxd2-F3iWz8,74257
 illumio_pylo/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 illumio_pylo/utilities/cli.py,sha256=7Wv7qhdc91-vsaxiu4j8k7LY7V9dcwWHnHV7PLpOBAI,320
@@ -65,8 +65,8 @@ illumio_pylo/utilities/resources/iplists-import-example.xlsx,sha256=VW-7CRr8NA2V
 illumio_pylo/utilities/resources/workload-exporter-filter-example.csv,sha256=cn5IA8AGEPjvS-EsPXA_GJ-LFsdF9t_44rSzFTCmAzE,36
 illumio_pylo/utilities/resources/workloads-import-example.csv,sha256=DEOGVikFjxQpMFFI0l0jb3hrxEEeZCpTGkmWkz6GUcY,91
 illumio_pylo/utilities/resources/workloads-import-example.xlsx,sha256=U8Ac2BZidA6NlvBFAVPHqeY5zmg3rjmIAXp5b3b1P5w,17101
-illumio_pylo-0.3.7.dist-info/LICENSE,sha256=WYmcYJG1QFgu1hfo7qrEkZ3Jhcz8NUWe6XUraZvlIFs,10172
-illumio_pylo-0.3.7.dist-info/METADATA,sha256=wydOUCStSL8nqGPvpBlvDa-xfIjGAqKy2N_OXcQozGk,12224
-illumio_pylo-0.3.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-illumio_pylo-0.3.7.dist-info/top_level.txt,sha256=c5cu_ZMuSuxjq48ih58Kc0Tr8-JdQtV8GrKJicvWNFE,13
-illumio_pylo-0.3.7.dist-info/RECORD,,
+illumio_pylo-0.3.8.dist-info/LICENSE,sha256=WYmcYJG1QFgu1hfo7qrEkZ3Jhcz8NUWe6XUraZvlIFs,10172
+illumio_pylo-0.3.8.dist-info/METADATA,sha256=TJ4GTpwJhhvBtDV6XDIsk3bfFw7DYvcTJ7QgCr4Ots4,12224
+illumio_pylo-0.3.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+illumio_pylo-0.3.8.dist-info/top_level.txt,sha256=c5cu_ZMuSuxjq48ih58Kc0Tr8-JdQtV8GrKJicvWNFE,13
+illumio_pylo-0.3.8.dist-info/RECORD,,