BackupGateway / Client / import_hypervisor_configuration

import_hypervisor_configuration#

BackupGateway.Client.import_hypervisor_configuration(**kwargs)#

Connect to a hypervisor by importing its configuration.

See also: AWS API Documentation

Request Syntax

response = client.import_hypervisor_configuration(
    Host='string',
    KmsKeyArn='string',
    Name='string',
    Password='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Username='string'
)
Parameters:

  • Host (string) –

    [REQUIRED]

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

  • KmsKeyArn (string) – The Key Management Service for the hypervisor.

  • Name (string) –

    [REQUIRED]

    The name of the hypervisor.

  • Password (string) – The password for the hypervisor.

  • Tags (list) –

    The tags of the hypervisor configuration to import.

    • (dict) –

      A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

      • Key (string) – [REQUIRED]

        The key part of a tag’s key-value pair. The key can’t start with aws:.

      • Value (string) – [REQUIRED]

        The value part of a tag’s key-value pair.

  • Username (string) – The username for the hypervisor.

Return type:

dict

Returns:

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) –

    • HypervisorArn (string) –

      The Amazon Resource Name (ARN) of the hypervisor you disassociated.

Exceptions

  • BackupGateway.Client.exceptions.ValidationException

  • BackupGateway.Client.exceptions.ConflictException

  • BackupGateway.Client.exceptions.InternalServerException

  • BackupGateway.Client.exceptions.AccessDeniedException

  • BackupGateway.Client.exceptions.ThrottlingException