PreferencesConnect#

class ansys.stk.core.stkobjects.PreferencesConnect#

Allow configuring connect preferences.

Overview#

acknowledge_message_receipt

Get or set the initial connect Acknowledge mode state.

allow_asynchronous_communications

Asynchronous allowed.

allow_connect

Get or set the connection allowed property.

allow_external_connect

Allow connections from other machines.

allow_logging

Allow for command logging.

authentication_mode

Get or set the authentication mode for the server.

error_notify_mode

Get or set the initial connect Error Notify mode state.

log_filename

File for logging commands.

maximum_connections

Max number of simultaneous connections.

polling_period

Period between port polls in msec.

socket

TCP/IP Socket Port.

tls_ca_file

Get or set the filepath to the server certificate authentication file for mTLS authentication. (e.g. ca.crt)

tls_server_certificate_file

Get or set the filepath to the server certificate file for mTLS authentication. (e.g. server.crt)

tls_server_key_file

Get or set the filepath to the server key file for mTLS authentication. (e.g. server.key)

uds_directory

Get or set the filepath to the directory for the UDS socket file. Supported on Linux platforms only.

uds_identifier

Get or set an optional UDS ID for multiple connections. Supported on Linux platforms only.

verbose

Get or set the initial connect Verbose mode state.

wildcard_ignore_nack

Ignore Backs when Wildcards used.

Import detail#

from ansys.stk.core.stkobjects import PreferencesConnect

Property detail#

property PreferencesConnect.acknowledge_message_receipt: bool#

Get or set the initial connect Acknowledge mode state.

property PreferencesConnect.allow_asynchronous_communications: bool#

Asynchronous allowed.

property PreferencesConnect.allow_connect: bool#

Get or set the connection allowed property.

property PreferencesConnect.allow_external_connect: bool#

Allow connections from other machines.

property PreferencesConnect.allow_logging: bool#

Allow for command logging.

property PreferencesConnect.authentication_mode: ConnectAuthenticationMode#

Get or set the authentication mode for the server.

property PreferencesConnect.error_notify_mode: bool#

Get or set the initial connect Error Notify mode state.

property PreferencesConnect.log_filename: str#

File for logging commands.

property PreferencesConnect.maximum_connections: int#

Max number of simultaneous connections.

property PreferencesConnect.polling_period: int#

Period between port polls in msec.

property PreferencesConnect.socket: int#

TCP/IP Socket Port.

property PreferencesConnect.tls_ca_file: str#

Get or set the filepath to the server certificate authentication file for mTLS authentication. (e.g. ca.crt)

property PreferencesConnect.tls_server_certificate_file: str#

Get or set the filepath to the server certificate file for mTLS authentication. (e.g. server.crt)

property PreferencesConnect.tls_server_key_file: str#

Get or set the filepath to the server key file for mTLS authentication. (e.g. server.key)

property PreferencesConnect.uds_directory: str#

Get or set the filepath to the directory for the UDS socket file. Supported on Linux platforms only.

property PreferencesConnect.uds_identifier: str#

Get or set an optional UDS ID for multiple connections. Supported on Linux platforms only.

property PreferencesConnect.verbose: bool#

Get or set the initial connect Verbose mode state.

property PreferencesConnect.wildcard_ignore_nack: bool#

Ignore Backs when Wildcards used.