APIs in Category: Client | API version 4.0

ClientRegistryDestroy ClientRegistryGet ClientRegistrySet | DFM Server maintains a registry of name/value pairs on behalf of client applications. Applications can use this To store persistent data about the user's configuration of the application. Examples might be View preferences or window sizes and locations. Information in the client application registry is indexed by the Name of the appliacation and the Name of the user that authenticates with DataFabric Manager. The APIs determine the Username automatically. Applications should pick an "ApplicationName" that is likely To be unique. We encourage client application developers To use the application provider's company stock ticker symbol as a prefix for the application Name To reduce the chance of Name collisions. For example, all client applications provided by Network Appliance will use application names beginning with "NTAP".

NetApp Manage ONTAP API version 4.0

ClientRegistryDestroy (supported) | [top]

> Remove one or all name/value pairs From the persistent store.

> Input Name | Type
> ClientRegistryDestroy | ClientRegistryDestroy
> Output Name | Type
> ClientRegistryDestroyResult | ClientRegistryDestroyResult

> Error Name | Description
> EINVALIDINPUTERROR |  |
> ENAMENOTFOUND |  |

ClientRegistryGet (supported) | [top]

> Retrieve one or all name/value string pairs.

> Input Name | Type
> ClientRegistryGet | ClientRegistryGet
> Output Name | Type
> ClientRegistryGetResult | ClientRegistryGetResult

> Error Name | Description
> EINVALIDINPUTERROR |  |
> ENAMENOTFOUND |  |

ClientRegistrySet (supported) | [top]

> Store one or more name/value string pairs.

> Input Name | Type
> ClientRegistrySet | ClientRegistrySet
> Output Name | Type
> ClientRegistrySetResult | ClientRegistrySetResult

Element definition: ClientRegistryDestroy | [top]

> Remove one or all name/value pairs From the persistent store.

> Name | Type | Description
> ApplicationName | xsd:string | Unique Name identifying the application requesting the data.
> Match | xsd:string optional | Specify how the API should determine which name/value pairs To remove. Use "exact", the default, To specify that the Option Name must exactly Match "Option". The API returns ENAMENOTFOUND if an Option by that Name does not exist. Use "all" To indicate that the API should ignore the Option Name and return all name/value pairs. Use "regexp" To indicate that the API should interpret the Option as an extended regular expression, and return all name/value pairs where the Option Name matches the pattern specified in "Option". The API returns EINVALIDINPUTERROR if the "Option" is not a valid regular expression.
> Option | xsd:string optional | Name of the Key To remove. See the Description of the "Match" parameter for more information.

Element definition: ClientRegistryDestroyResult | [top]

> [none]

Element definition: ClientRegistryGet | [top]

> Retrieve one or all name/value string pairs.

> Name | Type | Description
> ApplicationName | xsd:string | Unique Name identifying the application requesting the data.
> Match | xsd:string optional | Indicate how the API should find matching Options. Use "exact", the default, To specify that the Option Name must exactly Match "Option". The API returns ENAMENOTFOUND if no Option with that Name exists for this application. Use "all" To indicate that the API should ignore the Option Name and return all name/value pairs. Use "regexp" To indicate that the API should interpret the Option as an extended regular expression, and return all name/value pairs where the Option Name matches the pattern specified in "Option". In the case of "regexp", the API returns EINVALIDINPUTERROR if the "Option" is not a valid regular expression.
> Option | xsd:string optional | Name of the registry Key To fetch. See the Description of the "Match" parameter for more information.

Element definition: ClientRegistryGetResult | [top]

> Name | Type | Description
> Options | ArrayOfClientOptionInfo | An array of name/value pair Objects.

Element definition: ClientRegistrySet | [top]

> Store one or more name/value string pairs.

> Name | Type | Description
> ApplicationName | xsd:string | Unique Name identifying the application requesting storage.
> Options | ArrayOfClientOptionInfo | An array of name/value pair Objects.

Element definition: ClientRegistrySetResult | [top]

> [none]

Element definition: ArrayOfClientOptionInfo | [top]

> Name | Type | Description
> ClientOptionInfo | ClientOptionInfo[] |

Element definition: ClientOptionInfo | [top]

> Single name/value pair.

> Name | Type | Description
> Option | xsd:string | Key for the database To be stored.
> Value | xsd:string | The data itself.