# vmware/vmware-config-modules architecture

> Architecture diagram of the GitHub repository vmware/vmware-config-modules, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vmware/vmware-config-modules
- Repository: https://github.com/vmware/vmware-config-modules

## Overview

Config Modules is a Python library for consistent compliance auditing and remediation across VMware products, also exposed through SaltStack integration. The main workflow accepts an operation through the controller interface, delegates workflow operations, and uses product-specific controllers to inspect or change configuration; results are returned in structured response models. The graph preserves the documented schema-based controller model and major product families. Some workflow and product-specific connections are not shown in sampled source, so those links are omitted or marked unverified.

Main entry points: [`config_modules_vmware/interfaces/controller_interface.py`](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/interfaces/controller_interface.py) (Controller interface), [`config_modules_vmware/controllers`](https://github.com/vmware/vmware-config-modules/tree/main/config_modules_vmware/controllers) (Product controllers), [`config_modules_vmware/framework/clients/common/rest_client.py`](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/common/rest_client.py) (REST clients), [`config_modules_vmware/framework/clients/vcenter/dependencies/pyVmomi/VmomiSupport.py`](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/vcenter/dependencies/pyVmomi/VmomiSupport.py) (pyVmomi types)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Interfaces and workflows"]
  node_controller_api["Controller interface"]
  node_metadata_api["Metadata interface"]
  node_compliance_ops["Compliance operations"]
  node_configuration_ops["Configuration operations"]
  node_salt_modules["Salt modules"]
  node_salt_states["Salt states"]
end

subgraph group_controls["Controllers and schemas"]
  node_controller_base["Controller base<br/>[base_controller.py]"]
  node_product_controls["Product controllers"]
  node_schema["Schema utility<br/>[schema_utility.py]"]
end

subgraph group_platform["Product connectivity"]
  node_contexts["Product contexts"]
  node_rest_clients["REST clients<br/>[rest_client.py]"]
  node_sddc_client["SDDC Manager client"]
  node_esxi_client["ESXi CLI client<br/>[esx_cli_client.py]"]
  node_vc_client["vCenter VMOMI client<br/>[vc_vmomi_client.py]"]
  node_pyvmomi["pyVmomi types<br/>[VmomiSupport.py]"]
end

subgraph group_framework["Shared framework"]
  node_metadata["Controller metadata<br/>[metadata.py]"]
  node_responses["Response models"]
  node_logging["Logging context<br/>[logger_adapter.py]"]
  node_config["Runtime config<br/>[config.py]"]
  node_comparator["Configuration comparator<br/>[comparator.py]"]
end

node_consumer(("Calling service"))

node_consumer -->|"invokes"| node_controller_api
node_controller_api -->|"dispatches"| node_compliance_ops
node_controller_api -->|"dispatches"| node_configuration_ops
node_controller_api -->|"loads metadata"| node_metadata_api
node_salt_modules -->|"uses"| node_metadata_api
node_compliance_ops -.->|"dispatches controls"| node_product_controls
node_configuration_ops -.->|"dispatches controls"| node_product_controls
node_product_controls -.->|"extends"| node_controller_base
node_controller_base -->|"compares values"| node_comparator
node_metadata -->|"retrieves schema"| node_schema
node_controller_api -->|"formats results"| node_responses
node_product_controls -->|"uses context"| node_contexts
node_contexts -.->|"provides connectivity"| node_rest_clients
node_sddc_client -->|"delegates requests"| node_rest_clients
node_vc_client -->|"uses types"| node_pyvmomi
node_rest_clients -->|"reads settings"| node_config
node_sddc_client -->|"reads settings"| node_config
node_logging -->|"loads format"| node_config
node_pyvmomi -.->|"supports VMOMI types"| node_pyvmomi

click node_controller_api "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/interfaces/controller_interface.py"
click node_metadata_api "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/interfaces/metadata_interface.py"
click node_compliance_ops "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/workflows/compliance_operations.py"
click node_configuration_ops "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/workflows/configuration_operations.py"
click node_salt_modules "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/salt/modules/compliance_control.py"
click node_salt_states "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/salt/states/compliance_control.py"
click node_controller_base "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/controllers/base_controller.py"
click node_product_controls "https://github.com/vmware/vmware-config-modules/tree/main/config_modules_vmware/controllers"
click node_schema "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/schemas/schema_utility.py"
click node_metadata "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/models/controller_models/metadata.py"
click node_responses "https://github.com/vmware/vmware-config-modules/tree/main/config_modules_vmware/framework/models/output_models"
click node_contexts "https://github.com/vmware/vmware-config-modules/tree/main/config_modules_vmware/framework/auth/contexts"
click node_rest_clients "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/common/rest_client.py"
click node_sddc_client "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/sddc_manager/sddc_manager_rest_client.py"
click node_esxi_client "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/esxi/esx_cli_client.py"
click node_vc_client "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/vcenter/vc_vmomi_client.py"
click node_pyvmomi "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/vcenter/dependencies/pyVmomi/VmomiSupport.py"
click node_logging "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/logging/logger_adapter.py"
click node_config "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/config.py"
click node_comparator "https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/utils/comparator.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_controller_api,node_metadata_api,node_compliance_ops,node_configuration_ops,node_salt_modules,node_salt_states toneBlue
class node_controller_base,node_product_controls,node_schema toneAmber
class node_contexts,node_rest_clients,node_sddc_client,node_esxi_client,node_vc_client,node_pyvmomi toneMint
class node_metadata,node_responses,node_logging,node_config,node_comparator toneRose
class node_consumer toneIndigo
```

## Components

### Interfaces and workflows

- [Controller interface](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/interfaces/controller_interface.py): `config_modules_vmware/interfaces/controller_interface.py`
- [Metadata interface](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/interfaces/metadata_interface.py): `config_modules_vmware/interfaces/metadata_interface.py`
- [Compliance operations](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/workflows/compliance_operations.py): `config_modules_vmware/services/workflows/compliance_operations.py`
- [Configuration operations](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/workflows/configuration_operations.py): `config_modules_vmware/services/workflows/configuration_operations.py`
- [Salt modules](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/salt/modules/compliance_control.py): `config_modules_vmware/services/salt/modules/compliance_control.py`
- [Salt states](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/salt/states/compliance_control.py): `config_modules_vmware/services/salt/states/compliance_control.py`

### Controllers and schemas

- [Controller base](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/controllers/base_controller.py): `config_modules_vmware/controllers/base_controller.py`
- [Product controllers](https://github.com/vmware/vmware-config-modules/tree/main/config_modules_vmware/controllers): `config_modules_vmware/controllers`
- [Schema utility](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/schemas/schema_utility.py): `config_modules_vmware/schemas/schema_utility.py`

### Product connectivity

- [Product contexts](https://github.com/vmware/vmware-config-modules/tree/main/config_modules_vmware/framework/auth/contexts): `config_modules_vmware/framework/auth/contexts`
- [REST clients](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/common/rest_client.py): `config_modules_vmware/framework/clients/common/rest_client.py`
- [SDDC Manager client](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/sddc_manager/sddc_manager_rest_client.py): `config_modules_vmware/framework/clients/sddc_manager/sddc_manager_rest_client.py`
- [ESXi CLI client](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/esxi/esx_cli_client.py): `config_modules_vmware/framework/clients/esxi/esx_cli_client.py`
- [vCenter VMOMI client](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/vcenter/vc_vmomi_client.py): `config_modules_vmware/framework/clients/vcenter/vc_vmomi_client.py`
- [pyVmomi types](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/clients/vcenter/dependencies/pyVmomi/VmomiSupport.py): `config_modules_vmware/framework/clients/vcenter/dependencies/pyVmomi/VmomiSupport.py`

### Shared framework

- [Controller metadata](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/models/controller_models/metadata.py): `config_modules_vmware/framework/models/controller_models/metadata.py`
- [Response models](https://github.com/vmware/vmware-config-modules/tree/main/config_modules_vmware/framework/models/output_models): `config_modules_vmware/framework/models/output_models`
- [Logging context](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/logging/logger_adapter.py): `config_modules_vmware/framework/logging/logger_adapter.py`
- [Runtime config](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/services/config.py): `config_modules_vmware/services/config.py`
- [Configuration comparator](https://github.com/vmware/vmware-config-modules/blob/main/config_modules_vmware/framework/utils/comparator.py): `config_modules_vmware/framework/utils/comparator.py`

### Other components

- **Calling service**

## Connections

- Calling service → Controller interface: invokes
- Controller interface → Compliance operations: dispatches (evidence: `config_modules_vmware/interfaces/controller_interface.py`)
- Controller interface → Configuration operations: dispatches (evidence: `config_modules_vmware/interfaces/controller_interface.py`)
- Controller interface → Metadata interface: loads metadata (evidence: `config_modules_vmware/interfaces/controller_interface.py`)
- Salt modules → Metadata interface: uses
- Compliance operations → Product controllers: dispatches controls
- Configuration operations → Product controllers: dispatches controls
- Product controllers → Controller base: extends (evidence: `config_modules_vmware/controllers/vcenter/ip_based_storage_port_group_config.py`)
- Controller base → Configuration comparator: compares values (evidence: `config_modules_vmware/controllers/base_controller.py`)
- Controller metadata → Schema utility: retrieves schema (evidence: `config_modules_vmware/framework/models/controller_models/metadata.py`)
- Controller interface → Response models: formats results (evidence: `config_modules_vmware/interfaces/controller_interface.py`)
- Product controllers → Product contexts: uses context (evidence: `config_modules_vmware/controllers/esxi/host_client_session_idle_timeout.py`)
- Product contexts → REST clients: provides connectivity
- SDDC Manager client → REST clients: delegates requests (evidence: `config_modules_vmware/framework/clients/sddc_manager/sddc_manager_rest_client.py`)
- vCenter VMOMI client → pyVmomi types: uses types (evidence: `config_modules_vmware/framework/clients/vcenter/vc_vmomi_client.py`)
- REST clients → Runtime config: reads settings (evidence: `config_modules_vmware/framework/clients/common/rest_client.py`)
- SDDC Manager client → Runtime config: reads settings (evidence: `config_modules_vmware/framework/clients/sddc_manager/sddc_manager_rest_client.py`)
- Logging context → Runtime config: loads format (evidence: `config_modules_vmware/framework/logging/logger_adapter.py`)
- pyVmomi types → pyVmomi types: supports VMOMI types (evidence: `config_modules_vmware/framework/clients/vcenter/dependencies/pyVmomi/VmomiSupport.py`)
