mark-as-archived¶
Description¶
Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle.state which equals DISCONNECTED or CUTOVER.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
mark-as-archived
--source-server-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--source-server-id (string)
Mark as archived by Source Server ID.
--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.
--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¶
arn -> (string)
Source server ARN.
dataReplicationInfo -> (structure)
Source server data replication info.
dataReplicationError -> (structure)
Error in obtaining data replication info.
error -> (string)
Error in data replication.
rawError -> (string)
Error in data replication.
dataReplicationInitiation -> (structure)
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 -> (list)
Request to query data initiation steps.
(structure)
Data replication intiation step.
name -> (string)
Request to query data initiation step name.
status -> (string)
Request to query data initiation status.
dataReplicationState -> (string)
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 durating.
lastSnapshotDateTime -> (string)
Request to query data replication last snapshot time.
replicatedDisks -> (list)
Request to query disks replicated.
(structure)
Request to query disks replicated.
backloggedStorageBytes -> (long)
Request to query data replication backlog size in bytes.
deviceName -> (string)
Request to query device name.
replicatedStorageBytes -> (long)
Request to query amount of data replicated in bytes.
rescannedStorageBytes -> (long)
Request to query amount of data rescanned in bytes.
totalStorageBytes -> (long)
Request to query total amount of data replicated in bytes.
isArchived -> (boolean)
Source server archived status.
launchedInstance -> (structure)
Source server launched instance.
ec2InstanceID -> (string)
Configure launced instance EC2 ID.
firstBoot -> (string)
Configure launced instance first boot.
jobID -> (string)
Configure launced instance Job ID.
lifeCycle -> (structure)
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 -> (structure)
Lifecycle last Cutover.
finalized -> (structure)
Lifecycle Cutover finalized date and time.
apiCallDateTime -> (string)
Lifecycle Cutover finalized date and time.
initiated -> (structure)
Lifecycle last Cutover initiated.
apiCallDateTime -> (string)
jobID -> (string)
Lifecycle last Cutover initiated by Job ID.
reverted -> (structure)
Lifecycle last Cutover reverted.
apiCallDateTime -> (string)
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime -> (string)
Lifecycle last seen date and time.
lastTest -> (structure)
Lifecycle last Test.
finalized -> (structure)
Lifecycle last Test finlized.
apiCallDateTime -> (string)
Lifecycle Test failed API call date and time.
initiated -> (structure)
Lifecycle last Test initiated.
apiCallDateTime -> (string)
Lifecycle last Test initiated API call date and time.
jobID -> (string)
Lifecycle last Test initiated Job ID.
reverted -> (structure)
Lifecycle last Test reverted.
apiCallDateTime -> (string)
Lifecycle last Test reverted API call date and time.
state -> (string)
Lifecycle state.
replicationType -> (string)
Source server replication type.
sourceProperties -> (structure)
Source server properties.
cpus -> (list)
Source Server CPUs.
(structure)
Source server CPU information.
cores -> (long)
The number of CPU cores on the source server.
modelName -> (string)
The source server’s CPU model name.
disks -> (list)
Source Server disks.
(structure)
The disk identifier.
bytes -> (long)
The amount of storage on the disk in bytes.
deviceName -> (string)
The disk or device name.
identificationHints -> (structure)
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 -> (list)
Source server network interfaces.
(structure)
Network interface.
ips -> (list)
Network interface IPs.
(string)
isPrimary -> (boolean)
Network interface primary IP.
macAddress -> (string)
Network interface Mac address.
os -> (structure)
Source server OS.
fullString -> (string)
OS full string.
ramBytes -> (long)
Source server RAM in bytes.
recommendedInstanceType -> (string)
Source server recommended instance type.
sourceServerID -> (string)
Source server ID.
tags -> (map)
Source server Tags.
key -> (string)
value -> (string)
vcenterClientID -> (string)
Source server vCenter client id.