package operations.v1

Get desktop application:
View/edit binary Protocol Buffers messages

OperationsService is a service responsible for executing operations in the IsardVDI infrastructure

• rpc ListHypervisors (ListHypervisorsRequest, ListHypervisorsResponse)

  operations.proto:8

  ListHypervisors returns a list with all the hypervisors and their resources

  message ListHypervisorsRequest

  operations.proto:72

  ListHypervisorsRequest is the request for the ListHypervisors method

  (message has no fields)

  message ListHypervisorsResponse

  operations.proto:75

  ListHypervisorsResponse is the response for the ListHypervisors method

  • repeated ListHypervisorsResponseHypervisor hypervisors = 1

    hypervisors contains all the hypervisors in the operations service

• rpc CreateHypervisor (CreateHypervisorRequest, stream CreateHypervisorResponse)

  operations.proto:10

  CreateHypervisor creates and adds a new hypervisor on the pool

  message CreateHypervisorRequest

  operations.proto:102

  CreateHypervisorRequest is the request for the CreateHypervisor method

  • string id = 1

    id is the ID of the hypervisor

  message CreateHypervisorResponse

  operations.proto:108

  CreateHypervisorResponse is the response for the CreateHypervisor method

  • OperationState state = 1

    state is the state of the operation

  • string msg = 2

    msg contains info related with the operation

• rpc CreateHypervisors (CreateHypervisorsRequest, stream CreateHypervisorsResponse)

  operations.proto:12

  CreateHypervisors creates and adds multiple new hypervisor on the pool

  message CreateHypervisorsRequest

  operations.proto:117

  CreateHypervisorsRequest is the request for the CreateHypervisors method

  • repeated string ids = 1

    ids are the IDs of the hypervisors

  message CreateHypervisorsResponse

  operations.proto:123

  CreateHypervisorsResponse is the response for the CreateHypervisors method

  • OperationState state = 1

    state is the state of the operation

  • string msg = 2

    msg contains info related with the operation

• rpc DestroyHypervisor (DestroyHypervisorRequest, stream DestroyHypervisorResponse)

  operations.proto:14

  DestroyHypervisor destroys a Hypervisor. It doesn't stop / migrate the running VMs or anything like that

  message DestroyHypervisorRequest

  operations.proto:132

  DestroyHypervisorRequest is the request for the DestroyHypervisor method

  • string id = 1

    id is the ID of the hypervisor

  message DestroyHypervisorResponse

  operations.proto:138

  DestroyHypervisorResponse is the response for the DestroyHypervisor method

  • OperationState state = 1

    state is the state of the operation

  • string msg = 2

    msg contains info related with the operation

• rpc DestroyHypervisors (DestroyHypervisorsRequest, stream DestroyHypervisorsResponse)

  operations.proto:16

  DestroyHypervisor destroys multiple Hypervisors. It doesn't stop / migrate the running VMs or anything like that

  message DestroyHypervisorsRequest

  operations.proto:147

  DestroyHypervisorsRequest is the request for the DestroyHypervisors method

  • repeated string ids = 1

    ids are the ID of the hypervisors

  message DestroyHypervisorsResponse

  operations.proto:153

  DestroyHypervisorsResponse is the response for the DestroyHypervisors method

  • OperationState state = 1

    state is the state of the operation

  • string msg = 2

    msg contains info related with the operation

• rpc ExpandStorage (ExpandStorageRequest, stream ExpandStorageResponse)

  operations.proto:19

  ExpandStorage adds more storage to the shared storage pool

  message ExpandStorageRequest

  operations.proto:162

  ExpandStorageRequest is the request for the ExpandStorage method

  • int32 min_bytes = 1

    min_bytes is the minimum number of bytes that the storage needs to be expanded

  message ExpandStorageResponse

  operations.proto:168

  ExpandStorageResponse is the response for the ExpandStorage method

  • OperationState state = 1

    state is the state of the operation

  • string msg = 2

    msg contains info related with the operation

