ReplicationPolicy#

class ReplicationPolicy(name=None, description=None, type=None, replication_configurations=None, status=None, should_include_new_mount_targets=None, should_keep_deleted_files=None, exclude_file_patterns=None, change_user_session_ownership_spec=None, is_reverse=False, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#

Bases: ExternalizableAbstractModel

Replication policy model.

Parameters:

  • name (required min=1 chars, max=64 chars) – (name) Name of the replication policy.

  • description (max=180 chars) – (description) Replication policy description.

  • type (required) – (type)

  • replication_configurations (required) – (replication_configurations) Replication configuration represents combination of file server entities involved in the replication policy, schedules, policy status and replication summary status. For SMART_DR the system supports a single replication configuration object per replication policy. For DATA_SYNC or VDI_SYNC, replicationConfigurations are allowed between 1 and 10. Note that in VDI_SYNC, the primary file server of the first replication entity is the preferred file server for replication.

  • status – (status)

  • should_include_new_mount_targets – (should_include_new_mount_targets) This attribute denotes whether the new mount targets in the file server should be included in the replication policy. By default it is always true. If specific mount targets are selected then you should mark this field as false. This is applicable for SMART_DR.

  • should_keep_deleted_files – (should_keep_deleted_files) Flag to maintain deleted files or folders on the target that are deleted on the source. This is applicable for DATA_SYNC.

  • exclude_file_patterns – (exclude_file_patterns) Display a list of file patterns to exclude from the replication. For example, [”.txt”, “.yaml”]. This is applicable for DATA_SYNC.

  • change_user_session_ownership_spec – (change_user_session_ownership_spec)

  • is_reverse – (is_reverse) A boolean flag to reverse the data replication configuration during a planned failover or to resume replication from the secondary site. Use this configuration only if reverse replication is required for failover. A reverse policy can be created when the file servers are in a failed-over state. No replication entities need to be specified to create a reverse policy. This configuration is applicable only for the SMART_DR policy. (Default False)

property change_user_session_ownership_spec#
Type:

OwnershipSpec

property description#

Replication policy description.

Type:

str

property exclude_file_patterns#

Display a list of file patterns to exclude from the replication. For example, [”.txt”, “.yaml”]. This is applicable for DATA_SYNC.

Type:

list[ str ]

property is_reverse#

A boolean flag to reverse the data replication configuration during a planned failover or to resume replication from the secondary site. Use this configuration only if reverse replication is required for failover. A reverse policy can be created when the file servers are in a failed-over state. No replication entities need to be specified to create a reverse policy. This configuration is applicable only for the SMART_DR policy.

Type:

bool

property name#

Name of the replication policy.

Type:

str

property replication_configurations#

Replication configuration represents combination of file server entities involved in the replication policy, schedules, policy status and replication summary status. For SMART_DR the system supports a single replication configuration object per replication policy. For DATA_SYNC or VDI_SYNC, replicationConfigurations are allowed between 1 and 10. Note that in VDI_SYNC, the primary file server of the first replication entity is the preferred file server for replication.

Type:

list[ ReplicationConfiguration ]

property should_include_new_mount_targets#

This attribute denotes whether the new mount targets in the file server should be included in the replication policy. By default it is always true. If specific mount targets are selected then you should mark this field as false. This is applicable for SMART_DR.

Type:

bool

property should_keep_deleted_files#

Flag to maintain deleted files or folders on the target that are deleted on the source. This is applicable for DATA_SYNC.

Type:

bool

property status#
Type:

PolicyStatus

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

property type#
Type:

ReplicationPolicyType