vserver

vserver-add-aggregates

PATCH /api/svm/svms/{uuid}

Note: Set the object "aggregates" with the new list of aggregates.

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

ONTAPI attribute	REST attribute	Comment
aggr-list	See comment column for details	Supply the following REST API properties: aggregates.name aggregates.uuid To add one or more aggregates to the SVM aggregate list, provide the absolute list of aggregates along with the new aggregates in the REST API PATCH request.
vserver-name	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

To add one or more aggregates to the SVM aggregate list, provide the absolute list of aggregates along with the new aggregates in the REST API PATCH request.

vserver-name

No REST Equivalent

vserver-add-protocols

PATCH /api/svm/svms/{uuid}

Note: Add protocols to allowed-list for the SVM.

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

ONTAPI attribute	REST attribute	Comment
protocols	See comment column for details	cifs.allowed fcp.allowed iscsi.allowed nfs.allowed nvme.allowed ndmp.allowed Consider the protocol service allowed when the protocol's allowed flag is set to "true". SVM data access protocols are configurable using the protocol endpoint. For example, to start or stop NFS protocol service, use the endpoint /api/protocols/nfs/services/\{svm.uuid\}.
vserver-name	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

protocols

See comment column for details

cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed

Consider the protocol service allowed when the protocol's allowed flag is set to "true".

SVM data access protocols are configurable using the protocol endpoint. For example, to start or stop NFS protocol service, use the endpoint /api/protocols/nfs/services/\{svm.uuid\}.

vserver-name

No REST Equivalent

vserver-config-diff-get

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

vserver-config-diff-get-iter

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

vserver-create

POST /api/svm/svms

Note: Create and configure the SVM with the data access protocols, data and management interfaces, and service configurations.

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

ONTAPI attribute	REST attribute	Comment
antivirus-on-access-policy	No REST Equivalent
caching-policy	No REST Equivalent
comment	comment
ipspace	ipspace.name
is-repository-vserver	No REST Equivalent
is-space-enforcement-logical	No REST Equivalent
is-space-reporting-logical	No REST Equivalent
language	language
name-mapping-switch	nsswitch.namemap
name-server-switch	See comment column for details	Supply the following REST API properties: nsswitch.group nsswitch.netgroup nsswitch.passwd
quota-policy	No REST Equivalent	Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.
return-record	No REST Equivalent
root-volume	No REST Equivalent	Use REST endpoint "/api/storage/volumes" to manage SVM root volume information.
root-volume-aggregate	No REST Equivalent
root-volume-security-style	No REST Equivalent	Use REST endpoint "/api/storage/volumes" to manage SVM root volume security style information.
snapshot-policy	See comment column for details	Supply the following REST API properties: snapshot_policy.name snapshot_policy.uuid
vserver-name	name
vserver-subtype	subtype

ONTAPI attribute

REST attribute

Comment

antivirus-on-access-policy

No REST Equivalent

caching-policy

No REST Equivalent

comment

ipspace

ipspace.name

is-repository-vserver

No REST Equivalent

is-space-enforcement-logical

No REST Equivalent

is-space-reporting-logical

No REST Equivalent

language

name-mapping-switch

nsswitch.namemap

name-server-switch

See comment column for details

Supply the following REST API properties:
nsswitch.group
nsswitch.netgroup
nsswitch.passwd

quota-policy

No REST Equivalent

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

return-record

No REST Equivalent

root-volume

No REST Equivalent

Use REST endpoint "/api/storage/volumes" to manage SVM root volume information.

root-volume-aggregate

No REST Equivalent

root-volume-security-style

No REST Equivalent

Use REST endpoint "/api/storage/volumes" to manage SVM root volume security style information.

snapshot-policy

See comment column for details

Supply the following REST API properties:
snapshot_policy.name
snapshot_policy.uuid

vserver-name

name

vserver-subtype

subtype

vserver-create-async

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

vserver-data-policy-export

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

vserver-data-policy-import

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

vserver-data-policy-validation-get-error

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

vserver-destroy

DELETE /api/svm/svms/{uuid}

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

ONTAPI attribute	REST attribute	Comment
vserver-name	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

