Skip to main content

Retrieve SVMs and SVM properties

Contributors
PDFs

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.*

  • vserver show

Examples

  1. Retrieves a list of SVMs in the cluster sorted by name

  GET "/api/svm/svms?order_by=name"

  1. Retrieves a list of SVMs in the cluster that have the NFS protocol enabled

  GET "/api/svm/svms?nfs.enabled=true"

  1. Retrieves a list of SVMs in the cluster that have the CIFS protocol enabled

  GET "/api/svm/svms?cifs.enabled=true"

  1. 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"

  1. Retrieves a list of SVMs in the cluster that have the CIFS protocol allowed

  GET "/api/svm/svms?cifs.allowed=true"

  1. Retrieves a list of SVMs in the cluster where the NDMP protocol is specified as allowed

  GET "/api/svm/svms?ndmp.allowed=true"

  1. 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

  • Introduced in: 9.9

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

  • Introduced in: 9.9

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

  • Introduced in: 9.9

fcp.enabled

boolean

query

False

Filter by fcp.enabled

iscsi.allowed

boolean

query

False

Filter by iscsi.allowed

  • Introduced in: 9.9

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

  • Introduced in: 9.9

cifs.enabled

boolean

query

False

Filter by cifs.enabled

s3.name

string

query

False

Filter by s3.name

  • Introduced in: 9.7

s3.allowed

boolean

query

False

Filter by s3.allowed

  • Introduced in: 9.12

s3.enabled

boolean

query

False

Filter by s3.enabled

  • Introduced in: 9.7

ndmp.allowed

boolean

query

False

Filter by ndmp.allowed

  • Introduced in: 9.10

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

  • Introduced in: 9.9

qos_policy.uuid

string

query

False

Filter qos_policy.uuid

  • Introduced in: 9.9

max_volumes

string

query

False

Filter max_volumes

  • Introduced in: 9.9

fc_interfaces.name

string

query

False

Filter by fc_interfaces.name

  • Introduced in: 9.7

fc_interfaces.data_protocol

string

query

False

Filter by fc_interfaces.data_protocol

  • Introduced in: 9.7

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

  • Introduced in: 9.7

anti_ransomware_default_volume_state

string

query

False

Filter by anti_ransomware_default_volume_state

  • Introduced in: 9.10

qos_adaptive_policy_group_template.name

string

query

False

Filter by qos_adaptive_policy_group_template.name

  • Introduced in: 9.13

qos_adaptive_policy_group_template.uuid

string

query

False

Filter by qos_adaptive_policy_group_template.uuid

  • Introduced in: 9.13

anti_ransomware_auto_switch_from_learning_to_enabled

boolean

query

False

Filter by anti_ransomware_auto_switch_from_learning_to_enabled

  • Introduced in: 9.13

anti_ransomware_auto_switch_minimum_incoming_data

string

query

False

Filter by anti_ransomware_auto_switch_minimum_incoming_data

  • Introduced in: 9.13

anti_ransomware_auto_switch_minimum_incoming_data_percent

integer

query

False

Filter by anti_ransomware_auto_switch_minimum_incoming_data_percent

  • Introduced in: 9.13

anti_ransomware_auto_switch_duration_without_new_file_extension

integer

query

False

Filter by anti_ransomware_auto_switch_duration_without_new_file_extension

  • Introduced in: 9.13

anti_ransomware_auto_switch_minimum_learning_period

integer

query

False

Filter by anti_ransomware_auto_switch_minimum_learning_period

  • Introduced in: 9.13

anti_ransomware_auto_switch_minimum_file_count

integer

query

False

Filter by anti_ransomware_auto_switch_minimum_file_count

  • Introduced in: 9.13

anti_ransomware_auto_switch_minimum_file_extension

integer

query

False

Filter by anti_ransomware_auto_switch_minimum_file_extension

  • Introduced in: 9.13

auto_enable_analytics

boolean

query

False

Filter by auto_enable_analytics.

  • Introduced in: 9.12

auto_enable_activity_tracking

boolean

query

False

Filter by auto_enable_activity_tracking.

  • Introduced in: 9.12

storage.allocated

integer

query

False

Filter by storage_allocated

  • Introduced in: 9.14

