Method: Aws::Drs::Client#describe_source_servers

Defined in:

lib/aws-sdk-drs/client.rb

#describe_source_servers(params = {}) ⇒ Types::DescribeSourceServersResponse

Lists all Source Servers or multiple Source Servers filtered by ID.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.describe_source_servers({
  filters: {
    hardware_id: "BoundedString",
    source_server_i_ds: ["SourceServerID"],
    staging_account_i_ds: ["AccountID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure

resp.items #=> Array
resp.items[0].agent_version #=> String
resp.items[0].arn #=> String
resp.items[0].data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER"
resp.items[0].data_replication_info.data_replication_error.raw_error #=> String
resp.items[0].data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.items[0].data_replication_info.data_replication_initiation.start_date_time #=> String
resp.items[0].data_replication_info.data_replication_initiation.steps #=> Array
resp.items[0].data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.items[0].data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.items[0].data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.items[0].data_replication_info.eta_date_time #=> String
resp.items[0].data_replication_info.lag_duration #=> String
resp.items[0].data_replication_info.replicated_disks #=> Array
resp.items[0].data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].device_name #=> String
resp.items[0].data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].volume_status #=> String, one of "REGULAR", "CONTAINS_MARKETPLACE_PRODUCT_CODES", "MISSING_VOLUME_ATTRIBUTES", "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE", "PENDING"
resp.items[0].data_replication_info.staging_availability_zone #=> String
resp.items[0].data_replication_info.staging_outpost_arn #=> String
resp.items[0].last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.items[0].life_cycle.added_to_service_date_time #=> String
resp.items[0].life_cycle.elapsed_replication_duration #=> String
resp.items[0].life_cycle.first_byte_date_time #=> String
resp.items[0].life_cycle.last_launch.initiated.api_call_date_time #=> String
resp.items[0].life_cycle.last_launch.initiated.job_id #=> String
resp.items[0].life_cycle.last_launch.initiated.type #=> String, one of "RECOVERY", "DRILL"
resp.items[0].life_cycle.last_launch.status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.items[0].life_cycle.last_seen_by_service_date_time #=> String
resp.items[0].recovery_instance_id #=> String
resp.items[0].replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.items[0].reversed_direction_source_server_arn #=> String
resp.items[0].source_cloud_properties.origin_account_id #=> String
resp.items[0].source_cloud_properties.origin_availability_zone #=> String
resp.items[0].source_cloud_properties.origin_region #=> String
resp.items[0].source_cloud_properties.source_outpost_arn #=> String
resp.items[0].source_network_id #=> String
resp.items[0].source_properties.cpus #=> Array
resp.items[0].source_properties.cpus[0].cores #=> Integer
resp.items[0].source_properties.cpus[0].model_name #=> String
resp.items[0].source_properties.disks #=> Array
resp.items[0].source_properties.disks[0].bytes #=> Integer
resp.items[0].source_properties.disks[0].device_name #=> String
resp.items[0].source_properties.identification_hints.aws_instance_id #=> String
resp.items[0].source_properties.identification_hints.fqdn #=> String
resp.items[0].source_properties.identification_hints.hostname #=> String
resp.items[0].source_properties.identification_hints.vm_ware_uuid #=> String
resp.items[0].source_properties.last_updated_date_time #=> String
resp.items[0].source_properties.network_interfaces #=> Array
resp.items[0].source_properties.network_interfaces[0].ips #=> Array
resp.items[0].source_properties.network_interfaces[0].ips[0] #=> String
resp.items[0].source_properties.network_interfaces[0].is_primary #=> Boolean
resp.items[0].source_properties.network_interfaces[0].mac_address #=> String
resp.items[0].source_properties.os.full_string #=> String
resp.items[0].source_properties.ram_bytes #=> Integer
resp.items[0].source_properties.recommended_instance_type #=> String
resp.items[0].source_properties.supports_nitro_instances #=> Boolean
resp.items[0].source_server_id #=> String
resp.items[0].staging_area.error_message #=> String
resp.items[0].staging_area.staging_account_id #=> String
resp.items[0].staging_area.staging_source_server_arn #=> String
resp.items[0].staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :filters (Types::DescribeSourceServersRequestFilters) —

  A set of filters by which to return Source Servers.

• :max_results (Integer) —

  Maximum number of Source Servers to retrieve.

• :next_token (String) —

  The token of the next Source Server to retrieve.

Returns:

• (Types::DescribeSourceServersResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array<Types::SourceServer>

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-drs/client.rb', line 1632

def describe_source_servers(params = {}, options = {})
  req = build_request(:describe_source_servers, params)
  req.send_request(options)
end