vserver-name

No REST Equivalent

vserver-destroy-async

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

vserver-get

GET /api/svm/svms/{uuid}

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

ONTAPI attribute	REST attribute	Comment
aggr-list	See comment column for details	Supply the following REST API properties: aggregates.name aggregates.uuid
allowed-protocols	See comment column for details	Supply the following REST API properties: cifs.allowed fcp.allowed iscsi.allowed nfs.allowed nvme.allowed ndmp.allowed cifs.enabled fcp.enabled iscsi.enabled nfs.enabled nvme.enabled s3.enabled Consider the protocol service allowed when the protocol's allowed flag is set to "true". Consider the protocol service enabled when the protocol's enabled flag is set to "true".
antivirus-on-access-policy	No REST Equivalent
caching-policy	No REST Equivalent
comment	comment
disallowed-protocols	See comment column for details	Supply the following REST API properties: cifs.allowed fcp.allowed iscsi.allowed nfs.allowed nvme.allowed ndmp.allowed cifs.enabled fcp.enabled iscsi.enabled nfs.enabled nvme.enabled s3.enabled Consider the protocol service not allowed when the protocol's allowed flag is set to "false". Consider the protocol service disabled when the protocol's enabled flag is set to "false".
ipspace	ipspace.name
is-config-locked-for-changes	No REST Equivalent
is-repository-vserver	No REST Equivalent
is-space-enforcement-logical	No REST Equivalent
is-space-reporting-logical	No REST Equivalent
is-vserver-protected	See comment column for details	Supply the following REST API properties: snapmirror.is_protected snapmirror.protected_volumes_count
language	language
ldap-domain	ldap.ad_domain
max-volumes	max_volumes
name-mapping-switch	nsswitch.namemap
name-server-switch	See comment column for details	Supply the following REST API properties: nsswitch.group nsswitch.netgroup nsswitch.passwd
nis-domain	See comment column for details	Supply the following REST API properties: nis.domain nis.enabled nis.servers
operational-state	state	SVM "state" property is a combination of SVM's administrative state and operational-state.
operational-state-stopped-reason	No REST Equivalent
qos-policy-group	See comment column for details	Supply the following REST API properties: qos_policy.uuid qos_policy.name qos_policy.min_throughput_iops qos_policy.min_throughput_mbps qos_policy.max_throughput_iops qos_policy.max_throughput_mbps
quota-policy	No REST Equivalent	Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.
root-volume	No REST Equivalent	Use REST endpoint "/api/storage/volumes" to view SVM root volume information.
root-volume-aggregate	No REST Equivalent
root-volume-security-style	No REST Equivalent	Use REST endpoint "/api/storage/volumes" to view SVM root volume security style information.
snapshot-policy	See comment column for details	Supply the following REST API properties: snapshot_policy.name snapshot_policy.uuid
state	state	SVM "state" property is a combination of SVM's administrative state and operational-state.
uuid	uuid
volume-delete-retention-hours	No REST Equivalent
vserver-aggr-info-list	See comment column for details	Supply the following REST API properties: aggregates.name aggregates.uuid
vserver-name	name
vserver-subtype	subtype
vserver-type	No REST Equivalent	SVM REST APIs allow management of data SVMs only.

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

allowed-protocols

See comment column for details

Supply the following REST API properties:
cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed
cifs.enabled
fcp.enabled
iscsi.enabled
nfs.enabled
nvme.enabled
s3.enabled

Consider the protocol service allowed when the protocol's allowed flag is set to "true".

Consider the protocol service enabled when the protocol's enabled flag is set to "true".

antivirus-on-access-policy

No REST Equivalent

caching-policy

No REST Equivalent

comment

disallowed-protocols

See comment column for details

Supply the following REST API properties:
cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed
cifs.enabled
fcp.enabled
iscsi.enabled
nfs.enabled
nvme.enabled
s3.enabled

Consider the protocol service not allowed when the protocol's allowed flag is set to "false".

Consider the protocol service disabled when the protocol's enabled flag is set to "false".

ipspace

ipspace.name

is-config-locked-for-changes

