Skip to main content
Ctrl+K
ansys-tools-local-product-launcher - Home ansys-tools-local-product-launcher - Home
  • Getting started
  • User guide
  • Examples
  • API reference
  • Contribute
Ctrl+K
  • GitHub
Ctrl+K
  • Getting started
  • User guide
  • Examples
  • API reference
  • Contribute
  • GitHub

Section Navigation

  • Product launcher
  • Product instance
  • Plugin interface
  • Configuration management
  • Helpers
  • PyAnsys
  • API reference

API reference#

This section describes Local Product Launcher API endpoints so that you can understand how to interact with them programmatically.

  • Product launcher
    • launch_product()
  • Product instance
    • ProductInstance
  • Plugin interface
    • DataclassProtocol
    • LauncherProtocol
    • METADATA_KEY_DOC
    • METADATA_KEY_NOPROMPT
    • ServerType
  • Configuration management
    • get_config_for()
    • get_launch_mode_for()
    • is_configured()
    • save_config()
    • set_config_for()
  • Helpers
    • gRPC helpers
    • Port management helpers

previous

Define the HTTP Server launcher plugin

next

Product launcher

Show Source

© Copyright (c) 2024 ANSYS, Inc. All rights reserved.

Created using Sphinx 8.1.3.

Built with the Ansys Sphinx Theme 1.2.2.
Last updated on