Skip to main content
Command reference

snapmirror policy show

Suggest changes
PDFs

Show SnapMirror policies

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The snapmirror policy show command displays the following information about SnapMirror policies:

  • Vserver Name

  • SnapMirror Policy Name

  • SnapMirror Policy Type

  • Number of Rules in the policy

  • Tries

  • Transfer Priority

  • Comment for the policy

  • Individual Rule Names

  • Keep value for the Rule

  • Total of Keep values across all Rules in the policy

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-vserver <vserver name>] - Vserver Name

Selects the policies that match this parameter value.

[-policy <sm_policy>] - SnapMirror Policy Name

Selects the policies that match this parameter value.

[-type {vault|async-mirror|mirror-vault|strict-sync-mirror|sync-mirror|automated-failover|automated-failover-duplex|continuous|undefined}] - Snapmirror Policy Type

Selects the policies that match this parameter value. A policy can be of type async-mirror , vault or mirror-vault .

[-owner {cluster-admin|vserver-admin}] - Owner of the Policy

Selects the policies that match this parameter value. A policy can be owned by either the "Cluster Admin" or a "Vserver Admin" .

[-comment <text>] - Comment

Selects the policies that match this parameter value.

[-tries <integer_or_unlimited>] - Tries Limit

Selects the policies that match this parameter value.

[-transfer-priority {low|normal}] - Transfer Scheduling Priority

Selects the policies that match this parameter value.

[-ignore-atime {true|false}] - Ignore File Access Time

Selects the policies that match this parameter value.

[-restart {always|never|default}] - Restart Behavior

Selects the policies that match this parameter value.

[-is-network-compression-enabled {true|false}] - Is Network Compression Enabled

Selects the policies that match this parameter value.

[-create-snapshot {true|false}] - Create a New Snapshot Copy

Selects the policies that match this parameter value.

[-rpo <integer>] - Recovery Point Objective (seconds)

Selects the policies that match this parameter value.

[-always-replicate-snapshots {true|false}] - This prioritizes replication of app-consistent snapshots over synchronous replication

Selects the policies that match this parameter value.

[-snapmirror-label <text>,…​] - Snapshot Copy Label

Selects the policies that match this parameter value.

[-keep <text>,…​] - Snapshot Copy Retention Count

Selects the policies that match this parameter value.

[-preserve {true|false}] - Snapshot Copy Preserve Enabled

Selects the policies that match this parameter value.

[-warn <integer>,…​] - Warning Threshold Count

Selects the policies that match this parameter value.

[-schedule <text>,…​] - Snapshot Copy Creation Schedule

Selects the policies that match this parameter value.

[-prefix <text>,…​] - Snapshot Copy Creation Prefix

Selects the policies that match this parameter value.

[-retention-period {{<integer> seconds|minutes|hours|days|months|years} | infinite}] - Snapshot Copy Retention Period

This optional parameter specifies the duration for which the snapshots associated with this rule will be locked. The parameter is specified as a number followed by a suffix. The valid suffixes are seconds , minutes , hours , days , months , and years . For example, a value of 6months represents a retention period of 6 months. It can also be set to a special value of infinite for infinite retention. The destination volume must have the snapshot-locking-enabled parameter set to true for this field to take effect else it will be ignored.

[-total-rules <integer>] - Total Rules in the Policy

Selects the policies that match this parameter value.

[-total-keep <integer>] - Total Retention Count for All Rules in the Policy

Selects the policies that match this parameter value.

[-common-snapshot-schedule <text>] - Common Snapshot Copy Creation Schedule for SnapMirror Synchronous (privilege: advanced)

Selects the policies that match this parameter value.

[-are-data-ops-sequentially-split {true|false}] - Is Sequential Splitting of Data Operations Enabled? (privilege: advanced)

Selects the policies that match this parameter value.

[-sequential-split-op-timeout-secs <integer>] - Sequential Split Op Timeout in Seconds (privilege: advanced)

Selects the policies that match this parameter value.

[-disable-fast-resync {true|false}] - Disable Fast Resync (privilege: advanced)

Selects the policies that match this parameter value.

[-discard-configs <network>,…​] - Configurations Not Replicated During Identity Preserve Vserver DR

Selects the policies that match this parameter value.

[-transfer-schedule-name <text>] - Transfer Schedule Name

Selects the policies that match this parameter value.

[-throttle <throttleType>] - Throttle (KB/sec)

Selects the policies that match this parameter value.

Examples

The following example displays information about all SnapMirror policies:

cs::> snapmirror policy show
Vserver Policy             Policy Number         Transfer
Name    Name               Type   Of Rules Tries Priority Comment
------- ------------------ ------ -------- ----- -------- ----------
cs      DPDefault          async-mirror  2     8  normal  Asynchronous SnapMirror policy for mirroring all snapshots and the latest active file system.
  SnapMirror Label: sm_created                         Keep:       1
                    all_source_snapshots                           1
                                                 Total Keep:       2

cs      MirrorAllSnapshots async-mirror  2     8  normal  Asynchronous SnapMirror policy for mirroring all snapshots and the latest active file system.
  SnapMirror Label: sm_created                         Keep:       1
                    all_source_snapshots                           1
                                                 Total Keep:       2

cs      MirrorAndVault     mirror-vault  3     8  normal  A unified Asynchronous SnapMirror and SnapVault policy for mirroring the latest active file system and daily and weekly snapshots.
  SnapMirror Label: sm_created                         Keep:       1
                    daily                                          7
                    weekly                                        52
                                                 Total Keep:      60

cs      MirrorLatest       async-mirror  1     8  normal  Asynchronous SnapMirror policy for mirroring the latest active file system.
  SnapMirror Label: sm_created                         Keep:       1
                                                 Total Keep:       1

vs0.example.com
        TieredBackup       vault         0     8  normal  Use for tiered backups
  Snapmirror-label: -                                  Keep:       -
                                                 Total Keep:       0

cs  Unified7year     mirror-vault  4     8  normal  Unified SnapMirror policy with 7year retention.
  SnapMirror Label: sm_created                         Keep:       1
                    daily                                          7
                    weekly                                        52
                    monthly                                       84
                                                 Total Keep:     144

cs      XDPDefault         vault         2     8  normal  Vault policy with daily and weekly rules.
  SnapMirror Label: daily                              Keep:       7
                    weekly                                        52
                                                 Total Keep:      59

7 entries were displayed.

The following example shows all the policies with the following fields - vserver (default), policy (default) and transfer-priority:

cs::> snapmirror policy show -fields transfer-priority
vserver     policy    transfer-priority
----------- --------- -----------------
cs      DPDefault normal
cs      MirrorAllSnapshots
                      normal
cs      MirrorAndVault
                      normal
cs      MirrorLatest
                      normal
vs0.example.com
      TieredBackup
                      normal
cs      Unified7year
                      normal
cs      XDPDefault
                      normal
7 entries were displayed.