Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeStorageVirtualMachines

Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "StorageVirtualMachineIds": [ "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.

Filters

Enter a filter name:value pair to view a select set of SVMs.

Type: Array of StorageVirtualMachineFilter objects

Array Members: Maximum number of 1 item.

Required: No

MaxResults

The maximum number of resources to return in the response. This value must be an integer greater than zero.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 2147483647.

Required: No

NextToken

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

Type: String

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

Pattern: ^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$

Required: No

StorageVirtualMachineIds

Enter the ID of one or more SVMs that you want to view.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Fixed length of 21.

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

Required: No

Response Syntax


{
   "NextToken": "string",
   "StorageVirtualMachines": [ 
      { 
         "ActiveDirectoryConfiguration": { 
            "NetBiosName": "string",
            "SelfManagedActiveDirectoryConfiguration": { 
               "DnsIps": [ "string" ],
               "DomainName": "string",
               "FileSystemAdministratorsGroup": "string",
               "OrganizationalUnitDistinguishedName": "string",
               "UserName": "string"
            }
         },
         "CreationTime": number,
         "Endpoints": { 
            "Iscsi": { 
               "DNSName": "string",
               "IpAddresses": [ "string" ],
               "Ipv6Addresses": [ "string" ]
            },
            "Management": { 
               "DNSName": "string",
               "IpAddresses": [ "string" ],
               "Ipv6Addresses": [ "string" ]
            },
            "Nfs": { 
               "DNSName": "string",
               "IpAddresses": [ "string" ],
               "Ipv6Addresses": [ "string" ]
            },
            "Smb": { 
               "DNSName": "string",
               "IpAddresses": [ "string" ],
               "Ipv6Addresses": [ "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.

NextToken

Type: String

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

Pattern: ^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$

StorageVirtualMachines

Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.

Type: Array of StorageVirtualMachine objects

Array Members: Maximum number of 50 items.

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.

Message: A detailed error message.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

Message: A detailed error message.

HTTP Status Code: 500

StorageVirtualMachineNotFound

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

Message: A detailed error message.

HTTP Status Code: 400

Examples

View SVMs

The following example will return the SVMs for a specific Amazon FSx for ONTAP file system, showing 5 SVMs per page in the response.


{
    "Filters": [
        {
            "Name": "fsx-ontap-fs-id",
            "Values": [ "fs-0123456789abcdef5" ]
        }
    ],
    "MaxResults": 5
}