---
title: "The Properties Facet"
url: https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet
language: python
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# The Properties Facet

Programming language: Python. Other languages: [C++](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/cpp.md), [C#](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/csharp.md), [Java](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/java.md), [JavaScript](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/matlab.md), [PHP](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/php.md), [Ruby](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/ruby.md), [Swift](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/swift.md).

The `Properties` facet lets an administrative client read and update the [configuration properties](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/python.md) of a running program's communicator. It implements the [`Ice::PropertiesAdmin`](https://code.zeroc.com/ice/3.8/api/python/Ice.PropertiesAdminPrx.html) interface.

## Reading and Updating Properties

An administrative client reads properties with `getProperty` and `getPropertiesForPrefix`, and updates them with `setProperties`. `setProperties` merges the properties it receives into the communicator's properties: it adds or changes each property that has a value, and removes each property whose value is empty. The other properties keep their values.

`setProperties` applies [property validation](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-overview/python.md#property-validation) to each property it adds, changes or removes. The update is not all or nothing: when validation rejects a property, the properties that `setProperties` applied before it keep their new values. Set [Ice.Trace.Admin.Properties](https://docs.zeroc.com/ice/3.8/property-reference/ice-trace-properties/python.md#ice.trace.admin.properties) to trace the changes that `setProperties` makes.

> **Note**
>
> Changing a property generally does not reconfigure an initialized Ice component. When the Metrics facet is also enabled, updates to `IceMX.Metrics.*` through this facet reconfigure the metrics views. Application properties take effect when the application reads them again or handles a property update callback.

## Receiving Property Updates

An application can register callbacks that the `Properties` facet calls after each successful `setProperties` call. A callback receives the added and changed properties with their new values, and the removed properties with empty values; the dictionary is empty when the call changed nothing. Direct calls to `Properties.setProperty` do not invoke these callbacks.

`findAdminFacet` returns a [NativePropertiesAdmin](https://code.zeroc.com/ice/3.8/api/python/Ice.NativePropertiesAdmin.html) wrapper that provides access to the update callbacks of this facet. `removeAdminFacet` returns `None` for this facet.

```py
propertiesAdmin = communicator.findAdminFacet("Properties")
if propertiesAdmin is not None:
    assert isinstance(propertiesAdmin, Ice.NativePropertiesAdmin)
    ...
```

`addUpdateCallback` accepts a callable that takes a `dict[str, str]` and returns `None`. Retain the callable to unregister it with `removeUpdateCallback`:

```py
def onUpdate(changes: dict[str, str]) -> None:
    """Apply updated application settings."""
    ...

propertiesAdmin.addUpdateCallback(onUpdate)
# When notifications are no longer needed:
propertiesAdmin.removeUpdateCallback(onUpdate)
```

## See Also

- [Properties and Configuration](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/python.md)
- [IceGrid](https://docs.zeroc.com/ice/3.8/services/icegrid.md)
- [Using the admin Object](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/using-the-admin-object/python.md)
