Data Source: oci_disaster_recovery_dr_protection_group

This data source provides details about a specific Dr Protection Group resource in Oracle Cloud Infrastructure Disaster Recovery service.

Get the DR protection group identified by drProtectionGroupId.

Example Usage

data "oci_disaster_recovery_dr_protection_group" "test_dr_protection_group" {
	#Required
	dr_protection_group_id = oci_disaster_recovery_dr_protection_group.test_dr_protection_group.id
}

Argument Reference

The following arguments are supported:

• dr_protection_group_id - (Required) The OCID of the DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID

Attributes Reference

The following attributes are exported:

• compartment_id - The OCID of the compartment containing the DR protection group. Example: ocid1.compartment.oc1..uniqueID

• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations.CostCenter": "42"}

• display_name - The display name of the DR protection group. Example: EBS PHX Group

• freeform_tags - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

• id - The OCID of the DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID

• life_cycle_details - A message describing the DR protection group’s current state in more detail.

• lifecycle_sub_state - The current sub-state of the DR protection group.

• log_location - The details of an object storage log location for a DR protection group.

  • bucket - The bucket name inside the object storage namespace. Example: operation_logs
  • namespace - The namespace in object storage (Note - this is usually the tenancy name). Example: myocitenancy
  • object - The object name inside the object storage bucket. Example: switchover_plan_executions

