Managedomain Command Reference

Contents

Overview
Host Management
API Gateway Management
Group Management
Topology Management
Deployment

Overview

The managedomain script enables you to perform tasks such as the following:

  • Host management (registering and deleting hosts, or changing Admin Node Manager credentials)

  • API Gateway management (creating and deleting API Gateway instances, or adding Windows and Linux/Solaris services)

  • Group management (editing or deleting API Gateway groups)

  • Topology management (viewing topologies)

  • Deployment (deploying to a group, listing deployments, creating or downloading deployment archives, and editing group passphrases)

To run this command, enter managedomain in the following directory, and follow the instructions at the command prompt:

Windows INSTALL_DIR\apigateway\Win32\bin
UNIX/Linux INSTALL_DIR/apigateway/posix/bin


Host Management

The managedomain command options for host management are as follows:

Option Description Why Use this Option
1 Register host Add a new host that runs an API Gateway to a domain topology. You must ensure that the host is registered in order to create and run API servers. For example, you can specify the following:

  • If host is an Admin Node Manager

  • Use SSL

  • Hostname

  • Node Manager name

  • Node Manager port

  • Node Manager passphrase

  • Windows/UNIX service for Node Manager

  • Trust store details

If the host you are registering is not the Admin Node Manager, you must specify the Admin Node Manager host details. The Admin Node Manager must also be running.
2 Edit a host Edit the details for a host registered in a domain topology. Used occasionally. You can update the following:

  • Hostname

  • Node Manager name

  • Node Manager port

  • Node Manager passphrase

  • Windows/UNIX service for Node Manager

  • Use SSL

When you get a license for an evaluation mode API Gateway, you must use this option to change the host from 127.0.0.1 to a network reachable address or hostname. You must also restart the Node Manager to pick up any changes.
3 Delete a host Delete a registered host from a domain topology. Used occasionally. You must first stop and delete all API Gateways running on the host. This option is only for use on a remote non-Admin Node Manager node that is being removed from the topology. You must also stop the remote Node Manager process. This option will not work on the Admin Node Manager host, or if run locally on the host to be removed.
4 Change credentials for Admin Node Manager, currently connecting as: user admin with truststore None By default, you connect to the Node Manager using managedomain with the credentials admin/changeme. You can override these at startup by passing the --username --password command line parameters, or reset while running managedomain with this option. This username/password refers to an admin user configured in the Policy Studio.


API Gateway Management

The managedomain command options for API Gateway management are as follows:

Option Description Why Use this Option
5 Create API Gateway instance Create a new API Gateway instance. You can also do this in Policy Studio and API Gateway Manager. You can create API Gateway instances locally or on any host configured in the topology.
6 Edit an API Gateway (rename, change management port) Rename the API Gateway instance, enable/disable SSL, or change the management port. This functionality is not available in Policy Studio and API Gateway Manager.
7 Delete API Gateway instance Delete an API Gateway instance from the topology, and optionally delete the files on disk. You can also do this in Policy Studio and API Gateway Manager. You must ensure that the API Gateway instance has stopped.
8 Add a tag to an API Gateway Add a name-value tag to the API Gateway. The Topology view on the API Gateway Manager Dashboard displays tags and enables you to filter for API Gateway instances by tag.
9 Delete a tag from an API Gateway Delete a name-value tag from the API Gateway. The tag will no longer be displayed in the API Gateway Manager Dashboard.
10 Add a Windows/UNIX service for existing local API Gateway Group Management Must be run by a user with permission to create a service on the host operating system (root on Linux, or Administrator on Windows). When run on Linux, adds an init.d script.


Group Management

The managedomain command options for group management are as follows:

Option Description Why Use this Option
11 Edit group (rename it) Rename an API Gateway group. This functionality is not available in the Policy Studio and API Gateway Manager.
12 Delete a group Delete all API Gateways in the group and the group itself. You must ensure that all API Gateways in the group have been stopped first.


Topology Management

The managedomain command options for topology management are as follows:

Option Description Why Use this Option
13 Print topology Output the contents of the deployed domain topology. This includes the following:

  • Topology version

  • Hosts

  • Admin Node Manager

  • Groups

  • API Gateway instances (tags)
14 Check topologies are in sync For advanced users. Check that all Node Managers are running the same topology version. Useful only in multi-host environment. Topologies should be in sync if everything is running correctly.
15 Check the Admin Node Manager topology against another topology For advanced users. Compare the two topologies and highlights differences. There should be no differences if everything is running correctly.
16 Sync all topologies For advanced users. Forces a sync of all topologies.
17 Reset the local topology For advanced users. Delete the contents of the apigateway/groups directory. This means that you would need to re-register the host and recreate a local API Gateway instance. Alternatively, you can manually delete the contents of this directory to prevent issues if the host has been registered with other node managers.


Deployment

The managedomain command options for deployment are as follows:

Option Description Why Use this Option
18 Deploy to a group Deploy a configuration (.fed file) to API Gateways. This functionality is also available in Policy Studio and API Gateway Manager.
19 List deployment information List the deployment information for all API Gateways in a topology. This functionality is also available in Policy Studio and API Gateway Manager.
20 Create deployment archive Create a deployment archive from a directory that contains a federated API Gateway configuration.
21 Download deployment archive Download the .fed file deployed to an API Gateway. This functionality is also available in Policy Studio.
22 Update deployment archive properties Update the manifest properties relating to the deployed configuration only. This functionality is also available in Policy Studio. Enables you to update the properties without performing a new deployment.
23 Change group configuration passphrase The default passphrase for the API Gateway configuration is “”. Use this option to set a more secure password. This functionality is also available in Policy Studio.


Prev     Next
  Home