APIs in Category: snapmirror-policy | Vserver API version 1.21

snapmirror-policy-add-rule snapmirror-policy-create snapmirror-policy-delete snapmirror-policy-get snapmirror-policy-get-iter snapmirror-policy-modify snapmirror-policy-modify-rule snapmirror-policy-remove-rule | This set of APIs allows management of SnapMirror Policies in a cluster environment including: creation, deletion, modification and information query.

NetApp Manage ONTAP

snapmirror-policy-add-rule | [top]

> Add a rule to SnapMirror policy

> Input Name | Range | Type | Description
> keep |  | string | Specifies the Snapshot copy retention count.
> policy-name |  | sm-policy | The name of the SnapMirror policy.
> preserve |  | boolean optional | Specifies whether Snapshot copy preserve is enabled.
> snapmirror-label |  | string | Specifies the Snapshot copy label.
> warn | [0..2^32-1] | integer optional | Specifies the warning threshold count.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOPNOTSUPPORTED |  |

snapmirror-policy-create | [top]

> Create the specified SnapMirror Policy

> Input Name | Range | Type | Description
> comment |  | string optional | A human readable description associated with the SnapMirror policy.
> ignore-atime |  | boolean optional | Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only.
> policy-name |  | sm-policy | The name of the SnapMirror policy.
> restart |  | sm-restart-enum optional | Defines the behavior of SnapMirror if an interrupted transfer exists. Applies to SnapMirror data protection relationship only. Possible values: "always" , "never" , "default"
> return-record |  | boolean optional | If set to true, returns the snapmirror-policy on successful creation. Default: false
> transfer-priority |  | sm-transfer-priority-enum optional | Specifies the priority at which a SnapMirror transfer runs. 'normal' : By default every transfer in the system has this priority. These transfers are scheduled before most 'low' priority transfers. 'low': These transfers have least priority and usually are scheduled after most 'normal' priority transfers. Possible values: "low" , "normal"
> tries |  | string optional | Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. Valid input is a positive integer or 'unlimited'. The default is '8'.
> Output Name | Range | Type | Description
> result |  | snapmirror-policy-info optional | The snapmirror-policy created (keys or the entire object if requested)

> Errno | Description
> EINVALIDNPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |

snapmirror-policy-delete | [top]

> Delete the specified SnapMirror Policy

> Input Name | Range | Type | Description
> policy-name |  | sm-policy | The name of the SnapMirror policy.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |

snapmirror-policy-get | [top]

> Get Information about a single SnapMirror Policy

> Input Name | Range | Type | Description
> desired-attributes |  | snapmirror-policy-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> policy-name |  | sm-policy | The name of the SnapMirror policy.
> Output Name | Range | Type | Description
> attributes |  | snapmirror-policy-info | The attributes of the snapmirror-policy.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |

snapmirror-policy-get-iter | [top]

> Get Information about multiple SnapMirror Policies

> Input Name | Range | Type | Description
> desired-attributes |  | snapmirror-policy-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | snapmirror-policy-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the snapmirror-policy object. All snapmirror-policy objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | snapmirror-policy-info[] optional | The list of attributes of snapmirror-policy objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more snapmirror-policy objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |

snapmirror-policy-modify | [top]

> Modify the specified SnapMirror Policy

> Input Name | Range | Type | Description
> comment |  | string optional | A human readable description associated with the SnapMirror policy.
> ignore-atime |  | boolean optional | Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only.
> policy-name |  | sm-policy | The name of the SnapMirror policy.
> restart |  | sm-restart-enum optional | Defines the behavior of SnapMirror if an interrupted transfer exists. Applies to SnapMirror data protection relationship only. Possible values: "always" , "never" , "default"
> transfer-priority |  | sm-transfer-priority-enum optional | Specifies the priority at which a SnapMirror transfer runs. 'normal' : By default every transfer in the system has this priority. These transfers are scheduled before most 'low' priority transfers. 'low': These transfers have least priority and usually are scheduled after most 'normal' priority transfers. Possible values: "low" , "normal"
> tries |  | string optional | Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. Valid input is a positive integer or 'unlimited'. The default is '8'.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINVALIDNPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |

snapmirror-policy-modify-rule | [top]

> Modify a SnapMirror policy rule

> Input Name | Range | Type | Description
> keep |  | string optional | Specifies the Snapshot copy retention count.
> policy-name |  | sm-policy | The name of the SnapMirror policy.
> preserve |  | boolean optional | Specifies whether Snapshot copy preserve is enabled.
> snapmirror-label |  | string | Specifies the Snapshot copy label.
> warn | [0..2^32-1] | integer optional | Specifies the warning threshold count.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOPNOTSUPPORTED |  |

