Skip to content

Latest commit

 

History

History
 
 

Gateway-Management-Utilities

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

Gateway Management Utilities

A suite of encapsulated assertions useful for calling RestMan directly from policy with a service to test the assertions (Utility Assertions Tester), plus the Gateway Dependency Analyzer utility that uses the assertions to query the Gateway and determine internal dependencies, a Certificate Report utility, a License Report utility, and the Cluster Wide Property Manager.

Installation

Deploy using the GMU (assumes connection details are in <gateway>.properties):

# ./GatewayMigrationUtility.sh migrateIn -z <gateway>.properties -b Gateway-Management-Utilities.bundle -r Gateway-Management-Utilities.result

You can also deploy directly to restman using curl:

# curl -k -X PUT -d @Gateway-Management-Utilities.bundle -H "Content-Type: application/xml" -u admin:<password> -o Gateway-Management-Utilities-Deploy.result 'https://<gateway>:8443/restman/1.0/bundle?test=false&activate=true'

Finally, you can deploy the bundle using the bootstrap bundle provisioning feature:

# mkdir -p /opt/SecureSpan/Gateway/node/default/etc/bootstrap/bundle
copy the bundle file to /opt/SecureSpan/Gateway/node/default/etc/bootstrap/bundle
# chmod -R 775 /opt/SecureSpan/Gateway/node/default/etc/bootstrap
# systemctl restart ssg

Accessing the Utility Assertions Tester service

Point your browser to https://<gateway>:8443/apigw/utilityTester and provide Policy Manager admin credentials.

Accessing the API Gateway Dependency Analyzer service

Point your browser to https://<gateway>:8443/apigw/dependencyAnalyzer and provide Policy Manager admin credentials.

Accessing the API Gateway Certificate Report

Point your browser to https://<gateway>:8443/apigw/certificateReport and provide Policy Manager admin credentials.

The API Gateway Certificate Report can also return application/json or text/xml responses using ?format=json or ?format=xml in the url. Using this mechanism requires credentials in a role that has read access to trusted certificates and private keys. All responses will return X-AlertStatus, X-AlertLevel and X-AlertMessage HTTP headers to help users avoid parsing the responses.

Accessing the API Gateway License Report

Point your browser to https://<gateway>:8443/apigw/licenseReport and provide Policy Manager admin credentials.

The API Gateway License Report can also return application/json or text/xml responses using ?format=json or ?format=xml in the url. All responses will return X-AlertStatus, X-AlertLevel and X-AlertMessage HTTP headers to help users avoid parsing the responses.

Accessing the API Gateway Cluster Wide Property Manager

Point your browser to https://<gateway>:8443/apigw/cwpManager and provide Policy Manager admin credentials.


Note that restman requires an authenticated user who is a member of the administrator role to execute many of the calls to work, hence why admin credentials are required to use these services.