No REST Equivalent

is-repository-vserver

No REST Equivalent

is-space-enforcement-logical

No REST Equivalent

is-space-reporting-logical

No REST Equivalent

is-vserver-protected

See comment column for details

Supply the following REST API properties:
snapmirror.is_protected
snapmirror.protected_volumes_count

language

ldap-domain

ldap.ad_domain

max-volumes

max_volumes

name-mapping-switch

nsswitch.namemap

name-server-switch

See comment column for details

Supply the following REST API properties:
nsswitch.group
nsswitch.netgroup
nsswitch.passwd

nis-domain

See comment column for details

Supply the following REST API properties:
nis.domain
nis.enabled
nis.servers

operational-state

state

SVM "state" property is a combination of SVM's administrative state and operational-state.

operational-state-stopped-reason

No REST Equivalent

qos-policy-group

See comment column for details

Supply the following REST API properties:
qos_policy.uuid
qos_policy.name
qos_policy.min_throughput_iops
qos_policy.min_throughput_mbps
qos_policy.max_throughput_iops
qos_policy.max_throughput_mbps

quota-policy

No REST Equivalent

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

root-volume

No REST Equivalent

Use REST endpoint "/api/storage/volumes" to view SVM root volume information.

root-volume-aggregate

No REST Equivalent

root-volume-security-style

No REST Equivalent

Use REST endpoint "/api/storage/volumes" to view SVM root volume security style information.

snapshot-policy

See comment column for details

Supply the following REST API properties:
snapshot_policy.name
snapshot_policy.uuid

state

SVM "state" property is a combination of SVM's administrative state and operational-state.

uuid

volume-delete-retention-hours

No REST Equivalent

vserver-aggr-info-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

vserver-name

name

vserver-subtype

subtype

vserver-type

No REST Equivalent

SVM REST APIs allow management of data SVMs only.

vserver-get-iter

GET /api/svm/svms

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

ONTAPI attribute	REST attribute	Comment
aggr-list	See comment column for details	Supply the following REST API properties: aggregates.name aggregates.uuid
allowed-protocols	See comment column for details	Supply the following REST API properties: cifs.allowed fcp.allowed iscsi.allowed nfs.allowed nvme.allowed ndmp.allowed cifs.enabled fcp.enabled iscsi.enabled nfs.enabled nvme.enabled s3.enabled Consider the protocol service allowed when the protocol's allowed flag is set to "true". Consider the protocol service enabled when the protocol's enabled flag is set to "true".
antivirus-on-access-policy	No REST Equivalent
caching-policy	No REST Equivalent
comment	comment
disallowed-protocols	See comment column for details	Supply the following REST API properties: cifs.allowed fcp.allowed iscsi.allowed nfs.allowed nvme.allowed ndmp.allowed cifs.enabled fcp.enabled iscsi.enabled nfs.enabled nvme.enabled s3.enabled Consider the protocol service not allowed when the protocol's allowed flag is set to "false". Consider the protocol service disabled when the protocol's enabled flag is set to "false".
ipspace	ipspace
is-config-locked-for-changes	No REST Equivalent
is-repository-vserver	No REST Equivalent
is-space-enforcement-logical	No REST Equivalent
is-space-reporting-logical	No REST Equivalent
is-vserver-protected	See comment column for details	Supply the following REST API properties: snapmirror.is_protected snapmirror.protected_volumes_count
language	language
ldap-domain	ldap.ad_domain
max-volumes	max_volumes
name-mapping-switch	nsswitch.namemap
name-server-switch	See comment column for details	Supply the following REST API properties: nsswitch.group nsswitch.netgroup nsswitch.passwd
nis-domain	See comment column for details	Supply the following REST API properties: nis.domain nis.enabled nis.servers
operational-state	state	SVM "state" property is a combination of SVM's administrative state and operational-state.
operational-state-stopped-reason	No REST Equivalent
qos-policy-group	See comment column for details	Supply the following REST API properties: qos_policy.uuid qos_policy.name qos_policy.min_throughput_iops qos_policy.min_throughput_mbps qos_policy.max_throughput_iops qos_policy.max_throughput_mbps
quota-policy	No REST Equivalent	Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.
root-volume	No REST Equivalent	Use REST endpoint "/api/storage/volumes" to view SVM root volume information.
root-volume-aggregate	No REST Equivalent
root-volume-security-style	No REST Equivalent	Use REST endpoint "/api/storage/volumes" to view SVM root volume security style information.
snapshot-policy	See comment column for details	Supply the following REST API properties: snapshot_policy.name snapshot_policy.uuid
state	state	SVM "state" property is a combination of SVM's administrative state and operational-state.
uuid	uuid
volume-delete-retention-hours	No REST Equivalent
vserver-aggr-info-list	See comment column for details	Supply the following REST API properties: aggregates.name aggregates.uuid
vserver-name	name
vserver-subtype	subtype
vserver-type	No REST Equivalent
max-records	max_records	Specifies the maximum number of records to return before paging.

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

