Jump to

• Request
• Response

Add Protection Policy to Replication Server

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raId}/replicationServers/{repServerName}/protectionPolicies/{policyName}

Add a protection policy to the the replication server on a Recovery Appliance. If necessary for replication to function properly, add protected databases that are in the upstream policy, but not in a downstream policy, to either an existing or newly created downstream policy.

Request

Path Parameters

• policyName(required): string
  Protection policy name.
• raId(required): string
  Recovery Appliance id.
• repServerName(required): string
  Replication Server name.

Header Parameters

• ORCL-EM-ZDLRATARGET-AUTHORIZATION:
  Upstream Recovery Appliance Administrator Credential. If not specified preferred credentials will be used.

  Example:

  NAMED:NC_RA_UPSTREAM

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Parameter to identify the protection policies to be added to the Replication Server

Show Source

• protectionPolicies(required): array protectionPolicies
  List of protection policies to be added to the Replication Server

{
    "type":"object",
    "description":"Parameter to identify the protection policies to be added to the Replication Server",
    "required":[
        "protectionPolicies"
    ],
    "properties":{
        "protectionPolicies":{
            "description":"List of protection policies to be added to the Replication Server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AddPolicyToReplicationServerDetails"
            }
        }
    }
}

Nested Schema : protectionPolicies

Type: array

List of protection policies to be added to the Replication Server

Show Source

• Array of: object AddPolicyToReplicationServerDetails
  Parameters for the Add Protection Policy to Replication Server API.

{
    "description":"List of protection policies to be added to the Replication Server",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AddPolicyToReplicationServerDetails"
    }
}

Nested Schema : AddPolicyToReplicationServerDetails

Type: object

Parameters for the Add Protection Policy to Replication Server API.

Show Source

• downstreamPolicyGoal: string
  Recovery Window Goal of the downstream policy to be created (only if useExistingDsPolicy is false). Value is in ISO 8601 duration format. Examples - P2D (2 days), PT3H (3 hours), PT78M (78 minutes), PT345S (345 seconds)

  Example: P3D
• downstreamPolicyName: string
  Name of downstream protection policy that databases should be added to (either an existing or to be created policy on the downstream).

  Example: GOLD_DOWNSTREAM
• downstreamRaCred: string
  Administrator credential for the downstream Recovery Appliance

  Example: NAMED:NC_RA_DOWNSTREAM
• downstreamRaDbName(required): string
  Downstream Recovery Appliance database name.

  Example: DB_DOWNSTREAM
• downstreamRaName(required): string
  Downstream Recovery Appliance name.

  Example: RA_DOWNSTREAM
• downstreamRepServerName: string
  Replication Server name on downstream Recovery Appliance. Value is only needed if enableTwoWayReplication is true.

  Example: DB_DOWNSTREAM_UNIQUENAME_DB_UPSTREAM_UNIQUENAME_REP
• downstreamRepUser(required): string
  Database user name for a unique virtual private catalog user on the downstream Recovery Appliance to be granted permission to manage the replicated backups. This user will be granted access to each protected database enrolled with the downstream protection policy.

  Example: REPUSER_FROM_DB_UPSTREAM_UNIQUENAME_TO_DB_DOWNSTREAM_UNIQUENAME
• downstreamVpcUser: string
  An additional downstream VPC user that should be granted access to the protected databases in the downstream policy for backup and recovery purposes. This user is not the same as the replication user.

  Example: BACKUPUSER1
• enableTwoWayReplication: boolean
  Default Value: false

  Indicates if two-way replication should be enabled, which means that the downstream protection policy will also be added to the downstream replication server which points to the upstream Recovery Appliance.
• mode: string
  Allowed Values: [ "REPLICATION", "READ-ONLY", "REQUEST-ONLY" ]

  Mode to use when adding the protection policy to the replication server. Possible values are REPLICATION (default), READ-ONLY and REQUEST-ONLY.
• numDbsNeedingEnrollment: integer
  Number of databases that need to be enrolled on downstream Recovery Appliance.
• raDbType(required): string
  Allowed Values: [ "rac_database", "oracle_database" ]

  Recovery Appliance database type (rac_database for production, oracle_database for view based RAs)
• skipInitialReplication: boolean
  Default Value: false

  Indicates if the initial replication is to be skipped (default is false).
• upstreamRaDbName(required): string
  Upstream Recovery Appliance database name.

  Example: DB_UPSTREAM
• upstreamRepUser: string
  Database user name for a unique virtual private catalog user on the upstream Recovery Appliance who should be granted access to the protected databases in the upstream policy. Only needed if enableTwoWayReplication is true.

  Example: REPUSER_FROM_DB_DOWNSTREAM_UNIQUENAME_TO_DB_UPSTREAM_UNIQUENAME
• useExistingDsPolicy(required): boolean
  Indicates if databases in the upstream protection policy that are not enrolled on the downstream Recovery Appliance should be added to an existing downstream policy. If false a new policy will be created on the downstream Recovery Appliance, and those databases will be added to it.

