topic Re: Looking for SIP Trunk Status (In Service/Out of Service) via AXL in Management

Looking for SIP Trunk Status (In Service/Out of Service) via AXL

caten — Wed, 11 Nov 2015 15:02:36 GMT

Hello,

I work on generating monitoring profiles for a third party NMS. We are looking for a way to gather SIP Trunk Status via the AXL API. I took a look through some older documentation and found this link:

http://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cucm/devguide/9_1_1/xmldev-911/serviceability.html#wp1079635

From this link, it states that selectCMDevice:
{
SIPStatus
Displays the status of SIP trunk. The following options are available:

•InService

•OutOfService

•PartialService

•Unknown
}

When I use the risport API call for selectCMDevice or selectCMDeviceSIP I do not receive my response. Below is my response from a 10.5 node:
{
<item xsi:type="ns1:CmNodeSIP">
<ReturnCode xsi:type="ns1:RisReturnCode">Ok</ReturnCode>
<Name xsi:type="xsd:string">HQA-CUCM-10X</Name>
<NoChange xsi:type="xsd:boolean">false</NoChange>
<CmDevices soapenc:arrayType="ns1:CmDeviceSIP[1]" xsi:type="soapenc:Array">
<item xsi:type="ns1:CmDeviceSIP">
<Name xsi:type="xsd:string">HQA-ExpresswayC-8X_Trunk</Name>
<IpAddress xsi:type="xsd:string">172.31.50.30</IpAddress>
<DirNumber xsi:type="xsd:string" xsi:nil="true"/>
<Class xsi:type="ns1:DeviceClass">SIP Trunk</Class>
<Model xsi:type="xsd:unsignedInt">131</Model>
<Product xsi:type="xsd:unsignedInt">0</Product>
<BoxProduct xsi:type="xsd:unsignedInt">0</BoxProduct>
<Httpd xsi:type="ns1:CmDevHttpd">Unknown</Httpd>
<RegistrationAttempts xsi:type="xsd:unsignedInt">0</RegistrationAttempts>
<IsCtiControllable xsi:type="xsd:boolean">false</IsCtiControllable>
<LoginUserId xsi:type="xsd:string" xsi:nil="true"/>
<Status xsi:type="ns1:CmDevRegStat">Unknown</Status>
<StatusReason xsi:type="xsd:unsignedInt">0</StatusReason>
<PerfMonObject xsi:type="xsd:unsignedInt">0</PerfMonObject>
<DChannel xsi:type="xsd:unsignedInt">0</DChannel>
<Description xsi:type="xsd:string">HQA-ExpresswayC-8X</Description>
<H323Trunk xsi:type="ns1:H323Trunk">
<ConfigName xsi:type="xsd:string" xsi:nil="true"/>
<TechPrefix xsi:type="xsd:string" xsi:nil="true"/>
<Zone xsi:type="xsd:string" xsi:nil="true"/>
<RemoteCmServer1 xsi:type="xsd:string" xsi:nil="true"/>
<RemoteCmServer2 xsi:type="xsd:string" xsi:nil="true"/>
<RemoteCmServer3 xsi:type="xsd:string" xsi:nil="true"/>
<AltGkList xsi:type="xsd:string" xsi:nil="true"/>
<ActiveGk xsi:type="xsd:string" xsi:nil="true"/>
<CallSignalAddr xsi:type="xsd:string" xsi:nil="true"/>
<RasAddr xsi:type="xsd:string" xsi:nil="true"/>
</H323Trunk>
<TimeStamp xsi:type="xsd:unsignedInt">0</TimeStamp>
<Protocol xsi:type="ns1:ProtocolType">Any</Protocol>
<NumOfLines xsi:type="xsd:unsignedInt">0</NumOfLines>
<LinesStatus soapenc:arrayType="ns1:CmDevSingleLineStatus[0]" xsi:type="soapenc:Array"/>
</item>
</CmDevices>
</item>
</CmNodes>
</SelectCmDeviceResultSIP>
}

Does anyone know of a better method to gather SIP trunk status?

Thanks!

Re: Looking for SIP Trunk Status (In Service/Out of Service) via AXL

npetrele — Wed, 11 Nov 2015 16:17:04 GMT

Can you post your request XML?

Re: Looking for SIP Trunk Status (In Service/Out of Service) via AXL

caten — Wed, 11 Nov 2015 17:09:50 GMT

