FSx / Client / describe_storage_virtual_machines

describe_storage_virtual_machines

FSx.Client.describe_storage_virtual_machines(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_storage_virtual_machines(
    StorageVirtualMachineIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'file-system-id',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• StorageVirtualMachineIds (list) –

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

  • (string) –

• Filters (list) –

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

  • (dict) –

    A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). You can use multiple filters to return results that meet all applied filter requirements.

    • Name (string) –

      The name for this filter.

    • Values (list) –

      The values of the filter. These are all the values for any of the applied filters.

      • (string) –

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

• NextToken (string) – (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.

Return type:

dict

Returns:

Response Syntax

{
    'StorageVirtualMachines': [
        {
            'ActiveDirectoryConfiguration': {
                'NetBiosName': 'string',
                'SelfManagedActiveDirectoryConfiguration': {
                    'DomainName': 'string',
                    'OrganizationalUnitDistinguishedName': 'string',
                    'FileSystemAdministratorsGroup': 'string',
                    'UserName': 'string',
                    'DnsIps': [
                        'string',
                    ]
                }
            },
            'CreationTime': datetime(2015, 1, 1),
            'Endpoints': {
                'Iscsi': {
                    'DNSName': 'string',
                    'IpAddresses': [
                        'string',
                    ]
                },
                'Management': {
                    'DNSName': 'string',
                    'IpAddresses': [
                        'string',
                    ]
                },
                'Nfs': {
                    'DNSName': 'string',
                    'IpAddresses': [
                        'string',
                    ]
                },
                'Smb': {
                    'DNSName': 'string',
                    'IpAddresses': [
                        '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': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'LifecycleTransitionReason': {
                'Message': 'string'
            },
            'RootVolumeSecurityStyle': 'UNIX'|'NTFS'|'MIXED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • StorageVirtualMachines (list) –

    Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.

    • (dict) –

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

      • ActiveDirectoryConfiguration (dict) –

        Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

        • NetBiosName (string) –

          The NetBIOS name of the Active Directory computer object that is joined to your SVM.

        • SelfManagedActiveDirectoryConfiguration (dict) –

          The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

          • DomainName (string) –

            The fully qualified domain name of the self-managed AD directory.

          • OrganizationalUnitDistinguishedName (string) –

            The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

          • FileSystemAdministratorsGroup (string) –

            The name of the domain group whose members have administrative privileges for the FSx file system.

          • UserName (string) –

            The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

          • DnsIps (list) –

            A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

            • (string) –

      • CreationTime (datetime) –

        The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

      • Endpoints (dict) –

        The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.

        • Iscsi (dict) –

          An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.

          • DNSName (string) –

            The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

          • IpAddresses (list) –

            The SVM endpoint’s IP addresses.

            • (string) –

        • Management (dict) –

          An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.

          • DNSName (string) –

            The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

          • IpAddresses (list) –

            The SVM endpoint’s IP addresses.

            • (string) –

        • Nfs (dict) –

          An endpoint for connecting using the Network File System (NFS) protocol.

          • DNSName (string) –

            The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

          • IpAddresses (list) –

            The SVM endpoint’s IP addresses.

            • (string) –

        • Smb (dict) –

          An endpoint for connecting using the Server Message Block (SMB) protocol.

          • DNSName (string) –

            The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

          • IpAddresses (list) –

            The SVM endpoint’s IP addresses.

            • (string) –

      • FileSystemId (string) –

        The globally unique ID of the file system, assigned by Amazon FSx.

      • Lifecycle (string) –

        Describes the SVM’s lifecycle status.

        • CREATED - The SVM is fully available for use.

        • CREATING - Amazon FSx is creating the new SVM.

        • DELETING - Amazon FSx is deleting an existing SVM.

        • FAILED - Amazon FSx was unable to create the SVM.

        • MISCONFIGURED - The SVM is in a failed but recoverable state.

        • PENDING - Amazon FSx has not started creating the SVM.

      • Name (string) –

        The name of the SVM, if provisioned.

      • ResourceARN (string) –

        The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      • StorageVirtualMachineId (string) –

        The SVM’s system generated unique ID.

      • Subtype (string) –

        Describes the SVM’s subtype.

      • UUID (string) –

        The SVM’s UUID (universally unique identifier).

      • Tags (list) –

        A list of Tag values, with a maximum of 50 elements.

        • (dict) –

          Specifies a key-value pair for a resource tag.

          • Key (string) –

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Value (string) –

            A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

      • LifecycleTransitionReason (dict) –

        Describes why the SVM lifecycle state changed.

        • Message (string) –

          A detailed error message.

      • RootVolumeSecurityStyle (string) –

        The security style of the root volume of the SVM.

  • NextToken (string) –

    (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.

Exceptions

• FSx.Client.exceptions.BadRequest

• FSx.Client.exceptions.InternalServerError

• FSx.Client.exceptions.StorageVirtualMachineNotFound