FreeKB - Broadcom API Gateway List Cluster Wide Properties using the Gateway Migration Utility (GMU)
Broadcom API Gateway - List Cluster Wide Properties using the Gateway Migration Utility (GMU)

In your API Gateway, you can select Tasks > Global Settings > Manager Cluster-Wide Properties to display the Cluster Wide Properties. In this example, there is a cluster wide property with a key of "foo" and a value of "bar".


 


List Cluster Wide Property Name and ID

This assumes you are familiar with the basic usage of the Gateway Migration Utility and that you are using an arguments file with an encoded password to connect to your API Gateway.

The Gateway Migration Utility can be used to list the ID and key of each Cluster Wide Property.

/path/to/GatewayMigrationUtility.sh list -argFile example.properties -type CLUSTER_PROPERTY

 

In this example, the Cluster Wide Property "foo" has an ID of 1a5b56dfad45645645fd5464df65.

1a5b56dfad45645645fd5464df65     foo

 


List Cluster Wide Property Name and ID and Value

Usually, you are going to need more than just the name and ID. You probably are going to need the value (bar in this example). Restman can be used to get the name, ID, and value. In this example, every Cluster Wide Property will be returned.

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

 

Or, a single Cluster Wide Property can be returned by including the ID.

/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/clusterProperties/1a5b56dfad45645645fd5464df65'

 

Or, you can use the -query option to return a single Cluster Wide Property by including the name of the Cluster Wide Property.

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

 

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

 

Something like this should be returned.

<l7:List>
  <l7:Item>
    <l7:Name>foo</l7:Name>
    <l7:Id>1a5b56dfad45645645fd5464df65</l7:Id>
    <l7:Type>CLUSTER_PROPERTY</l7:Type>
    <l7:TimeStamp>2019-03-29T00:55:11.088-05:00</l7:TimeStamp>
    <l7:Link rel="self" uri="https://example.com:8443/restman/1.0/clusterProperties/1a5b56dfad45645645fd5464df65"/>
    <l7:Resource>
      <l7:ClusterProperty id="1a5b56dfad45645645fd5464df65" version="1">
        <l7:Name>foo</l7:Name>
        <l7:Value>bar</l7:Value>
      </l7:ClusterProperty>
    </l7:Resource>
  </l7:Item>
</l7:List>

 



Add a Comment




We will never share your name or email with anyone. Enter your email if you would like to be notified when we respond to your comment.




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




Comments

Web design by yours truely - me, myself, and I   |   jeremy.canfield@freekb.net   |