• members - A list of DR protection group members.

  • autonomous_database_standby_type_for_dr_drills - This specifies the mechanism used to create a temporary Autonomous Database instance for DR Drills. See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-clone-about.html for information about these clone types. See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-data-guard-snapshot-standby.html for information about snapshot standby.

  • backend_set_mappings - A list of backend set mappings that are used to transfer or update backends during DR.

    • destination_backend_set_name - The name of the destination backend set. Example: My_Destination_Backend_Set
    • is_backend_set_for_non_movable - This flag specifies if this backend set is used for traffic for non-movable compute instances. Backend sets that point to non-movable instances are only enabled or disabled during DR. For non-movable instances this flag should be set to ‘true’. Backend sets that point to movable instances are emptied and their contents are transferred to the destination region network load balancer. For movable instances this flag should be set to ‘false’. Example: true
    • source_backend_set_name - The name of the source backend set. Example: My_Source_Backend_Set

  • backup_config - The details of backup performed on OKE Cluster.

    • backup_schedule - The schedule for backing up namespaces to the destination region. If a backup schedule is not specified, only a single backup will be created. This format of the string specifying the backup schedule must conform with RFC-5545. This schedule will use the UTC timezone. This property applies to the OKE cluster member in primary region. Example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
    • image_replication_vault_secret_id - The OCID of the vault secret that stores the image credential. This property applies to the OKE cluster member in both the primary and standby region.
    • max_number_of_backups_retained - The maximum number of backups that should be retained. This property applies to the OKE cluster member in primary region.
    • namespaces - A list of namespaces that need to be backed up. The default value is null. If a list of namespaces is not provided, all namespaces will be backed up. This property applies to the OKE cluster member in primary region. Example: [“default”, “pv-nginx”]
    • replicate_images - Controls the behaviour of image replication across regions. This property applies to the OKE cluster member in primary region.

  • backup_location - The details for object storage backup location of an OKE Cluster

    • bucket - The bucket name inside the object storage namespace. Example: operation_logs
    • namespace - The namespace in object storage backup location(Note - this is usually the tenancy name). Example: myocitenancy
    • object - The object name inside the object storage bucket. Example: switchover_plan_executions

  • block_volume_attach_and_mount_operations - The details of the block volume operations performed on the non-movable compute instance.

    • attachments - A list of details of attach or detach operations performed on block volumes.
      • block_volume_id - The OCID of the block volume. Example: ocid1.volume.oc1..uniqueID
      • volume_attachment_reference_instance_id - The OCID of the reference compute instance needed to obtain the volume attachment details. This reference compute instance belongs to the peer DR protection group. Example: ocid1.instance.oc1..uniqueID
    • mounts - A list of details of mount operations performed on block volumes.
      • mount_point - The physical mount point where the file system is mounted on the block volume. Example: /mnt/yourmountpoint

  • block_volume_operations - Deprecated. Use the ‘blockVolumeAttachAndMountOperations’ attribute instead of this. Operations performed on a list of block volumes used on the non-movable compute instance.

    • attachment_details - Deprecated. Use the ‘ComputeInstanceNonMovableBlockVolumeAttachOperationDetails’ definition instead of this. The details for attaching or detaching a block volume.
      • volume_attachment_reference_instance_id - The OCID of the reference compute instance needed to obtain the volume attachment details. This reference compute instance belongs to the peer DR protection group. Example: ocid1.instance.oc1..uniqueID
    • block_volume_id - The OCID of the block volume. Example: ocid1.volume.oc1..uniqueID
    • mount_details - Deprecated. Use the ‘ComputeInstanceNonMovableBlockVolumeMountOperationDetails’ definition instead of this. The details for mounting or unmounting the file system on a block volume.
      • mount_point - The physical mount point used for mounting and unmounting the file system on a block volume. Example: /mnt/yourmountpoint

  • bucket - The bucket name inside the object storage namespace. Example: bucket_name

  • common_destination_key - The OCID of a vault and customer-managed encryption key in the destination region.

    The customer-managed encryption key in this will be used to encrypt all the volumes of the volume group after they move to the destination region. If you specify this common vault and encryption key, you cannot specify vaults and encryption keys individually for each volume using ‘sourceVolumeToDestinationEncryptionKeyMappings’.

    The customer-managed encryption key in this will be used to encrypt the file system when it move to the destination region.

    • encryption_key_id - The OCID of the customer-managed encryption key in the destination region vault. Example: ocid1.key.oc1..uniqueID
    • vault_id - The OCID of the destination region vault for the customer-managed encryption key. Example: ocid1.vault.oc1..uniqueID

  • connection_string_type - The type of connection strings used to connect to an Autonomous Container Database snapshot standby created during a DR Drill operation. See https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html for information about these service types.

  • destination_availability_domain - The availability domain of the destination mount target. Example: BBTh:region-AD

  • destination_backup_policy_id - The OCID of the backup policy to use in the destination region. This policy will be used to create backups for this volume group after it moves the destination region. Example: ocid1.volumebackuppolicy.oc1..uniqueID

  • destination_capacity_reservation_id - The OCID of a capacity reservation in the destination region which will be used to launch the compute instance. Example: ocid1.capacityreservation.oc1..uniqueID

  • destination_compartment_id - The OCID of a compartment in the destination region in which the compute instance should be launched. Example: ocid1.compartment.oc1..uniqueID

  • destination_dedicated_vm_host_id - The OCID of a dedicated VM host in the destination region where the compute instance should be launched. Example: ocid1.dedicatedvmhost.oc1..uniqueID

  • destination_encryption_key - The OCID of a vault and customer-managed encryption key in the destination region.

    The customer-managed encryption key in this will be used to encrypt all the volumes of the volume group after they move to the destination region. If you specify this common vault and encryption key, you cannot specify vaults and encryption keys individually for each volume using ‘sourceVolumeToDestinationEncryptionKeyMappings’.

    The customer-managed encryption key in this will be used to encrypt the file system when it move to the destination region.

    • encryption_key_id - The OCID of the customer-managed encryption key in the destination region vault. Example: ocid1.key.oc1..uniqueID
    • vault_id - The OCID of the destination region vault for the customer-managed encryption key. Example: ocid1.vault.oc1..uniqueID

  • destination_load_balancer_id - The OCID of the destination load balancer. The backend sets in this destination load balancer are updated during DR. Example: ocid1.loadbalancer.oc1..uniqueID

  • destination_network_load_balancer_id - The OCID of the destination network load balancer. The backend sets in this destination network load balancer are updated during DR. Example: ocid1.networkloadbalancer.oc1..uniqueID

  • destination_snapshot_policy_id - The OCID of the snapshot policy to use in the destination region. This policy will be attached to the file system after it moves to the destination region. Example: ocid1.filesystemsnapshotpolicy.oc1..uniqueID

  • export_mappings - A list of mappings between the primary region file system export and destination region mount target.

    • destination_mount_target_id - The OCID of the destination mount target on which this file system export should be created. Example: ocid1.mounttarget.oc1..uniqueID
    • export_id - The OCID of the export path. Example: ocid1.export.oc1..uniqueID

  • file_system_operations - Operations performed on a list of file systems used on the non-movable compute instance.

    • export_path - The export path of the file system. Example: /fs-export-path
    • mount_details - Mount details of a file system.
      • mount_target_id - The OCID of the mount target for this file system. Example: ocid1.mounttarget.oc1..uniqueID
    • mount_point - The physical mount point of the file system on a host. Example: /mnt/yourmountpoint
    • mount_target_id - The OCID of mount target. Example: ocid1.mounttarget.oc1..uniqueID
    • unmount_details - Unmount details for a file system.
      • mount_target_id - The OCID of the mount target for this file system. Example: ocid1.mounttarget.oc1..uniqueID

  • is_movable - A flag indicating if the compute instance should be moved during DR operations. Example: false

  • is_retain_fault_domain - A flag indicating if the compute instance should be moved to the same fault domain in the destination region. The compute instance launch will fail if this flag is set to true and capacity is not available in the specified fault domain in the destination region. Example: false

  • is_start_stop_enabled - A flag indicating whether the non-movable compute instance needs to be started and stopped during DR operations.

  • jump_host_id - The OCID of the compute instance member that is designated as a jump host. This compute instance will be used to perform DR operations on the cluster using Oracle Cloud Agent’s Run Command feature. Example: ocid1.instance.oc1..uniqueID

  • load_balancer_mappings - The list of source-to-destination load balancer mappings required for DR operations. This property applies to the OKE cluster member in primary region.

    • destination_load_balancer_id - The OCID of the destination Load Balancer. Example: ocid1.loadbalancer.oc1..uniqueID
    • source_load_balancer_id - The OCID of the source Load Balancer. Example: ocid1.loadbalancer.oc1..uniqueID

  • managed_node_pool_configs - The list of node pools with configurations for minimum and maximum node counts. This property applies to the OKE cluster member in both the primary and standby region.

    • id - The OCID of the managed node pool in OKE cluster.
    • maximum - The maximum number to which nodes in the managed node pool could be scaled up.
    • minimum - The minimum number to which nodes in the managed node pool could be scaled down.

  • member_id - The OCID of the member. Example: ocid1.instance.oc1..uniqueID

  • member_type - The type of the member.

  • namespace - The namespace in object storage (Note - this is usually the tenancy name). Example: myocitenancy

  • network_load_balancer_mappings - The list of source-to-destination network load balancer mappings required for DR operations. This property applies to the OKE cluster member in primary region.

    • destination_network_load_balancer_id - The OCID of the destination Network Load Balancer. Example: ocid1.networkloadbalancer.oc1..uniqueID
    • source_network_load_balancer_id - The OCID of the source Network Load Balancer. Example: ocid1.networkloadbalancer.oc1..uniqueID

  • password_vault_secret_id - The OCID of the vault secret where the database SYSDBA password is stored. This password is required and used for performing database DR Drill operations when using full clone. Example: ocid1.vaultsecret.oc1..uniqueID

  • peer_cluster_id - The OCID of the peer OKE cluster. This property applies to the OKE cluster member in both the primary and standby region. Example: ocid1.cluster.oc1.uniqueID

  • source_volume_to_destination_encryption_key_mappings - A list of mappings between source volume IDs in the volume group and customer-managed encryption keys in the destination region which will be used to encrypt the volume after it moves to the destination region.

    If you add the entry for source volumes and its corresponding vault and encryption keys here, you can not use ‘commonDestinationKey’ for encrypting all volumes with common encryption key. Similarly, if you specify common vault and encryption key using ‘commonDestinationKey’, you cannot specify vaults and encryption keys individually for each volume using ‘sourceVolumeToDestinationEncryptionKeyMappings’.

    An entry for each volume in volume group should be added in this list. The encryption key will not be updated for the volumes that are part of volume group but missing in this list.

    • destination_encryption_key - The OCID of a vault and customer-managed encryption key in the destination region.

      The customer-managed encryption key in this will be used to encrypt all the volumes of the volume group after they move to the destination region. If you specify this common vault and encryption key, you cannot specify vaults and encryption keys individually for each volume using ‘sourceVolumeToDestinationEncryptionKeyMappings’.

      The customer-managed encryption key in this will be used to encrypt the file system when it move to the destination region.

      • encryption_key_id - The OCID of the customer-managed encryption key in the destination region vault. Example: ocid1.key.oc1..uniqueID
      • vault_id - The OCID of the destination region vault for the customer-managed encryption key. Example: ocid1.vault.oc1..uniqueID

    • source_volume_id - The OCID of the source boot volume or block volume. Example: ocid1.volume.oc1..uniqueID

  • vault_mappings - The list of source-to-destination vault mappings required for DR operations. This property applies to the OKE cluster member in primary region.

    • destination_vault_id - The OCID of the destination Vault. Example: ocid1.vault.oc1..uniqueID
    • source_vault_id - The OCID of the source Vault. Example: ocid1.vault.oc1..uniqueID

  • virtual_node_pool_configs - The list of node pools with configurations for minimum and maximum node counts. This property applies to the OKE cluster member in both the primary and standby region.

    • id - The OCID of the virtual node pool in OKE cluster.
    • maximum - The maximum number to which nodes in the virtual node pool could be scaled up.
    • minimum - The minimum number to which nodes in the virtual node pool could be scaled down.

  • vnic_mapping - A list of compute instance VNIC mappings.

    • destination_nsg_id_list - A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to the source VNIC. Example: [ ocid1.networksecuritygroup.oc1..uniqueID1, ocid1.networksecuritygroup.oc1..uniqueID2 ]
    • destination_subnet_id - The OCID of the destination subnet to which the source VNIC should connect. Example: ocid1.subnet.oc1..uniqueID
    • source_vnic_id - The OCID of the VNIC. Example: ocid1.vnic.oc1..uniqueID

  • vnic_mappings - A list of compute instance VNIC mappings.

    • destination_nsg_id_list - A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to the source VNIC. Example: [ ocid1.networksecuritygroup.oc1..uniqueID, ocid1.networksecuritygroup.oc1..uniqueID ]
    • destination_primary_private_ip_address - The private IP address to be assigned as the VNIC’s primary IP address in the destination subnet. This must be a valid IP address in the destination subnet and the IP address must be available. Example: 10.0.3.3
    • destination_primary_private_ip_hostname_label - The hostname label to be assigned in the destination subnet for the primary private IP of the source VNIC. This label is the hostname portion of the private IP’s fully qualified domain name (FQDN) (for example, ‘myhost1’ in the FQDN ‘myhost1.subnet123.vcn1.oraclevcn.com’). Example: myhost1
    • destination_reserved_public_ip_id - The OCID of the reserved public IP address to be assigned to the compute instance in the destination region. Example: ocid1.publicip.oc1..uniqueID
    • destination_subnet_id - The OCID of the destination subnet to which the source VNIC should connect. Example: ocid1.subnet.oc1..uniqueID
    • source_vnic_id - The OCID of the source VNIC. Example: ocid1.vnic.oc1..uniqueID

• peer_id - The OCID of the peer DR protection group. Example: ocid1.drprotectiongroup.oc1..uniqueID

• peer_region - The region of the peer DR protection group. Example: us-ashburn-1

• role - The role of the DR protection group.

• state - The current state of the DR protection group.

• system_tags - Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

• time_created - The date and time the DR protection group was created. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z

• time_updated - The date and time the DR protection group was updated. An RFC3339 formatted datetime string. Example: 2019-03-29T09:36:42Z