5.8 Command API
29.3343GPPIMS Application Level Gateway (IMS-ALG) – IMS Access Gateway (IMS-AGW)Iq InterfaceRelease 17Stage 3TS
5.8.1 Add
Table 5.8.1.1: Descriptors used by Command Add Request
|
Descriptors used by Add request: |
Media (Stream(LocalControl, Local, Remote)), Event, Signals |
Table 5.8.1.2: Descriptors used by Command Add Reply
|
Descriptors used by Add reply: |
Media (Stream (Local)), Error When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are: – The Error Descriptor – SDP properties returned in "Reserve AGW Connection Point" and "Reserve and Configure AGW Connection Point" procedures, as specified in 15.17.2.2 and 15.17.2.4. |
5.8.2 Modify
Table 5.8.2.1: Descriptors used by Command Modify Request
|
Descriptors used by Modify request: |
Media (TerminationState, Stream (LocalControl, Local, Remote)), Signals, Event |
Table 5.8.2.2: Descriptors used by Command Modify Reply
|
Descriptors used by Modify reply: |
Media (Stream(Local)), Error When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are: – The Error Descriptor – SDP properties returned in " Configure AGW Connection Point " procedure as specified in 15.17.2.3. |
5.8.3 Subtract
Table 5.8.3.1: Descriptor used by Command Subtract Request
|
Descriptors used by Subtract request: |
None, Audit() NOTE |
|
NOTE: This requests that no statistics are to be returned |
|
Table 5.8.3.2: Descriptor used by Command Subtract Reply
|
Descriptors used by Subtract reply: |
None, Error |
5.8.4 Move
Table 5.8.4.1: Command Move
|
Move command used: |
No |
If used:
Table 5.8.4.2: Descriptor used by Move command
|
Descriptors used by Move request: |
– |
|
Descriptors used by Move reply: |
– |
5.8.5 AuditValue
Table 5.8.5.1: Auditvalue
|
Audited Properties: |
Property Name and Identity |
Descriptor |
|
TerminationState: – Root (MGW Audit) |
TerminationState Descriptor |
|
|
For Packages: Root |
Packages Descriptor |
|
|
None (MGW Audit) : – Root |
Audit (empty) Descriptor |
|
|
IP Realm Availability : – ipra/* (ROOT) |
TerminationState Descriptor |
|
|
Base root properties: – root/* (ROOT) |
TerminationState Descriptor |
|
|
SDPCapNeg Extensions: – sdpe/* |
TerminationState Descriptor |
|
|
Audited Statistics: |
None |
|
|
Audited Signals: |
None |
|
|
Audited Events: |
None |
|
|
Packages Audit possible: |
Yes |
|
5.8.6 AuditCapabilities
Table 5.8.6.1: Auditcapability
|
Audited Properties: |
Property Name and Identity |
Descriptor |
|
None |
– |
|
|
Audited Statistics: |
None |
|
|
Audited Signals: |
None |
|
|
Audited Events: |
None |
|
Table 5.8.6.2: Scoped Auditing
|
Audited Properties / ContextAttributes used for a scoped audit : |
None |
5.8.7 Notify
Table 5.8.7.1: Descriptors Used by Notify Request
|
Descriptors used by Notify Request |
ObservedEvents |
Table 5.8.7.2: Descriptors Used by Notify Reply
|
Descriptors used by Notify Reply: |
None, Error |
5.8.8 ServiceChange
Table 5.8.8.1: ServiceChangeMethods and ServiceChangeReasons sent by IMS-ALG:
|
Service Change Methods Supported: |
ServiceChange Reasons supported: |
|
Handoff (NOTE 2, NOTE 3) |
"903 MGC Directed Change" (Optional, NOTE 4) |
|
Restart (NOTE 2) |
"901 Cold Boot" (Optional) "902 Warm Boot" (Optional) |
|
Forced (NOTE 2) |
"905 Termination Taken Out Of Service" (Optional) |
|
Graceful (NOTE 2) |
"905 Termination Taken Out Of Service" (Optional) |
|
NOTE 1: When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. NOTE 2: ROOT Only. NOTE 3: Not involving more than 1 IMS-ALG. This does not preclude the use of the MGCId in a ServiceChange (Handoff) scenario, nor does it change the expected IMS-AGW behaviour upon receipt of such a message, as the IMS-AGW has actually no means to differentiate whether the ServiceChangeMgcId parameter that may be received in a ServiceChange (handoff) message relates to a logical IMS-ALG inside the same IMS-ALG server or is part of another IMS-ALG. NOTE 4: Support of this procedure is mandatory in the IMS-AGW. |
|
Table 5.8.8.2: ServiceChangeMethods and ServiceChangeReasons sent by IMS-AGW:
|
Service Change Methods Supported: |
ServiceChange Reasons supported: |
|
Forced |
"904 Termination Malfunction", ALL except ROOT (Optional, NOTE 4) "905 Termination Taken Out Of Service" , ALL (Mandatory) "906 Loss Of Lower Layer Connectivity" , ALL except ROOT (Optional, NOTE 4) "907 Transmission Failure" , ALL except ROOT (Optional, NOTE 4) "908 MG Impending Failure" ROOT only (Mandatory) "910 Media Capability Failure" , ALL except ROOT (Optional, NOTE 4) "915 State Loss" ROOT only (Optional, NOTE 4) |
|
Graceful (NOTE 2) |
"905 Termination Taken Out Of Service" , (Optional, NOTE 4) "908 MG Impending Failure" (Optional, NOTE 4) |
|
Disconnected (NOTE 2) |
"900 Service Restored" (Mandatory) "916 Packages Change" (Optional) "917 Capability Change" (Optional) |
|
Restart (NOTE 2) |
"900 Service Restored" (Mandatory) "916 Packages Change" (Optional) "917 Capability Change "(Optional) |
|
Handoff (NOTE 2, NOTE 3) |
"903 MGC Directed Change" (Mandatory) |
|
NOTE 1: When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. NOTE 2: ROOT Only. NOTE 3: In response to a IMS-ALG Ordered Re-Register (clause 5.17.3.7). NOTE 4: Support of this procedure is mandatory in the IMS-ALG. |
|
Table 5.8.8.3: Service Change Address
|
ServiceChangeAddress used: |
No |
Table 5.8.8.4: Service Change Delay
|
ServiceChangeDelay used: |
No |
|
|
If yes |
Valid time period: |
|
Table 5.8.8.5: Service Change Incomplete Flag
|
ServiceChange Incomplete Flag used: |
No |
Table 5.8.8.6: Service Change Version
|
Version used in ServiceChangeVersion: |
2 or 3 |
|
NOTE: Version 2 shall be supported as the minimum protocol version. See clause 5.3. |
|
Table 5.8.8.7: ServiceChangeProfile
|
ServiceChangeProfile mandatory: |
Yes |
|
NOTE: The ServiceChangeProfile is mandatory in the AGW Register and AGW Re-Register procedures. |
|
Table 5.8.8.8: Profile negotiation
|
Profile negotiation as per H.248.18: |
No |
Table 5.8.8.9: ServiceChangeMGCId
|
ServiceChangeMGCId used: |
Yes |
5.8.9 Manipulating and auditing context attributes
Table 5.8.9.1: Manipulating and auditing context attributes
|
Context Attributes Manipulated: |
Emergency Indicator, Priority Indicator, Topology |
|
Context Attributes Audited: |
None |