select_scheduler#

Desktop.select_scheduler(scheduler_type: str, address: str | None = None, username: str | None = None, force_password_entry: bool | None = False) → str#

Select a scheduler to submit the job.

Parameters:

scheduler_typestr

Name of the scheduler. Options are “RSM”`, “”Windows HPC”`, “”HPC Platform Services`, “”Remote RSM”`,

“”Ansys Cloud Burst Compute”`.

addressstr, optional

String specifying the IP address or hostname of the head node or for the remote host running the RSM service.

usernamestr, optional

Username string to use for remote RSM service (or blank to use username stored in current submission host user settings). If the (non-blank) username doesn’t match the username stored in current submission host user settings, then the Select Scheduler dialog is displayed to allow for password entry prior to job submission.

force_password_entrybool, optional

Boolean used to force display of the Select Scheduler GUI to allow for: password entry prior to job submission.

Returns:

str: The selected scheduler (if selection was successful, this string should match the input option string, although it could differ in upper/lowercase).

Examples

>>> from ansys.aedt.core import Desktop

>>> d = Desktop(version="2026.1", new_desktop=False)
>>> d.select_scheduler("HPC Platform Services", address="https://myserver.com:8443/hps/")
>>> job_id = d.submit_job("via_gsg.aedt")
>>> d.release_desktop(False, False)