[ aws . drs ]

describe-source-servers

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-source-servers is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: items

Synopsis

  describe-source-servers
--filters <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--filters (structure)

A set of filters by which to return Source Servers.

hardwareId -> (string)

An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.

sourceServerIDs -> (list)

An array of Source Servers IDs that should be returned. An empty array means all Source Servers.

(string)

Shorthand Syntax:

hardwareId=string,sourceServerIDs=string,string

JSON Syntax:

{
  "hardwareId": "string",
  "sourceServerIDs": ["string", ...]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

items -> (list)

An array of Source Servers.

(structure)

arn -> (string)

The ARN of the Source Server.

dataReplicationInfo -> (structure)

The Data Replication Info of the Source Server.

dataReplicationError -> (structure)

Error in data replication.

error -> (string)

Error in data replication.

rawError -> (string)

Error in data replication.

dataReplicationInitiation -> (structure)

Information about whether the data replication has been initiated.

nextAttemptDateTime -> (string)

The date and time of the next attempt to initiate data replication.

startDateTime -> (string)

The date and time of the current attempt to initiate data replication.

steps -> (list)

The steps of the current attempt to initiate data replication.

(structure)

Data replication initiation step.

name -> (string)

The name of the step.

status -> (string)

The status of the step.

dataReplicationState -> (string)

The state of the data replication.

etaDateTime -> (string)

An estimate of when the data replication will be completed.

lagDuration -> (string)

Data replication lag duration.

replicatedDisks -> (list)

The disks that should be replicated.

(structure)

A disk that should be replicated.

backloggedStorageBytes -> (long)

The size of the replication backlog in bytes.

deviceName -> (string)

The name of the device.

replicatedStorageBytes -> (long)

The amount of data replicated so far in bytes.

rescannedStorageBytes -> (long)

The amount of data to be rescanned in bytes.

totalStorageBytes -> (long)

The total amount of data to be replicated in bytes.

lastLaunchResult -> (string)

The status of the last recovery launch of this Source Server.

lifeCycle -> (structure)

The lifecycle information of this Source Server.

addedToServiceDateTime -> (string)

The date and time of when the Source Server was added to the service.

elapsedReplicationDuration -> (string)

The amount of time that the Source Server has been replicating for.

firstByteDateTime -> (string)

The date and time of the first byte that was replicated from the Source Server.

lastLaunch -> (structure)

An object containing information regarding the last launch of the Source Server.

initiated -> (structure)

An object containing information regarding the initiation of the last launch of a Source Server.

apiCallDateTime -> (string)

The date and time the last Source Server launch was initiated.

jobID -> (string)

The ID of the Job that was used to last launch the Source Server.

type -> (string)

The Job type that was used to last launch the Source Server.

lastSeenByServiceDateTime -> (string)

The date and time this Source Server was last seen by the service.

recoveryInstanceId -> (string)

The ID of the Recovery Instance associated with this Source Server.

sourceProperties -> (structure)

The source properties of the Source Server.

cpus -> (list)

An array of CPUs.

(structure)

Information about a server’s CPU.

cores -> (long)

The number of CPU cores.

modelName -> (string)

The model name of the CPU.

disks -> (list)

An array of disks.

(structure)

An object representing a data storage device on a server.

bytes -> (long)

The amount of storage on the disk in bytes.

deviceName -> (string)

The disk or device name.

identificationHints -> (structure)

Hints used to uniquely identify a machine.

awsInstanceID -> (string)

AWS Instance ID identification hint.

fqdn -> (string)

Fully Qualified Domain Name identification hint.

hostname -> (string)

Hostname identification hint.

vmWareUuid -> (string)

vCenter VM path identification hint.

lastUpdatedDateTime -> (string)

The date and time the Source Properties were last updated on.

networkInterfaces -> (list)

An array of network interfaces.

(structure)

Network interface.

ips -> (list)

Network interface IPs.

(string)

isPrimary -> (boolean)

Whether this is the primary network interface.

macAddress -> (string)

The MAC address of the network interface.

os -> (structure)

Operating system.

fullString -> (string)

The long name of the Operating System.

ramBytes -> (long)

The amount of RAM in bytes.

recommendedInstanceType -> (string)

The recommended EC2 instance type that will be used when recovering the Source Server.

sourceServerID -> (string)

The ID of the Source Server.

tags -> (map)

The tags associated with the Source Server.

key -> (string)

value -> (string)

nextToken -> (string)

The token of the next Source Server to retrieve.