allowed-protocols

See comment column for details

Supply the following REST API properties:
cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed
cifs.enabled
fcp.enabled
iscsi.enabled
nfs.enabled
nvme.enabled
s3.enabled

Consider the protocol service allowed when the protocol's allowed flag is set to "true".

Consider the protocol service enabled when the protocol's enabled flag is set to "true".

antivirus-on-access-policy

No REST Equivalent

caching-policy

No REST Equivalent

comment

disallowed-protocols

See comment column for details

Supply the following REST API properties:
cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed
cifs.enabled
fcp.enabled
iscsi.enabled
nfs.enabled
nvme.enabled
s3.enabled

Consider the protocol service not allowed when the protocol's allowed flag is set to "false".

Consider the protocol service disabled when the protocol's enabled flag is set to "false".

ipspace

is-config-locked-for-changes

No REST Equivalent

is-repository-vserver

No REST Equivalent

is-space-enforcement-logical

No REST Equivalent

is-space-reporting-logical

No REST Equivalent

is-vserver-protected

See comment column for details

Supply the following REST API properties:
snapmirror.is_protected
snapmirror.protected_volumes_count

language

ldap-domain

ldap.ad_domain

max-volumes

max_volumes

name-mapping-switch

nsswitch.namemap

name-server-switch

See comment column for details

Supply the following REST API properties:
nsswitch.group
nsswitch.netgroup
nsswitch.passwd

nis-domain

See comment column for details

Supply the following REST API properties:
nis.domain
nis.enabled
nis.servers

operational-state

state

SVM "state" property is a combination of SVM's administrative state and operational-state.

operational-state-stopped-reason

No REST Equivalent

qos-policy-group

See comment column for details

Supply the following REST API properties:
qos_policy.uuid
qos_policy.name
qos_policy.min_throughput_iops
qos_policy.min_throughput_mbps
qos_policy.max_throughput_iops
qos_policy.max_throughput_mbps

quota-policy

No REST Equivalent

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

root-volume

No REST Equivalent

Use REST endpoint "/api/storage/volumes" to view SVM root volume information.

root-volume-aggregate

No REST Equivalent

root-volume-security-style

No REST Equivalent

Use REST endpoint "/api/storage/volumes" to view SVM root volume security style information.

snapshot-policy

See comment column for details

Supply the following REST API properties:
snapshot_policy.name
snapshot_policy.uuid

state

SVM "state" property is a combination of SVM's administrative state and operational-state.

uuid

volume-delete-retention-hours

No REST Equivalent

vserver-aggr-info-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

vserver-name

name

vserver-subtype

subtype

vserver-type

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-http-proxy-create

POST /api/network/http-proxy

Note: You can create the HTTP proxy configuration either for a particular SVM or for a particular IPspace.

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

ONTAPI attribute	REST attribute	Comment
ipspace	See comment column for details	Supply the following REST API properties: ipspace.name ipspace.uuid
password	No REST Equivalent
port	port
server	server
skip-config-validation	No REST Equivalent
username	No REST Equivalent
vserver	See comment column for details	Supply the following REST API properties: svm.name svm.uuid

ONTAPI attribute

REST attribute

Comment

ipspace

See comment column for details

