APIs in Category: options | 7-Mode API version 1.21

options-get options-list-info options-set

NetApp Manage ONTAP

options-get | [top]

> Get the value of a single option.

> Input Name | Range | Type | Description
> name |  | string | Name of the option.
> Output Name | Range | Type | Description
> cluster-constraint |  | string | Indicates the cluster-specific constraints of option. "none" - no constraint. "same_preferred" - same value should be used on both nodes of a HA pair. "same_required" - same value must be used on both nodes of a HA pair. "only_one" - value is used for both nodes of a HA pair, when in takeover mode. "unknown" - value is not valid. In Data ONTAP Cluster-Mode, this field will always be "none".
> value |  | string | Value of the option.

> Errno | Description
> EONTAPI_ENOENT |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

options-list-info | [top]

> Get a list of all options

> Output Name | Range | Type | Description
> options |  | option-info[] |

> Errno | Description
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

options-set | [top]

> Set the value of a single option. For complete list of names and values of options, please refer to options man pages.

> Input Name | Range | Type | Description
> name |  | string | Name of the option.
> value |  | string | Value of the option.
> Output Name | Range | Type | Description
> cluster-constraint |  | string | Cluster-specific constraint of the option. "none" - no constraint. "same_preferred" - same value should be used on both nodes of a HA pair. "same_required" - same value must be used on both nodes of a HA pair. "only_one" - value is used for both nodes of a HA pair, when in takeover mode. "unknown" - value is not valid. In Data ONTAP Cluster-Mode, this field will always be "none".
> message |  | string optional | Informative message that was issued as a result of setting (or trying to set) the option.

> Errno | Description
> EONTAPI_ENOENT |  |
> EONTAPI_EINVAL |  |
> EVSERVERNOTFOUND |  |

> Vfiler-enabled
> Yes

Element definition: option-info | [top]

> Name | Range | Type | Description
> cluster-constraint |  | string optional | Indicates the cluster-specific constraints of option. "none" - no constraint. "same_preferred" - same value should be used on both nodes of a HA pair. "same_required" - same value must be used on both nodes of a HA pair. "only_one" - value is used for both nodes of a HA pair, when in takeover mode. "unknown" - value is not valid. In Data ONTAP Cluster-Mode, this field will always be "none". This field is optional in Data ONTAP Cluster-Mode, but required in Data ONTAP 7-Mode.
> name |  | string optional | Name of the option. This field is optional in Data ONTAP Cluster-Mode, but required in Data ONTAP 7-Mode.
> value |  | string optional | Value of the option. This field is optional in Data ONTAP Cluster-Mode, but required in Data ONTAP 7-Mode.