DataPower

Joseph Morgan IBM Champion posted Sat January 11, 2025 08:10 PM

Hey Kirby - I haven't seen your name in a while.  Let's touch base sometime!

 On a 10.6.0.2 box, the first request runs fine, whereas on a 10.5.0.11 box, I also get an internal error "*** Unknown command or macro".  So, I suspect something is not altogether right on the 10.5 box, or maybe the new probe isn't ready on that FW, or I, too, am missing something.  I issued the exact action XML on both appliances.   It is interesting to note, too, the "CreateProbeCapture" action is in the "AnyActionElement" within the XSD of the 10.0.5.11 "xml-mgmt.xsd".  Though you don't need the  "<FilterByAPIClientID/>" at all, with our without it, it errors on a 10.5.0.11 box.  The format of your SOAP Envelope is clearly correct, because it works exactly as typed on the 10.6.0.2 box.

On your 2nd call, your format is just a tiny bit off as the name of the MPG is an attribute.   Consider this:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
     <soapenv:Body>
         <dp:request xmlns:dp="http://www.datapower.com/schemas/management" domain="WTX">
             <dp:modify-config>
                 <MultiProtocolGateway name="domain-status">
                         <DebugMode>on</DebugMode>
                 </MultiProtocolGateway>
             </dp:modify-config>
         </dp:request>
     </soapenv:Body>
</soapenv:Envelope>

Para PC posted Sun January 12, 2025 01:57 AM

Implement distinct roles for teachers, students, administrators, and potentially parents, each with tailored access and permissions.

CHARLES COBLE posted Mon January 13, 2025 09:08 AM

Tested this and confirmed it works, change names and domain to match yours.  This does require probe settings to be enabled and opt state up as well:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
     <env:Body>
          <dp:request xmlns:dp="http://www.datapower.com/schemas/management" domain="apiconnect">
               <dp:modify-config>
                    <MultiProtocolGateway name="webapi">
                         <DebugMode>on</DebugMode>
                    </MultiProtocolGateway>
               </dp:modify-config>
          </dp:request>
     </env:Body>
</env:Envelope>

--------

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
     <env:Body>
          <dp:request xmlns:dp="http://www.datapower.com/schemas/management" domain="apiconnect">
               <dp:do-action>
                    <CreateProbeCapture>
                         <CaptureName>Test</CaptureName>
                         <ServiceType>MultiProtocolGateway</ServiceType>
                         <ServiceName>webapi</ServiceName>
                         <CaptureCount>20</CaptureCount>
                         <Interval>1</Interval>
                    </CreateProbeCapture>
               </dp:do-action>
          </dp:request>
     </env:Body>
</env:Envelope>

Kirby Clements posted Mon January 13, 2025 10:47 AM

Thanks Joe and Charles! Nice to have the confirms on the 10.6.0.x machine. I'll be using 10.5.0.15 for probably the next 8 months. Going to check the probe settings for 'on'.  In my case, there would be no probe existing and this request would create the probe. I'm guessing the 'capture' settings would then be automatically defaulted to capture the '20' transaction, or, do I also need a 2nd SOMA call with that 'capture' request to actually 'capture' the transactions? 

Joseph Morgan IBM Champion posted Mon January 13, 2025 12:20 PM

For the *old* probe, capturing probe data is exceedingly difficult.  KumbaSoft's DPAA tool managed to do it.  IBM Improved things quite a bit for the new probe.  There is a 2nd action you'll need to utilize, and that is the "GetAllProbeData" action (See the "ActionGetAllProbeData" in the schemas).    There are others you might want to examine, which are the "ListProbeCaptures", "GetDetailsProbeCapture", "GetProbeTransactionData" and finally the "DeleteProbeCapture" actions.

Kirby Clements posted Mon January 13, 2025 12:49 PM

Thanks Joe - I've got both requests working now, only using the <CreateProbeCapture>  as of now per our requirements. The ports being defined in different domains, with different ports, such as the 'gateway peeriring' ports of 'Local' and 'Monitor' port, has been the trick to have the 'probe settings' up in each domain. I didn't know each application domain needs different port numbers for those ports in particular  but that was my hangup. So now that the gateway peering is up, no 'port already in use' errors, I am good. It is going to be a task to assign different ports in each domain but I'm thinking that is the only way to satisfy the 'gateway peering' errors, at least so far. I was thinking the default 'local' port of '16380' and 'Monitor' port of '26380' would work in all domains, but was wrong about that.

Hermann Stamm-Wilbrandt posted Tue January 14, 2025 05:49 AM

Ports are a global resource in 0..65535 (16bit) range:
https://en.wikipedia.org/wiki/Port_(computer_networking)

Only a single service can listen on a port for a whole device.

In case you are talking about the old Probe, please keep this bold statement from DataPower docs in mind:
https://www.ibm.com/docs/en/datapower-gateway/10.5.0?topic=probe-ways-enable#probe_enabling__traditional

Kirby Clements posted Wed January 15, 2025 11:08 AM

Thanks Hermann - it's the new probe with the default capture count of '20'. We're gonna make sure no probes stay on for sure. I'll be setting up about 50 application domains for the Probe Settings adjustments to the gateway-peering configs, so that the SOMA calls to turn on the probe will work. My results in testing as of today show that 10.6.0.x accepts the SOMA call for <CreateProbeCapture>  but the firmware of 10.5.0.x does not, and gives the error of 'error' *** 'Unknown command or macro', identical to Joe's testing responses. 

Joseph Morgan IBM Champion posted Wed January 15, 2025 02:33 PM

Hey Hermann,

To add to Kriby's comments, I've also noticed some of the actions issued through the XML Management don't do what one would expect (even in 10.6.x).  For example, the ListProbeCaptures action just returns an "OK" and nothing else.   I would have expected it to return a list with capture IDs so other actions like "GetAllProbeData" can then be invoked.

Any suggestions?

Amit Munwes posted Thu January 16, 2025 01:52 AM

In DPOD we utilize the REST APIs which work both for 10.5 and 10.6. 
Note that some of the responses change between versions.

Hermann Stamm-Wilbrandt posted Thu January 16, 2025 07:11 AM

@Kirby Clements 

Please try again, and if your are not on latest 10.5.0.x, please try on a dev system with upgrade to latest.

Why?

This is 10.0.5:

$ grep CreateProbeCapture xml-mgmt.xsd 
  <xsd:complexType name="ActionCreateProbeCapture">
      <xsd:element name="CreateProbeCapture" type="tns:ActionCreateProbeCapture" />
      <xsd:enumeration value="CreateProbeCapture" />
$

And this is identical on 10.6.0:

$ grep CreateProbeCapture xml-mgmt.xsd
  <xsd:complexType name="ActionCreateProbeCapture">
      <xsd:element name="CreateProbeCapture" type="tns:ActionCreateProbeCapture" />
      <xsd:enumeration value="CreateProbeCapture" />
$

@Joseph
Please create a (query type) support ticket on ListProbeCaptures.

Kirby Clements posted Sun February 02, 2025 12:26 PM

Late in this response, but to answer Hermann's request, I did test with 10.5.0.15 and get the exact same error when testing with 10.5.0.11.  Since this is a POC we are going to use 10.6.0.x for the SOMA probe creation in our sandbox environment. Thanks to everyone for the input.