Supply the following REST API properties:
ipspace.name
ipspace.uuid

password

No REST Equivalent

port

server

skip-config-validation

No REST Equivalent

username

No REST Equivalent

vserver

See comment column for details

Supply the following REST API properties:
svm.name
svm.uuid

vserver-http-proxy-delete

DELETE /api/network/http-proxy/{uuid}

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

ONTAPI attribute	REST attribute	Comment
ipspace	No REST Equivalent
vserver	uuid

ONTAPI attribute

REST attribute

Comment

ipspace

No REST Equivalent

vserver

uuid

vserver-http-proxy-get

GET /api/network/http-proxy/{uuid}

Note: In addition to the ONTAPI attributes captured here, the REST API attribute "scope" identifies whether a proxy is owned by an SVM or cluster.

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

ONTAPI attribute	REST attribute	Comment
ipspace	See comment column for details	Supply the following REST API properties: ipspace.name ipspace.uuid
password	No REST Equivalent
port	port
server	server
username	No REST Equivalent
vserver	See comment column for details	Supply the following REST API properties: svm.name svm.uuid uuid
ipspace	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

ipspace

See comment column for details

Supply the following REST API properties:
ipspace.name
ipspace.uuid

password

No REST Equivalent

port

server

username

No REST Equivalent

vserver

See comment column for details

Supply the following REST API properties:
svm.name
svm.uuid
uuid

ipspace

No REST Equivalent

vserver-http-proxy-get-iter

GET /api/network/http-proxy

Note: In addition to the ONTAPI attributes captured here, the REST API attribute "scope" identifies whether a proxy is owned by an SVM or cluster.

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

ONTAPI attribute	REST attribute	Comment
ipspace	See comment column for details	Supply the following REST API properties: ipspace.name ipspace.uuid
password	No REST Equivalent
port	port
server	server
username	No REST Equivalent
vserver	See comment column for details	Supply the following REST API properties: svm.name svm.uuid
max-records	max_records	Specifies the maximum number of records to return before paging.

ONTAPI attribute

REST attribute

Comment

ipspace

See comment column for details

Supply the following REST API properties:
ipspace.name
ipspace.uuid

password

No REST Equivalent

port

server

username

No REST Equivalent

vserver

See comment column for details

Supply the following REST API properties:
svm.name
svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-http-proxy-modify

PATCH /api/network/http-proxy/{uuid}

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

ONTAPI attribute	REST attribute	Comment
ipspace	No REST Equivalent
password	No REST Equivalent
port	port
server	server
skip-config-validation	No REST Equivalent
username	No REST Equivalent
vserver	uuid

ONTAPI attribute

REST attribute

Comment

ipspace

No REST Equivalent

password

No REST Equivalent

port

server

skip-config-validation

No REST Equivalent

username

No REST Equivalent

vserver

uuid

vserver-lock

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

GET /api/security/login/messages/{uuid}

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

ONTAPI attribute	REST attribute	Comment
message	banner
vserver	svm.name

ONTAPI attribute

REST attribute

Comment

message

banner

vserver

svm.name

GET /api/security/login/messages

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

ONTAPI attribute	REST attribute	Comment
message	banner
vserver	svm.name
max-records	max_records	Specifies the maximum number of records to return before paging.

ONTAPI attribute

REST attribute

Comment

message

banner

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

PATCH /api/security/login/messages/{uuid}

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

ONTAPI attribute	REST attribute	Comment
message	banner

ONTAPI attribute

REST attribute

Comment

message

banner

PATCH /api/security/login/messages

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

ONTAPI attribute	REST attribute	Comment
continue-on-failure	continue_on_failure
max-failure-count	No REST Equivalent
max-records	max_records	Specifies the maximum number of records to return before paging.
message	banner
vserver	svm.name
return-failure-list	No REST Equivalent
return-success-list	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

continue-on-failure

continue_on_failure

max-failure-count

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

message

banner

vserver

svm.name

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

vserver-modify

PATCH /api/svm/svms/{uuid}

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

