[ aws . drs ]

create-extended-source-server

Description

Create an extended source server in the target Account based on the source server in staging account.

See also: AWS API Documentation

Synopsis

  create-extended-source-server
--source-server-arn <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--source-server-arn (string) [required]

This defines the ARN of the source server in staging Account based on which you want to create an extended source server.

Constraints:

• min: 20
• max: 2048
• pattern: ^arn:(?:[0-9a-zA-Z_-]+:){3}([0-9]{12,}):source-server/(s-[0-9a-zA-Z]{17})$

--tags (map)

A list of tags associated with the extended source server.

key -> (string)

Constraints:

• min: 0
• max: 256

value -> (string)

Constraints:

• min: 0
• max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

sourceServer -> (structure)

Created extended source server.

agentVersion -> (string)

The version of the DRS agent installed on the source server

Constraints:

• pattern: ^[0-9]{1,5}.[0-9]{1,5}.[0-9]{1,5}(.[0-9]{4}.[0-9]{3}.[0-9]{4})?$

arn -> (string)

The ARN of the Source Server.

Constraints:

• min: 20
• max: 2048
• pattern: ^arn:.{16,2044}$

dataReplicationInfo -> (structure)

The Data Replication Info of the Source Server.

dataReplicationError -> (structure)

Error in data replication.

error -> (string)

Error in data replication.

Possible values:

• 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

rawError -> (string)

Error in data replication.

Constraints:

• min: 0
• max: 65536

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.

Constraints:

• min: 19
• max: 32
• pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

startDateTime -> (string)

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

Constraints:

• min: 19
• max: 32
• pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

steps -> (list)

The steps of the current attempt to initiate data replication.

(structure)

Data replication initiation step.

name -> (string)

The name of the step.

Possible values:

• 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

status -> (string)

The status of the step.

Possible values:

• NOT_STARTED
• IN_PROGRESS
• SUCCEEDED
• FAILED
• SKIPPED

dataReplicationState -> (string)

The state of the data replication.

Possible values:

• STOPPED
• INITIATING
• INITIAL_SYNC
• BACKLOG
• CREATING_SNAPSHOT
• CONTINUOUS
• PAUSED
• RESCAN
• STALLED
• DISCONNECTED

etaDateTime -> (string)

An estimate of when the data replication will be completed.

Constraints:

• min: 19
• max: 32
• pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

lagDuration -> (string)

Data replication lag duration.

Constraints:

• min: 1
• max: 64

replicatedDisks -> (list)

The disks that should be replicated.

Constraints:

• min: 0
• max: 60

(structure)

A disk that should be replicated.

backloggedStorageBytes -> (long)

The size of the replication backlog in bytes.

Constraints:

• min: 0

deviceName -> (string)

The name of the device.

Constraints:

• min: 0
• max: 256

replicatedStorageBytes -> (long)

The amount of data replicated so far in bytes.

Constraints:

• min: 0

rescannedStorageBytes -> (long)

The amount of data to be rescanned in bytes.

Constraints:

• min: 0

totalStorageBytes -> (long)

The total amount of data to be replicated in bytes.

Constraints:

• min: 0

volumeStatus -> (string)

The status of the volume.

Possible values:

• REGULAR
• CONTAINS_MARKETPLACE_PRODUCT_CODES
• MISSING_VOLUME_ATTRIBUTES
• MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE
• PENDING

stagingAvailabilityZone -> (string)

AWS Availability zone into which data is being replicated.

Constraints:

• min: 0
• max: 255
• pattern: ^(us(-gov)?|ap|ca|cn|eu|sa|af|me|il)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z]$

stagingOutpostArn -> (string)

The ARN of the staging Outpost

Constraints:

• min: 20
• max: 255
• pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$

lastLaunchResult -> (string)

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

Possible values:

• NOT_STARTED
• PENDING
• SUCCEEDED
• FAILED

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.

Constraints:

• min: 19
• max: 32
• pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

elapsedReplicationDuration -> (string)

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

Constraints:

• min: 1
• max: 64

firstByteDateTime -> (string)

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

Constraints:

• min: 19
• max: 32
• pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

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.

Constraints:

• min: 19
• max: 32
• pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

jobID -> (string)

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

Constraints:

• min: 24
• max: 24
• pattern: ^drsjob-[0-9a-zA-Z]{17}$

type -> (string)

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

Possible values:

• RECOVERY
• DRILL

status -> (string)

Status of Source Server’s last launch.

Possible values:

• PENDING
• IN_PROGRESS
• LAUNCHED
• FAILED
• TERMINATED

lastSeenByServiceDateTime -> (string)

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

Constraints:

• min: 19
• max: 32
• pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

