CA API Gateway 9.1

9.4 9.1

Patch a Software Gateway

This section describes how to patch s in the Software form factor. 
gateway91
This section describes how to patch
API Gateway
s in the Software form factor. 
The
API Gateway
 provides patch management feature to help you organize the incremental patches for the
API Gateway
 software. These patches may be issued by CA Technologies to update functionality in the
API Gateway
 software.
It is highly recommended that you back up your
API Gateway
 before installing a patch. Be prepared to restart the
API Gateway
 software if the patch requires it.
Obtain the Patch Files
To obtain the patch files
:
  1. Log in to the CA Support site: http://support.ca.com
  2. Point to
    Download Center
     and then choose
    Download Products
    .
  3. On the Download Center page:
    1. Select
      My Products
       and then choose your product from the drop-down list (if not already displayed).
    2. Select the release number.
    3. The
      Gen level
       is '0000' for base releases and '01' for service pack releases.
    4. Click
      Go
       to see the archive files available for the release.
  4. Review the Release Notes to see a listing of the contents of each archive.
  5. Download the appropriate archive(s) to your hard drive and unzip them.
  6. Locate the necessary patch files in the archive and copy them to a temporary location on your hard drive.
    Tip:
     See List of Update Files for the names of patch files you need.
  7. Copy the patch files to the following directory on the
    API Gateway
    :
    /opt/SecureSpan/Controller
Understanding the Types of Patch Files
This section helps you understand the different types of patch files provided by CA Technologies and is of interest to advanced users.
There are three types of patch files for the software
API Gateway
:
  • Core Application Patches
    The Application Patches update the
    API Gateway
     and
    API Gateway
     Enterprise Service Manager software. These patches are available from the CA Support site with names that follow this syntax:
    Layer7_
    <version>
    .L7P 
  • Application Update Patches
    These patches are periodic updates to the
    API Gateway
     application, pending the release of the next patch. They are typically used to resolve any issues that arose as a result of the deployment of the Core Application Patch. These patches provide quick responses to new security threats at the application level (for example, updating the default cipher suite list to combat CBC attacks). They also provide enhancements to functionality pending the next major/minor release.
     
  • Other Patches
    These include hot fixes, extended functionality for a niche project, cumulative Platform Updates, and other items that do not fall in any of the above categories.
    Monitor the Release Notes for all patching information. These notes discuss any security vulnerabilities or hot fixes handled by the application patches. When deciding on when to update your
    API Gateway
     software, be sure to take into account factors such as: functionality, security features, and end-of-life timelines on the versions.
Install a Patch
To install a patch
:
  1. Log in as the
    root
     user. 
  2. Run the following command:
    # /opt/SecureSpan/Controller/bin/patch.sh <target> <action>
    Where:
    • "<target>"
       is either the patch API endpoint URI or the Process Controller home directory; if not specified, the <
      target
      > defaults to:
      /opt/SecureSpan/Controller
    • "<action>"
       is one of the actions in the following table.
  3. If you have installed a patch, you may be prompted to restart the
    API Gateway
    .
Action
Description
upload
<filename>
Uploads the patch named
<filename>
 to the
API Gateway
.
install
<patch_ID>
Installs the patch with the identifier
<patch_ID>
. This patch must already be uploaded using the
upload
 action.
The patch ID is normally the patch file name, excluding the extension.
A message will indicate that the patch was successfully installed. If further configuration is required or if a
API Gateway
 restart is necessary, this will be noted on the screen.
delete
<patch_ID>
Removes an uninstalled patch from the list of registered patches on the
API Gateway
. It physically deletes the patch from the internal repository, but not from the original pre-upload location.
Note the following when deleting a patch:
  • Only patches in the UPLOADED state can be deleted.
  • Deleting a patch only sets its state to NONE -- the patch itself is not physically removed from the appliance.
  • A deleted patch may be uploaded and installed again if necessary.
list
Lists all the patches currently registered on the
API Gateway
 and their statuses.

Content feedback and comments