snapmirror-policy-remove-rule | [top]

> Remove a rule from SnapMirror policy

> Input Name | Range | Type | Description
> policy-name |  | sm-policy | The name of the SnapMirror policy.
> snapmirror-label |  | string | Specifies the Snapshot copy label.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOPNOTSUPPORTED |  |

Element definition: sm-policy | [top]

> SnapMirror Policy

> [none]

Element definition: sm-restart-enum | [top]

> always|never|default Possible values: "always" , "never" , "default"

> [none]

Element definition: sm-transfer-priority-enum | [top]

> low|normal Possible values: "low" , "normal"

> [none]

Element definition: snapmirror-policy-info | [top]

> Information about SnapMirror Policy When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> comment |  | string optional | A human readable description associated with the SnapMirror policy. Attributes: optional-for-create, modifiable
> ignore-atime |  | boolean optional | Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only. Attributes: optional-for-create, modifiable
> owner |  | policy-owner optional | The owner of the SnapMirror policy. Attributes: non-creatable, non-modifiable Possible values: "cluster_admin" , "vserver_admin"
> policy-name |  | sm-policy optional | The name of the SnapMirror policy. Attributes: key, required-for-create, non-modifiable
> restart |  | sm-restart-enum optional | Defines the behavior of SnapMirror if an interrupted transfer exists. Applies to SnapMirror data protection relationship only. Attributes: optional-for-create, modifiable Possible values: "always" , "never" , "default"
> snapmirror-policy-rules |  | snapmirror-policy-rule-info[] optional | Information about rules in the policy.
> total-keep | [0..2^32-1] | integer optional | Total Retention Count for All Rules in the Policy Attributes: non-creatable, non-modifiable
> total-rules | [0..2^32-1] | integer optional | Total Rules in the Policy Attributes: non-creatable, non-modifiable
> transfer-priority |  | sm-transfer-priority-enum optional | Specifies the priority at which a SnapMirror transfer runs. 'normal' : By default every transfer in the system has this priority. These transfers are scheduled before most 'low' priority transfers. 'low': These transfers have least priority and usually are scheduled after most 'normal' priority transfers. Attributes: optional-for-create, modifiable Possible values: "low" , "normal"
> tries |  | string optional | Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. Valid input is a positive integer or 'unlimited'. The default is '8'. Attributes: optional-for-create, modifiable
> vserver-name |  | vserver-name optional | Specifies the vserver for the SnapMirror policy. Attributes: key, non-creatable, non-modifiable

Element definition: policy-owner | [top]

> cluster-admin|vserver-admin Possible values: "cluster_admin" , "vserver_admin"

> [none]

Element definition: sm-policy | [top]

> SnapMirror Policy

> [none]

Element definition: sm-restart-enum | [top]

> always|never|default Possible values: "always" , "never" , "default"

> [none]

Element definition: sm-transfer-priority-enum | [top]

> low|normal Possible values: "low" , "normal"

> [none]

Element definition: snapmirror-policy-rule-info | [top]

> Information about rules in the policy.

> Name | Range | Type | Description
> keep |  | string optional | Specifies the maximum number of Snapshot copies that are retained on the SnapMirror vault destination volume for a rule. The total number of Snapshot copies retained for all the rules in a policy cannot exceed 251. Attributes: non-creatable, non-modifiable
> preserve |  | boolean optional | Specifies the behavior when the Snapshot copy retention count is reached on the SnapMirror vault destination for the rule. The default value is 'false', which means that the oldest Snapshot copy will be rotated out to make room for new ones only if the number of Snapshot copies has exceeded the retention count specified in the keep parameter. When set to 'true', an incremental SnapMirror vault update will fail when the Snapshot copies have reached the retention count. Attributes: non-creatable, non-modifiable
> snapmirror-label |  | string optional | Specifies the Snapshot copy label. It is used for the purpose of Snapshot copy selection as well as for accounting of Snapshot copies at the SnapMirror vault destination. Only Snapshot copies that have a SnapMirror label that matches this parameter will be transferred to the SnapMirror vault destination. The label can be 31 or fewer characters in length. Attributes: non-creatable, non-modifiable
> warn | [0..2^32-1] | integer optional | Specifies the warning threshold count for the rule. The default value is 0. When set to a value greater than zero, an event is generated after the remaining number of Snapshot copies (for the particular rule) retained on a SnapMirror vault destination reaches the specified warn limit. The preserve parameter for the rule must be 'true' to set the warn parameter to a value greater than zero. Attributes: non-creatable, non-modifiable

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]