{
    "type":"object",
    "description":"Parameters for the Add Protection Policy to Replication Server API.",
    "required":[
        "downstreamRaName",
        "upstreamRaDbName",
        "downstreamRaDbName",
        "raDbType",
        "useExistingDsPolicy",
        "downstreamRepUser"
    ],
    "properties":{
        "downstreamRaName":{
            "type":"string",
            "description":"Downstream Recovery Appliance name.",
            "example":"RA_DOWNSTREAM"
        },
        "upstreamRaDbName":{
            "type":"string",
            "description":"Upstream Recovery Appliance database name.",
            "example":"DB_UPSTREAM"
        },
        "downstreamRaDbName":{
            "type":"string",
            "description":"Downstream Recovery Appliance database name.",
            "example":"DB_DOWNSTREAM"
        },
        "raDbType":{
            "$ref":"#/components/schemas/RaDbTypeEnum"
        },
        "numDbsNeedingEnrollment":{
            "type":"integer",
            "description":"Number of databases that need to be enrolled on downstream Recovery Appliance."
        },
        "useExistingDsPolicy":{
            "type":"boolean",
            "description":"Indicates if databases in the upstream protection policy that are not enrolled on the downstream Recovery Appliance should be added to an existing downstream policy. If false a new policy will be created on the downstream Recovery Appliance, and those databases will be added to it."
        },
        "downstreamPolicyName":{
            "type":"string",
            "description":"Name of downstream protection policy that databases should be added to (either an existing or to be created policy on the downstream).",
            "example":"GOLD_DOWNSTREAM"
        },
        "downstreamPolicyGoal":{
            "type":"string",
            "description":"Recovery Window Goal of the downstream policy to be created (only if useExistingDsPolicy is false). Value is in ISO 8601 duration format. Examples - P2D (2 days), PT3H (3 hours), PT78M (78 minutes), PT345S (345 seconds)",
            "example":"P3D"
        },
        "mode":{
            "$ref":"#/components/schemas/AddPolicyModeEnum"
        },
        "skipInitialReplication":{
            "type":"boolean",
            "default":false,
            "description":"Indicates if the initial replication is to be skipped (default is false)."
        },
        "enableTwoWayReplication":{
            "type":"boolean",
            "default":false,
            "description":"Indicates if two-way replication should be enabled, which means that the downstream protection policy will also be added to the downstream replication server which points to the upstream Recovery Appliance."
        },
        "downstreamRepServerName":{
            "type":"string",
            "description":"Replication Server name on downstream Recovery Appliance. Value is only needed if enableTwoWayReplication is true.",
            "example":"DB_DOWNSTREAM_UNIQUENAME_DB_UPSTREAM_UNIQUENAME_REP"
        },
        "downstreamRaCred":{
            "type":"string",
            "description":"Administrator credential for the downstream Recovery Appliance",
            "example":"NAMED:NC_RA_DOWNSTREAM"
        },
        "downstreamRepUser":{
            "type":"string",
            "description":"Database user name for a unique virtual private catalog user on the downstream Recovery Appliance to be granted permission to manage the replicated backups. This user will be granted access to each protected database enrolled with the downstream protection policy.",
            "example":"REPUSER_FROM_DB_UPSTREAM_UNIQUENAME_TO_DB_DOWNSTREAM_UNIQUENAME"
        },
        "downstreamVpcUser":{
            "type":"string",
            "description":"An additional downstream VPC user that should be granted access to the protected databases in the downstream policy for backup and recovery purposes. This user is not the same as the replication user.",
            "example":"BACKUPUSER1"
        },
        "upstreamRepUser":{
            "type":"string",
            "description":"Database user name for a unique virtual private catalog user on the upstream Recovery Appliance who should be granted access to the protected databases in the upstream policy. Only needed if enableTwoWayReplication is true.",
            "example":"REPUSER_FROM_DB_DOWNSTREAM_UNIQUENAME_TO_DB_UPSTREAM_UNIQUENAME"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : ReplicationServerDpSubmissionDetails

Type: object

Replication deployment procedure submission details.

Show Source

• executionId(required): string
  Deployment procedure execution id.
• instanceName(required): string
  Deployment procedure instance name.
• procedureId(required): string
  Deployment procedure submission id.
• submissionBy(required): string
  Name of the Enterprise Manager user who submitted the deployment procedure.
• submissionName(required): string
  Name of the submitted deployment procedure.
• submittedDpEmUrl(required): string
  Link to the Enterprise Manager deployment procedure details page.

  Example: /em/faces/core-jobs-procedureExecutionTracking?showProcActLink=yes&executionGUID=C0E2AD7B1E61060BE053B36FF10A1B07&instanceGUID=C0E2AD7B1E5C060BE053B36FF10A1B07

{
    "type":"object",
    "description":"Replication deployment procedure submission details.",
    "required":[
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName",
        "submittedDpEmUrl"
    ],
    "properties":{
        "submissionName":{
            "type":"string",
            "description":"Name of the submitted deployment procedure."
        },
        "submissionBy":{
            "type":"string",
            "description":"Name of the Enterprise Manager user who submitted the deployment procedure."
        },
        "executionId":{
            "type":"string",
            "description":"Deployment procedure execution id."
        },
        "procedureId":{
            "type":"string",
            "description":"Deployment procedure submission id."
        },
        "instanceName":{
            "type":"string",
            "description":"Deployment procedure instance name."
        },
        "submittedDpEmUrl":{
            "type":"string",
            "description":"Link to the Enterprise Manager deployment procedure details page.",
            "example":"/em/faces/core-jobs-procedureExecutionTracking?showProcActLink=yes&executionGUID=C0E2AD7B1E61060BE053B36FF10A1B07&instanceGUID=C0E2AD7B1E5C060BE053B36FF10A1B07"
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top