I have tried both selectCMDevice and selectCMDeviceSIP. Note that the below are pulled from a BASH script to make things easier for me to edit/test.

selectCMDevice

request='<?xml version="1.0" encoding="utf-8"?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soapenv:Body>

<ns1:SelectCmDevice soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://schemas.cisco.com/ast/soap/">

</ns1:SelectCmDevice>

<Status xsi:type="xsd:string">Registered</Status>

<Item>>HQA-ExpresswayC-8X_Trunk</Item>

</item>

</SelectItems>

</multiRef>

</multiRef>

</soapenv:Body>

</soapenv:Envelope>'

curl --silent -k -u 'XXXXXXXX:XXXXXX' -H "Content-type: text/xml;" -H "SOAPAction: http://schemas.cisco.com/ast/soap/action/#RisPort#selectCmDevice" -d "$request" https://172.31.50.30:8443/realtimeservice/services/RisPort | xmllint --format -

No results for this trunk are found here:

<?xml version="1.0" encoding="UTF-8"?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soapenv:Body>

<ns1:SelectCmDeviceResponse xmlns:ns1="http://schemas.cisco.com/ast/soap/" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

</SelectCmDeviceResult>

</ns1:SelectCmDeviceResponse>

</soapenv:Body>

</soapenv:Envelope>

selectCMDeviceSIP

request='<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">

<soapenv:Header>

</soapenv:Header>

<soapenv:Body>

<soap:SelectCmDeviceSIP soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<Class xsi:type="xsd:string">SIP Trunk</Class>

<item>

<Item>HQA-ExpresswayC-8X_Trunk</Item>

</item>

</SelectItems>

</CmSelectionCriteriaSIP>

</soap:SelectCmDeviceSIP>

</soapenv:Body>

</soapenv:Envelope>'

curl --silent -k -u 'XXXXXXXX:XXXXXX' -H "Content-type: text/xml;" -H "SOAPAction: http://schemas.cisco.com/ast/soap/action/#RisPort#selectCmDeviceSIP" -d "$request" https://172.31.50.30:8443/realtimeservice/services/RisPort | xmllint --format -

Results are found:

<?xml version="1.0" encoding="UTF-8"?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soapenv:Body>

<ns1:SelectCmDeviceSIPResponse xmlns:ns1="http://schemas.cisco.com/ast/soap/" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<NoChange xsi:type="xsd:boolean">false</NoChange>

</item>

<ReturnCode xsi:type="ns1:RisReturnCode">NotFound</ReturnCode>

</item>

<NoChange xsi:type="xsd:boolean">false</NoChange>

<Name xsi:type="xsd:string">HQA-ExpresswayC-8X_Trunk</Name>

<Class xsi:type="ns1:DeviceClass">SIP Trunk</Class>

<Httpd xsi:type="ns1:CmDevHttpd">Unknown</Httpd>

<IsCtiControllable xsi:type="xsd:boolean">false</IsCtiControllable>

<Status xsi:type="ns1:CmDevRegStat">Registered</Status>

<Description xsi:type="xsd:string">HQA-ExpresswayC-8X</Description>

</H323Trunk>

</item>

</CmDevices>

</item>

</CmNodes>

</SelectCmDeviceResultSIP>

</ns1:SelectCmDeviceSIPResponse>

</soapenv:Body>

</soapenv:Envelope>

Thanks!

Re: Looking for SIP Trunk Status (In Service/Out of Service) via AXL

dstaudt — Wed, 11 Nov 2015 17:37:20 GMT

