DiscoveredExternalClusterInstance¶

class oci.database_management.models.DiscoveredExternalClusterInstance(**kwargs)¶

Bases: oci.database_management.models.discovered_external_db_system_component.DiscoveredExternalDbSystemComponent

The details of an external cluster instance discovered in an external DB system discovery run.

Attributes

`COMPONENT_TYPE_ASM`	str(object=’’) -> str
`COMPONENT_TYPE_ASM_INSTANCE`	str(object=’’) -> str
`COMPONENT_TYPE_CLUSTER`	str(object=’’) -> str
`COMPONENT_TYPE_CLUSTER_INSTANCE`	str(object=’’) -> str
`COMPONENT_TYPE_DATABASE`	str(object=’’) -> str
`COMPONENT_TYPE_DATABASE_HOME`	str(object=’’) -> str
`COMPONENT_TYPE_DATABASE_INSTANCE`	str(object=’’) -> str
`COMPONENT_TYPE_DATABASE_NODE`	str(object=’’) -> str
`COMPONENT_TYPE_DBSYSTEM`	str(object=’’) -> str
`COMPONENT_TYPE_LISTENER`	str(object=’’) -> str
`COMPONENT_TYPE_PLUGGABLE_DATABASE`	str(object=’’) -> str
`NODE_ROLE_HUB`	A constant which can be used with the node_role property of a DiscoveredExternalClusterInstance.
`NODE_ROLE_LEAF`	A constant which can be used with the node_role property of a DiscoveredExternalClusterInstance.
`STATUS_EXISTING`	str(object=’’) -> str
`STATUS_MARKED_FOR_DELETION`	str(object=’’) -> str
`STATUS_NEW`	str(object=’’) -> str
`STATUS_UNKNOWN`	str(object=’’) -> str
`adr_home_directory`	Gets the adr_home_directory of this DiscoveredExternalClusterInstance.
`associated_components`	Gets the associated_components of this DiscoveredExternalDbSystemComponent.
`cluster_id`	Gets the cluster_id of this DiscoveredExternalClusterInstance.
`component_id`	[Required] Gets the component_id of this DiscoveredExternalDbSystemComponent.
`component_name`	[Required] Gets the component_name of this DiscoveredExternalDbSystemComponent.
`component_type`	[Required] Gets the component_type of this DiscoveredExternalDbSystemComponent.
`connector`	Gets the connector of this DiscoveredExternalClusterInstance.
`crs_base_directory`	Gets the crs_base_directory of this DiscoveredExternalClusterInstance.
`display_name`	[Required] Gets the display_name of this DiscoveredExternalDbSystemComponent.
`host_name`	[Required] Gets the host_name of this DiscoveredExternalClusterInstance.
`is_selected_for_monitoring`	Gets the is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent.
`node_role`	Gets the node_role of this DiscoveredExternalClusterInstance.
`resource_id`	Gets the resource_id of this DiscoveredExternalDbSystemComponent.
`status`	Gets the status of this DiscoveredExternalDbSystemComponent.

Methods

`__init__`(**kwargs)	Initializes a new DiscoveredExternalClusterInstance object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

COMPONENT_TYPE_ASM = 'ASM'¶

COMPONENT_TYPE_ASM_INSTANCE = 'ASM_INSTANCE'¶

COMPONENT_TYPE_CLUSTER = 'CLUSTER'¶

COMPONENT_TYPE_CLUSTER_INSTANCE = 'CLUSTER_INSTANCE'¶

COMPONENT_TYPE_DATABASE = 'DATABASE'¶

COMPONENT_TYPE_DATABASE_HOME = 'DATABASE_HOME'¶

COMPONENT_TYPE_DATABASE_INSTANCE = 'DATABASE_INSTANCE'¶

COMPONENT_TYPE_DATABASE_NODE = 'DATABASE_NODE'¶

COMPONENT_TYPE_DBSYSTEM = 'DBSYSTEM'¶

COMPONENT_TYPE_LISTENER = 'LISTENER'¶

COMPONENT_TYPE_PLUGGABLE_DATABASE = 'PLUGGABLE_DATABASE'¶

NODE_ROLE_HUB = 'HUB'¶: A constant which can be used with the node_role property of a DiscoveredExternalClusterInstance. This constant has a value of “HUB”

NODE_ROLE_LEAF = 'LEAF'¶: A constant which can be used with the node_role property of a DiscoveredExternalClusterInstance. This constant has a value of “LEAF”

STATUS_EXISTING = 'EXISTING'¶

STATUS_MARKED_FOR_DELETION = 'MARKED_FOR_DELETION'¶

STATUS_NEW = 'NEW'¶

STATUS_UNKNOWN = 'UNKNOWN'¶

__init__(**kwargs)¶

Initializes a new DiscoveredExternalClusterInstance object with values from keyword arguments. The default value of the component_type attribute of this class is CLUSTER_INSTANCE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