storage.available

integer

query

False

Filter by storage_available

  • Introduced in: 9.14

storage.used_percentage

integer

query

False

Filter by storage_used_percentage

  • Introduced in: 9.14

number_of_volumes_in_recovery_queue

integer

query

False

Filter by number_of_volumes_in_recovery_queue

  • Introduced in: 9.13

total_volume_size_in_recovery_queue

integer

query

False

Filter by total_volume_size_in_recovery_queue

  • Introduced in: 9.13

storage.limit_threshold_exceeded

integer

query

False

Filter by storage.limit_threshold_exceeded

  • Introduced in: 9.14

storage.limit

integer

query

False

Filter by storage.limit

  • Introduced in: 9.14

storage.limit_threshold_alert

integer

query

False

Filter by storage.limit_threshold_alert

  • Introduced in: 9.14

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.

  • Default value: 1

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_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

returned_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

href

self

href

_links

Name Type Description

self

href

aggregates

Name Type Description

_links

_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

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

_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.

organizational_unit

string

Specifies the organizational unit within the Active Directory domain to associate with the CIFS server.

password

string

The account password used to add this CIFS server to the Active Directory. This is not audited. Valid in POST only.

user

string

The user account used to add this CIFS server to the Active Directory. Valid in POST only.

cifs

Name Type Description

_links

_links

ad_domain

ad_domain

allowed

boolean

If this is set to true, an SVM administrator can manage the CIFS service. If it is false, only the cluster administrator can manage the service.

auth-style

string

Authentication type.

domain_workgroup

string

The NetBIOS name of the domain or workgroup associated with the CIFS server.

enabled

boolean

If allowed, setting to true enables the CIFS service.

name

string

The NetBIOS name of the CIFS server.

workgroup

string

The workgroup name.

dns

Name Type Description

_links

_links

domains

array[string]

A list of DNS domains. Domain names have the following requirements:

  • The name must contain only the following characters: A through Z, a through z, 0 through 9, ".", "-" or "_".

  • The first character of each label, delimited by ".", must be one of the following characters: A through Z or a through z or 0 through 9.

  • The last character of each label, delimited by ".", must be one of the following characters: A through Z, a through z, or 0 through 9.

  • The top level domain must contain only the following characters: A through Z, a through z.

  • The system reserves the following names:"all", "local", and "localhost".

servers

array[string]

The list of IP addresses of the DNS servers. Addresses can be either IPv4 or IPv6 addresses.

node

The node on which the FC port is located.

Name Type Description

name

string

The name of the node on which the FC port is located.

fc_port_reference

An FC port is the physical port of an FC adapter on a cluster node that can be connected to an FC network.

Name Type Description

_links

_links

name

string

The name of the FC port.

node

node

The node on which the FC port is located.

uuid

string

The unique identifier of the FC port.

location

The location of the Fibre Channel interface is defined by the location of its port.

Name Type Description

port

fc_port_reference

An FC port is the physical port of an FC adapter on a cluster node that can be connected to an FC network.

fc_interface_svm

Name Type Description

_links

_links

data_protocol

string

The data protocol for which the Fibre Channel interface is configured.

location

location

The location of the Fibre Channel interface is defined by the location of its port.

name

string

The name of the Fibre Channel interface.

uuid

string

The unique identifier of the Fibre Channel interface.

fcp

Name Type Description

_links

_links

allowed

boolean

If this is set to true, an SVM administrator can manage the FCP service. If it is false, only the cluster administrator can manage the service.

enabled

boolean

If allowed, setting to true enables the FCP service.

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0).

broadcast_domain

Broadcast domain UUID along with a readable name.

Name Type Description

_links

_links

name

string

Name of the broadcast domain, scoped to its IPspace

uuid

string

Broadcast domain UUID

home_node

Name Type Description

_links

_links

name

string

uuid

string

location

Home_node is optional.

Name Type Description

broadcast_domain

broadcast_domain

Broadcast domain UUID along with a readable name.

home_node

home_node

ip_subnet_reference

A named subnet. Either UUID or name can be supplied on input.

Name Type Description

_links

_links

name

string

The name of the subnet. If only the name is provided, the IPspace scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the subnet.

ip_interface_svm

