check

ansys.mapdl.core.cli.check.check(ip='127.0.0.1', port=50052, timeout=10)

Collect diagnostic information from a running MAPDL instance.

Parameters:

ipstr, default: “127.0.0.1”

IP address of the MAPDL gRPC server.

portint, default: 50052

Port of the MAPDL gRPC server.

timeoutint, default: 10

Seconds to wait when establishing the gRPC connection.

Returns:

dict

Nested dictionary with the connection, information, geometry, mesh, and post_processing sections, as returned by ansys.mapdl.core.information.get_mapdl_info().

Raises:

MapdlConnectionError

When no MAPDL instance can be reached at the given address.

Return type:

Dict[str, Any]

Examples

Report the version of the instance running on the default port:

>>> from ansys.mapdl.core.cli.check import check
>>> check()["information"]["mapdl_version"]
'2021 R2'