Skip to main content
ONTAP 9.12.1 ONTAPI-to-REST mapping
A newer release of this product is available.

nameservice

Contributors
Suggest changes

name-service-cache-group-membership-settings-get

GET /api/name-services/cache/group-membership/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

grplist-ttl

ttl

is-enabled

enabled

vserver-name

svm.name

name-service-cache-group-membership-settings-get-iter

GET /api/name-services/cache/group-membership/settings

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

grplist-ttl

ttl

is-enabled

enabled

vserver-name

svm.name

max-records

num-records

name-service-cache-group-membership-settings-modify

PATCH /api/name-services/cache/group-membership/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

grplist-ttl

ttl

is-enabled

enabled

name-service-cache-hosts-settings-get

GET /api/name-services/cache/host/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-dns-ttl-enabled

dns-ttl-enabled

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

name-service-cache-hosts-settings-get-iter

GET /api/name-services/cache/host/settings

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-dns-ttl-enabled

dns-ttl-enabled

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

max-records

num-records

name-service-cache-hosts-settings-modify

PATCH /api/name-services/cache/host/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-dns-ttl-enabled

dns-ttl-enabled

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

negative-ttl

negative-ttl

ttl

ttl

name-service-cache-netgroup-settings-get

GET /api/name-services/cache/netgroup/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled-byhost

negative-ttl

negative-ttl-byhost

ttl

ttl-byhost

ttl-members

ttl-for-members

vserver-name

svm.name

name-service-cache-netgroup-settings-get-iter

GET /api/name-services/cache/netgroup/settings

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled-byhost

negative-ttl

negative-ttl-byhost

ttl

ttl-byhost

ttl-members

ttl-for-members

vserver-name

svm.name

max-records

num-records

No REST Equivalent

name-service-cache-netgroup-settings-modify

PATCH /api/name-services/cache/netgroup/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled-byhost

negative-ttl

negative-ttl-byhost

ttl

ttl-byhost

ttl-members

ttl-for-members

name-service-cache-unix-group-settings-get

GET /api/name-services/cache/unix-group/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

name-service-cache-unix-group-settings-get-iter

GET /api/name-services/cache/unix-group/settings

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

max-records

num-records

name-service-cache-unix-group-settings-modify

PATCH /api/name-services/cache/unix-group/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

name-service-cache-unix-user-settings-get

GET /api/name-services/cache/unix-user/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

name-service-cache-unix-user-settings-get-iter

GET /api/name-services/cache/unix-user/settings

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

max-records

num-records

name-service-cache-unix-user-settings-modify

PATCH /api/name-services/cache/unix-user/settings/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

name-service-nis-binding-detail-get

GET /api/name-services/nis/{svm.uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

bound-server

binding_details.server

bound-status

binding_details.status.message

nis-domain

domain

vserver

svm.uuid

name-service-nis-binding-detail-get-iter

GET /api/name-services/nis

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

bound-server

binding_details.server

bound-status

binding_details.status.message

nis-domain

domain

vserver

svm.uuid

max-records

max_records

name-service-nis-show-bound

GET /api/name-services/nis/{svm.uuid}

Note: The REST API does not have a separate NIS show-bound operation. You can retrieve NIS bound-servers by using NIS GET. Use the /api/security/authentication/cluster/nis REST API endpoint to retrieve cluster NIS configurations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

bound-servers

bound_servers

nis-domain

domain

vserver

svm.name

name-service-nis-show-bound-iter

GET /api/name-services/nis

Note: The REST API does not have a separate NIS show-bound operation. You can retrieve NIS bound-servers by using NIS GET.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

bound-servers

bound_servers

nis-domain

domain

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

name-service-unix-group-fileonly-get

This ONTAPI call does not have an equivalent REST API call.

name-service-unix-group-fileonly-modify

This ONTAPI call does not have an equivalent REST API call.

name-service-unix-user-fileonly-get

This ONTAPI call does not have an equivalent REST API call.

name-service-unix-user-fileonly-modify

This ONTAPI call does not have an equivalent REST API call.

nameservice-get-hostname-from-ipv4

GET /api/name-services/host-record/{svm.uuid}/{host}

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

ip-address

host

node

No REST Equivalent

show-source

No REST Equivalent

vserver

svm.uuid

nameservice-get-ip-from-hostname

GET /api/name-services/host-record/{svm.uuid}/{host}

Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

address-family

No REST Equivalent

Both IPv4 and IPv6 IP addresses are sent as a separate list in REST API.

hostname

host

node

No REST Equivalent

show-source

No REST Equivalent

vserver

svm.uuid

nameservice-get-ipv4-from-hostname

This ONTAPI call does not have an equivalent REST API call.

nameservice-nsswitch-create

POST /api/svm/svms

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

nameservice-database

No REST Equivalent

The "database" property is merged with the "nameservice-sources" property.

nameservice-sources

nsswitch.hosts

Similar to hosts database, nsswitch sources for other databases can also be specified:
nsswitch.group → specify group databse sources
nsswitch.passwd → specify passwd database sources
nsswitch.netgroup → specify netgroup database sources
nsswitch.namemap → specify namemap database sources

return-record

?return_records=true

nameservice-nsswitch-destroy

This ONTAPI call does not have an equivalent REST API call.

nameservice-nsswitch-get

GET /api/svm/svms/{uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

nameservice-database

No REST Equivalent

The "database" property is merged with the "nameservice-sources" property.

nameservice-sources

nsswitch.hosts

Similar to hosts database, nsswitch sources for other databases are also retrieved:
nsswitch.group → group databse sources
nsswitch.passwd → passwd database sources
nsswitch.netgroup → netgroup database sources
nsswitch.namemap → namemap database sources

vserver-name

name

nameservice-nsswitch-get-iter

GET /api/svm/svms

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

nameservice-database

No REST Equivalent

The "database" property is merged with the "nameservice-sources" property.

nameservice-sources

nsswitch.hosts

Similar to hosts database, nsswitch sources for other databases are also retrieved:
nsswitch.group → group databse sources
nsswitch.passwd → passwd database sources
nsswitch.netgroup → netgroup database sources
nsswitch.namemap → namemap database sources

vserver-name

name

max-records

max_records

Specifies the maximum number of records to return before paging.

nameservice-nsswitch-modify

PATCH /api/svm/svms/{uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

nameservice-database

No REST Equivalent

The "database" property is merged with the "nameservice-sources" property.

nameservice-sources

nsswitch.hosts

Similar to hosts database, nsswitch sources for other databases can also be specified:
nsswitch.group → specify group databse sources
nsswitch.passwd → specify passwd database sources
nsswitch.netgroup → specify netgroup database sources
nsswitch.namemap → specify namemap database sources