Summary of all API TPM options
The following is a summary of all of the tpm options for controlling the various API settings:
User Management Options
| Option | Description | Version |
|---|---|---|
rest-api-admin-passAliases: rest-api-admin-password | Specify the initial Admin User Password for API access. rest-api-admin-password alias only available from version 7.1.2 onwards. | 7.0.0 |
rest-api-admin-user | Specify the initial Admin Username for API access. | 7.0.0 |
Connector Options
Applies to: Tungsten Clustering for MySQL
| Option | Description | Version |
|---|---|---|
connector-rest-api | Enable (default) or Disable the API. | 7.0.0 |
connector-rest-api-address | Address for the API to bind too. | 7.0.0 |
connector-rest-api-authentication | Enforce authentication for the API. | 7.0.0 |
connector-rest-api-port | Port for the Connector API. | 7.0.0 |
connector-rest-api-ssl | Enable SSL for the API. | 7.0.0 |
Manager Options
Applies to: Tungsten Clustering for MySQL
| Option | Description | Version |
|---|---|---|
manager-rest-apiAliases: mgr-api | Enable (default) or Disable API. | |
manager-rest-api-addressAliases: mgr-api-address | Address for the API to bind too. | 7.0.0 |
manager-rest-api-authentication | Enforce authentication for the API. | 7.0.0 |
manager-rest-api-portAliases: mgr-api-port | Port for the manager API. | 7.0.0 |
manager-rest-api-ssl | Enable SSL for the API. | 7.0.0 |
Replicator Options
| Option | Description | Version |
|---|---|---|
replicator-rest-api | Enable or Disable API. | 7.0.0 |
replicator-rest-api-address | Address for the API to bind too. | 7.0.0 |
replicator-rest-api-authentication | Enforce authentication for the API. | 7.0.0 |
replicator-rest-api-port | Port for the Replicator API. | 7.0.0 |
replicator-rest-api-ssl | Enable or Disable SSL for the API. | 7.0.0 |
Group Alias Options
| Option | Description | Version |
|---|---|---|
rest-api-address | Address for the API to bind too. Setting this property acts as a group alias forconnector-rest-api-address, manager-rest-api-address and replicator-rest-api-address. | 7.2.0 |
rest-api-authentication | Enable Authentication for the API. Setting this property acts as a group alias forconnector-rest-api-authentication, manager-rest-api-authentication and replicator-rest-api-authentication. | 7.2.0 |
rest-api-ssl | Enable SSL for the API. Setting this property acts as a group alias forconnector-rest-api-ssl, manager-rest-api-ssl and replicator-rest-api-ssl. | 7.2.0 |
rest-apis | Enable or Disable API. Setting this property acts as a group alias forconnector-rest-api, manager-rest-api and replicator-rest-api. | 7.2.0 |