models_v2.mssql_connection_response_params module

class models_v2.mssql_connection_response_params.MssqlConnectionResponseParams(host_identifier=None, error=None, skip_connection_discovery=None, servers=None, fci_clusters=None, aag_groups=None)

Bases: object

Implementation of the ‘MssqlConnectionResponseParams’ model.

Specifies the response parameters after connecting to a SQL node/cluster using given IP or hostname FQDN.

Attributes:

host_identifier (string): Specifies the unique identifier to locate

the SQL node or cluster. The host identifier can be IP address or FQDN.

error (Error): Specifies the error object with error code and a

message.

skip_connection_discovery (bool): Specifies whether to skip the

discovery phase of all SQL servers, AAG groups etc during registration process.

servers (list of SQLServer): Specifies the list of SQL servers. If SQL

server is a part of avalibility group then it will be returned in aagServers field. This will include the list of all standalone SQL servers and servers belonging to any FCI enviournment.

fci_clusters (list of FCICluster): Specifies the list of FCI (Failover

Cluster Instaces) Clusters. This will contain the list of all failover pools under a windows cluster. FCI clusters which are part of AAG, will be returned seperatly under aagServers field.

aag_groups (list of AAGGroup): Specifies the list of AAG (Always on

Avalibility) groups.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.