Update SVM properties
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.
Related ONTAP commands
-
vserver modify
-
vserver rename
-
vserver start
-
vserver stop
-
security ssl modify
-
vserver add-protocols
-
vserver remove-protocols
Examples
-
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."}'
-
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."}'
-
Updates the "language" field for an individual SVM
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"language":"en.UTF-8"}'
-
Updates the "name" field for an SVM or renames the SVM
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"name":"svm_new"}'
-
Updates the aggregates for an individual SVM
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"aggregates":["{"name":aggr1"},{"name":"aggr2"},{"name":"aggr3"}]}'
-
Updates the Snapshot copy policy for an individual SVM
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"snapshot_policy":{"name":"custom1"}}'
-
Updates the TLS certificate for an individual SVM
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"certificate":{"uuid":"1cd8a442-86d1-11e0-ae1c-123478563412"}}'
-
Updates the QoS policy for the SVM
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"qos_policy_group":{"name":"qpolicy1"}}'
-
Allows NFS protocol which was previously disallowed for the SVM
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"nfs":{"allowed":"true"}}'
-
Updates the max volume limit for the SVM
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"max_volumes":"200"}'
-
Updates whether file system analytics is enabled on all newly created volumes in the SVM.
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"auto_enable_analytics":"true"}'
-
Updates whether volume activity tracking is enabled on all newly created volumes in the SVM.
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"auto_enable_activity_tracking":"true"}'
-
Updates the QoS adaptive policy group template for the SVM.
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"qos_adaptive_policy_group_template":{"name":"aqpolicy1"}}'
-
Updates the maximum storage permitted on a single SVM.
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"storage":{"limit":"40GB"}}'
-
Updates the percentage of storage capacity at which an alert message is sent.
PATCH "/api/svm/svms/f16f0935-5281-11e8-b94d-005056b46485" '{"storage":{"limit":"400MB", "limit_threshold_alert":"98"}}'
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.
|
Request Body
Name | Type | Description |
---|---|---|
_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 |
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 |
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 |
||
comment |
string |
Comment |
dns |
||
fc_interfaces |
array[fc_interface_svm] |
FC Interface for the SVM |
fcp |
||
ip_interfaces |
array[ip_interface_svm] |
IP interfaces for the SVM |
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 |
||
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 |
||
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 |
||
nfs |
||
nis |
||
nsswitch |
Name service switch configuration |
|
number_of_volumes_in_recovery_queue |
integer |
Number of volumes in the recovery queue. |
nvme |
||
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 |
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 |
||
snapmirror |
Specifies attributes for SVM DR protection. |
|
snapshot_policy |
This is a reference to the Snapshot copy policy. |
|
state |
string |
SVM State |
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. |
Example request
{
"_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"
}
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
job |
Example response
{
"job": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uuid": "string"
}
}
Response
Status: 202, Accepted
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. |
262179 |
Unexpected argument "storage_limit". |
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 |
---|---|---|
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. |
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 |
||
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 |
||
domains |
array[string] |
A list of DNS domains. Domain names have the following requirements:
|
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 |
||
name |
string |
The name of the FC port. |
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 |