Interface parameters. Name and home_node are optional.

Name Type Description

_links

_links

ip

ip

IP information

location

location

Home_node is optional.

name

string

The name of the interface (optional).

service_policy

string

Built-in service policies for SVMs.

services

array[string]

The services associated with the interface.

subnet

ip_subnet_reference

A named subnet. Either UUID or name can be supplied on input.

uuid

string

The UUID that uniquely identifies the interface.

ipspace

Either the UUID or name may be supplied on input.

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

iscsi

Name Type Description

_links

_links

allowed

boolean

If this is set to true, an SVM administrator can manage the iSCSI service. If it is false, only the cluster administrator can manage the service.

enabled

boolean

If allowed, setting to true enables the ISCSI service.

ldap

Name Type Description

ad_domain

string

This parameter specifies the name of the Active Directory domain used to discover LDAP servers for use by this client. This is mutually exclusive with servers during POST.

base_dn

string

Specifies the default base DN for all searches.

bind_dn

string

Specifies the user that binds to the LDAP servers. SVM API supports anonymous binding. For Simple and SASL LDAP binding, use the LDAP API endpoint.

enabled

boolean

Enable LDAP? Setting to true creates a configuration if not already created.

restrict_discovery_to_site

boolean

Specifies whether or not LDAP server discovery is restricted to site-scope.

servers

array[string]

ndmp

Name Type Description

allowed

boolean

If this is set to true, an SVM administrator can manage the NDMP service. If it is false, only the cluster administrator can manage the service.

nfs

Name Type Description

_links

_links

allowed

boolean

If this is set to true, an SVM administrator can manage the NFS service. If it is false, only the cluster administrator can manage the service.

enabled

boolean

If allowed, setting to true enables the NFS service.

nis

Name Type Description

_links

_links

domain

string

The NIS domain to which this configuration belongs.

enabled

boolean

Enable NIS? Setting to true creates a configuration if not already created.

servers

array[string]

A list of hostnames or IP addresses of NIS servers used by the NIS domain configuration.

nsswitch

Name service switch configuration

Name Type Description

group

array[string]

Group sources

hosts

array[string]

Host sources

namemap

array[string]

NameMap sources

netgroup

array[string]

NetGroup sources

passwd

array[string]

Password sources

nvme

Name Type Description

_links

_links

allowed

boolean

If this is set to true, an SVM administrator can manage the NVMe service. If it is false, only the cluster administrator can manage the service.

enabled

boolean

If allowed, setting to true enables the NVMe service.

qos_adaptive_policy_group_template

This optionally specifies which QoS adaptive policy group to apply to the SVM as a template. This policy group will then be assigned to volumes created or rehosted into this SVM. This policy group defines measurable service level objectives (SLOs) and Service Level Agreements (SLAs) that adjust based on the volume allocated space or used space.

Name Type Description

_links

_links

max_throughput_iops

integer

Specifies the maximum throughput in IOPS, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

max_throughput_mbps

integer

Specifies the maximum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

min_throughput_iops

integer

Specifies the minimum throughput in IOPS, 0 means none. Setting "min_throughput" is supported on AFF platforms only, unless FabricPool tiering policies are set. This is mutually exclusive with name and UUID during POST and PATCH.

min_throughput_mbps

integer

Specifies the minimum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

name

string

The QoS policy group name. This is mutually exclusive with UUID and other QoS attributes during POST and PATCH.

uuid

string

The QoS policy group UUID. This is mutually exclusive with name and other QoS attributes during POST and PATCH.

qos_policy

This optionally specifies which QoS policy group to apply to the Vserver. This policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated.

Name Type Description

_links

_links

max_throughput_iops

integer

Specifies the maximum throughput in IOPS, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

max_throughput_mbps

integer

Specifies the maximum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

min_throughput_iops

integer

Specifies the minimum throughput in IOPS, 0 means none. Setting "min_throughput" is supported on AFF platforms only, unless FabricPool tiering policies are set. This is mutually exclusive with name and UUID during POST and PATCH.

min_throughput_mbps

integer

Specifies the minimum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

name

string

The QoS policy group name. This is mutually exclusive with UUID and other QoS attributes during POST and PATCH.

uuid

string

