Skip to content

Update VCSG Location

API reference for diameter.message.commands.update_vcsg_location.

This module contains Update VCSG Location Request and Answer messages for the S7a/S7d interface, implementing AVPs documented in 3GPP TS 29.272.

UpdateVcsgLocation

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

Bases: DefinedMessage

An Update-VCSG-Location 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 UpdateVcsgLocation.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 UpdateVcsgLocationRequest or UpdateVcsgLocationAnswer automatically:

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

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

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

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

UpdateVcsgLocationAnswer

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

Bases: UpdateVcsgLocation

An Update-VCSG-Location-Answer message.

3GPP TS 29.272 version 19.4.0

auth_session_state instance-attribute

auth_session_state: int

drmp instance-attribute

drmp: int

error_diagnostic instance-attribute

error_diagnostic: int

experimental_result instance-attribute

experimental_result: ExperimentalResult

failed_avp instance-attribute

failed_avp: list[FailedAvp]

origin_host instance-attribute

origin_host: bytes

origin_realm instance-attribute

origin_realm: bytes

proxy_info instance-attribute

proxy_info: list[ProxyInfo]

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]

uva_flags instance-attribute

uva_flags: int

vendor_specific_application_id instance-attribute

vendor_specific_application_id: VendorSpecificApplicationId

vplmn_csg_subscription_data instance-attribute

vplmn_csg_subscription_data: list[VplmnCsgSubscriptionData]

UpdateVcsgLocationRequest

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

Bases: UpdateVcsgLocation

An Update-VCSG-Location-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

msisdn instance-attribute

msisdn: bytes

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

sgsn_number instance-attribute

sgsn_number: bytes

supported_features instance-attribute

supported_features: list[SupportedFeatures]

user_name instance-attribute

user_name: str

uvr_flags instance-attribute

uvr_flags: int

vendor_specific_application_id instance-attribute

vendor_specific_application_id: VendorSpecificApplicationId