component_id (str) – The value to assign to the component_id property of this DiscoveredExternalClusterInstance.
display_name (str) – The value to assign to the display_name property of this DiscoveredExternalClusterInstance.
component_name (str) – The value to assign to the component_name property of this DiscoveredExternalClusterInstance.
component_type (str) – The value to assign to the component_type property of this DiscoveredExternalClusterInstance. Allowed values for this property are: “ASM”, “ASM_INSTANCE”, “CLUSTER”, “CLUSTER_INSTANCE”, “DATABASE”, “DATABASE_INSTANCE”, “DATABASE_HOME”, “DATABASE_NODE”, “DBSYSTEM”, “LISTENER”, “PLUGGABLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
resource_id (str) – The value to assign to the resource_id property of this DiscoveredExternalClusterInstance.
is_selected_for_monitoring (bool) – The value to assign to the is_selected_for_monitoring property of this DiscoveredExternalClusterInstance.
status (str) – The value to assign to the status property of this DiscoveredExternalClusterInstance. Allowed values for this property are: “NEW”, “EXISTING”, “MARKED_FOR_DELETION”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
associated_components (list[oci.database_management.models.AssociatedComponent]) – The value to assign to the associated_components property of this DiscoveredExternalClusterInstance.
host_name (str) – The value to assign to the host_name property of this DiscoveredExternalClusterInstance.
cluster_id (str) – The value to assign to the cluster_id property of this DiscoveredExternalClusterInstance.
node_role (str) – The value to assign to the node_role property of this DiscoveredExternalClusterInstance. Allowed values for this property are: “HUB”, “LEAF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
crs_base_directory (str) – The value to assign to the crs_base_directory property of this DiscoveredExternalClusterInstance.
adr_home_directory (str) – The value to assign to the adr_home_directory property of this DiscoveredExternalClusterInstance.
connector (oci.database_management.models.ExternalDbSystemDiscoveryConnector) – The value to assign to the connector property of this DiscoveredExternalClusterInstance.

adr_home_directory¶

Gets the adr_home_directory of this DiscoveredExternalClusterInstance. The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.

Returns:	The adr_home_directory of this DiscoveredExternalClusterInstance.
Return type:	str

associated_components¶

Gets the associated_components of this DiscoveredExternalDbSystemComponent. The list of associated components.

Returns:	The associated_components of this DiscoveredExternalDbSystemComponent.
Return type:	list[oci.database_management.models.AssociatedComponent]

cluster_id¶

Gets the cluster_id of this DiscoveredExternalClusterInstance. The unique identifier of the Oracle cluster.

Returns:	The cluster_id of this DiscoveredExternalClusterInstance.
Return type:	str

component_id¶

[Required] Gets the component_id of this DiscoveredExternalDbSystemComponent. The identifier of the discovered DB system component.

Returns:	The component_id of this DiscoveredExternalDbSystemComponent.
Return type:	str

component_name¶

[Required] Gets the component_name of this DiscoveredExternalDbSystemComponent. The name of the discovered DB system component.

Returns:	The component_name of this DiscoveredExternalDbSystemComponent.
Return type:	str

component_type¶

[Required] Gets the component_type of this DiscoveredExternalDbSystemComponent. The external DB system component type.

Allowed values for this property are: “ASM”, “ASM_INSTANCE”, “CLUSTER”, “CLUSTER_INSTANCE”, “DATABASE”, “DATABASE_INSTANCE”, “DATABASE_HOME”, “DATABASE_NODE”, “DBSYSTEM”, “LISTENER”, “PLUGGABLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The component_type of this DiscoveredExternalDbSystemComponent.
Return type:	str

connector¶

Gets the connector of this DiscoveredExternalClusterInstance.

Returns:	The connector of this DiscoveredExternalClusterInstance.
Return type:	oci.database_management.models.ExternalDbSystemDiscoveryConnector

crs_base_directory¶

Gets the crs_base_directory of this DiscoveredExternalClusterInstance. The Oracle base location of Cluster Ready Services (CRS).

Returns:	The crs_base_directory of this DiscoveredExternalClusterInstance.
Return type:	str

display_name¶

[Required] Gets the display_name of this DiscoveredExternalDbSystemComponent. The user-friendly name for the discovered DB system component. The name does not have to be unique.

Returns:	The display_name of this DiscoveredExternalDbSystemComponent.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

host_name¶

[Required] Gets the host_name of this DiscoveredExternalClusterInstance. The name of the host on which the cluster instance is running.

Returns:	The host_name of this DiscoveredExternalClusterInstance.
Return type:	str

is_selected_for_monitoring¶

Gets the is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent. Indicates whether the DB system component should be provisioned as an OCI resource or not.

Returns:	The is_selected_for_monitoring of this DiscoveredExternalDbSystemComponent.
Return type:	bool

node_role¶

Gets the node_role of this DiscoveredExternalClusterInstance. The role of the cluster node.

Allowed values for this property are: “HUB”, “LEAF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The node_role of this DiscoveredExternalClusterInstance.
Return type:	str

resource_id¶

Gets the resource_id of this DiscoveredExternalDbSystemComponent. The OCID of the existing OCI resource matching the discovered DB system component.

Returns:	The resource_id of this DiscoveredExternalDbSystemComponent.
Return type:	str

status¶

Gets the status of this DiscoveredExternalDbSystemComponent. The state of the discovered DB system component.

Allowed values for this property are: “NEW”, “EXISTING”, “MARKED_FOR_DELETION”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this DiscoveredExternalDbSystemComponent.
Return type:	str