DiscoveredCloudCluster

class oci.database_management.models.DiscoveredCloudCluster(**kwargs)

Bases: DiscoveredCloudDbSystemComponent

The details of a cloud cluster discovered in a cloud DB system discovery run.

Attributes:

COMPONENT_TYPE_ASM

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_ASM_INSTANCE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_CLUSTER

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_CLUSTER_INSTANCE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DATABASE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DATABASE_HOME

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DATABASE_INSTANCE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DATABASE_NODE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_DBSYSTEM

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_LISTENER

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

COMPONENT_TYPE_PLUGGABLE_DATABASE

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent.

STATUS_EXISTING

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_EXISTING_BASIC

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_EXISTING_BASIC_PE

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_EXISTING_PE

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_MARKED_FOR_DELETION

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_MARKED_FOR_MIGRATION

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_MARKED_FOR_UPGRADE

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_MARKED_FOR_UPGRADE_MIGRATION

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_NEW

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

STATUS_UNKNOWN

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent.

associated_components

Gets the associated_components of this DiscoveredCloudDbSystemComponent.

cluster_instances

Gets the cluster_instances of this DiscoveredCloudCluster.

component_id

[Required] Gets the component_id of this DiscoveredCloudDbSystemComponent.

component_name

[Required] Gets the component_name of this DiscoveredCloudDbSystemComponent.

component_type

[Required] Gets the component_type of this DiscoveredCloudDbSystemComponent.

dbaas_id

Gets the dbaas_id of this DiscoveredCloudDbSystemComponent.

display_name

[Required] Gets the display_name of this DiscoveredCloudDbSystemComponent.

grid_home

Gets the grid_home of this DiscoveredCloudCluster.

is_flex_cluster

Gets the is_flex_cluster of this DiscoveredCloudCluster.

is_selected_for_monitoring

Gets the is_selected_for_monitoring of this DiscoveredCloudDbSystemComponent.

network_configurations

Gets the network_configurations of this DiscoveredCloudCluster.

ocr_file_location

Gets the ocr_file_location of this DiscoveredCloudCluster.

resource_id

Gets the resource_id of this DiscoveredCloudDbSystemComponent.

scan_configurations

Gets the scan_configurations of this DiscoveredCloudCluster.

status

Gets the status of this DiscoveredCloudDbSystemComponent.

version

Gets the version of this DiscoveredCloudCluster.

vip_configurations

Gets the vip_configurations of this DiscoveredCloudCluster.

Methods:

__init__(**kwargs)

Initializes a new DiscoveredCloudCluster 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'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “ASM”

COMPONENT_TYPE_ASM_INSTANCE = 'ASM_INSTANCE'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “ASM_INSTANCE”

COMPONENT_TYPE_CLUSTER = 'CLUSTER'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “CLUSTER”

COMPONENT_TYPE_CLUSTER_INSTANCE = 'CLUSTER_INSTANCE'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “CLUSTER_INSTANCE”

COMPONENT_TYPE_DATABASE = 'DATABASE'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “DATABASE”

COMPONENT_TYPE_DATABASE_HOME = 'DATABASE_HOME'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “DATABASE_HOME”

COMPONENT_TYPE_DATABASE_INSTANCE = 'DATABASE_INSTANCE'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “DATABASE_INSTANCE”

COMPONENT_TYPE_DATABASE_NODE = 'DATABASE_NODE'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “DATABASE_NODE”

COMPONENT_TYPE_DBSYSTEM = 'DBSYSTEM'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “DBSYSTEM”

COMPONENT_TYPE_LISTENER = 'LISTENER'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “LISTENER”

COMPONENT_TYPE_PLUGGABLE_DATABASE = 'PLUGGABLE_DATABASE'

A constant which can be used with the component_type property of a DiscoveredCloudDbSystemComponent. This constant has a value of “PLUGGABLE_DATABASE”

STATUS_EXISTING = 'EXISTING'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “EXISTING”

STATUS_EXISTING_BASIC = 'EXISTING_BASIC'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “EXISTING_BASIC”

STATUS_EXISTING_BASIC_PE = 'EXISTING_BASIC_PE'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “EXISTING_BASIC_PE”

STATUS_EXISTING_PE = 'EXISTING_PE'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “EXISTING_PE”

STATUS_MARKED_FOR_DELETION = 'MARKED_FOR_DELETION'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “MARKED_FOR_DELETION”

STATUS_MARKED_FOR_MIGRATION = 'MARKED_FOR_MIGRATION'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “MARKED_FOR_MIGRATION”

STATUS_MARKED_FOR_UPGRADE = 'MARKED_FOR_UPGRADE'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “MARKED_FOR_UPGRADE”

STATUS_MARKED_FOR_UPGRADE_MIGRATION = 'MARKED_FOR_UPGRADE_MIGRATION'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “MARKED_FOR_UPGRADE_MIGRATION”

STATUS_NEW = 'NEW'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “NEW”

STATUS_UNKNOWN = 'UNKNOWN'

A constant which can be used with the status property of a DiscoveredCloudDbSystemComponent. This constant has a value of “UNKNOWN”

__init__(**kwargs)

