Skip to content

Profile Update

API reference for diameter.message.commands.profile_update.

This module contains Profile Update Request and Answer messages for the Sh interface, implementing AVPs documented in 3GPP TS 29.329.

ProfileUpdate 

ProfileUpdate(header: MessageHeader = None, avps: list[Avp] = None)

Bases: DefinedMessage

A Profile-Update base message.

This message class lists message attributes based on the current 3GPP TS 29.329 version 17.0.0 Release 17 as python properties, accessible as instance attributes. AVPs not listed in the spec protocol can be retrieved using the ProfileUpdate.find_avps search method.

Examples:

AVPs accessible either as instance attributes or by searching:

>>> msg = Message.from_bytes(b"...")
>>> msg.session_id
dra1.python-diameter.org;2323;546
>>> msg.find_avps((AVP_SESSION_ID, 0))
['dra1.python-diameter.org;2323;546']

When diameter message is decoded using Message.from_bytes, it returns either an instance of ProfileUpdateRequest or ProfileUpdateAnswer automatically:

>>> msg = Message.from_bytes(b"...")
>>> assert msg.header.is_request is True
>>> assert isinstance(msg, ProfileUpdateRequest)

When creating a new message, the ProfileUpdateRequest or ProfileUpdateAnswer class should be instantiated directly, and values for AVPs set as class attributes:

>>> msg = ProfileUpdateRequest()
>>> msg.session_id = "dra1.python-diameter.org;2323;546"

Other, custom AVPs can be appended to the message using the ProfileUpdate.append_avp method, or by overwriting the avp attribute entirely. Regardless of the custom AVPs set, the mandatory values listed in TS 29.272 must be set, however they can be set as None, if they are not to be used.

Warning

Every AVP documented for the subclasses of this command can be accessed as an instance attribute, even if the original network-received message did not contain that specific AVP. Such AVPs will be returned with the value None when accessed.

Every other AVP not mentioned here, and not present in a network-received message will raise an AttributeError when being accessed; their presence should be validated with hasattr before accessing.

ProfileUpdateAnswer 

ProfileUpdateAnswer(
    header: MessageHeader = None, avps: list[Avp] = None
)

Bases: ProfileUpdate

A Profile-Update-Answer message.

3GPP TS 29.329 version 17.0.0

auth_session_state instance-attribute 

auth_session_state: int

data_reference instance-attribute 

data_reference: int

drmp instance-attribute 

drmp: int

experimental_result instance-attribute 

experimental_result: ExperimentalResult

failed_avp instance-attribute 

failed_avp: FailedAvp

load instance-attribute 

load: list[Load]

oc_olr instance-attribute 

oc_olr: OcOlr

oc_supported_features instance-attribute 

oc_supported_features: OcSupportedFeatures

origin_host instance-attribute 

origin_host: bytes

origin_realm instance-attribute 

origin_realm: bytes

proxy_info instance-attribute 

proxy_info: list[ProxyInfo]

repository_data_id instance-attribute 

repository_data_id: RepositoryDataId

result_code instance-attribute 

result_code: int

route_record instance-attribute 

route_record: list[bytes]

session_id instance-attribute 

session_id: str

supported_features instance-attribute 

supported_features: list[SupportedFeatures]

vendor_specific_application_id instance-attribute 

vendor_specific_application_id: VendorSpecificApplicationId

wildcarded_impu instance-attribute 

wildcarded_impu: str

wildcarded_public_identity instance-attribute 

wildcarded_public_identity: str

ProfileUpdateRequest 

ProfileUpdateRequest(
    header: MessageHeader = None, avps: list[Avp] = None
)

Bases: ProfileUpdate

A Profile-Update-Request message.

3GPP TS 29.329 version 17.0.0

auth_session_state instance-attribute 

auth_session_state: int

data_reference instance-attribute 

data_reference: list[int]

destination_host instance-attribute 

destination_host: bytes

destination_realm instance-attribute 

destination_realm: bytes

drmp instance-attribute 

drmp: int

oc_supported_features instance-attribute 

oc_supported_features: OcSupportedFeatures

origin_host instance-attribute 

origin_host: bytes

origin_realm instance-attribute 

origin_realm: bytes

proxy_info instance-attribute 

proxy_info: list[ProxyInfo]

route_record instance-attribute 

route_record: list[bytes]

session_id instance-attribute 

session_id: str

supported_features instance-attribute 

supported_features: list[SupportedFeatures]

user_data instance-attribute 

user_data: bytes

user_identity instance-attribute 

user_identity: UserIdentity

user_name instance-attribute 

user_name: str

vendor_specific_application_id instance-attribute 

vendor_specific_application_id: VendorSpecificApplicationId

wildcarded_impu instance-attribute 

wildcarded_impu: str

wildcarded_public_identity instance-attribute 

wildcarded_public_identity: str