Skip to content

Describe Storage Virtual Machines

fsx_describe_storage_virtual_machines R Documentation

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

Description

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

Usage

fsx_describe_storage_virtual_machines(StorageVirtualMachineIds, Filters,
  MaxResults, NextToken)

Arguments

StorageVirtualMachineIds

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

Filters

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

MaxResults

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

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.

Value

A list with the following syntax:

list(
  StorageVirtualMachines = list(
    list(
      ActiveDirectoryConfiguration = list(
        NetBiosName = "string",
        SelfManagedActiveDirectoryConfiguration = list(
          DomainName = "string",
          OrganizationalUnitDistinguishedName = "string",
          FileSystemAdministratorsGroup = "string",
          UserName = "string",
          DnsIps = list(
            "string"
          ),
          DomainJoinServiceAccountSecret = "string"
        )
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      Endpoints = list(
        Iscsi = list(
          DNSName = "string",
          IpAddresses = list(
            "string"
          ),
          Ipv6Addresses = list(
            "string"
          )
        ),
        Management = list(
          DNSName = "string",
          IpAddresses = list(
            "string"
          ),
          Ipv6Addresses = list(
            "string"
          )
        ),
        Nfs = list(
          DNSName = "string",
          IpAddresses = list(
            "string"
          ),
          Ipv6Addresses = list(
            "string"
          )
        ),
        Smb = list(
          DNSName = "string",
          IpAddresses = list(
            "string"
          ),
          Ipv6Addresses = list(
            "string"
          )
        )
      ),
      FileSystemId = "string",
      Lifecycle = "CREATED"|"CREATING"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING",
      Name = "string",
      ResourceARN = "string",
      StorageVirtualMachineId = "string",
      Subtype = "DEFAULT"|"DP_DESTINATION"|"SYNC_DESTINATION"|"SYNC_SOURCE",
      UUID = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      LifecycleTransitionReason = list(
        Message = "string"
      ),
      RootVolumeSecurityStyle = "UNIX"|"NTFS"|"MIXED"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_storage_virtual_machines(
  StorageVirtualMachineIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "file-system-id",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)