BackupGateway / Client / test_hypervisor_configuration
test_hypervisor_configuration#
- BackupGateway.Client.test_hypervisor_configuration(**kwargs)#
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
See also: AWS API Documentation
Request Syntax
response = client.test_hypervisor_configuration( GatewayArn='string', Host='string', Password='string', Username='string' )
- Parameters:
GatewayArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
Host (string) –
[REQUIRED]
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Password (string) – The password for the hypervisor.
Username (string) – The username for the hypervisor.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
BackupGateway.Client.exceptions.ValidationException
BackupGateway.Client.exceptions.ConflictException
BackupGateway.Client.exceptions.InternalServerException
BackupGateway.Client.exceptions.ResourceNotFoundException
BackupGateway.Client.exceptions.ThrottlingException