Retrieve SVMs and SVM properties
GET /svm/svms
Introduced In: 9.6
Retrieves a list of SVMs and individual SVM properties. This includes protocol configurations such as CIFS and NFS, export policies, name service configurations, and network services.
Important notes
-
The SVM object includes a large set of fields and can be expensive to retrieve. Use this API to list the collection of SVMs, and to retrieve only the full details of individual SVMs as needed.
-
It is not recommended to create or delete more than five SVMs in parallel.
-
REST APIs only expose a data SVM as an SVM.
Expensive properties
There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields
query parameter. See Requesting specific fields to learn more.
-
snapmirror.*
Related ONTAP commands
-
vserver show
Examples
-
Retrieves a list of SVMs in the cluster sorted by name
GET "/api/svm/svms?order_by=name"
-
Retrieves a list of SVMs in the cluster that have the NFS protocol enabled
GET "/api/svm/svms?nfs.enabled=true"
-
Retrieves a list of SVMs in the cluster that have the CIFS protocol enabled
GET "/api/svm/svms?cifs.enabled=true"
-
Retrieves a list of SVMs in the cluster that have the S3 protocol enabled
GET "/api/svm/svms?s3.enabled=true"
5 Retrieves a list of SVMs in the cluster that have the FCP protocol allowed
GET "/api/svm/svms?fcp.allowed=true"
-
Retrieves a list of SVMs in the cluster that have the CIFS protocol allowed
GET "/api/svm/svms?cifs.allowed=true"
-
Retrieves a list of SVMs in the cluster where the NDMP protocol is specified as allowed
GET "/api/svm/svms?ndmp.allowed=true"
-
Retrieves a list of SVMs in the cluster that have the s3 protocol allowed
GET "/api/svm/svms?s3.allowed=true"
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
nis.enabled |
boolean |
query |
False |
Filter by nis.enabled |
nis.servers |
string |
query |
False |
Filter by nis.servers |
nis.domain |
string |
query |
False |
Filter by nis.domain |
nvme.allowed |
boolean |
query |
False |
Filter by nvme.allowed
|
nvme.enabled |
boolean |
query |
False |
Filter by nvme.enabled |
language |
string |
query |
False |
Filter by language |
nfs.allowed |
boolean |
query |
False |
Filter by nfs.allowed
|
nfs.enabled |
boolean |
query |
False |
Filter by nfs.enabled |
comment |
string |
query |
False |
Filter by comment |
aggregates.name |
string |
query |
False |
Filter by aggregates.name |
aggregates.uuid |
string |
query |
False |
Filter by aggregates.uuid |
subtype |
string |
query |
False |
Filter by subtype |
dns.servers |
string |
query |
False |
Filter by dns.servers |
dns.domains |
string |
query |
False |
Filter by dns.domains |
fcp.allowed |
boolean |
query |
False |
Filter by fcp.allowed
|
fcp.enabled |
boolean |
query |
False |
Filter by fcp.enabled |
iscsi.allowed |
boolean |
query |
False |
Filter by iscsi.allowed
|
iscsi.enabled |
boolean |
query |
False |
Filter by iscsi.enabled |
name |
string |
query |
False |
Filter by name |
ipspace.uuid |
string |
query |
False |
Filter by ipspace.uuid |
ipspace.name |
string |
query |
False |
Filter by ipspace.name |
ldap.base_dn |
string |
query |
False |
Filter by ldap.base_dn |
ldap.servers |
string |
query |
False |
Filter by ldap.servers |
ldap.enabled |
boolean |
query |
False |
Filter by ldap.enabled |
ldap.bind_dn |
string |
query |
False |
Filter by ldap.bind_dn |
ldap.ad_domain |
string |
query |
False |
Filter by ldap.ad_domain |
uuid |
string |
query |
False |
Filter by uuid |
cifs.name |
string |
query |
False |
Filter by cifs.name |
cifs.ad_domain.fqdn |
string |
query |
False |
Filter by cifs.ad_domain.fqdn |
cifs.ad_domain.organizational_unit |
string |
query |
False |
Filter by cifs.ad_domain.organizational_unit |
cifs.allowed |
boolean |
query |
False |
Filter by cifs.allowed
|
cifs.enabled |
boolean |
query |
False |
Filter by cifs.enabled |
s3.name |
string |
query |
False |
Filter by s3.name
|
s3.allowed |
boolean |
query |
False |
Filter by s3.allowed
|
s3.enabled |
boolean |
query |
False |
Filter by s3.enabled
|
ndmp.allowed |
boolean |
query |
False |
Filter by ndmp.allowed
|
nsswitch.netgroup |
string |
query |
False |
Filter by nsswitch.netgroup |
nsswitch.group |
string |
query |
False |
Filter by nsswitch.group |
nsswitch.hosts |
string |
query |
False |
Filter by nsswitch.hosts |
nsswitch.namemap |
string |
query |
False |
Filter by nsswitch.namemap |
nsswitch.passwd |
string |
query |
False |
Filter by nsswitch.passwd |
qos_policy.name |
string |
query |
False |
Filter qos_policy.name
|
qos_policy.uuid |
string |
query |
False |
Filter qos_policy.uuid
|
max_volumes |
string |
query |
False |
Filter max_volumes
|
fc_interfaces.name |
string |
query |
False |
Filter by fc_interfaces.name
|
fc_interfaces.data_protocol |
string |
query |
False |
Filter by fc_interfaces.data_protocol
|
snapshot_policy.uuid |
string |
query |
False |
Filter by snapshot_policy.uuid |
snapshot_policy.name |
string |
query |
False |
Filter by snapshot_policy.name |
state |
string |
query |
False |
Filter by state |
certificate.uuid |
string |
query |
False |
Filter by certificate.uuid
|
anti_ransomware_default_volume_state |
string |
query |
False |
Filter by anti_ransomware_default_volume_state
|
qos_adaptive_policy_group_template.name |
string |
query |
False |
Filter by qos_adaptive_policy_group_template.name
|
qos_adaptive_policy_group_template.uuid |
string |
query |
False |
Filter by qos_adaptive_policy_group_template.uuid
|
anti_ransomware_auto_switch_from_learning_to_enabled |
boolean |
query |
False |
Filter by anti_ransomware_auto_switch_from_learning_to_enabled
|
anti_ransomware_auto_switch_minimum_incoming_data |
string |
query |
False |
Filter by anti_ransomware_auto_switch_minimum_incoming_data
|
anti_ransomware_auto_switch_minimum_incoming_data_percent |
integer |
query |
False |
Filter by anti_ransomware_auto_switch_minimum_incoming_data_percent
|
anti_ransomware_auto_switch_duration_without_new_file_extension |
integer |
query |
False |
Filter by anti_ransomware_auto_switch_duration_without_new_file_extension
|
anti_ransomware_auto_switch_minimum_learning_period |
integer |
query |
False |
Filter by anti_ransomware_auto_switch_minimum_learning_period
|
anti_ransomware_auto_switch_minimum_file_count |
integer |
query |
False |
Filter by anti_ransomware_auto_switch_minimum_file_count
|
anti_ransomware_auto_switch_minimum_file_extension |
integer |
query |
False |
Filter by anti_ransomware_auto_switch_minimum_file_extension
|
auto_enable_analytics |
boolean |
query |
False |
Filter by auto_enable_analytics.
|
auto_enable_activity_tracking |
boolean |
query |
False |
Filter by auto_enable_activity_tracking.
|
storage.allocated |
integer |
query |
False |
Filter by storage_allocated
|
storage.available |
integer |
query |
False |
Filter by storage_available
|
storage.used_percentage |
integer |
query |
False |
Filter by storage_used_percentage
|
number_of_volumes_in_recovery_queue |
integer |
query |
False |
Filter by number_of_volumes_in_recovery_queue
|
total_volume_size_in_recovery_queue |
integer |
query |
False |
Filter by total_volume_size_in_recovery_queue
|
storage.limit_threshold_exceeded |
integer |
query |
False |
Filter by storage.limit_threshold_exceeded
|
storage.limit |
integer |
query |
False |
Filter by storage.limit
|
storage.limit_threshold_alert |
integer |
query |
False |
Filter by storage.limit_threshold_alert
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[svm] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"aggregates": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"available_size": 10156560384,
"name": "aggr1",
"snaplock_type": "string",
"state": "string",
"type": "string",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"anti_ransomware_default_volume_state": "string",
"anti_ransomware_incoming_write_threshold": "string",
"anti_ransomware_incoming_write_threshold_percent": "string",
"certificate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "string",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"cifs": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ad_domain": {
"default_site": "string",
"fqdn": "example.com",
"organizational_unit": "string",
"password": "string",
"user": "string"
},
"auth-style": "domain",
"domain_workgroup": "string",
"name": "CIFS1",
"workgroup": "workgrp1"
},
"comment": "string",
"dns": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"domains": [
"example.com",
"example2.example3.com"
],
"servers": [
"10.224.65.20",
"2001:db08:a0b:12f0::1"
]
},
"fc_interfaces": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"data_protocol": "string",
"location": {
"port": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "0a",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
},
"name": "lif1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"fcp": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
}
},
"ip_interfaces": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ip": {
"address": "10.10.10.7",
"netmask": "24"
},
"location": {
"broadcast_domain": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "bd1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"home_node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
},
"name": "lif1",
"service_policy": "string",
"services": [
"data_nfs"
],
"subnet": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "subnet1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"ipspace": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "Default",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"iscsi": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
}
},
"language": "c.utf_8",
"ldap": {
"ad_domain": "string",
"base_dn": "string",
"bind_dn": "string",
"servers": [
"string"
]
},
"max_volumes": "string",
"name": "svm1",
"nfs": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
}
},
"nis": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"domain": "string",
"servers": [
"string"
]
},
"nsswitch": {
"group": [
"string"
],
"hosts": [
"string"
],
"namemap": [
"string"
],
"netgroup": [
"string"
],
"passwd": [
"string"
]
},
"number_of_volumes_in_recovery_queue": 0,
"nvme": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
}
},
"qos_adaptive_policy_group_template": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"max_throughput_iops": 10000,
"max_throughput_mbps": 500,
"min_throughput_iops": 2000,
"min_throughput_mbps": 500,
"name": "performance",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"qos_policy": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"max_throughput_iops": 10000,
"max_throughput_mbps": 500,
"min_throughput_iops": 2000,
"min_throughput_mbps": 500,
"name": "performance",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"routes": [
{
"destination": {
"address": "10.10.10.7",
"family": "string",
"netmask": "24"
},
"gateway": "10.1.1.1"
}
],
"s3": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"certificate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "string",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"default_unix_user": "string",
"default_win_user": "string",
"name": "s3-server-1"
},
"snapmirror": {
"protected_consistency_group_count": 0,
"protected_volumes_count": 0
},
"snapshot_policy": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "default",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"state": "running",
"storage": {
"allocated": 0,
"available": 0,
"used_percentage": 0
},
"subtype": "string",
"total_volume_size_in_recovery_queue": 0,
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
]
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
aggregates
Name | Type | Description |
---|---|---|
_links |
||
available_size |
integer |
Space available, in bytes. |
name |
string |
|
snaplock_type |
string |
SnapLock type. |
state |
string |
Aggregate state. |
type |
string |
Type of aggregate. |
uuid |
string |
event_log
Name | Type | Description |
---|---|---|
is_enabled_on_new_file_extension_seen |
boolean |
Specifies whether to send an EMS when a new file extension is discovered. |
is_enabled_on_snapshot_copy_creation |
boolean |
Specifies whether to send an EMS when a Snapshot copy is created. |
arw_vserver
Anti-ransomware related information for the SVM.
Name | Type | Description |
---|---|---|
event_log |
certificate
Support for this field will be removed in a future release. Please use /svm/svms/{svm.uuid}/web for this field. Certificate for incoming TLS connection requests.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
Certificate name |
uuid |
string |
Certificate UUID |
ad_domain
Name | Type | Description |
---|---|---|
default_site |
string |
The default site used by LIFs that do not have a site membership. |
fqdn |
string |
The fully qualified domain name of the Windows Active Directory to which this CIFS server belongs. A CIFS server appears as a member of Windows server object in the Active Directory store. |