Function Reference

Contents

Function Reference#

This reference provides a complete catalog of all functions in the Policy-as-a-Code system, organized in a sleek table format by functionality.

Application Entry Points#

Function	Description	Returns	Source
`main(**kwargs)`	Application entry point with menu system and deployment coordination	`int` (exit code)	main.py
`deploy_policy(...)`	Orchestrates complete policy deployment workflow	`int` (exit code)	main.py

Core Policy Engine#

Function	Description	Returns	Source
`build_policy(...)`	Executes 22-step policy construction algorithm	`None`	build_policy.py:205
`discover_and_delete_policy_rules(...)`	Discovers and deletes existing policy rules with rollback capability	`None`	build_policy.py:55

Policy Rule Creators#

Function	Description	Returns	Source
`create_security_rules(...)`	Creates security policy rules from business requirements	`None`	build_policy.py:162
`create_decryption_rules(...)`	Creates TLS inspection decryption rules	`None`	build_policy.py:169
`create_nat_rules(...)`	NAT policy rule creation (future implementation)	`None`	build_policy.py:176
`create_authentication_rules(...)`	Authentication policy rules (future implementation)	`None`	build_policy.py:184
`create_override_rules(...)`	Application override rules (future implementation)	`None`	build_policy.py:191
`create_pbf_rules(...)`	Policy-Based Forwarding rules (future implementation)	`None`	build_policy.py:198
`security_policy_pre(...)`	Generates security policy pre-rules	`None`	security_policy_pre.py
`security_policy_post(...)`	Generates security policy post-rules	`None`	security_policy_post.py
`decryption_policy(...)`	Generates decryption policy rules from config files	`None`	decryption_policy.py

Business Requirements Processing#

Function	Description	Returns	Source
`generate_app_categories_template(...)`	Extracts available App-ID categories for validation	`None`	template_generator.py
`generate_url_categories_template(...)`	Extracts available URL categories for validation	`None`	template_generator.py
`parse_app_categories(filename)`	Parses application category requirements from CSV/JSON	`dict`	category_parser.py
`parse_url_categories(filename)`	Parses URL category requirements from CSV/JSON	`dict`	category_parser.py

Object Management#

Function	Description	Returns	Source
`create_tags(...)`	Creates organizational and metadata tags	`None`	manage_tags.py
`tag_applications(...)`	Applies metadata tags to applications	`None`	manage_tags.py
`create_application_filters(...)`	Creates application filters from requirements	`None`	application_filters.py
`create_application_groups(...)`	Creates application groups referencing filters	`None`	application_groups.py
`handle_address_objects_and_groups(...)`	Delta-based synchronization of address objects	`None`	address_objects_staging.py
`create_service_objects(...)`	Creates service objects and groups from config	`None`	service_objects.py
`create_edls(...)`	Deploys external dynamic lists with environment substitution	`None`	edls.py
`create_custom_url_categories(...)`	Creates custom URL categories from requirements	`None`	url_categories.py

Security Profile Management#

Function	Description	Returns	Source
`create_security_profile_groups(...)`	Creates security profile groups for policy assignment	`None`	security_profile_groups.py
`create_url_filtering_static_profiles(...)`	Creates URL filtering profiles from static JSON	`None`	security_profile_url_filtering.py
`create_url_filtering_auto_profiles(...)`	Auto-generates URL filtering profiles from requirements	`None`	security_profile_url_filtering.py
`create_log_forwarding_profiles(...)`	Creates comprehensive logging configuration profiles	`None`	log_forwarding_profiles.py
`import_custom_signatures(...)`	Imports custom app/vulnerability/spyware signatures	`None`	custom_objects.py
`import_custom_response_pages(...)`	Imports environment-specific custom response pages	`None`	custom_objects.py

Utility Functions#

Function	Description	Returns	Source
`load_menu_options()`	Loads deployment menu configuration	`dict`	auxiliary_functions.py
`display_menu()`	Displays interactive deployment menu	`None`	auxiliary_functions.py
`get_user_choice()`	Handles user input validation and selection	`str`	auxiliary_functions.py
`delete_objects(...)`	Bulk/individual object deletion with error handling	`None`	auxiliary_functions.py
`delete_non_sdk_objects(...)`	Deletes objects via direct API (non-SDK supported)	`None`	auxiliary_functions.py
`create_non_sdk_objects(...)`	Creates objects via direct API (non-SDK supported)	`None`	auxiliary_functions.py
`execute_multi_config_api_call(...)`	Executes bulk operations using multi-config XML	`None`	auxiliary_functions.py

Integration and External Systems#

Function	Description	Returns	Source
`generate_categories_for_servicenow(...)`	Generates category mappings for ServiceNow integration	`None`	service_now.py

Configuration Management#

Component	Description	Type	Source
`settings.py`	Global configuration: paths, toggles, deployment flags	`module`	settings.py
`rich_output.py`	Rich console formatting utilities for enhanced UX	`module`	rich_output.py