Initializes a new DiscoveredCloudCluster object with values from keyword arguments. The default value of the component_type attribute of this class is CLUSTER 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 DiscoveredCloudCluster.

  • display_name (str) – The value to assign to the display_name property of this DiscoveredCloudCluster.

  • component_name (str) – The value to assign to the component_name property of this DiscoveredCloudCluster.

  • component_type (str) – The value to assign to the component_type property of this DiscoveredCloudCluster. Allowed values for this property are: “ASM”, “ASM_INSTANCE”, “CLUSTER”, “CLUSTER_INSTANCE”, “DATABASE”, “DATABASE_INSTANCE”, “DATABASE_HOME”, “DATABASE_NODE”, “DBSYSTEM”, “LISTENER”, “PLUGGABLE_DATABASE”

  • resource_id (str) – The value to assign to the resource_id property of this DiscoveredCloudCluster.

  • dbaas_id (str) – The value to assign to the dbaas_id property of this DiscoveredCloudCluster.

  • is_selected_for_monitoring (bool) – The value to assign to the is_selected_for_monitoring property of this DiscoveredCloudCluster.

  • status (str) – The value to assign to the status property of this DiscoveredCloudCluster. Allowed values for this property are: “NEW”, “EXISTING”, “EXISTING_BASIC”, “EXISTING_PE”, “EXISTING_BASIC_PE”, “MARKED_FOR_UPGRADE”, “MARKED_FOR_MIGRATION”, “MARKED_FOR_UPGRADE_MIGRATION”, “MARKED_FOR_DELETION”, “UNKNOWN”

  • associated_components (list[oci.database_management.models.AssociatedCloudComponent]) – The value to assign to the associated_components property of this DiscoveredCloudCluster.

  • grid_home (str) – The value to assign to the grid_home property of this DiscoveredCloudCluster.

  • version (str) – The value to assign to the version property of this DiscoveredCloudCluster.

  • is_flex_cluster (bool) – The value to assign to the is_flex_cluster property of this DiscoveredCloudCluster.

  • network_configurations (list[oci.database_management.models.CloudClusterNetworkConfiguration]) – The value to assign to the network_configurations property of this DiscoveredCloudCluster.

  • vip_configurations (list[oci.database_management.models.CloudClusterVipConfiguration]) – The value to assign to the vip_configurations property of this DiscoveredCloudCluster.

  • scan_configurations (list[oci.database_management.models.CloudClusterScanListenerConfiguration]) – The value to assign to the scan_configurations property of this DiscoveredCloudCluster.

  • ocr_file_location (str) – The value to assign to the ocr_file_location property of this DiscoveredCloudCluster.

  • cluster_instances (list[oci.database_management.models.DiscoveredCloudClusterInstance]) – The value to assign to the cluster_instances property of this DiscoveredCloudCluster.

property associated_components

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

Returns

The associated_components of this DiscoveredCloudDbSystemComponent.

Return type

list[oci.database_management.models.AssociatedCloudComponent]

property cluster_instances

Gets the cluster_instances of this DiscoveredCloudCluster. The list of cluster instances for the cloud cluster.

Returns

The cluster_instances of this DiscoveredCloudCluster.

Return type

list[oci.database_management.models.DiscoveredCloudClusterInstance]

property component_id

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

Returns

The component_id of this DiscoveredCloudDbSystemComponent.

Return type

str

property component_name

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

Returns

The component_name of this DiscoveredCloudDbSystemComponent.

Return type

str

property component_type

[Required] Gets the component_type of this DiscoveredCloudDbSystemComponent. The cloud 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 DiscoveredCloudDbSystemComponent.

Return type

str

property dbaas_id

Gets the dbaas_id of this DiscoveredCloudDbSystemComponent. The OCID of the existing DBaas OCI resource matching the discovered DB system component.

Returns

The dbaas_id of this DiscoveredCloudDbSystemComponent.

Return type

str

property display_name

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

Returns

The display_name of this DiscoveredCloudDbSystemComponent.

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.

property grid_home

Gets the grid_home of this DiscoveredCloudCluster. The directory in which Oracle Grid Infrastructure is installed.

Returns

The grid_home of this DiscoveredCloudCluster.

Return type

str

property is_flex_cluster

Gets the is_flex_cluster of this DiscoveredCloudCluster. Indicates whether the cluster is an Oracle Flex Cluster or not.

Returns

The is_flex_cluster of this DiscoveredCloudCluster.

Return type

bool

property is_selected_for_monitoring

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

Returns

The is_selected_for_monitoring of this DiscoveredCloudDbSystemComponent.

Return type

bool

property network_configurations

Gets the network_configurations of this DiscoveredCloudCluster. The list of network address configurations of the cloud cluster.

Returns

The network_configurations of this DiscoveredCloudCluster.

Return type

list[oci.database_management.models.CloudClusterNetworkConfiguration]

property ocr_file_location

Gets the ocr_file_location of this DiscoveredCloudCluster. The location of the Oracle Cluster Registry (OCR) file.

Returns

The ocr_file_location of this DiscoveredCloudCluster.

Return type

str

property resource_id

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

Returns

The resource_id of this DiscoveredCloudDbSystemComponent.

Return type

str

property scan_configurations

Gets the scan_configurations of this DiscoveredCloudCluster. The list of Single Client Access Name (SCAN) configurations of the cloud cluster.

Returns

The scan_configurations of this DiscoveredCloudCluster.

Return type

list[oci.database_management.models.CloudClusterScanListenerConfiguration]

property status

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

Allowed values for this property are: “NEW”, “EXISTING”, “EXISTING_BASIC”, “EXISTING_PE”, “EXISTING_BASIC_PE”, “MARKED_FOR_UPGRADE”, “MARKED_FOR_MIGRATION”, “MARKED_FOR_UPGRADE_MIGRATION”, “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 DiscoveredCloudDbSystemComponent.

Return type

str

property version

Gets the version of this DiscoveredCloudCluster. The version of Oracle Clusterware running in the cluster.

Returns

The version of this DiscoveredCloudCluster.

Return type

str

property vip_configurations

Gets the vip_configurations of this DiscoveredCloudCluster. The list of Virtual IP (VIP) configurations of the cloud cluster.

Returns

The vip_configurations of this DiscoveredCloudCluster.

Return type

list[oci.database_management.models.CloudClusterVipConfiguration]