|
APIs in Category: nis |
Vserver API version 1.15 |
nis-create |
| nis-create | [top] |
Create an NIS domain configuration. Multiple NIS domains can be configured on a single Vserver, but only one NIS domain can be active at any given time.
Input Name Range Type Description is-active boolean
Specifies whether the NIS domain configuration is active or inactive. nis-domain string
Specifies the NIS domain. For example: 'example.com' nis-servers ip-address[]
Specifies the IP address of one or more NIS servers in the domain. return-record boolean
optional
If set to true, returns the NIS domain configuration on successful creation. Default: false Output Name Range Type Description result nis-domain-config-info
optional
The NIS domain configuration created (keys or the entire object if requested)
Errno Description EOBJECTNOTFOUND EVSERVERNTFOUND EINVALIDINPUTERROR EINTERNALERROR
| nis-destroy | [top] |
Destroy an existing NIS configuration.
Input Name Range Type Description nis-domain string
Specifies the NIS domain. For example: 'example.com'
Errno Description EOBJECTNOTFOUND EVSERVERNTFOUND EINTERNALERROR
| nis-get | [top] |
Get NIS domain configuration.
Input Name Range Type Description desired-attributes nis-domain-config-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. nis-domain string
Specifies the NIS domain. For example: 'example.com' Output Name Range Type Description attributes nis-domain-config-info
The attributes of the NIS domain configuration.
Errno Description EOBJECTNOTFOUND EVSERVERNTFOUND EINTERNALERROR
| nis-get-iter | [top] |
Iterate over a list of NIS configurations.
Input Name Range Type Description desired-attributes nis-domain-config-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..100] integer
optional
The maximum number of records to return in this call. Default: 20 query nis-domain-config-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the NIS domain configuration object. All NIS domain configuration 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 nis-domain-config-info[]
optional
The list of attributes of NIS domain configuration objects. next-tag string
optional
Tag for the next call. Not present when there are no more NIS domain configuration objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR EINVALIDINPUTERROR EVSERVERNTFOUND
| nis-modify | [top] |
Modify the attributes of NIS configuration.
Input Name Range Type Description is-active boolean
optional
Specifies whether the NIS domain configuration is active or inactive. nis-domain string
Specifies the NIS domain. For example: 'example.com' nis-servers ip-address[]
optional
Specifies the IP address of one or more NIS servers in the domain.
Errno Description EOBJECTNOTFOUND EVSERVERNTFOUND EINVALIDINPUTERROR EINTERNALERROR
| Element definition: ip-address | [top] |
IPv4 address in dotted notation as '192.168.125.123'
[none]
| Element definition: nis-domain-config-info | [top] |
NIS domain configuration information 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 is-active boolean
optional
Specifies whether the NIS domain configuration is active or inactive. Attributes: required-for-create, modifiable nis-domain string
optional
Specifies the NIS domain. For example: 'example.com' Attributes: key, required-for-create, non-modifiable nis-servers ip-address[]
optional
Specifies the IP address of one or more NIS servers in the domain. Attributes: required-for-create, modifiable vserver string
optional
Specifies the Vserver for the NIS domain configuration. Attributes: key, non-creatable, non-modifiable
| Element definition: ip-address | [top] |
IPv4 address in dotted notation as '192.168.125.123'
[none]