Skip to main content
A newer release of this product is available.

name-mapping

Contributors
Suggest changes

name-mapping-create

POST /api/name-services/name-mappings

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

ONTAPI attribute REST attribute Comment

address

client_match

direction

direction

hostname

client_match

pattern

pattern

position

index

replacement

replacement

return-record

return_records

name-mapping-delete

DELETE /api/name-services/name-mappings/{svm.uuid}/{direction}/{index}

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

ONTAPI attribute REST attribute Comment

direction

direction

position

index

name-mapping-get-iter

GET /api/name-services/name-mappings

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

ONTAPI attribute REST attribute Comment

address

client_match

direction

direction

hostname

client_match

pattern

pattern

position

index

replacement

replacement

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

name-mapping-insert

PATCH /api/name-services/name-mappings/{svm.uuid}/{direction}/{index}

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

ONTAPI attribute REST attribute Comment

address

client_match

direction

direction

hostname

client_match

pattern

pattern

position

index

replacement

replacement

name-mapping-modify

PATCH /api/name-services/name-mappings/{svm.uuid}/{direction}/{index}

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

ONTAPI attribute REST attribute Comment

address

client_match

direction

direction

hostname

client_match

pattern

pattern

position

index

replacement

replacement

name-mapping-refresh-hostname

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

name-mapping-swap

PATCH /api/name-services/name-mappings/{svm.uuid}/{direction}/{index}

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

ONTAPI attribute REST attribute Comment

direction

direction

position

index

with-position

new_index

name-mapping-unix-group-add-user

POST /api/name-services/unix-groups/{svm.uuid}/{unix_group.name}/users

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

ONTAPI attribute REST attribute Comment

group-name

unix_group.name

UNIX group name should be specified as path parameter.

user-name

name

'name' parameter is used to add single user to the specified group.

name-mapping-unix-group-add-users

POST /api/name-services/unix-groups/{svm.uuid}/{unix_group.name}/users

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

ONTAPI attribute REST attribute Comment

group-name

unix_group.name

UNIX group name should be specified as path parameter.

user-list

records

'records' parameter is used to add multiple users in a single REST API call.

name-mapping-unix-group-create

POST /api/name-services/unix-groups

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

ONTAPI attribute REST attribute Comment

group-id

id

group-name

name

return-record

return_records

skip-name-validation

skip_name_validation

name-mapping-unix-group-delete-user

DELETE /api/name-services/unix-groups/{svm.uuid}/{unix_group.name}/users/{name}

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

ONTAPI attribute REST attribute Comment

group-name

unix_group.name

UNIX group name should be specified as path parameter.

user-name

name

UNIX user to be deleted should be specified as path parameter.

name-mapping-unix-group-destroy

DELETE /api/name-services/unix-groups/{svm.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

group-name

name

name-mapping-unix-group-get

GET /api/name-services/unix-groups

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

ONTAPI attribute REST attribute Comment

group-id

id

group-name

name

skip-name-validation

No REST Equivalent

skip-name-validation is a create field and will not be displayed in GET.

users

users

vserver

svm.name

group-name

name

name-mapping-unix-group-get-iter

GET /api/name-services/unix-groups/{svm.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

group-id

id

group-name

name

skip-name-validation

No REST Equivalent

skip-name-validation is a create field and will not be displayed in GET.

users

users

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

name-mapping-unix-group-modify

PATCH /api/name-services/unix-groups/{svm.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

group-id

id

group-name

name

name-mapping-unix-user-create

POST /api/name-services/unix-users

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

ONTAPI attribute REST attribute Comment

full-name

full_name

group-id

primary_gid

return-record

?return_records=true

skip-name-validation

skip_name_validation

user-id

id

user-name

name

name-mapping-unix-user-destroy

DELETE /api/name-services/unix-users/{svm.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

user-name

name

name-mapping-unix-user-get

GET /api/name-services/unix-users/{svm.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

full-name

full_name

group-id

primary_gid

skip-name-validation

No REST Equivalent

This field is only available for UNIX users POST end-point.

user-id

id

user-name

name

vserver

svm.name

user-name

name

name-mapping-unix-user-get-iter

GET /api/name-services/unix-users

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

ONTAPI attribute REST attribute Comment

full-name

full_name

group-id

primary_gid

skip-name-validation

No REST Equivalent

This field is only available for UNIX users POST end-point.

user-id

id

user-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

name-mapping-unix-user-modify

PATCH /api/name-services/unix-users/{svm.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

full-name

full_name

group-id

primary_gid

user-id

id

user-name

name

name-service-unix-group-limits-get

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

name-service-unix-user-limits-get

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