APIs in Category: srm | API version 5.0

srm-file-type-add srm-file-type-delete srm-file-type-list-info | These apis include SRM related operation e.g. SRM file type operation.

NetApp Manage ONTAP

srm-file-type-add | [top]

> Add the SRM file type in dfm.

> Input Name | Range | Type | Description
> srm-file-type-name |  | string | SRM file type. If an invalid file type is provided then error will be returned. Following characters are not allowed in file type: /, \, *, ?, <, >, | Also, a file type can start with a ... (dot) but should have at least one more character and cannot have a ... (dot) in between the file name.
> Output Name | Range | Type | Description
> srm-file-type-id |  | obj-id | Unique identifier representing an srm file type in dfm.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

srm-file-type-delete | [top]

> Delete the SRM file type in dfm. If any entry in the input is invalid then, none of the file types will be deleted and error will be returned.

> Input Name | Range | Type | Description
> srm-file-type-name-or-id-list |  | object-name-or-id[] | Represents an array of either file type name or unique identifiers corresponding to SRM file types in dfm.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

srm-file-type-list-info | [top]

> Returns all the SRM file types in dfm.

> Input Name | Range | Type | Description
> srm-file-type-id |  | obj-id optional | Unique identifier representing an srm file type in dfm. If no input was provided then all the SRM file types will be listed.
> Output Name | Range | Type | Description
> srm-file-types |  | srm-file-type-info[] | The list of SRM file types.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

Element definition: obj-id | [top]

> Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

> [none]

Element definition: object-name-or-id | [top]

> Name or ID of an object.

> [none]

Element definition: srm-file-type-info | [top]

> Information of one SRM file type.

> Name | Range | Type | Description
> srm-file-type-id |  | obj-id | A unique identifier representing SRM file type in dfm.
> srm-file-type-name |  | string | SRM file type

Element definition: obj-id | [top]

> Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

> [none]