Broadcom API Gateway - List Active Connectors using the Gateway Migration Utility

by
Jeremy Canfield |
Updated: February 23 2022
| Broadcom API Gateway articles
This assumes you are familiar with the basic usage of the Gateway Migration Utility. Following is an example of how to list every active connector in an API Gateway.
/path/to/GatewayMigrationUtility.sh restman
-host apig.example.com
-port 8443
-username john.doe
-password f5VPX0yUJPg.m4BrjdgMv84UgktddJD3xA
-method GET
-path '1.0/activeConnectors'
Or the -argFile option can be used, to reduce the number of options that are used on the command line.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/activeConnectors'
Or, you can return a single active connector by including the ID of the connector.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/activeConnectors/fa003c1f2478cc407b0a8acbba2aa199'
Or, you can use the -query option to return a single active connector by including the name of the connector.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/activeConnectors'
-query 'name=connector001'
The -response option can be used to output the XML to a file.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/activeConnectors'
-response activeConnectors.xml
Here is an example of the output that should be returned.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<l7:List xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
<l7:Name>SSG_ACTIVE_CONNECTOR List</l7:Name>
<l7:Type>List</l7:Type>
<l7:TimeStamp>2021-01-29T05:46:12.965-06:00</l7:TimeStamp>
<l7:Link rel="self" uri="https://apig.example.com:8443/restman/1.0/activeConnectors"/>
<l7:Link rel="template" uri="https://apig.example.com:8443/restman/1.0/activeConnectors/template"/>
<l7:Item>
<l7:Name>connector001</l7:Name>
<l7:Id>8f928688badd6eece8a5278788f3351e</l7:Id>
<l7:Type>SSG_ACTIVE_CONNECTOR</l7:Type>
<l7:TimeStamp>2021-01-29T05:46:12.965-06:00</l7:TimeStamp>
<l7:Link rel="self" uri="https://apig.example.com:8443/restman/1.0/activeConnectors/8f928688badd6eece8a5278788f3351e"/>
<l7:Resource>
<l7:ActiveConnector id="8f928688badd6eece8a5278788f3351e" version="3">
<l7:Name>connector001</l7:Name>
<l7:Enabled>true</l7:Enabled>
<l7:Type>MqNative</l7:Type>
<l7:Properties>
<l7:Property key="MqNativeChannel">
<l7:StringValue>CHANNEL001</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeHostName">
<l7:StringValue>mq.example.com</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeInboundIsFailedQueuePutMessageOptionsUsed">
<l7:StringValue>false</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeInboundIsGetMessageOptionsUsed">
<l7:StringValue>false</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeInboundIsOpenOptionsUsed">
<l7:StringValue>false</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeInboundIsReplyQueuePutMessageOptionsUsed">
<l7:StringValue>false</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeIsQueueCredentialRequired">
<l7:StringValue>true</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeIsSslEnabled">
<l7:StringValue>false</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeOutboundIsReplyQueueGetMessageOptionsUsed">
<l7:StringValue>false</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeOutboundIsTemplateQueue">
<l7:StringValue>false</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeOutboundMessageFormat">
<l7:StringValue>AUTOMATIC</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativePort">
<l7:StringValue>5221</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeQueueManagerName">
<l7:StringValue>MANAGER001</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeReplyType">
<l7:StringValue>REPLY_NONE</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeSecurePasswordOid">
<l7:StringValue>8f928688badd6eece8a5278788a0636d</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeTargetQueueName">
<l7:StringValue>QUEUE001</l7:StringValue>
</l7:Property>
<l7:Property key="MqNativeUserId">
<l7:StringValue>john.doe</l7:StringValue>
</l7:Property>
<l7:Property key="inbound">
<l7:StringValue>false</l7:StringValue>
</l7:Property>
</l7:Properties>
</l7:ActiveConnector>
</l7:Resource>
</l7:Item>
</l7:List>
Did you find this article helpful?
If so, consider buying me a coffee over at