ONTAPI attribute	REST attribute	Comment
aggr-list	See comment column for details	Supply the following REST API properties: aggregates.name aggregates.uuid
allowed-protocols	No REST Equivalent
antivirus-on-access-policy	No REST Equivalent
caching-policy	No REST Equivalent
comment	comment
disallowed-protocols	No REST Equivalent
is-space-enforcement-logical	No REST Equivalent
is-space-reporting-logical	No REST Equivalent
language	language
max-volumes	max_volumes
name-mapping-switch	nsswitch.namemap
name-server-switch	See comment column for details	Supply the following REST API properties: nsswitch.group nsswitch.netgroup nsswitch.passwd
qos-policy-group	See comment column for details	Supply the following REST API properties: qos_policy.uuid qos_policy.name
quota-policy	No REST Equivalent	Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.
snapshot-policy	No REST Equivalent
state	state
volume-delete-retention-hours	No REST Equivalent
vserver-name	name

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

allowed-protocols

No REST Equivalent

antivirus-on-access-policy

No REST Equivalent

caching-policy

No REST Equivalent

comment

disallowed-protocols

No REST Equivalent

is-space-enforcement-logical

No REST Equivalent

is-space-reporting-logical

No REST Equivalent

language

max-volumes

max_volumes

name-mapping-switch

nsswitch.namemap

name-server-switch

See comment column for details

Supply the following REST API properties:
nsswitch.group
nsswitch.netgroup
nsswitch.passwd

qos-policy-group

See comment column for details

Supply the following REST API properties:
qos_policy.uuid
qos_policy.name

quota-policy

No REST Equivalent

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

snapshot-policy

No REST Equivalent

state

volume-delete-retention-hours

No REST Equivalent

vserver-name

name

vserver-modify-iter

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

vserver-motd-get

GET /api/security/login/messages/{uuid}

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

ONTAPI attribute	REST attribute	Comment
is-cluster-message-enabled	show_cluster_message	This field is only modifiable by the cluster administrator
message	message
vserver	svm.name

ONTAPI attribute

REST attribute

Comment

is-cluster-message-enabled

show_cluster_message

This field is only modifiable by the cluster administrator

message

vserver

svm.name

vserver-motd-get-iter

GET /api/security/login/messages

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

ONTAPI attribute	REST attribute	Comment
is-cluster-message-enabled	show_cluster_message	This field is only modifiable by the cluster administrator
message	message
vserver	svm.name
max-records	max_records	Specifies the maximum number of records to return before paging.

ONTAPI attribute

REST attribute

Comment

is-cluster-message-enabled

show_cluster_message

This field is only modifiable by the cluster administrator

message

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-motd-modify

PATCH /api/security/login/messages/{uuid}

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

ONTAPI attribute	REST attribute	Comment
is-cluster-message-enabled	show_cluster_message	This field is only modifiable by the cluster administrator
message	message

ONTAPI attribute

REST attribute

Comment

is-cluster-message-enabled

show_cluster_message

This field is only modifiable by the cluster administrator

message

vserver-motd-modify-iter

PATCH /api/security/login/messages

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

ONTAPI attribute	REST attribute	Comment
continue-on-failure	continue_on_failure
is-cluster-message-enabled	show_cluster_message	This field is only modifiable by the cluster administrator
max-failure-count	No REST Equivalent
max-records	max_records	Specifies the maximum number of records to return before paging.
message	message
vserver	svm.name
return-failure-list	No REST Equivalent
return-success-list	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

continue-on-failure

continue_on_failure

is-cluster-message-enabled

show_cluster_message

This field is only modifiable by the cluster administrator

max-failure-count

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

message

vserver

svm.name

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

vserver-protect-precheck

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

vserver-protect-precheck-dp-support

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

vserver-protect-precheck-network

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

vserver-protect-precheck-vge-support

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

vserver-remove-aggregates

PATCH /api/svm/svms/{uuid}

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

ONTAPI attribute	REST attribute	Comment
aggr-list	See comment column for details	Supply the following REST API properties: aggregates.name aggregates.uuid To remove one or more aggregates from the SVM aggregate list, provide the absolute list of aggregates, without specifying the aggregates to be removed, in the REST API PATCH request.
vserver-name	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

