Skip to content

Returns a description of virtual tape library (VTL) devices for the specified tape gateway

Description

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.

This operation is only supported in the tape gateway type.

Usage

storagegateway_describe_vtl_devices(GatewayARN, VTLDeviceARNs, Marker,
  Limit)

Arguments

  • GatewayARN

    [required] The Amazon Resource Name (ARN) of the gateway. Use the list_gateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • VTLDeviceARNs

    An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

    All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

  • Marker

    An opaque string that indicates the position at which to begin describing the VTL devices.

  • Limit

    Specifies that the number of VTL devices described be limited to the specified number.

Value

A list with the following syntax:

list(
  GatewayARN = "string",
  VTLDevices = list(
    list(
      VTLDeviceARN = "string",
      VTLDeviceType = "string",
      VTLDeviceVendor = "string",
      VTLDeviceProductIdentifier = "string",
      DeviceiSCSIAttributes = list(
        TargetARN = "string",
        NetworkInterfaceId = "string",
        NetworkInterfacePort = 123,
        ChapEnabled = TRUE|FALSE
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_vtl_devices(
  GatewayARN = "string",
  VTLDeviceARNs = list(
    "string"
  ),
  Marker = "string",
  Limit = 123
)

Examples

# Returns a description of virtual tape library (VTL) devices for the
# specified gateway.
svc$describe_vtl_devices(
  GatewayARN = "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  Limit = 123L,
  Marker = "1",
  VTLDeviceARNs = list()
)