The QoS policy group UUID. This is mutually exclusive with name and other QoS attributes during POST and PATCH.

ip_info

IP information

Name Type Description

address

string

IPv4 or IPv6 address

family

string

IPv4 or IPv6

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always the netmask length.

network_route_for_svm

Name Type Description

destination

ip_info

IP information

gateway

string

The IP address of the gateway router leading to the destination.

certificate

Specifies the certificate that will be used for creating HTTPS connections to the S3 server.

Name Type Description

_links

_links

name

string

Certificate name

uuid

string

Certificate UUID

s3

Name Type Description

_links

_links

certificate

certificate

Specifies the certificate that will be used for creating HTTPS connections to the S3 server.

default_unix_user

string

Specifies the default UNIX user for NAS Access.

default_win_user

string

Specifies the default Windows user for NAS Access.

enabled

boolean

Specifies whether or not to enable S3. Setting this value to true creates a service if one is not yet created.

is_http_enabled

boolean

Specifies whether HTTP is enabled on the S3 server. By default, HTTP is disabled on the S3 server.

is_https_enabled

boolean

Specifies whether HTTPS is enabled on the S3 server. By default, HTTPS is enabled on the S3 server.

name

string

Specifies the name of the S3 server. A server name length can range from 1 to 253 characters and can only contain the following combination of characters 0-9, A-Z, a-z, ".", and "-".

port

integer

Specifies the HTTP listener port for the S3 server. By default, HTTP is enabled on port 80.

secure_port

integer

Specifies the HTTPS listener port for the S3 server. By default, HTTPS is enabled on port 443.

snapmirror

Specifies attributes for SVM DR protection.

Name Type Description

is_protected

boolean

Specifies whether the SVM is a SnapMirror source SVM, using SnapMirror to protect its data.

protected_consistency_group_count

integer

Specifies the number of SVM DR protected consistency groups in the SVM.

protected_volumes_count

integer

Specifies the number of SVM DR protected volumes in the SVM.

snapshot_policy

This is a reference to the Snapshot copy policy.

Name Type Description

_links

_links

name

string

uuid

string

storage

Name Type Description

allocated

integer

Total size of the volumes in SVM, in bytes.

available

integer

Currently available storage capacity in SVM, in bytes.

limit

integer

Maximum storage permitted on a single SVM, in bytes.

limit_threshold_alert

integer

Indicates at what percentage of storage capacity an alert message is sent. The default value is 90.

limit_threshold_exceeded

boolean

Indicates whether the total storage capacity exceeds the alert percentage.

used_percentage

integer

The percentage of storage capacity used.

svm

Name Type Description

_links

_links

aggregates

array[aggregates]

List of allowed aggregates for SVM volumes. An administrator is allowed to create volumes on these aggregates.

aggregates_delegated

boolean

This property is true when the administrator has delegated the aggregates for the SVM volumes.

anti_ransomware

arw_vserver

Anti-ransomware related information for the SVM.

anti_ransomware_auto_switch_duration_without_new_file_extension

integer

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this SVM from “learning” (dry-run) to “enabled” is that no new file-extensions are observed in the volume in recent time. This parameter optionally specifies the recent time duration (in days) to be considered during which no new file-extension should be observed in a given volume to automatically switch the anti-ransomware state from '`learning`" to “enabled”.

anti_ransomware_auto_switch_from_learning_to_enabled

boolean

This property specifies whether anti-ransomware state of the volumes in this SVM are automatically switched by the system from “learning” (dry-run) to “enabled” (active) state after sufficient learning.

anti_ransomware_auto_switch_minimum_file_count

integer

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this SVM from “learning” (dry-run) to “enabled” is that the volume should have a minimum file count in “learning” state. This parameter optionally specifies the minimum number of newly created files in “learning” state in a given volume to automatically switch the anti-ransomware state from “learning” to “enabled”.

anti_ransomware_auto_switch_minimum_file_extension

integer

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this SVM from “learning” (dry-run) to “enabled” is that the volume should have minimum number of file extensions in “learning” state. This parameter optionally specifies the minimum number of new file extensions in “learning” state in a given volume to automatically switch the anti-ransomware state from “learning” to “enabled”.

anti_ransomware_auto_switch_minimum_learning_period

