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

Update SVM properties

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

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"}}'

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: 0

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

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.

comment

string

Comment

fc_interfaces

array[fc_interface_svm]

FC Interface for the SVM

ip_interfaces

array[ip_interface_svm]

IP interfaces for the SVM

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.

name

string

The name of the SVM.

nsswitch

nsswitch

Name service switch configuration

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

uuid

string

The unique identifier of the SVM.

volume_efficiency_policy

volume_efficiency_policy

This is a reference to the volume efficiency policy.
Example request 
{
  "aggregates": [
    {
      "name": "aggr1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "certificate": {
    "name": "cert1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "comment": "string",
  "fc_interfaces": [
    {
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "ip_interfaces": [
    {
      "services": [
        "data_nfs"
      ],
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "language": "c.utf_8",
  "name": "svm1",
  "nsswitch": {
    "group": [
      "string"
    ],
    "hosts": [
      "string"
    ],
    "namemap": [
      "string"
    ],
    "netgroup": [
      "string"
    ],
    "passwd": [
      "string"
    ]
  },
  "snapmirror": {
    "protected_volumes_count": 0
  },
  "snapshot_policy": {
    "name": "default",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "state": "running",
  "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7",
  "volume_efficiency_policy": {
    "name": "default",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "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.

Definitions

See Definitions

href

Name Type Description

href

string

_links

aggregates

Aggregate

Name Type Description

name

string

uuid

string

certificate

Certificate for incoming TLS connection requests.

Name Type Description

name

string

Certificate name

uuid

string

Certificate UUID

ad_domain

cifs

Name Type Description

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

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

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

uuid

string

The unique identifier of the Fibre Channel interface.

fcp

Name Type Description

enabled

boolean

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

ip

IP information

broadcast_domain

Broadcast domain UUID along with a readable name.

Name Type Description

name

string

Name of the broadcast domain, scoped to its IPspace

uuid

string

Broadcast domain UUID

home_node

Name Type Description

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

ip

ip

IP information

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

name

string

IPspace name

uuid

string

IPspace UUID

iscsi

Name Type Description

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

enabled

boolean

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

nis

Name Type Description

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

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

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.

certificate

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

Name Type Description

name

string

Certificate name

uuid

string

Certificate UUID

s3

Name Type Description

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

name

string

uuid

string

volume_efficiency_policy

This is a reference to the volume efficiency policy.

Name Type Description

name

string

Name of the volume efficiency policy

uuid

string

Unique identifier of the volume efficiency policy.

svm

Name Type Description

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.

comment

string

Comment

fc_interfaces

array[fc_interface_svm]

FC Interface for the SVM

ip_interfaces

array[ip_interface_svm]

IP interfaces for the SVM

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.

name

string

The name of the SVM.

nsswitch

nsswitch

Name service switch configuration

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

uuid

string

The unique identifier of the SVM.

volume_efficiency_policy

volume_efficiency_policy

This is a reference to the volume efficiency policy.
Name Type Description

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.