To remove one or more aggregates from the SVM aggregate list, provide the absolute list of aggregates, without specifying the aggregates to be removed, in the REST API PATCH request.

vserver-name

No REST Equivalent

vserver-remove-protocols

PATCH /api/svm/svms/{uuid}

Note: Add protocols to disallowed-list for the SVM.

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

ONTAPI attribute	REST attribute	Comment
protocols	See comment column for details	cifs.allowed fcp.allowed iscsi.allowed nfs.allowed nvme.allowed ndmp.allowed Consider the protocol service not allowed when the protocol's allowed flag is set to "false". SVM data access protocols are configurable using the protocol endpoint. For example, to start or stop NFS protocol service, use the endpoint /api/protocols/nfs/services/\{svm.uuid\}.
vserver-name	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

protocols

See comment column for details

cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed

Consider the protocol service not allowed when the protocol's allowed flag is set to "false".

SVM data access protocols are configurable using the protocol endpoint. For example, to start or stop NFS protocol service, use the endpoint /api/protocols/nfs/services/\{svm.uuid\}.

vserver-name

No REST Equivalent

vserver-rename

PATCH /api/svm/svms/{uuid}

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

ONTAPI attribute	REST attribute	Comment
new-name	name
vserver-name	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

new-name

name

vserver-name

No REST Equivalent

vserver-rename-async

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

vserver-san-purge

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

vserver-san-purge-verify

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

vserver-saninit

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

vserver-show-aggr-get-iter

GET /api/svm/svms/{uuid}

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

ONTAPI attribute	REST attribute	Comment
aggregate-name	See comment column for details	Supply the following REST API properties: aggregates.name aggregates.uuid
aggregate-type	No REST Equivalent
available-size	No REST Equivalent
is-nve-capable	No REST Equivalent
snaplock-type	No REST Equivalent
vserver-name	No REST Equivalent
max-records	max_records	Specifies the maximum number of records to return before paging.
vserver	name

ONTAPI attribute

REST attribute

Comment

aggregate-name

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

aggregate-type

No REST Equivalent

available-size

No REST Equivalent

is-nve-capable

No REST Equivalent

snaplock-type

No REST Equivalent

vserver-name

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver

name

vserver-start

PATCH /api/svm/svms/{uuid}

Note: Set the "state" to "running" to start the SVM.

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

ONTAPI attribute	REST attribute	Comment
force	No REST Equivalent
vserver-name	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

force

No REST Equivalent

vserver-name

No REST Equivalent

vserver-stop

PATCH /api/svm/svms/{uuid}

Note: Set the "state" to "stopped" to stop the SVM.

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

ONTAPI attribute	REST attribute	Comment
vserver-name	No REST Equivalent

ONTAPI attribute

REST attribute

Comment

vserver-name

No REST Equivalent

vserver-unlock

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

volume-clone-create-async

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

vserver

Creating your file...

vserver-add-aggregates

vserver-add-protocols

vserver-config-diff-get

vserver-config-diff-get-iter

vserver-create

vserver-create-async

vserver-data-policy-export

vserver-data-policy-import

vserver-data-policy-validation-get-error

vserver-destroy

vserver-destroy-async

vserver-get

vserver-get-iter

vserver-http-proxy-create

vserver-http-proxy-delete

vserver-http-proxy-get

vserver-http-proxy-get-iter

vserver-http-proxy-modify

vserver-lock

vserver-login-banner-get

vserver-login-banner-get-iter

vserver-login-banner-modify

vserver-login-banner-modify-iter

vserver-modify

vserver-modify-iter

vserver-motd-get

vserver-motd-get-iter

vserver-motd-modify

vserver-motd-modify-iter

vserver-protect-precheck

vserver-protect-precheck-dp-support

vserver-protect-precheck-network

vserver-protect-precheck-vge-support

vserver-remove-aggregates

vserver-remove-protocols

vserver-rename

vserver-rename-async

vserver-san-purge

vserver-san-purge-verify

vserver-saninit

vserver-show-aggr-get-iter

vserver-start

vserver-stop

vserver-unlock

volume-clone-create-async