• rpc ShrinkStorage (ShrinkStorageRequest, stream ShrinkStorageResponse)

  operations.proto:21

  ShrinkStorage removes storage from the shared storage pool

  message ShrinkStorageRequest

  operations.proto:177

  ShrinkStorageRequest is the request for the ShrinkStorage method

  • int32 max_bytes = 1

    max_bytes is the maximum number of bytes that the storage needs to be shrink

  message ShrinkStorageResponse

  operations.proto:183

  ShrinkStorageResponse is the response for the ShrinkStorage method

  • OperationState state = 1

    state is the state of the operation

  • string msg = 2

    msg contains info related with the operation

• rpc CreateBackup (CreateBackupRequest, stream CreateBackupResponse)

  operations.proto:24

  CreateBackup creates a new backup of the storage pool

  message CreateBackupRequest

  operations.proto:192

  CreateBackupRequest is the request for the CreateBackup method

  (message has no fields)

  message CreateBackupResponse

  operations.proto:195

  CreateBackupResponse is the response for the CreateBackup method

  • OperationState state = 1

    state is the state of the operation

  • string msg = 2

    msg contains info related with the operation

HypervisorCapabilites are the different capabilites that a hypervisor can have

Used in: ListHypervisorsResponseHypervisor

• HYPERVISOR_CAPABILITIES_UNSPECIFIED = 0

  default zero value

• HYPERVISOR_CAPABILITIES_STORAGE = 1

  HYPERVISOR_CAPABILITIES_STORAGE means the hypervisor has access to the shared storage pool

• HYPERVISOR_CAPABILITIES_GPU = 2

  HYPERVISOR_CAPABILITIES_GPU means the hypervisor has access to a GPU

HypervisorGPU is the representation of a GPU that an hypervisor can have

Used in: ListHypervisorsResponseHypervisor

• string brand = 1

  Brand is the brand of the GPU. This is probably going to be 'NVIDIA'

• string model = 2

  Model is the GPU model

HypervisorState are the different states that a operations hypervisor can be

Used in: ListHypervisorsResponseHypervisor

• HYPERVISOR_STATE_UNSPECIFIED = 0

  default zero value

• HYPERVISOR_STATE_UNKNOWN = 1

  HYPERVISOR_STATE_UNKNOWN

• HYPERVISOR_STATE_AVAILABLE_TO_CREATE = 2

  HYPERVISOR_STATE_AVAILABLE_TO_CREATE means the hypervisor can be created

• HYPERVISOR_STATE_AVAILABLE_TO_DESTROY = 3

  HYPERVISOR_STATE_AVAILABLE_TO_DESTROY means the hypervisor can be destroyed

ListHypervisorsResponseHypervisor is each hypervisor in the response of the ListHypervisors method

Used in: ListHypervisorsResponse

• string id = 1

  id is the ID of the hypervisor

• int32 cpu = 2

  cpu is the number of CPU threads that the machine has

• int32 ram = 3

  ram is the number of RAM that the machine has. It's in MB

• repeated HypervisorCapabilities capabilities = 4

  capabilities are the capabilities that the hypervisor has

• HypervisorState state = 5

  state is the state of the hypervisor

• repeated HypervisorGPU gpus = 6

  gpus are all the gpus that the hypervisor has available. If there are GPUs, the HYPERVISOR_CAPABILITIES_GPU needs to be set

OperationState are the different states that a operation can be

Used in: CreateBackupResponse, CreateHypervisorResponse, CreateHypervisorsResponse, DestroyHypervisorResponse, DestroyHypervisorsResponse, ExpandStorageResponse, ShrinkStorageResponse

• OPERATION_STATE_UNSPECIFIED = 0

  default zero value

• OPERATION_STATE_SCHEDULED = 1

  OPERATION_STATE_SCHEDULED means that the operation is queued, and it's going to be ran when it's its time

• OPERATION_STATE_ACTIVE = 2

  OPERATION_STATE_ACTIVE means that the operation is being executed

• OPERATION_STATE_FAILED = 3

  OPERATION_STATE_FAILED means the operation has failed

• OPERATION_STATE_COMPLETED = 4

  OPERATION_STATE_COMPLETED means the operation has finished successfully