|
APIs in Category: options |
API version 1.4 |
options-get |
| 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. Possible values: "none", "same_preferred" (the same value should be used on both nodes of a cluster), "same_required" (the same value must be used on both nodes of a cluster), "only_one" (the value is used for both nodes of a cluster, when in takeover mode). value string
Value of the option.
Errno Description ENOENT
Vfiler-enabled Yes
| options-list-info | [top] |
Get a list of all options
Output Name Range Type Description options option-info[]
Vfiler-enabled Yes
| options-set | [top] |
Set the value of a single option.
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. Possible values: "none", "same_preferred" (the same value should be used on both nodes of a cluster), "same_required" (the same value must be used on both nodes of a cluster), "only_one" (the value is used for both nodes of a cluster, when in takeover mode). message string
optional
Informative message that was issued as a result of setting (or trying to set) the option. This value can be present if the API is successful (in which case it is an informative message or warning), as well as if the API has failed (in which case it is a more detailed message about the failure).
Errno Description ENOENT EINVAL
Vfiler-enabled Yes
| Element definition: option-info | [top] |
Name Range Type Description cluster-constraint string
Indicates the cluster-specific constraints of option. Possible values: "none", "same_preferred" (the same value should be used on both nodes of a cluster), "same_required" (the same value must be used on both nodes of a cluster), "only_one" (the value is used for both nodes of a cluster, when in takeover mode). name string
Name of the option. value string
Value of the option.