Skip to content

Insert Subscriber Data

API reference for diameter.message.commands.insert_subscriber_data.

This module contains Insert Subscriber Data Request and Answer messages for the S6a/S6d and S7a/S7d interfaces, implementing AVPs documented in 3GPP TS 29.272.

InsertSubscriberData

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

Bases: DefinedMessage

An Insert-Subscriber-Data base message.

This message class lists message attributes based on the current 3GPP TS 29.272 version 19.4.0 Release 19 as python properties, accessible as instance attributes. AVPs not listed in the spec protocol can be retrieved using the InsertSubscriberData.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 InsertSubscriberDataRequest or InsertSubscriberDataAnswer automatically:

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

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

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

Other, custom AVPs can be appended to the message using the InsertSubscriberData.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.

InsertSubscriberDataAnswer

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

Bases: InsertSubscriberData

An Insert-Subscriber-Data-Answer message.

3GPP TS 29.272 version 19.4.0

auth_session_state instance-attribute

auth_session_state: int

drmp instance-attribute

drmp: int

eps_location_information instance-attribute

eps_location_information: EpsLocationInformation

eps_user_state instance-attribute

eps_user_state: EpsUserState

experimental_result instance-attribute

experimental_result: ExperimentalResult

failed_avp instance-attribute

failed_avp: list[FailedAvp]

ida_flags instance-attribute

ida_flags: int

ims_voice_over_ps_sessions_supported instance-attribute

ims_voice_over_ps_sessions_supported: int

last_ue_activity_time instance-attribute

last_ue_activity_time: datetime

local_time_zone instance-attribute

local_time_zone: LocalTimeZone

monitoring_event_config_status instance-attribute

monitoring_event_config_status: list[MonitoringEventConfigStatus]

monitoring_event_report instance-attribute

monitoring_event_report: list[MonitoringEventReport]

origin_host instance-attribute

origin_host: bytes

origin_realm instance-attribute

origin_realm: bytes

proxy_info instance-attribute

proxy_info: list[ProxyInfo]

rat_type instance-attribute

rat_type: int

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]

supported_services instance-attribute

supported_services: SupportedServices

vendor_specific_application_id instance-attribute

vendor_specific_application_id: VendorSpecificApplicationId

InsertSubscriberDataRequest

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

Bases: InsertSubscriberData

An Insert-Subscriber-Data-Request message.

3GPP TS 29.272 version 19.4.0

auth_session_state instance-attribute

auth_session_state: int

destination_host instance-attribute

destination_host: bytes

destination_realm instance-attribute

destination_realm: bytes

drmp instance-attribute

drmp: int

idr_flags instance-attribute

idr_flags: int

origin_host instance-attribute

origin_host: bytes

origin_realm instance-attribute

origin_realm: bytes

proxy_info instance-attribute

proxy_info: list[ProxyInfo]

reset_id instance-attribute

reset_id: list[bytes]

route_record instance-attribute

route_record: list[bytes]

session_id instance-attribute

session_id: str

subscription_data instance-attribute

subscription_data: SubscriptionData

supported_features instance-attribute

supported_features: list[SupportedFeatures]

user_name instance-attribute

user_name: str

vendor_specific_application_id instance-attribute

vendor_specific_application_id: VendorSpecificApplicationId

vplmn_csg_subscription_data instance-attribute

vplmn_csg_subscription_data: list[VplmnCsgSubscriptionData]