package check.v1

Get desktop application:
View/edit binary Protocol Buffers messages

CheckService is a service that checks if IsardVDI is running correctly

• rpc CheckIsardVDI (CheckIsardVDIRequest, CheckIsardVDIResponse)

  check.proto:8

  CheckIsardVDI checks a whole IsardVDI installation

  message CheckIsardVDIRequest

  check.proto:41

  CheckIsardVDIRequest contains the parameters requiered to run a check in a IsardVDI installation

  • string host = 1

    host is the IsardVDI host

  • optional Auth auth = 2

    auth is the authentication method

  • string template_id = 3

    tempalte_id is the tempalte ID of the template that is going to be used to check IsardVDI

  • bool fail_maintenance_mode = 4

    fail_maintenance_mode will fail the check if the maintenance mode is enabled

  • bool fail_self_signed = 5

    fail_self_signed will fail the check if it finds any self signed certificate

  message CheckIsardVDIResponse

  check.proto:65

  CheckIsardVDIResponse is the response of a IsardVDI check

  • string isardvdi_version = 1

    isardvdi_version is the version of the IsardVDI installation

  • bool maintenance_mode = 2

    maintenance_mode is whether the installation is on maintenance mode or not

  • string isardvdi_sdk_version = 3

    isardvdi_sdk_version is the version of the IsardVDI Go SDK (used to call the API)

  • optional DependenciesVersions dependencies_versions = 4

    dependencies_versions are the versions of the external programs used for the check

  • int32 hypervisor_num = 5

    hypervisor_num

• rpc CheckHypervisor (CheckHypervisorRequest, CheckHypervisorResponse)

  check.proto:10

  CheckHypervisor checks a specific hypervisor in a specific IsardVDI installation

  message CheckHypervisorRequest

  check.proto:80

  CheckHypervisorRequest contains the parameters requiered to run a check in a specific hypervisor

  • string host = 1

    host is the IsardVDI host

  • optional Auth auth = 2

    auth is the authentication method

  • string hypervisor_id = 3

    hypervisor_id is the ID of the hypervisor that is going to be checked

  • string template_id = 4

    tempalte_id is the tempalte ID of the template that is going to be used to check IsardVDI

  • bool fail_maintenance_mode = 5

    fail_maintenance_mode will fail the check if the maintenance mode is enabled

  • bool fail_self_signed = 6

    fail_self_signed will fail the check if it finds any self signed certificate

  message CheckHypervisorResponse

  check.proto:96

  CheckHypervisorResponse is the response of a hypervisor check

  • string isardvdi_version = 1

    isardvdi_version is the version of the IsardVDI installation

  • bool maintenance_mode = 2

    maintenance_mode is whether the installation is on maintenance mode or not

  • bool only_forced = 3

    only_forced is whether the hypervisor is in only forced mode

  • string isardvdi_sdk_version = 4

    isardvdi_sdk_version is the version of the IsardVDI Go SDK (used to call the API)

  • optional DependenciesVersions dependencies_versions = 5

    dependencies_versions are the versions of the external programs used for the check

Auth contains all the authentication methods supported

Used in: CheckHypervisorRequest, CheckIsardVDIRequest

• oneof method

  method is the method used for authentication

  • AuthForm form = 1

    form is the authentication through user + password

  • AuthToken token = 2

    token is the authentication using user ID + token

AuthForm is an authentication method using category + user + password

Used in: Auth

• string category = 1

  category is the category ID of the user

• string username = 2

  username is the username of the user

• string password = 3

  password is the password of the user

AuthToken is an authentication method that uses a token

Used in: Auth

• string token = 1

  token is the token used to authenticate the user

DependenciesVersions contains the versions of the programs used to check "external" features, such as the VPN, or the desktop viewers

Used in: CheckHypervisorResponse, CheckIsardVDIResponse

• string remmina = 1

  remmina is the version of the Remmina viewer used

• string remote_viewer = 2

  remote_viewer is the version of the Remote Viewer used

• string wireguard = 3

  wireguard is the version of WireGuard used