:doc:`BackupGateway <../../backup-gateway>` / Client / test_hypervisor_configuration

*****************************
test_hypervisor_configuration
*****************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TestHypervisorConfiguration>`_  


  **Request Syntax**
  ::

    response = client.test_hypervisor_configuration(
        GatewayArn='string',
        Host='string',
        Password='string',
        Username='string'
    )
    
  :type GatewayArn: string
  :param GatewayArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.

    

  
  :type Host: string
  :param Host: **[REQUIRED]** 

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

    

  
  :type Password: string
  :param Password: 

    The password for the hypervisor.

    

  
  :type Username: string
  :param Username: 

    The username for the hypervisor.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`BackupGateway.Client.exceptions.ValidationException`

  
  *   :py:class:`BackupGateway.Client.exceptions.ConflictException`

  
  *   :py:class:`BackupGateway.Client.exceptions.InternalServerException`

  
  *   :py:class:`BackupGateway.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`BackupGateway.Client.exceptions.ThrottlingException`

  