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

Retrieve SVMs and SVM properties

Contributors
PDFs

GET /svm/svms

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 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 DOC 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"

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

boolean

query

False

Filter by nvme.enabled

language

string

query

False

Filter by language

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

boolean

query

False

Filter by fcp.enabled

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

boolean

query

False

Filter by cifs.enabled

s3.name

string

query

False

Filter by s3.name

s3.enabled

boolean

query

False

Filter by s3.enabled

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

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

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

_links

num_records

integer

Number of records

records

array[svm]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "aggregates": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "aggr1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "certificate": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "cifs": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "ad_domain": {
          "fqdn": "example.com",
          "organizational_unit": "string",
          "password": "string",
          "user": "string"
        },
        "name": "CIFS1"
      },
      "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"
          ],
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "ipspace": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "exchange",
        "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"
        ]
      },
      "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"
        ]
      },
      "nvme": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        }
      },
      "routes": [
        {
          "destination": {
            "address": "10.10.10.7",
            "family": "string",
            "netmask": "24"
          },
          "gateway": "10.1.1.1"
        }
      ],
      "s3": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "s3-server-1"
      },
      "snapmirror": {
        "protected_volumes_count": 0
      },
      "snapshot_policy": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "default",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "state": "running",
      "subtype": "string",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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

Aggregate

Name Type Description

_links

_links

name

string

uuid

string

certificate

Certificate for incoming TLS connection requests.

Name Type Description

_links

_links

uuid

string

Certificate UUID

ad_domain

Name Type Description

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

enabled

boolean

Specifies whether or not the CIFS service is administratively enabled.

name

string

The NetBIOS name of the CIFS server.

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

enabled

boolean

Enable Fiber Channel Protocol (FCP)? Setting to true creates a service if not already created.

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

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

enabled

boolean

Enable iSCSI? Setting to true creates a service if not already created.

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.

servers

array[string]

nfs

Name Type Description

_links

_links

enabled

boolean

Enable NFS? Setting to true creates a service if not already created.

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

enabled

boolean

Enable NVMe? Setting to true creates a service if not already created.

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, you must set the netmask length. The default value is 64. Output is always 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.

s3

Name Type Description

_links

_links

enabled

boolean

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

name

string

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

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

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.

certificate

certificate

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.

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

name

string

The name of the SVM.

nfs

nfs

nis

nis

nsswitch

nsswitch

Name service switch configuration

nvme

nvme

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

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.

uuid

string

The unique identifier of the SVM.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.