Administrative Actions

The administrator interface provides administrative actions for this AMPS instance.

These actions are designed to be usable from a minimal web browser interface. Retrieving the URI for an action requests that AMPS take that action. In other words, clicking on the link for the action in a browser or performing a GET from a script will cause AMPS to take the appropriate action.

• Authorization: Selecting the authorization resource will allow the authentication or entitlement resources to be reset. Select transports, then the transport name, then reset to call the reset function defined by the respective authentication or entitlement resource. Use amps-admin as the transport name for the administrative interface.

  Admin Path: /amps/administrator/authorization/<resource-type>/transports/<transport-name>/reset

• Clients: Selecting the clients resource will list all connected clients by identifier. Selecting a single client will permit that client to be disconnected.

  Admin Path: /amps/administrator/clients/<id>/<action>

• Diagnostics: Selecting dump requests diagnostic log messages for replication, queues, and bookmark subscriptions. Diagnostics will include the following message IDs when applicable:

  Message ID	Level	Contents
  1E-0086	info	Overview of replication processing, destination state, and routing.
  31-0010	info	Overview of message queue state and delivery progress.
  23-0030	info	Overview of bookmark replay processing and associated clients and subscriptions.

  Logging levels and message inclusion/exclusion filters determine which messages are actually written. The requests are processed asynchronously, so the action's response does not indicate that all diagnostic messages have been written. Their order and count depend on the subsystems present and their processing state.

  Admin Path: /amps/administrator/diagnostics/dump

• Minidump: Selecting the minidump resource will create a minidump of the currently running AMPS instance.

  The minidump will be saved in a directory specified by the MiniDumpDirectory, or /tmp if no directory is specified. See Instance-Level Configuration for more information.

  Admin Path: /amps/administrator/minidump

• Queues: Selecting the queues resource allows you to select whether this instance will respect the original ownership of messages in the queue, or allow the instance to claim ownership of messages if the original owner is unreachable.

  The options available from this interface are enable_proxied_transfer (meaning to allow this instance to claim ownership if a direct link to the owning instance is not connected) or disable_proxied_transfer (meaning that only the instance that owned the original message can transfer ownership). By default, proxied transfer is disabled.

  Enabling proxied transfer is intended for temporary recovery purposes. See Disaster Recovery and Queue Message Ownership for warnings about duplicate delivery and inconsistent queue state, and for guidance on when to enable proxied transfer and how to disable it after recovery.

  Admin Path: /amps/administrator/queues/<id>/<action>

• Replication: Selecting the replication resource will list all currently configured replication destinations. For a destination configured for sync acknowledgement, downgrade changes the current acknowledgement type to async, and upgrade restores sync acknowledgement after a downgrade. Only destinations configured for sync acknowledgement can be successfully upgraded or downgraded. A destination configured for async acknowledgement always uses async acknowledgement. The reconnect action closes and reopens the connection to the selected destination.

  The sync and async acknowledgement type settings control whether this instance of AMPS waits for a persistence acknowledgment from this destination before sending its own persistence acknowledgment to publishers or upstream instances. With sync, it waits for this destination; with async, it does not. Local persistence and acknowledgment requirements for other destinations still apply. These settings do not affect replication priority or replication performance; they affect when persistence acknowledgments are sent upstream.

  Downgrading a destination reduces the failover guarantees for that destination, see Downgrading Acknowledgments for a Destination for details.

  Admin Path: /amps/administrator/replication/<id>/<action>

• SOW: Selecting the sow resource will list all currently configured sow. topics. Selecting a topic will permit you to compact that topic. Compacting a SOW causes AMPS to release unused space in the SOW: this is normally done during startup.

  Admin Path: /amps/administrator/sow/<id>/<action>

• Transaction Log: Selecting the transaction_log resource will allow the journals resources to be compressed, archived, or removed. Only journal files that are full will be displayed.

  Selecting a journal will permit you to compress, archive, or remove that journal and all older journals. Compressing a journal will compress the selected journal and all older journals. Archiving a journal will move the selected journal and all older journals to the specified archive location. Removing a journal will delete the selected journal and all older journals.

  Admin Path: /amps/administrator/transaction_log/journals/<id>/<action>

• Transports: Selecting the transports resource will list all currently configured transports. Selecting any individual transport will permit the transport to be enabled or disabled.

  Admin Path: /amps/administrator/transports/<id>/<action>

Entitlements Check for Admin Actions

The administrative interface provides a way to check access to an administrative action without running the action.

Admin Path: /amps/administrator/authorization/entitlement/transports/amps-admin/check

This resource requires a path parameter with the full path of the action to check. AMPS will run the entitlement check, and then return a true or false result indicating whether the user has permission to run the action.

For example, a full entitlement check on the ability to disconnect the client with object ID 1, requesting the result as a JSON document, would be:

http://server:admin_port/amps/administrator/authorization/entitlement/transports/amps-admin/check.json?path=/amps/administrator/clients/1/disconnect