It looks like the details for the requested device 'HQA-ExpresswayC-8X' are present in the response for SelectCmDeviceSIP, are you looking for something different?

          ...

             <item xsi:type="ns1:CmDeviceSIP">

                <Name xsi:type="xsd:string">HQA-ExpresswayC-8X_Trunk</Name>

                <IpAddress xsi:type="xsd:string">172.31.50.30</IpAddress>

                <DirNumber xsi:type="xsd:string" xsi:nil="true"/>

                <Class xsi:type="ns1:DeviceClass">SIP Trunk</Class>

                <Model xsi:type="xsd:unsignedInt">131</Model>

                <Product xsi:type="xsd:unsignedInt">0</Product>

                <BoxProduct xsi:type="xsd:unsignedInt">0</BoxProduct>

                <Httpd xsi:type="ns1:CmDevHttpd">Unknown</Httpd>

                <RegistrationAttempts xsi:type="xsd:unsignedInt">0</RegistrationAttempts>

                <IsCtiControllable xsi:type="xsd:boolean">false</IsCtiControllable>

                <LoginUserId xsi:type="xsd:string" xsi:nil="true"/>

                <Status xsi:type="ns1:CmDevRegStat">Registered</Status>

                <StatusReason xsi:type="xsd:unsignedInt">0</StatusReason>

                <PerfMonObject xsi:type="xsd:unsignedInt">0</PerfMonObject>

                <DChannel xsi:type="xsd:unsignedInt">0</DChannel>

                <Description xsi:type="xsd:string">HQA-ExpresswayC-8X</Description>

                <H323Trunk xsi:type="ns1:H323Trunk">

                  <ConfigName xsi:type="xsd:string" xsi:nil="true"/>

                  <TechPrefix xsi:type="xsd:string" xsi:nil="true"/>

                  <Zone xsi:type="xsd:string" xsi:nil="true"/>

                  <RemoteCmServer1 xsi:type="xsd:string" xsi:nil="true"/>

                  <RemoteCmServer2 xsi:type="xsd:string" xsi:nil="true"/>

                  <RemoteCmServer3 xsi:type="xsd:string" xsi:nil="true"/>

                  <AltGkList xsi:type="xsd:string" xsi:nil="true"/>

                  <ActiveGk xsi:type="xsd:string" xsi:nil="true"/>

                  <CallSignalAddr xsi:type="xsd:string" xsi:nil="true"/>

                  <RasAddr xsi:type="xsd:string" xsi:nil="true"/>

                </H323Trunk>

                <TimeStamp xsi:type="xsd:unsignedInt">0</TimeStamp>

                <Protocol xsi:type="ns1:ProtocolType">Any</Protocol>

                <NumOfLines xsi:type="xsd:unsignedInt">0</NumOfLines>

                <LinesStatus soapenc:arrayType="ns1:CmDevSingleLineStatus[0]" xsi:type="soapenc:Array"/>

              </item>

Re: Looking for SIP Trunk Status (In Service/Out of Service) via AXL

caten — Wed, 11 Nov 2015 17:42:26 GMT

Check this link:

http://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cucm/devguide/9_1_1/xmldev-911/serviceability.html#wp1079635

In 9.1.1 it appears that there was a SIPStatus field that would display one of the following:

InService

OutOfService

PartialService

Unknown

Looking at registration might be OK if SIP trunks to destinations were a 1-to-1 relationship, but how does that show me a partial service SIP trunk?

Thanks

Re: Looking for SIP Trunk Status (In Service/Out of Service) via AXL

npetrele — Wed, 11 Nov 2015 18:47:35 GMT

I'm not sure where your document comes from (yes, it's a Cisco link, but I've never seen that doc). It's possible it is incorrect, or something has changed since 9.1. But the status is actually one of the following now. I don't see SIPStatus as a returned field in the current documents.

Status

Allows device searches by status (or state):

Any
Registered
UnRegistered
Rejected
PartiallyRegistered
Unknown

Since you are making your request against a 10.5 server, I wouldn't use 9.1 documentation for it.

Re: Looking for SIP Trunk Status (In Service/Out of Service) via AXL

dstaudt — Wed, 11 Nov 2015 18:59:54 GMT

Hmm...that's indeed odd. SIPStatus in the response seems to have made its way into the docs (up until 9.1, removed thereafter) though it doesn't appear in any of the WSDLs or in the implementation.

"PartiallyRegistered" should only apply to SIP phones (with multiple lines), in that it's possible that only some of a phone's SIP lines could be registered. This does not apply to SIP trunks.

Per the schema versions I checked, the <Status> field should be able to return the complete range of statuses, i.e.:

<simpleType name="CmDevRegStat">

<restriction base="xsd:string">

    <enumeration value="Any"/>

    <enumeration value="Registered"/>

    <enumeration value="UnRegistered"/>

    <enumeration value="Rejected"/>

    <enumeration value="PartiallyRegistered"/>

    <enumeration value="Unknown"/>

</restriction>

</simpleType>

Re: Looking for SIP Trunk Status (In Service/Out of Service) via AXL

caten — Wed, 11 Nov 2015 19:55:29 GMT

I did some testing in my lab a little bit more and it appears that the status field does change, just not in the way I expected.

Up and Working (Single Destination):