Bootstrap FreeKB - Broadcom API Gateway - List Listen Ports using the Gateway Migration Utility
Broadcom API Gateway - List Listen Ports using the Gateway Migration Utility

Updated:   |  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 listen port in an API Gateway.

/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/listenPorts'

 

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/listenPorts'

 

Or, you can return a single listen port by including the ID of the listen port.

/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/listenPorts/fa003c1f2478cc407b0a8acbba2aa199'

 

Or, you can use the -query option to return a single listen port by including the name of the listen port.

/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/listenPorts'
-query 'name=httpsport'

 

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/listenPorts'
-response listenPorts.xml

 

Here is an example of the output that should be returned.

    <l7:Item>
        <l7:Name>https port</l7:Name>
        <l7:Id>c52cfe93f6a2bf473ed7a879f6d56fff</l7:Id>
        <l7:Type>SSG_CONNECTOR</l7:Type>
        <l7:TimeStamp>2021-01-29T04:55:11.311-06:00</l7:TimeStamp>
        <l7:Link rel="self" uri="https://apig.example.com:8443/restman/1.0/listenPorts/c52cfe93f6a2bf473ed7a879f6d56fff"/>
        <l7:Resource>
            <l7:ListenPort id="c52cfe93f6a2bf473ed7a879f6d56fff" version="28">
                <l7:Name>https port</l7:Name>
                <l7:Enabled>true</l7:Enabled>
                <l7:Protocol>HTTPS</l7:Protocol>
                <l7:Port>8443</l7:Port>
                <l7:EnabledFeatures>
                    <l7:StringValue>Published service message input</l7:StringValue>
                </l7:EnabledFeatures>
                <l7:TlsSettings>
                    <l7:ClientAuthentication>Required</l7:ClientAuthentication>
                    <l7:PrivateKeyReference id="00000000000000000000000000000002:key001" resourceUri="http://ns.l7tech.com/2010/04/gateway-management/privateKeys"/>
                    <l7:EnabledVersions>
                        <l7:StringValue>TLSv1.1</l7:StringValue>
                        <l7:StringValue>TLSv1.2</l7:StringValue>
                    </l7:EnabledVersions>
                    <l7:EnabledCipherSuites>
                        <l7:StringValue>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</l7:StringValue>
                        <l7:StringValue>TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</l7:StringValue>
                        <l7:StringValue>TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384</l7:StringValue>
                        <l7:StringValue>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</l7:StringValue>
                        <l7:StringValue>TLS_DHE_RSA_WITH_AES_256_GCM_SHA384</l7:StringValue>
                        <l7:StringValue>TLS_DHE_RSA_WITH_AES_128_GCM_SHA256</l7:StringValue>
                        <l7:StringValue>TLS_DHE_RSA_WITH_AES_256_CBC_SHA256</l7:StringValue>
                        <l7:StringValue>TLS_DHE_RSA_WITH_AES_128_CBC_SHA256</l7:StringValue>
                        <l7:StringValue>TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA</l7:StringValue>
                        <l7:StringValue>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</l7:StringValue>
                        <l7:StringValue>TLS_DHE_RSA_WITH_AES_128_CBC_SHA</l7:StringValue>
                        <l7:StringValue>TLS_DHE_RSA_WITH_AES_256_CBC_SHA</l7:StringValue>
                        <l7:StringValue>TLS_RSA_WITH_AES_256_GCM_SHA384</l7:StringValue>
                        <l7:StringValue>TLS_RSA_WITH_AES_128_GCM_SHA256</l7:StringValue>
                        <l7:StringValue>TLS_RSA_WITH_AES_256_CBC_SHA256</l7:StringValue>
                        <l7:StringValue>TLS_RSA_WITH_AES_128_CBC_SHA256</l7:StringValue>
                        <l7:StringValue>TLS_RSA_WITH_AES_256_CBC_SHA</l7:StringValue>
                        <l7:StringValue>TLS_RSA_WITH_AES_128_CBC_SHA</l7:StringValue>
                    </l7:EnabledCipherSuites>
                    <l7:Properties>
                        <l7:Property key="usesTLS">
                            <l7:BooleanValue>true</l7:BooleanValue>
                        </l7:Property>
                    </l7:Properties>
                </l7:TlsSettings>
                <l7:Properties>
                    <l7:Property key="useExtendedFtpCommandSet">
                        <l7:StringValue>false</l7:StringValue>
                    </l7:Property>
                </l7:Properties>
            </l7:ListenPort>
        </l7:Resource>
    </l7:Item>
</l7:List>

 




Did you find this article helpful?

If so, consider buying me a coffee over at Buy Me A Coffee



Comments


Add a Comment


Please enter 3a8374 in the box below so that we can be sure you are a human.