integer

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this SVM from “learning” (dry-run) to “enabled” is that the volume should be in “learning” state for sufficient time period. This parameter optionally specifies the minimum number of days a given volume should be in “learning” state to automatically switch the anti-ransomware state from “learning” to “enabled”.

anti_ransomware_default_volume_state

string

Specifies the default Anti-ransomware state of the volumes in the SVM. Default "anti_ransomware_default_volume_state" property is disabled for POST operation. If this value is "disabled", Anti-ransomware protection is disabled by default on the new volumes that are created in the SVM. If this value is "dry_run", Anti-ransomware protection is in learning mode by default on the new volumes that are created in the SVM. When the Anti-ransomware license is not present, this property is ignored and volumes will be created with the "disabled" state.

anti_ransomware_incoming_write_threshold

string

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this SVM from “learning” (dry-run) to “enabled” is that the volume should have sufficient data ingested to do the learning. This parameter optionally specifies the minimum amount of data (in GB) to be written to a given volume during the learning period to automatically switch the anti-ransomware state from “learning” to “enabled”. The amount of data considered as ingested also includes the data that is deleted or overwritten after ingestion.

anti_ransomware_incoming_write_threshold_percent

string

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this SVM from “learning” (dry-run) to “enabled” is that the volume should have sufficient data ingested to do the learning. This parameter optionally specifies the minimum amount of data (in percentage) to be written to a given volume during the learning period to automatically switch the anti-ransomware state from “learning” to “enabled”. The amount of data considered as ingested also includes the data that is deleted or overwritten after ingestion.

auto_enable_activity_tracking

boolean

Specifies whether volume activity tracking is automatically enabled on volumes that are created in the SVM.

auto_enable_analytics

boolean

Specifies whether file system analytics is automatically enabled on volumes that are created in the SVM.

certificate

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.

cifs

cifs

comment

string

Comment

dns

dns

fc_interfaces

array[fc_interface_svm]

FC Interface for the SVM

fcp

fcp

ip_interfaces

array[ip_interface_svm]

IP interfaces for the SVM

ipspace

ipspace

Either the UUID or name may be supplied on input.

is_space_enforcement_logical

boolean

Indicates whether logical space enforcement for the SVM is enabled.

is_space_reporting_logical

boolean

Indicates whether logical space reporting for the SVM is enabled.

iscsi

iscsi

language

string

Default volume language code. UTF-8 encoded languages are valid in POST or PATCH. Non UTF-8 language encodings are for backward compatibility and are not valid input for POST and PATCH requests.

ldap

ldap

max_volumes

string

This property is used by cluster administrator to specify the limit on maximum number of volumes allowed in the SVM. The value can be either the string "unlimited" or a number.

name

string

The name of the SVM.

ndmp

ndmp

nfs

nfs

nis

nis

nsswitch

nsswitch

Name service switch configuration

number_of_volumes_in_recovery_queue

integer

Number of volumes in the recovery queue.

nvme

nvme

qos_adaptive_policy_group_template

qos_adaptive_policy_group_template

This optionally specifies which QoS adaptive policy group to apply to the SVM as a template. This policy group will then be assigned to volumes created or rehosted into this SVM. This policy group defines measurable service level objectives (SLOs) and Service Level Agreements (SLAs) that adjust based on the volume allocated space or used space.

qos_policy

qos_policy

This optionally specifies which QoS policy group to apply to the Vserver. This policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated.

retention_period

integer

Volume delete retention period specifies the default duration, in hours that deleted volumes are retained in the recovery queue for possible future recovery.

routes

array[network_route_for_svm]

Optional array of routes for the SVM

s3

s3

snapmirror

snapmirror

Specifies attributes for SVM DR protection.

snapshot_policy

snapshot_policy

This is a reference to the Snapshot copy policy.

state

string

SVM State

storage

storage

subtype

string

SVM subtype. The SVM subtype sync_destination is created automatically when an SVM of subtype sync_source is created on the source MetroCluster cluster. A POST request with sync_destination as SVM subtype is invalid.

total_volume_size_in_recovery_queue

integer

Sum of the sizes of the volumes in the recovery queue.

uuid

string

The unique identifier of the SVM.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.