recoveryInstanceId -> (string)

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

Constraints:

• min: 10
• max: 19
• pattern: ^i-[0-9a-fA-F]{8,}$

replicationDirection -> (string)

Replication direction of the Source Server.

Possible values:

• FAILOVER
• FAILBACK

reversedDirectionSourceServerArn -> (string)

For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.

Constraints:

• min: 20
• max: 2048
• pattern: ^arn:(?:[0-9a-zA-Z_-]+:){3}([0-9]{12,}):source-server/(s-[0-9a-zA-Z]{17})$

sourceCloudProperties -> (structure)

Source cloud properties of the Source Server.

originAccountID -> (string)

AWS Account ID for an EC2-originated Source Server.

Constraints:

• min: 12
• max: 12
• pattern: [0-9]{12,}

originAvailabilityZone -> (string)

AWS Availability Zone for an EC2-originated Source Server.

Constraints:

• min: 0
• max: 255
• pattern: ^(us(-gov)?|ap|ca|cn|eu|sa|af|me|il)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z]$

originRegion -> (string)

AWS Region for an EC2-originated Source Server.

Constraints:

• min: 0
• max: 255
• pattern: ^(us(-gov)?|ap|ca|cn|eu|sa|af|me|il)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]$

sourceOutpostArn -> (string)

The ARN of the source Outpost

Constraints:

• min: 20
• max: 255
• pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$

sourceNetworkID -> (string)

ID of the Source Network which is protecting this Source Server’s network.

Constraints:

• min: 20
• max: 20
• pattern: ^sn-[0-9a-zA-Z]{17}$

sourceProperties -> (structure)

The source properties of the Source Server.

cpus -> (list)

An array of CPUs.

Constraints:

• min: 0
• max: 256

(structure)

Information about a server’s CPU.

cores -> (long)

The number of CPU cores.

Constraints:

• min: 0

modelName -> (string)

The model name of the CPU.

Constraints:

• min: 0
• max: 256

disks -> (list)

An array of disks.

Constraints:

• min: 0
• max: 1000

(structure)

An object representing a data storage device on a server.

bytes -> (long)

The amount of storage on the disk in bytes.

Constraints:

• min: 0

deviceName -> (string)

The disk or device name.

Constraints:

• min: 0
• max: 256

identificationHints -> (structure)

Hints used to uniquely identify a machine.

awsInstanceID -> (string)

AWS Instance ID identification hint.

Constraints:

• min: 0
• max: 255
• pattern: ^i-[0-9a-fA-F]{8,}$

fqdn -> (string)

Fully Qualified Domain Name identification hint.

Constraints:

• min: 0
• max: 256

hostname -> (string)

Hostname identification hint.

Constraints:

• min: 0
• max: 256

vmWareUuid -> (string)

vCenter VM path identification hint.

Constraints:

• min: 0
• max: 256

lastUpdatedDateTime -> (string)

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

Constraints:

• min: 19
• max: 32
• pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

networkInterfaces -> (list)

An array of network interfaces.

Constraints:

• min: 0
• max: 32

(structure)

Network interface.

ips -> (list)

Network interface IPs.

(string)

Constraints:

• min: 0
• max: 256

isPrimary -> (boolean)

Whether this is the primary network interface.

macAddress -> (string)

The MAC address of the network interface.

Constraints:

• min: 0
• max: 256

os -> (structure)

Operating system.

fullString -> (string)

The long name of the Operating System.

Constraints:

• min: 0
• max: 256

ramBytes -> (long)

The amount of RAM in bytes.

Constraints:

• min: 0

recommendedInstanceType -> (string)

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

Constraints:

• min: 0
• max: 255

supportsNitroInstances -> (boolean)

Are EC2 nitro instance types supported when recovering the Source Server.

sourceServerID -> (string)

The ID of the Source Server.

Constraints:

• min: 19
• max: 19
• pattern: ^s-[0-9a-zA-Z]{17}$

stagingArea -> (structure)

The staging area of the source server.

errorMessage -> (string)

Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR

Constraints:

• min: 0
• max: 65536

stagingAccountID -> (string)

Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.

Constraints:

• min: 12
• max: 12
• pattern: [0-9]{12,}

stagingSourceServerArn -> (string)

Arn of the staging source server if this source server is extended

Constraints:

• min: 20
• max: 2048
• pattern: ^arn:.{16,2044}$

status -> (string)

Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.

Possible values:

• EXTENDED
• EXTENSION_ERROR
• NOT_EXTENDED

tags -> (map)

The tags associated with the Source Server.

key -> (string)

Constraints:

• min: 0
• max: 256

value -> (string)

Constraints:

• min: 0
• max: 256