Migration of Cluster Properties

Products

• CA API Gateway

Issue/Introduction

I cannot find a viable way to Migrate Out Cluster properties using either the GMU or RESTMAN. Some of our Properties are not tied to Policies and so are not picked up as a part of a Policy Migration.

Example: Websocket Assertions need certain variables. I'd like to import these instead of having to hand enter these to every machine.

 

Environment

Release : 10.0

Component :

Resolution

Using Restman you can do this.

Ensure you have published the internal service of restman.

First list all CWP using postman / browser or other.

https://<HostName>:9443/restman/1.0/clusterProperties

Then build a BUNDLE for import/export for only the CWP needed:

*** Special Note in some cases you may have to add additional flags like encryption flags etc depending on the resource but for clusterProperty its not required. 

https://<HostName>:9443/restman/1.0/bundle?clusterProperty=4aec854b9d70b3bd44a39be8cea7eee7&clusterProperty=4aec854b9d70b3bd44a39be8cea7eedb

Example bundle

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<l7:Item xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">

    <l7:Name>Bundle</l7:Name>

    <l7:Type>BUNDLE</l7:Type>

    <l7:TimeStamp>2021-08-04T12:32:39.079-04:00</l7:TimeStamp>

    <l7:Link rel="self" uri="https://<HostName>:9443/restman/1.0/bundle?clusterProperty=4aec854b9d70b3bd44a39be8cea7eee7&amp;clusterProperty=4aec854b9d70b3bd44a39be8cea7eedb"/>

    <l7:Resource>

        <l7:Bundle>

            <l7:References>

                <l7:Item>

                    <l7:Name>websocket.max.inbound.connections</l7:Name>

                    <l7:Id>4aec854b9d70b3bd44a39be8cea7eee7</l7:Id>

                    <l7:Type>CLUSTER_PROPERTY</l7:Type>

                    <l7:TimeStamp>2021-08-04T12:32:39.079-04:00</l7:TimeStamp>

                    <l7:Resource>

                        <l7:ClusterProperty id="4aec854b9d70b3bd44a39be8cea7eee7" version="0">

                            <l7:Name>websocket.max.inbound.connections</l7:Name>

                            <l7:Value>4096</l7:Value>

                        </l7:ClusterProperty>

                    </l7:Resource>

                </l7:Item>

                <l7:Item>

                    <l7:Name>websocket.accept.queue.size</l7:Name>

                    <l7:Id>4aec854b9d70b3bd44a39be8cea7eedb</l7:Id>

                    <l7:Type>CLUSTER_PROPERTY</l7:Type>

                    <l7:TimeStamp>2021-08-04T12:32:39.079-04:00</l7:TimeStamp>

                    <l7:Resource>

                        <l7:ClusterProperty id="4aec854b9d70b3bd44a39be8cea7eedb" version="0">

                            <l7:Name>websocket.accept.queue.size</l7:Name>

                            <l7:Value>100</l7:Value>

                        </l7:ClusterProperty>

                    </l7:Resource>

                </l7:Item>

            </l7:References>

            <l7:Mappings>

                <l7:Mapping action="NewOrExisting" srcId="4aec854b9d70b3bd44a39be8cea7eee7" srcUri="https://<HostName>:9443/restman/1.0/clusterProperties/4aec854b9d70b3bd44a39be8cea7eee7" type="CLUSTER_PROPERTY">

                    <l7:Properties>

                        <l7:Property key="MapBy">

                            <l7:StringValue>name</l7:StringValue>

                        </l7:Property>

                    </l7:Properties>

                </l7:Mapping>

                <l7:Mapping action="NewOrExisting" srcId="4aec854b9d70b3bd44a39be8cea7eedb" srcUri="https://<HostName>:9443/restman/1.0/clusterProperties/4aec854b9d70b3bd44a39be8cea7eedb" type="CLUSTER_PROPERTY">

                    <l7:Properties>

                        <l7:Property key="MapBy">

                            <l7:StringValue>name</l7:StringValue>

                        </l7:Property>

                    </l7:Properties>

                </l7:Mapping>

            </l7:Mappings>

        </l7:Bundle>

    </l7:Resource>

</l7:Item>