Skip to content

aws.fsx.describe_storage_virtual_machines

Example SQL Queries

SELECT * FROM
aws.fsx.describe_storage_virtual_machines;

Description

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

Table Definition

Column NameColumn Data Type
filters Input Column

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

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name for this filter.

filters[].values[]
storage_virtual_machine_ids Input Column

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

VARCHAR[]
Show child fields
storage_virtual_machine_ids[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
active_directory_configuration

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

STRUCT(
"net_bios_name" VARCHAR,
"self_managed_active_directory_configuration" STRUCT(
"domain_name" VARCHAR,
"organizational_unit_distinguished_name" VARCHAR,
"file_system_administrators_group" VARCHAR,
"user_name" VARCHAR,
"dns_ips" VARCHAR[]
)
)
Show child fields
active_directory_configuration.net_bios_name

The NetBIOS name of the AD computer object to which the SVM is joined.

active_directory_configuration.self_managed_active_directory_configuration

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.

Show child fields
active_directory_configuration.self_managed_active_directory_configuration.dns_ips[]
active_directory_configuration.self_managed_active_directory_configuration.domain_name

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

active_directory_configuration.self_managed_active_directory_configuration.file_system_administrators_group

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

active_directory_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name

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.

active_directory_configuration.self_managed_active_directory_configuration.user_name

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

creation_time

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

TIMESTAMP_S
endpoints

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.

STRUCT(
"iscsi" STRUCT(
"dns_name" VARCHAR,
"ip_addresses" VARCHAR[]
),
"management" STRUCT(
"dns_name" VARCHAR,
"ip_addresses" VARCHAR[]
),
"nfs" STRUCT(
"dns_name" VARCHAR,
"ip_addresses" VARCHAR[]
),
"smb" STRUCT(
"dns_name" VARCHAR,
"ip_addresses" VARCHAR[]
)
)
Show child fields
endpoints.iscsi

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

Show child fields
endpoints.iscsi.dns_name

The file system's DNS name. You can mount your file system using its DNS name.

endpoints.iscsi.ip_addresses[]
endpoints.management

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

Show child fields
endpoints.management.dns_name

The file system's DNS name. You can mount your file system using its DNS name.

endpoints.management.ip_addresses[]
endpoints.nfs

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

Show child fields
endpoints.nfs.dns_name

The file system's DNS name. You can mount your file system using its DNS name.

endpoints.nfs.ip_addresses[]
endpoints.smb

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

Show child fields
endpoints.smb.dns_name

The file system's DNS name. You can mount your file system using its DNS name.

endpoints.smb.ip_addresses[]
file_system_id

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

VARCHAR
lifecycle

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.

VARCHAR
lifecycle_transition_reason

Describes why the SVM lifecycle state changed.

STRUCT(
"message" VARCHAR
)
Show child fields
lifecycle_transition_reason.message

A detailed error message.

name

The name of the SVM, if provisioned.

VARCHAR
resource_arn

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.

VARCHAR
root_volume_security_style

The security style of the root volume of the SVM.

VARCHAR
storage_virtual_machine_id

The SVM's system generated unique ID.

VARCHAR
subtype

Describes the SVM's subtype.

VARCHAR
tags

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

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

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

tags[].value

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.

uuid

The SVM's UUID (universally unique identifier).

VARCHAR