Broadcom API Gateway - Create Cluster Wide Properties 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.
Let's say you want to create a Cluster Wide Property using the Gateway Migration Utility. First, create an XML file.
touch createCWP.xml
Add the following to the XML file. In this example, the Cluster Wide Property will have a key of "foo" and a value of "bar".
<l7:ClusterProperty xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
<l7:Name>foo</l7:Name>
<l7:Value>bar</l7:Value>
</l7:ClusterProperty>
Issue the following command to create the Cluster Wide Property.
/path/to/GatewayMigrationUtility.sh restman
-host apig.example.com
-port 8443
-username john.doe
-password f5VPX0yUJPg.m4BrjdgMv84UgktddJD3xA
-method POST
-path '1.0/clusterProperties'
-request createCWP.xml
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 POST
-path '1.0/clusterProperties'
-request createCWP.xml
You can then use the Gateway Migration Utility to ensure the Cluster Wide Property was created.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/clusterProperties'
-query 'name=foo'
Which should return something like this.
<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>
Did you find this article helpful?
If so, consider buying me a coffee over at