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

Update SVM properties

Contributors
PDFs

PATCH /svm/svms/{uuid}

Introduced In: 9.6

Updates one or more of the following properties of an individual SVM: SVM name, SVM default volume language code, SVM comment, and SVM state.

  • vserver modify

  • vserver rename

  • vserver start

  • vserver stop

  • security ssl modify

  • vserver add-protocols

  • vserver remove-protocols

Examples

  1. Stops an SVM and updates the "comment" field for an individual SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"state":"stopped", "comment":"This SVM is stopped."}'

  1. Starts an SVM and updates the "comment" field for an individual SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"state":"running", "comment":"This SVM is running."}'

  1. Updates the "language" field for an individual SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"language":"en.UTF-8"}'

  1. Updates the "name" field for an SVM or renames the SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"name":"svm_new"}'

  1. Updates the aggregates for an individual SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"aggregates":{"name":["aggr1","aggr2","aggr3"]}}'

  1. Updates the Snapshot copy policy for an individual SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"snapshot_policy":{"name":"custom1"}}'

  1. Updates the TLS certificate for an individual SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"certificate":{"uuid":"1cd8a442-86d1-11e0-ae1c-123478563412"}}'

  1. Updates the QoS policy for the SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"qos_policy_group":{"name":"qpolicy1"}}'

  1. Allows NFS protocol which was previously disallowed for the SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"nfs":{"allowed":"true"}}'

  1. Updates the max volume limit for the SVM

  PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"max_volumes":"200"}'

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Filter by UUID

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Request Body

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

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.

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

nvme

nvme

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.

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.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "aggregates": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "aggr1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "anti_ransomware_default_volume_state": "string",
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "cert1",
    "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"
    ]
  },
  "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"
    ]
  },
  "nvme": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    }
  },
  "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": "cert1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "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"
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error codes Description

13434880

Failed to modify SVM parameters.

13434881

Failed to rename SVM.

13434883

SVM parameters except name modified successfully.

13434885

Non-UTF8 language(s) not supported.

13434886

Invalid Snapshot copy policy.

13434902

Modification of NSSwitch parameters failed for the SVM.

13434906

Operation not supported for an SVM of type sync-destination.

12451843

Certificate does not exist.

13434908

Invalid SVM name. The name is already in use by another SVM, IPSpace or cluster.

13434916

SVM is in the process of being created. Wait a few minutes, and then try the command again.

13434915

Failed to unlock the SVM because SVM create or delete job is in progress. Wait a few minutes, and then try the command again.

13434911

Invalid SVM name. Maximum supported length is 41 if SVM is of type \"sync-source\", otherwise 47.
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

self

href

aggregates

Aggregate

Name Type Description

_links

_links

name

string

uuid

string

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

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.

enabled

boolean

If allowed, setting to true enables the CIFS service.

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

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

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.

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

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

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.

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.

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

nvme

nvme

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.

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.
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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.