Bootstrap FreeKB - Broadcom API Gateway - Create Stored Password using the Gateway Migration Utility
Broadcom API Gateway - Create Stored Password using the Gateway Migration Utility

Updated:   |  Broadcom API Gateway articles

This assumes you are familiar with the basic usage of the Gateway Migration Utility. Create an XML file.

touch stored_password.xml

 

Add the following to the XML file. In this example, stored password foo with a value of bar will be created.

<l7:StoredPassword xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
  <l7:Name>foo</l7:Name>
  <l7:Password>bar</l7:Password>
  <l7:Properties>
      <l7:Property key="description">
          <l7:StringValue>foo password</l7:StringValue>
      </l7:Property>
      <l7:Property key="type">
          <l7:StringValue>Password</l7:StringValue>
      </l7:Property>
      <l7:Property key="usageFromVariable">
          <l7:BooleanValue>true</l7:BooleanValue>
      </l7:Property>
  </l7:Properties>
</l7:StoredPassword>

 

Issue the following command to create the stored password.

/path/to/GatewayMigrationUtility.sh restman
-host apig.example.com
-port 8443
-username john.doe
-password f5VPX0yUJPg.m4BrjdgMv84UgktddJD3xA
-method POST
-path '1.0/passwords'
-request stored_password.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/passwords'
-request stored_password.xml

 

Something like this should be displayed.

Status: 201 Created

 

You can then use the Gateway Migration Utility to ensure the stored password was created.

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

 

Which should return something like this.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<l7:List xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
    <l7:Name>SECURE_PASSWORD List</l7:Name>
    <l7:Type>List</l7:Type>
    <l7:TimeStamp>2020-09-15T06:58:08.958-05:00</l7:TimeStamp>
    <l7:Link rel="self" uri="https://api.example.com:8443/restman/1.0/passwords?name=foo"/>
    <l7:Link rel="template" uri="https://api.example.com:8443/restman/1.0/passwords/template"/>
    <l7:Item>
        <l7:Name>foo</l7:Name>
        <l7:Id>da698409abc96df215cf2f80b2175a41</l7:Id>
        <l7:Type>SECURE_PASSWORD</l7:Type>
        <l7:TimeStamp>2020-09-15T06:58:08.958-05:00</l7:TimeStamp>
        <l7:Link rel="self" uri="https://api.example.com:8443/restman/1.0/passwords/da698409abc96df215cf2f80b2175a41"/>
        <l7:Resource>
            <l7:StoredPassword id="da698409abc96df215cf2f80b2175a41" version="1">
                <l7:Name>foo</l7:Name>
                <l7:Properties>
                    <l7:Property key="description">
                        <l7:StringValue>my foo stored password</l7:StringValue>
                    </l7:Property>
                    <l7:Property key="lastUpdated">
                        <l7:DateValue>2019-07-25T14:39:50.934-05:00</l7:DateValue>
                    </l7:Property>
                    <l7:Property key="type">
                        <l7:StringValue>Password</l7:StringValue>
                    </l7:Property>
                    <l7:Property key="usageFromVariable">
                        <l7:BooleanValue>true</l7:BooleanValue>
                    </l7:Property>
                </l7:Properties>
            </l7:StoredPassword>
        </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 c7ceb4 in the box below so that we can be sure you are a human.