--- title: "POST /DescribeSourceServers" method: POST path: "/DescribeSourceServers" --- # POST /DescribeSourceServers `POST /DescribeSourceServers` Retrieves all SourceServers or multiple SourceServers by ID. ## Query parameters - `maxResults` string - `nextToken` string ## Request body - object - `filters` object — Request to filter Source Servers list. - `applicationIDs` ApplicationID[] — Request to filter Source Servers list by application IDs. - `isArchived` boolean — Request to filter Source Servers list by archived. - `lifeCycleStates` LifeCycleState[] — Request to filter Source Servers list by life cycle states. - `replicationTypes` ReplicationType[] — Request to filter Source Servers list by replication type. - `sourceServerIDs` SourceServerID[] — Request to filter Source Servers list by Source Server ID. - `maxResults` integer — Request to filter Source Servers list by maximum results. - `nextToken` string — Request to filter Source Servers list by next token. ## Response `200` Success - DescribeSourceServersResponse - `items` SourceServer[] — Request to filter Source Servers list by item. - `applicationID` string — Source server application ID. - `arn` string — Source server ARN. - `dataReplicationInfo` object — Source server data replication info. - `dataReplicationError` object — Error in obtaining data replication info. - `error` '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' | 'UNSUPPORTED_VM_CONFIGURATION' | 'LAST_SNAPSHOT_JOB_FAILED' — Error in data replication. - `rawError` string — Error in data replication. - `dataReplicationInitiation` object — Request to query whether data replication has been initiated. - `nextAttemptDateTime` string — Request to query next data initiation date and time. - `startDateTime` string — Request to query data initiation start date and time. - `steps` DataReplicationInitiationStep[] — Request to query data initiation steps. - `name` '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' — Request to query data initiation step name. - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'SKIPPED' — Request to query data initiation status. - `dataReplicationState` 'STOPPED' | 'INITIATING' | 'INITIAL_SYNC' | 'BACKLOG' | 'CREATING_SNAPSHOT' | 'CONTINUOUS' | 'PAUSED' | 'RESCAN' | 'STALLED' | 'DISCONNECTED' | 'PENDING_SNAPSHOT_SHIPPING' | 'SHIPPING_SNAPSHOT' — Request to query the data replication state. - `etaDateTime` string — Request to query the time when data replication will be complete. - `lagDuration` string — Request to query data replication lag duration. - `lastSnapshotDateTime` string — Request to query data replication last snapshot time. - `replicatedDisks` DataReplicationInfoReplicatedDisk[] — Request to query disks replicated. - `backloggedStorageBytes` integer — Request to query data replication backlog size in bytes. - `deviceName` string — Request to query device name. - `replicatedStorageBytes` integer — Request to query amount of data replicated in bytes. - `rescannedStorageBytes` integer — Request to query amount of data rescanned in bytes. - `totalStorageBytes` integer — Request to query total amount of data replicated in bytes. - `fqdnForActionFramework` string — Source server fqdn for action framework. - `isArchived` boolean — Source server archived status. - `launchedInstance` object — Source server launched instance. - `ec2InstanceID` string — Launched instance EC2 ID. - `firstBoot` 'WAITING' | 'SUCCEEDED' | 'UNKNOWN' | 'STOPPED' — Launched instance first boot. - `jobID` string — Launched instance Job ID. - `lifeCycle` object — Source server lifecycle state. - `addedToServiceDateTime` string — Lifecycle added to service data and time. - `elapsedReplicationDuration` string — Lifecycle elapsed time and duration. - `firstByteDateTime` string — Lifecycle replication initiation date and time. - `lastCutover` object — Lifecycle last Cutover. - `finalized` object — Lifecycle Cutover finalized date and time. - `apiCallDateTime` string — Lifecycle Cutover finalized date and time. - `initiated` object — Lifecycle last Cutover initiated. - `apiCallDateTime` string —

- `jobID` string — Lifecycle last Cutover initiated by Job ID. - `reverted` object — Lifecycle last Cutover reverted. - `apiCallDateTime` string — Lifecycle last Cutover reverted API call date time. - `lastSeenByServiceDateTime` string — Lifecycle last seen date and time. - `lastTest` object — Lifecycle last Test. - `finalized` object — Lifecycle last Test finalized. - `apiCallDateTime` string — Lifecycle Test failed API call date and time. - `initiated` object — Lifecycle last Test initiated. - `apiCallDateTime` string — Lifecycle last Test initiated API call date and time. - `jobID` string — Lifecycle last Test initiated Job ID. - `reverted` object — Lifecycle last Test reverted. - `apiCallDateTime` string — Lifecycle last Test reverted API call date and time. - `state` 'STOPPED' | 'NOT_READY' | 'READY_FOR_TEST' | 'TESTING' | 'READY_FOR_CUTOVER' | 'CUTTING_OVER' | 'CUTOVER' | 'DISCONNECTED' | 'DISCOVERED' | 'PENDING_INSTALLATION' — Lifecycle state. - `replicationType` 'AGENT_BASED' | 'SNAPSHOT_SHIPPING' — Source server replication type. - `sourceProperties` object — Source server properties. - `cpus` CPU[] — Source Server CPUs. - `cores` integer — The number of CPU cores on the source server. - `modelName` string — The source server's CPU model name. - `disks` Disk[] — Source Server disks. - `bytes` integer — The amount of storage on the disk in bytes. - `deviceName` string — The disk or device name. - `identificationHints` object — Source server identification hints. - `awsInstanceID` string — AWS Instance ID identification hint. - `fqdn` string — FQDN address identification hint. - `hostname` string — Hostname identification hint. - `vmPath` string — vCenter VM path identification hint. - `vmWareUuid` string — vmWare UUID identification hint. - `lastUpdatedDateTime` string — Source server last update date and time. - `networkInterfaces` NetworkInterface[] — Source server network interfaces. - `ips` BoundedString[] — Network interface IPs. - `isPrimary` boolean — Network interface primary IP. - `macAddress` string — Network interface Mac address. - `os` object — Source server OS. - `fullString` string — OS full string. - `ramBytes` integer — Source server RAM in bytes. - `recommendedInstanceType` string — Source server recommended instance type. - `sourceServerID` string — Source server ID. - `tags` object — Source server Tags. - `userProvidedID` string — Source server user provided ID. - `vcenterClientID` string — Source server vCenter client id. - `nextToken` string — Request to filter Source Servers next token. ## Other responses - `480` — UninitializedAccountException - `481` — ValidationException --- [API](https://skmtc.net/aws/apis/mgn.md) · [All operations](https://skmtc.net/aws/apis/mgn/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/mgn/versions/71048ba96dc1/schema)