StorageGateway / Client / describe_vtl_devices

describe_vtl_devices#

StorageGateway.Client.describe_vtl_devices(**kwargs)#

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.

Request Syntax

response = client.describe_vtl_devices(
    GatewayARN='string',
    VTLDeviceARNs=[
        'string',
    ],
    Marker='string',
    Limit=123
)

Parameters:

GatewayARN (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
VTLDeviceARNs (list) –
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

Note
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.
- (string) –
Marker (string) – An opaque string that indicates the position at which to begin describing the VTL devices.
Limit (integer) – Specifies that the number of VTL devices described be limited to the specified number.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string',
    'VTLDevices': [
        {
            'VTLDeviceARN': 'string',
            'VTLDeviceType': 'string',
            'VTLDeviceVendor': 'string',
            'VTLDeviceProductIdentifier': 'string',
            'DeviceiSCSIAttributes': {
                'TargetARN': 'string',
                'NetworkInterfaceId': 'string',
                'NetworkInterfacePort': 123,
                'ChapEnabled': True|False
            }
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) –

DescribeVTLDevicesOutput
- GatewayARN (string) –
  
  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
- VTLDevices (list) –
  
  An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.
  - (dict) –
    
    Represents a device object associated with a tape gateway.
    - VTLDeviceARN (string) –
      
      Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
    - VTLDeviceType (string) –
      
      Specifies the type of device that the VTL device emulates.
    - VTLDeviceVendor (string) –
      
      Specifies the vendor of the device that the VTL device object emulates.
    - VTLDeviceProductIdentifier (string) –
      
      Specifies the model number of device that the VTL device emulates.
    - DeviceiSCSIAttributes (dict) –
      
      A list of iSCSI information about a VTL device.
      - TargetARN (string) –
        
        Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
      - NetworkInterfaceId (string) –
        
        The network interface identifier of the VTL device.
      - NetworkInterfacePort (integer) –
        
        The port used to communicate with iSCSI VTL device targets.
      - ChapEnabled (boolean) –
        
        Indicates whether mutual CHAP is enabled for the iSCSI target.
- Marker (string) –
  
  An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

Exceptions

Examples

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

response = client.describe_vtl_devices(
    GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    Limit=123,
    Marker='1',
    VTLDeviceARNs=[
    ],
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    'Marker': '1',
    'VTLDevices': [
        {
            'DeviceiSCSIAttributes': {
                'ChapEnabled': False,
                'NetworkInterfaceId': '10.243.43.207',
                'NetworkInterfacePort': 3260,
                'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger',
            },
            'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001',
            'VTLDeviceProductIdentifier': 'L700',
            'VTLDeviceType': 'Medium Changer',
            'VTLDeviceVendor': 'STK',
        },
        {
            'DeviceiSCSIAttributes': {
                'ChapEnabled': False,
                'NetworkInterfaceId': '10.243.43.209',
                'NetworkInterfacePort': 3260,
                'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01',
            },
            'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001',
            'VTLDeviceProductIdentifier': 'ULT3580-TD5',
            'VTLDeviceType': 'Tape Drive',
            'VTLDeviceVendor': 'IBM',
        },
        {
            'DeviceiSCSIAttributes': {
                'ChapEnabled': False,
                'NetworkInterfaceId': '10.243.43.209',
                'NetworkInterfacePort': 3260,
                'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02',
            },
            'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002',
            'VTLDeviceProductIdentifier': 'ULT3580-TD5',
            'VTLDeviceType': 'Tape Drive',
            'VTLDeviceVendor': 'IBM',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}