UpdateStorageVirtualMachine - Amazon FSx

UpdateStorageVirtualMachine

Updates an Amazon FSx for ONTAP storage virtual machine (SVM).

Request Syntax

{ "ActiveDirectoryConfiguration": { "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "Password": "string", "UserName": "string" } }, "ClientRequestToken": "string", "StorageVirtualMachineId": "string", "SvmAdminPassword": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ActiveDirectoryConfiguration

Updates the Microsoft Active Directory (AD) configuration for an SVM that is joined to an AD.

Type: UpdateSvmActiveDirectoryConfiguration object

Required: No

ClientRequestToken

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

StorageVirtualMachineId

The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^(svm-[0-9a-f]{17,})$

Required: Yes

SvmAdminPassword

Enter a new SvmAdminPassword if you are updating it.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 50.

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$

Required: No

Response Syntax

{ "StorageVirtualMachine": { "ActiveDirectoryConfiguration": { "NetBiosName": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" } }, "CreationTime": number, "Endpoints": { "Iscsi": { "DNSName": "string", "IpAddresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ] }, "Nfs": { "DNSName": "string", "IpAddresses": [ "string" ] }, "Smb": { "DNSName": "string", "IpAddresses": [ "string" ] } }, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "RootVolumeSecurityStyle": "string", "StorageVirtualMachineId": "string", "Subtype": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UUID": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StorageVirtualMachine

Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuraton.

Type: StorageVirtualMachine object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

IncompatibleParameterError

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

StorageVirtualMachineNotFound

No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

HTTP Status Code: 400

UnsupportedOperation

The requested operation is not supported for this resource or API.

HTTP Status Code: 400

Examples

Update an Amazon FSx for ONTAP SVM

This example updates the Microsoft Active Directory user credentials of an existing SVM that is joined to a AD.

{ "ActiveDirectoryConfiguration": { "SelfManagedActiveDirectoryConfiguration": { "UserName": "admin_user" "Password": "new_password", } }, "StorageVirtualMachineId": "svm-0123456789abcdef3" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: