Update Policy

Update Policy

This request updates the specified policy properties.

Request
URI
PUT
https://{api_host}/policies/{policyId}
COPY
Path Parameters
string
policyId
Required

Unique policy ID

policyId example
d2d7e5ce-2994-4c48-82d1-a206c45237fc
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services


Request Body
NewReplicationPolicyRequest of type(s) application/json
Required
{
    "allowAdvancedRetentionRules": true,
    "allowCustomSlaSettings": true,
    "allowIncomingMigrations": true,
    "allowIncomingProtections": true,
    "allowNotificationConfiguration": true,
    "allowOutgoingMigrations": true,
    "allowOutgoingOnpremMigrations": true,
    "allowOutgoingOnpremProtections": true,
    "allowOutgoingProtections": true,
    "displayName": "Default Policy",
    "maxIncoming": 0,
    "maxInstances": 24,
    "maxPinnedInstances": 24,
    "minRpo": 15,
    "onpremDataCap": 512
}
boolean
allowAdvancedRetentionRules
Optional

A boolean flag indicating whether advanced retention rules are allowed or not.

boolean
allowCustomSlaSettings
Optional

Indicates whether custom SLA settings like rpo, quiesced, retention policy, etccan be specified during replication creation/edit or orgs are restricted toonly using SLA profiles

boolean
allowIncomingMigrations
Optional

A boolean flag indicating whether incoming migrations are allowed or not.

boolean
allowIncomingProtections
Optional

A boolean flag indicating whether incoming protections are allowed or not.

boolean
allowNotificationConfiguration
Optional

Indicates whether organizations can configure notifications settings.

boolean
allowOutgoingMigrations
Optional

A boolean flag indicating whether outgoing migrations are allowed or not.

boolean
allowOutgoingOnpremMigrations
Optional

A boolean flag indicating whether outgoing migrations to OnPrem are allowed or not.

boolean
allowOutgoingOnpremProtections
Optional

A boolean flag indicating whether outgoing protections to OnPrem are allowed or not.

boolean
allowOutgoingProtections
Optional

A boolean flag indicating whether outgoing protections are allowed or not.

string
displayName
Optional

User-friendly policy label. This value is case-sensitive and must be unique.

integer As int32 As int32
maxIncoming
Optional

This value controls how many incoming replications organizations can have. A negative value means unlimited number replications. 0 means the org can not be used as destination. A positive value represents upper bound. This field is ignored if allowIncomingProtections and allowIncomingMigrations are set to false.

integer As int32 As int32
maxInstances
Optional

If the replication has MPIT configured, this field controlsthe maximum number of instances a vm replication can have.

integer As int32 As int32
maxPinnedInstances
Optional

Maximum number of pinned instances a vm replication can have.

integer As int32 As int32
minRpo
Optional

Minimum RPO value lower bound. Incoming replications can not beconfigured if the policy of the destination organization has minimum RPO higher than the RPO in the replication settings.

integer As int64 As int64
onpremDataCap
Optional

Maximum bit rate (in mbit/sec) for replication data traffic from an on-prem appliance to this org. Applies to all on-prem appliances that replicate to this org. The cap is sent to an on-prem appliance when it pairs or repairs with us. The cap is enforced within the on-prem appliance.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ReplicationPolicyInfo of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "allowAdvancedRetentionRules": true,
    "allowCustomSlaSettings": true,
    "allowIncomingMigrations": true,
    "allowIncomingProtections": true,
    "allowNotificationConfiguration": true,
    "allowOutgoingMigrations": true,
    "allowOutgoingOnpremMigrations": true,
    "allowOutgoingOnpremProtections": true,
    "allowOutgoingProtections": true,
    "displayName": "Default Policy",
    "id": "1c82d607-5db5-46e5-a6f0-1823cc21e2f0",
    "maxIncoming": 0,
    "maxInstances": 24,
    "maxPinnedInstances": 24,
    "minRpo": 15,
    "orgs": 2
}
boolean
allowAdvancedRetentionRules
Optional

A boolean flag indicating whether advanced retention rules are allowed or not.

boolean
allowCustomSlaSettings
Optional

Indicates whether custom SLA settings like rpo, quiesced, retention policy, etc can be specified during replication creation/edit or orgs are restricted to only using predefined SLA profiles.

boolean
allowIncomingMigrations
Optional

A boolean flag indicating whether incoming migrations are allowed or not.

boolean
allowIncomingProtections
Optional

A boolean flag indicating whether incoming protections are allowed or not.

boolean
allowNotificationConfiguration
Optional

Indicates whether organizations can configure notifications settings.

boolean
allowOutgoingMigrations
Optional

A boolean flag indicating whether outgoing migrations are allowed or not.

boolean
allowOutgoingOnpremMigrations
Optional

A boolean flag indicating whether outgoing migrations to OnPrem are allowed or not.

boolean
allowOutgoingOnpremProtections
Optional

A boolean flag indicating whether outgoing protections to OnPrem are allowed or not.

boolean
allowOutgoingProtections
Optional

A boolean flag indicating whether outgoing protections are allowed or not.

string
displayName
Optional

User-friendly policy label. This value is case-sensitive and must be unique.

string
id
Optional

Unique policy id - for manually created policies this is a UUID. The default policy has a hard-coded id 'default'.

integer As int32 As int32
maxIncoming
Optional

This value controls how many incoming replications organizations can have. A negative value means unlimited number replications. 0 means the org can not be used as destination. A positive value represents upper bound. This field is ignored if allowIncomingProtections and allowIncomingMigrations are set to false.

integer As int32 As int32
maxInstances
Optional

If the replication has MPIT configured, this field controls the maximum number of instances a vm replication can have.The value is ignored if allowAdvancedRetentionRules is set to true.

integer As int32 As int32
maxPinnedInstances
Optional

Maximum number of pinned instances a vm replication can have.

integer As int32 As int32
minRpo
Optional

Minimum RPO value lower bound. Incoming replications can not be configured if the policy of the destination organization has minimum RPO higher than the RPO in the replication settings.

integer As int32 As int32
orgs
Optional

The number of organizations, which have this policy assigned.


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.