mgn / Client / start_replication

start_replication

mgn.Client.start_replication(**kwargs)

Starts replication for SNAPSHOT_SHIPPING agents.

See also: AWS API Documentation

Request Syntax

response = client.start_replication(
    sourceServerID='string'
)

Parameters:

sourceServerID (string) –

[REQUIRED]

ID of source server on which to start replication.

Return type:

dict

Returns:

Response Syntax

{
    'applicationID': 'string',
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            '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',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            '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',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'lastSnapshotDateTime': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'fqdnForActionFramework': 'string',
    'isArchived': True|False,
    'launchedInstance': {
        'ec2InstanceID': 'string',
        'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
        'jobID': 'string'
    },
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastCutover': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'lastSeenByServiceDateTime': 'string',
        'lastTest': {
            'finalized': {
                'apiCallDateTime': 'string'
            },
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string'
            },
            'reverted': {
                'apiCallDateTime': 'string'
            }
        },
        'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
    },
    'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmPath': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'tags': {
        'string': 'string'
    },
    'userProvidedID': 'string',
    'vcenterClientID': 'string'
}

Response Structure

• (dict) –

  • applicationID (string) –

    Source server application ID.

  • arn (string) –

    Source server ARN.

  • dataReplicationInfo (dict) –

    Source server data replication info.

    • dataReplicationError (dict) –

      Error in obtaining data replication info.

      • error (string) –

        Error in data replication.

      • rawError (string) –

        Error in data replication.

    • dataReplicationInitiation (dict) –

      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.

        • (dict) –

          Data replication initiation 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 duration.

    • lastSnapshotDateTime (string) –

      Request to query data replication last snapshot time.

    • replicatedDisks (list) –

      Request to query disks replicated.

      • (dict) –

        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 (dict) –

    Source server launched instance.

    • ec2InstanceID (string) –

      Launched instance EC2 ID.

    • firstBoot (string) –

      Launched instance first boot.

    • jobID (string) –

      Launched instance Job ID.

  • lifeCycle (dict) –

    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 (dict) –

      Lifecycle last Cutover.

      • finalized (dict) –

        Lifecycle Cutover finalized date and time.

        • apiCallDateTime (string) –

          Lifecycle Cutover finalized date and time.

      • initiated (dict) –

        Lifecycle last Cutover initiated.

        • apiCallDateTime (string) –

        • jobID (string) –

          Lifecycle last Cutover initiated by Job ID.

      • reverted (dict) –

        Lifecycle last Cutover reverted.

        • apiCallDateTime (string) –

          Lifecycle last Cutover reverted API call date time.

    • lastSeenByServiceDateTime (string) –

      Lifecycle last seen date and time.

    • lastTest (dict) –

      Lifecycle last Test.

      • finalized (dict) –

        Lifecycle last Test finalized.

        • apiCallDateTime (string) –

          Lifecycle Test failed API call date and time.

      • initiated (dict) –

        Lifecycle last Test initiated.

        • apiCallDateTime (string) –

          Lifecycle last Test initiated API call date and time.

        • jobID (string) –

          Lifecycle last Test initiated Job ID.

      • reverted (dict) –

        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 (dict) –

    Source server properties.

    • cpus (list) –

      Source Server CPUs.

      • (dict) –

        Source server CPU information.

        • cores (integer) –

          The number of CPU cores on the source server.

        • modelName (string) –

          The source server’s CPU model name.

    • disks (list) –

      Source Server disks.

      • (dict) –

        The disk identifier.

        • bytes (integer) –

          The amount of storage on the disk in bytes.

        • deviceName (string) –

          The disk or device name.

    • identificationHints (dict) –

      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.

      • (dict) –

        Network interface.

        • ips (list) –

          Network interface IPs.

          • (string) –

        • isPrimary (boolean) –

          Network interface primary IP.

        • macAddress (string) –

          Network interface Mac address.

    • os (dict) –

      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 (dict) –

    Source server Tags.

    • (string) –

      • (string) –

  • userProvidedID (string) –

    Source server user provided ID.

  • vcenterClientID (string) –

    Source server vCenter client id.

Exceptions

• mgn.Client.exceptions.UninitializedAccountException

• mgn.Client.exceptions.ResourceNotFoundException

• mgn.Client.exceptions.ValidationException

• mgn.Client.exceptions.ServiceQuotaExceededException

• mgn.Client.exceptions.ConflictException