Module netapp_ontap.resources.nis_service
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
NIS servers are used to authenticate user and client computers. NIS domain name and NIS server information is required to configure NIS.
It is important to note that this API is used to retrieve and manage NIS server configurations for data SVMs only. NIS configuration for the cluster is managed via /api/security/authentication/cluster/nis
.
Retrieving NIS Information
The NIS GET endpoint retrieves all of the NIS configurations for data SVMs.
Examples
Retrieving all fields for all NIS configurations
# The API:
/api/name-services/nis
# The call:
curl -X GET "https://<mgmt-ip>/api/name-services/nis?fields=*" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"svm": {
"uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1",
"name": "vs1"
"_links": {
"self": {
"href": "/api/svm/svms/179d3c85-7053-11e8-b9b8-005056b41bd1"
}
}
},
"domain": "domainA.example.com",
"servers": [
"10.10.10.10",
"example.com"
]
"bound-servers": [
"10.10.10.10"
]
"_links": {
"self": {
"href": "/api/name-services/nis/179d3c85-7053-11e8-b9b8-005056b41bd1"
}
}
},
{
"svm": {
"uuid": "6a52023b-7066-11e8-b9b8-005056b41bd1",
"name": "vs2"
"_links": {
"self": {
"href": "/api/svm/svms/6a52023b-7066-11e8-b9b8-005056b41bd1"
}
}
},
"domain": "domainB.example.com",
"servers": [
"2.2.2.2",
"3.3.3.3"
"4.4.4.4"
]
"bound-servers": [],
"_links": {
"self": {
"href": "/api/name-services/nis/6a52023b-7066-11e8-b9b8-005056b41bd1"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/name-services/nis?fields=*"
}
}
}
Retrieving all NIS configurations whose bound servers start with 10
# The API:
/api/name-services/nis
# The call:
curl -X GET "https://<mgmt-ip/api/name-services/nis?bound_servers=10*" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"svm": {
"uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1",
"name": "vs1"
"_links": {
"self": {
"href": "/api/svm/svms/179d3c85-7053-11e8-b9b8-005056b41bd1"
}
}
},
"bound-servers": [
"10.10.10.10"
]
"_links": {
"self": {
"href": "/api/name-services/nis/6a52023b-7066-11e8-b9b8-005056b41bd1"
}
}
}
],
"num_records": 1,
"_links": {
"self": {
"href": "/api/name-services/nis?bound_servers=10*"
}
}
}
Retrieving the NIS configuration of a specific SVM
# The API:
/api/name-services/nis/{svm.uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/name-services/nis/179d3c85-7053-11e8-b9b8-005056b41bd1" -H "accept: application/hal+json"
# The response:
{
"svm": {
"uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1",
"name": "vs1"
},
"domain": "domainA.example.com",
"servers": [
"10.10.10.10",
"example.com"
]
"bound_servers": [
"10.10.10.10"
]
}
Creating a NIS configuration
The NIS POST endpoint creates a NIS configuration for the specified SVM.
Example
The following example shows a POST operation:
# The API:
/api/name-services/nis
# The call:
curl -X POST "https://<mgmt-ip>/api/name-services/nis" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"svm\": { \"uuid\": \"179d3c85-7053-11e8-b9b8-005056b41bd1\" }, \"domain\": \"domainA.example.com\", \"servers\": [ \"10.10.10.10\",\"example.com\" ]}"
Updating the NIS configuration
The NIS PATCH endpoint updates the NIS configuration for the specified NIS server.
Examples
Updating the domain
# The API:
/api/name-services/nis/{svm.uuid}
# The call:
curl -X PATCH "https://<mgmt-ip>/api/name-services/nis/179d3c85-7053-11e8-b9b8-005056b41bd1" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"domain\": \"domainC.example.com\", \"servers\": [ \"13.13.13.13\" ]}"
Updating the server
# The API:
/api/name-services/nis/{svm.uuid}
# The call:
curl -X PATCH "https://<mgmt-ip>/api/name-services/nis/179d3c85-7053-11e8-b9b8-005056b41bd1" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"servers\": [ \"14.14.14.14\" ]}"
Deleting a NIS configuration
The NIS DELETE endpoint deletes the NIS configuration for the specified SVM.
Example
The following example shows a DELETE operation:
# The API:
/api/name-services/nis/{svm.uuid}
# The call:
curl -X DELETE "https://<mgmt-ip>/api/name-services/nis/179d3c85-7053-11e8-b9b8-005056b41bd1" -H "accept: application/hal+json"
Classes
class NisService (*args, **kwargs)
-
Allows interaction with NisService objects on the host
Initialize the instance of the resource.
Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:
MyResource(name='foo').name == 'foo'
Args
*args
- Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
- each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.
Ancestors
Static methods
def delete_collection(*args, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Deletes the NIS domain configuration of an SVM. NIS can be removed as a source from ns-switch if NIS is not used for lookups.
Related ONTAP commands
vserver services name-service nis-domain delete
Learn more
Delete all objects in a collection which match the given query.
All records on the host which match the query will be deleted.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves NIS domain configurations of all the SVMs. The bound_servers field indicates the successfully bound NIS servers. Lookups and authentications fail if there are no bound servers.
Related ONTAP commands
vserver services name-service nis-domain show
vserver services name-service nis-domain show-bound
Learn more
Find an instance of an object on the host given a query.
The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found or if more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
Resource
object containing the details of the object.Raises
NetAppRestError
: If the API call did not return exactly 1 matching resource. def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable
-
Retrieves NIS domain configurations of all the SVMs. The bound_servers field indicates the successfully bound NIS servers. Lookups and authentications fail if there are no bound servers.
Related ONTAP commands
vserver services name-service nis-domain show
vserver services name-service nis-domain show-bound
Learn more
Fetch a list of all objects of this type from the host.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. max_records
- The maximum number of records to return per call
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A list of
Resource
objectsRaises
NetAppRestError
: If there is no connection available to use either passed in or on the library. def patch_collection(body: dict, *args, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Updates NIS domain and server configuration of an SVM.
Important notes
- Both NIS domain and servers can be modified.
- Domains and servers cannot be empty.
- Both FQDNs and IP addresses are supported for the servers field.
- If the domain is modified, NIS servers must also be specified.
- IPv6 must be enabled if IPv6 family addresses are specified for the servers field.
Related ONTAP commands
vserver services name-service nis-domain modify
Learn more
Patch all objects in a collection which match the given query.
All records on the host which match the query will be patched with the provided body.
Args
body
- A dictionary of name/value pairs to set on all matching members of the collection.
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to patch the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400
Methods
def delete(self, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Deletes the NIS domain configuration of an SVM. NIS can be removed as a source from ns-switch if NIS is not used for lookups.
Related ONTAP commands
vserver services name-service nis-domain delete
Learn more
Send a deletion request to the host for this object.
Args
poll
- If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
- If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
- If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def get(self, **kwargs) -> NetAppResponse
-
Retrieves NIS domain and server configurations of an SVM. Both NIS domain and servers are displayed by default. The bound_servers field indicates the successfully bound NIS servers.
Related ONTAP commands
vserver services name-service nis-domain show
vserver services name-service nis-domain show-bound
Learn more
Fetch the details of the object from the host.
Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def patch(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Updates NIS domain and server configuration of an SVM.
Important notes
- Both NIS domain and servers can be modified.
- Domains and servers cannot be empty.
- Both FQDNs and IP addresses are supported for the servers field.
- If the domain is modified, NIS servers must also be specified.
- IPv6 must be enabled if IPv6 family addresses are specified for the servers field.
Related ONTAP commands
vserver services name-service nis-domain modify
Learn more
Send the difference in the object's state to the host as a modification request.
Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.
Args
hydrate
- If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll
- If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
- If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
- If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Creates an NIS domain and server confguration for a data SVM. NIS configuration for the cluster is managed via
/api/security/authentication/cluster/nis
.Important notes
- Each SVM can have one NIS domain configuration.
- Multiple SVMs can be configured with the same NIS domain. Specify the NIS domain and NIS servers as input.Domain name and servers fields cannot be empty.
- Both FQDNs and IP addresses are supported for the servers field.
- IPv6 must be enabled if IPv6 family addresses are specified in the servers field.
- A maximum of ten NIS servers are supported.
Required properties
svm.uuid
orsvm.name
- Existing SVM in which to create the NIS configuration.domain
- NIS domain to which the configuration belongs.servers
- List of NIS server IP addresses.
Related ONTAP commands
vserver services name-service nis-domain create
Learn more
Send this object to the host as a creation request.
Args
hydrate
- If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll
- If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
- If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
- If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400
Inherited members
class NisServiceSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the NisService object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var bound_servers
-
The bound_servers field of the nis_service.
var domain
-
The NIS domain to which this configuration belongs.
var links
-
The links field of the nis_service.
var opts
var servers
-
A list of hostnames or IP addresses of NIS servers used by the NIS domain configuration.
var svm
-
The svm field of the nis_service.