Contents
For an overview of the managedomain
command, see Configure an API Gateway domain.
To run the command in interactive mode, enter managedomain
in the following
directory, and follow the instructions at the command prompt:
This topic describes the managedomain
command options in interactive mode. Alternatively,
you can specify managedomain commands in non-interactive mode. For more details, enter managedomain
--help
.
The managedomain
interactive 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 Gateways. For example,
you can specify the following:
|
2
|
Edit a host
|
Edit the details for a host registered in a domain topology. Used occasionally. You can
update the following:
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 Admin Node Manager and/or credentials, currently connecting as: user admin with
truststore None
|
By default, you connect to an 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 Policy Studio.
|
The managedomain
interactive 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 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 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 or remove a Windows/UNIX service for existing local API Gateway
|
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.
|
The managedomain
interactive 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 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. |
The managedomain
interactive 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:
|
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.
|
The managedomain
interactive 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.
|
The managedomain
interactive options for group management are as follows:
Option | Description | Why Use this Option |
---|---|---|
24
|
Regenerate SSL certificates on localhost
|
Regenerate the SSL certificates used to secure API Gateway components in the domain (for example, Node Manager and the API Gateway instances that it manages). You must first stop the Node Manager on the localhost before running this option. You must run this option on all hosts in the domain. |
25
|
Sign CSR
|
Specify a Certificate Signing Request (CSR) to send to the Certificate Authority (CA) when applying for an SSL certificate. |
26
|
Submit externally signed certificate
|
Specify an SSL certificate signed by an externally signed Certificate Authority (CA). |
For details on how to use the managedomain
command in non-interactive mode to configure
SSL certificates and Admin Node Manager high availability, see Secure an API Gateway domain.
For more details on running managedomain in non-interactive mode, enter managedomain
--help