package host

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Delete (DeedDeleteRequest, DeedDeleteResponse)

  host.proto:19

  Remove the deed

  message DeedDeleteRequest

  host.proto:431

  DEED ---- Delete

  • optional Deed deed = 1

  message DeedDeleteResponse

  host.proto:435

  (message has no fields)

• rpc GetHost (DeedGetHostRequest, DeedGetHostResponse)

  host.proto:22

  Returns the full host for these settings.

  message DeedGetHostRequest

  host.proto:438

  GetHost

  • optional Deed deed = 1

  message DeedGetHostResponse

  host.proto:442

  • optional Host host = 1

• rpc GetOwner (DeedGetOwnerRequest, DeedGetOwnerResponse)

  host.proto:25

  Returns the owner for these settings.

  message DeedGetOwnerRequest

  host.proto:447

  GetOwner

  • optional Deed deed = 1

  message DeedGetOwnerResponse

  host.proto:451

  • optional Owner owner = 1

• rpc AddComment (HostAddCommentRequest, HostAddCommentResponse)

  host.proto:30

  Add a comment on this host.

  message HostAddCommentRequest

  host.proto:457

  HOST ---- AddComment

  • optional Host host = 1

  • optional comment.Comment new_comment = 2

  message HostAddCommentResponse

  host.proto:462

  (message has no fields)

• rpc AddTags (HostAddTagsRequest, HostAddTagsResponse)

  host.proto:33

  Set a tag on this host.

  message HostAddTagsRequest

  host.proto:465

  AddTags

  • optional Host host = 1

  • repeated string tags = 2

  message HostAddTagsResponse

  host.proto:470

  (message has no fields)

• rpc Delete (HostDeleteRequest, HostDeleteResponse)

  host.proto:36

  Delete host.

  message HostDeleteRequest

  host.proto:473

  Delete

  • optional Host host = 1

  message HostDeleteResponse

  host.proto:477

  (message has no fields)

• rpc FindHost (HostFindHostRequest, HostFindHostResponse)

  host.proto:39

  Find a host by its name

  message HostFindHostRequest

  host.proto:480

  FindHost

  • string name = 1

  message HostFindHostResponse

  host.proto:484

  • optional Host host = 1

• rpc GetComments (HostGetCommentsRequest, HostGetCommentsResponse)

  host.proto:42

  Get the comments for this host.

  message HostGetCommentsRequest

  host.proto:489

  GetComments

  • optional Host host = 1

  message HostGetCommentsResponse

  host.proto:493

  • optional comment.CommentSeq comments = 1

• rpc GetDeed (HostGetDeedRequest, HostGetDeedResponse)

  host.proto:45

  Return the deed for this host.

  message HostGetDeedRequest

  host.proto:498

  GetDeed

  • optional Host host = 1

  message HostGetDeedResponse

  host.proto:502

  • optional Deed deed = 1

• rpc GetHost (HostGetHostRequest, HostGetHostResponse)

  host.proto:48

  Return a host by its id

  message HostGetHostRequest

  host.proto:507

  GetHost

  • string id = 1

  message HostGetHostResponse

  host.proto:511

  • optional Host host = 1

• rpc GetHosts (HostGetHostsRequest, HostGetHostsResponse)

  host.proto:51

  Search for a number of hosts

  message HostGetHostsRequest

  host.proto:516

  GetHosts

  • optional HostSearchCriteria r = 1

  message HostGetHostsResponse

  host.proto:520

  • optional HostSeq hosts = 1

• rpc GetHostWhiteboard (HostGetHostWhiteboardRequest, HostGetHostWhiteboardResponse)

  host.proto:54

  Return the host whiteboard

  message HostGetHostWhiteboardRequest

  host.proto:525

  GetHostWhiteboard

  (message has no fields)

  message HostGetHostWhiteboardResponse

  host.proto:527

  • optional NestedHostSeq nested_hosts = 1

• rpc GetOwner (HostGetOwnerRequest, HostGetOwnerResponse)

  host.proto:57

  Get the owner settings of this particular host.

  message HostGetOwnerRequest

  host.proto:532

  GetOwner

  • optional Host host = 1

  message HostGetOwnerResponse

  host.proto:536

  • optional Owner owner = 1

• rpc GetProcs (HostGetProcsRequest, HostGetProcsResponse)

  host.proto:60

  Returns the list of proc resources allocated from this host.

  message HostGetProcsRequest

  host.proto:541

  GetProcs

  • optional Host host = 1

  message HostGetProcsResponse

  host.proto:545

  • optional ProcSeq procs = 1

• rpc GetRenderPartitions (HostGetRenderPartitionsRequest, HostGetRenderPartitionsResponse)

  host.proto:63

  Return any render partitions that are setup on this host.

  message HostGetRenderPartitionsRequest

  host.proto:550

  GetRenderPartitions

  • optional Host host = 1

  message HostGetRenderPartitionsResponse

  host.proto:554

  • optional renderPartition.RenderPartitionSeq render_partitions = 1

• rpc Lock (HostLockRequest, HostLockResponse)

  host.proto:66

  Locks the host. Its possible we'll need to pass in a show name here in the future

  message HostLockRequest

  host.proto:559

  Lock

  • optional Host host = 1

  message HostLockResponse

  host.proto:563

  (message has no fields)

• rpc Reboot (HostRebootRequest, HostRebootResponse)

  host.proto:69

  Issues an immediate reboot.

  message HostRebootRequest

  host.proto:566

  Reboot

  • optional Host host = 1

  message HostRebootResponse

  host.proto:570

  (message has no fields)

• rpc RebootWhenIdle (HostRebootWhenIdleRequest, HostRebootWhenIdleResponse)

  host.proto:74

  Sets the reboot when idle state, nothing has to be locked to set this. When the host pings in idle a reboot command is sent to the host and the host will be put into the Rebooting state. If any locks are set they will be removed upon reboot.

  message HostRebootWhenIdleRequest

  host.proto:573

  RebootWhenIdle

  • optional Host host = 1

  message HostRebootWhenIdleResponse

  host.proto:577

  (message has no fields)

• rpc RedirectToJob (HostRedirectToJobRequest, HostRedirectToJobResponse)

  host.proto:77

  Redirect the given procs to the specified job.

  message HostRedirectToJobRequest

  host.proto:580

  RedirectToJob

  • optional Host host = 1

  • repeated string proc_names = 2

  • string job_id = 3

  message HostRedirectToJobResponse

  host.proto:586

  • bool value = 1

• rpc RemoveTags (HostRemoveTagsRequest, HostRemoveTagsResponse)

  host.proto:80

  Remove a tag from this host.

  message HostRemoveTagsRequest

  host.proto:591

  RemoveTags

  • optional Host host = 1

  • repeated string tags = 2

  message HostRemoveTagsResponse

  host.proto:596

  (message has no fields)

• rpc RenameTag (HostRenameTagRequest, HostRenameTagResponse)

  host.proto:83

  Rename tag.

  message HostRenameTagRequest

  host.proto:599

  RenameTag

  • optional Host host = 1

  • string old_tag = 2

  • string new_tag = 3

  message HostRenameTagResponse

  host.proto:605

  (message has no fields)

• rpc SetAllocation (HostSetAllocationRequest, HostSetAllocationResponse)

  host.proto:86

  Assign a host to an allocation.

  message HostSetAllocationRequest

  host.proto:608

  SetAllocation

  • optional Host host = 1

  • string allocation_id = 2

  message HostSetAllocationResponse

  host.proto:613

  (message has no fields)

• rpc SetHardwareState (HostSetHardwareStateRequest, HostSetHardwareStateResponse)

  host.proto:91

  Manually set the hardware state for the host. The hardware state may be changed automatically if the host pings in. If the hardware state is set to "Reimage", the state will not automatically change with a host ping, and must be manually set back to Up.

  message HostSetHardwareStateRequest

  host.proto:616

  SetHardwareState

  • optional Host host = 1

  • HardwareState state = 2

  message HostSetHardwareStateResponse

  host.proto:621

  (message has no fields)

• rpc SetOs (HostSetOsRequest, HostSetOsResponse)

  host.proto:94

  Set the name of the host operating system.

  message HostSetOsRequest

  host.proto:624

  SetOs

  • optional Host host = 1

  • string os = 2

  message HostSetOsResponse

  host.proto:629

  (message has no fields)

• rpc SetThreadMode (HostSetThreadModeRequest, HostSetThreadModeResponse)

  host.proto:97

  Changes the host's [ThreadMode]

  message HostSetThreadModeRequest

  host.proto:632

  SetThreadMode

  • optional Host host = 1

  • ThreadMode mode = 2

  message HostSetThreadModeResponse

  host.proto:637

  (message has no fields)

• rpc Unlock (HostUnlockRequest, HostUnlockResponse)

  host.proto:100

  Unlocks the host for booking if the proc is in the Locked state. You cannot unlock a NimbyLocked proc.

  message HostUnlockRequest

  host.proto:640

  Unlock

  • optional Host host = 1

  message HostUnlockResponse

  host.proto:644

  (message has no fields)

• rpc Delete (OwnerDeleteRequest, OwnerDeleteResponse)

  host.proto:105

  Deletes the owner record.

  message OwnerDeleteRequest

  host.proto:649

  OWNER ---- Delete

  • optional Owner owner = 1

  message OwnerDeleteResponse

  host.proto:653

  (message has no fields)

• rpc GetDeeds (OwnerGetDeedsRequest, OwnerGetDeedsResponse)

  host.proto:108

  Get a list of all deeds this owner has.

  message OwnerGetDeedsRequest

  host.proto:656

  GetDeeds

  • optional Owner owner = 1

  message OwnerGetDeedsResponse

  host.proto:660

  • optional DeedSeq deeds = 1

• rpc GetHosts (OwnerGetHostsRequest, OwnerGetHostsResponse)

  host.proto:111

  Get a list of all hosts this owner is responsible for.

  message OwnerGetHostsRequest

  host.proto:665

  GetHosts

  • optional Owner owner = 1

  message OwnerGetHostsResponse

  host.proto:669

  • optional HostSeq hosts = 1

• rpc GetOwner (OwnerGetOwnerRequest, OwnerGetOwnerResponse)

  host.proto:114

  Return an Owner record by name, id, or email.

  message OwnerGetOwnerRequest

  host.proto:674

  GetOwner

  • string name = 1

  message OwnerGetOwnerResponse

  host.proto:678

  • optional Owner owner = 1

• rpc SetShow (OwnerSetShowRequest, OwnerSetShowResponse)

  host.proto:117

  Sets the owners show.

  message OwnerSetShowRequest

  host.proto:683

  SetShow

  • optional Owner owner = 1

  • string show = 2

  message OwnerSetShowResponse

  host.proto:688

  (message has no fields)

• rpc TakeOwnership (OwnerTakeOwnershipRequest, OwnerTakeOwnershipResponse)

  host.proto:121

  Set the hosts new owner settings. Any host may have an owner, not just desktops. This allows direct control of the cores. By default hosts have no owner settings.

  message OwnerTakeOwnershipRequest

  host.proto:691

  TakeOwnership

  • optional Owner owner = 1

  • string host = 2

  message OwnerTakeOwnershipResponse

  host.proto:696

  (message has no fields)

• rpc ClearRedirect (ProcClearRedirectRequest, ProcClearRedirectResponse)

  host.proto:126

  Clears the redirect off of the proc so it dispatches naturally.

  message ProcClearRedirectRequest

  host.proto:700

  PROC --- ClearRedirect

  • optional Proc proc = 1

  message ProcClearRedirectResponse

  host.proto:704

  • bool value = 1

• rpc GetFrame (ProcGetFrameRequest, ProcGetFrameResponse)

  host.proto:129

  Returns the [Frame] running on the [Proc]

  message ProcGetFrameRequest

  host.proto:709

  GetFrame

  • optional Proc proc = 1

  message ProcGetFrameResponse

  host.proto:713

  • optional job.Frame frame = 1

• rpc GetHost (ProcGetHostRequest, ProcGetHostResponse)

  host.proto:132

  Returns the [Host] this [Proc] was allocated from.

  message ProcGetHostRequest

  host.proto:718

  GetHost

  • optional Proc proc = 1

  message ProcGetHostResponse

  host.proto:722

  • optional Host host = 1

• rpc GetJob (ProcGetJobRequest, ProcGetJobResponse)

  host.proto:135

  Returns the [Job] the [Proc] has been assigned to.

  message ProcGetJobRequest

  host.proto:727

  GetJob

  • optional Proc proc = 1

  message ProcGetJobResponse

  host.proto:731

  • optional job.Job job = 1

• rpc GetLayer (ProcGetLayerRequest, ProcGetLayerResponse)

  host.proto:138

  Returns the [Layer] the [Proc] has been assigned to.

  message ProcGetLayerRequest

  host.proto:736

  GetLayer

  • optional Proc proc = 1

  message ProcGetLayerResponse

  host.proto:740

  • optional job.Layer layer = 1

• rpc GetProcs (ProcGetProcsRequest, ProcGetProcsResponse)

  host.proto:141

  Return a list of procs matching the search

  message ProcGetProcsRequest

  host.proto:745

  GetProcs

  • optional ProcSearchCriteria r = 1

  message ProcGetProcsResponse

  host.proto:749

  • optional ProcSeq procs = 1

• rpc Kill (ProcKillRequest, ProcKillResponse)

  host.proto:144

  Sends a kill signal to the running process.

  message ProcKillRequest

  host.proto:754

  Kill

  • optional Proc proc = 1

  message ProcKillResponse

  host.proto:758

  (message has no fields)

• rpc RedirectToGroup (ProcRedirectToGroupRequest, ProcRedirectToGroupResponse)

  host.proto:149

  Unbooks and redriects the proc to the specified group. Optionally kills the proc immediately. Will overwrite an existing redirect. Return true if the redirect was a success. The redirect would fail in the event that the specified group does not have a suitable frame for the proc.

  message ProcRedirectToGroupRequest

  host.proto:761

  RedirectToGroup

  • optional Proc proc = 1

  • string group_id = 2

  • bool kill = 3

  message ProcRedirectToGroupResponse

  host.proto:767

  • bool value = 1

• rpc RedirectToJob (ProcRedirectToJobRequest, ProcRedirectToJobResponse)

  host.proto:153

  Unbooks and redriects the proc to the specified job. Optionally kills the proc immediately. Will overwrite an existing redirect. Return true if the redirect was a success. The redirect would fail in the event th

  message ProcRedirectToJobRequest

  host.proto:772

  RedirectToJob

  • optional Proc proc = 1

  • string job_id = 2

  • bool kill = 3

  message ProcRedirectToJobResponse

  host.proto:778

  • bool value = 1

• rpc Unbook (ProcUnbookRequest, ProcUnbookResponse)

  host.proto:157

  Unbooks this [Proc]. Unbooking means the [Proc] will automatically seek out a new [Job] when the current [Frame] is complete.

  message ProcUnbookRequest

  host.proto:783

  Unbook

  • optional Proc proc = 1

  • bool kill = 2

  message ProcUnbookResponse

  host.proto:788

  (message has no fields)

• rpc UnbookProcs (ProcUnbookProcsRequest, ProcUnbookProcsResponse)

  host.proto:161

  Unbooks procs that match the ProcSearchCriteria. This request can span jobs, shows, allocations, hosts etc. Set kill to true if the running frames should immediately be killed.

  message ProcUnbookProcsRequest

  host.proto:791

  UnbookProcs

  • optional ProcSearchCriteria r = 1

  • bool kill = 2

  message ProcUnbookProcsResponse

  host.proto:796

  • int32 num_procs = 1

• rpc UnbookToGroup (ProcUnbookToGroupRequest, ProcUnbookToGroupResponse)

  host.proto:166

  Unbooks procs that match the ProcSearchCriteria and books them on the specified group, assuming the group has layers that can take the procs. If the kill boolean is set to true, the operation happens immediately. If false, the proc will move after it finishes its current frame.

  message ProcUnbookToGroupRequest

  host.proto:812

  UnbookToGroup

  • optional ProcSearchCriteria r = 1

  • optional job.Group group = 2

  • bool kill = 3

  message ProcUnbookToGroupResponse

  host.proto:818

  • int32 num_procs = 1

• rpc UnbookToJob (ProcUnbookToJobRequest, ProcUnbookToJobResponse)

  host.proto:171

  Unbooks procs that match the ProcSearchCriteria and books them on the specified list of jobs, assuming those jobs have layers that can take the procs. If the kill boolean is set to true, the operation happens immediately. If false, the proc will move after it finishes its current frame.

  message ProcUnbookToJobRequest

  host.proto:801

  UnbookToJob

  • optional ProcSearchCriteria r = 1

  • optional job.JobSeq jobs = 2

  • bool kill = 3

  message ProcUnbookToJobResponse

  host.proto:807

  • int32 num_procs = 1

Used in: DeedDeleteRequest, DeedGetHostRequest, DeedGetOwnerRequest, DeedSeq, HostGetDeedResponse

• string id = 1

• string host = 2

• string owner = 3

• string show = 4

Used in: OwnerGetDeedsResponse, show.ShowGetDeedsResponse

• repeated Deed deeds = 1

Used in: HardwareStateSeq, Host, HostSetHardwareStateRequest, NestedHost, report.RenderHost

• UP = 0

• DOWN = 1

• REBOOTING = 2

• REBOOT_WHEN_IDLE = 3

• REPAIR = 4

Used in: HostSearchCriteria

• repeated HardwareState state = 1

Used in: DeedGetHostResponse, HostAddCommentRequest, HostAddTagsRequest, HostDeleteRequest, HostFindHostResponse, HostGetCommentsRequest, HostGetDeedRequest, HostGetHostResponse, HostGetOwnerRequest, HostGetProcsRequest, HostGetRenderPartitionsRequest, HostLockRequest, HostRebootRequest, HostRebootWhenIdleRequest, HostRedirectToJobRequest, HostRemoveTagsRequest, HostRenameTagRequest, HostSeq, HostSetAllocationRequest, HostSetHardwareStateRequest, HostSetOsRequest, HostSetThreadModeRequest, HostUnlockRequest, ProcGetHostResponse

• string id = 1

• string name = 2

• string alloc_name = 3

• bool nimby_enabled = 4

• bool has_comment = 5

• float cores = 6

• float idle_cores = 7

• int64 memory = 8

• int64 idle_memory = 9

• int64 gpu_memory = 10

• int64 idle_gpu_memory = 11

• int64 total_swap = 12

• int64 total_memory = 13

• int64 total_gpu_memory = 14

• int64 total_mcp = 15

• int64 free_swap = 16

• int64 free_memory = 17

• int64 free_mcp = 18

• int64 free_gpu_memory = 19

• int32 load = 20

• int32 boot_time = 21

• int32 ping_time = 22

• string os = 23

• repeated string tags = 24

• HardwareState state = 25

• LockState lock_state = 26

• ThreadMode thread_mode = 27

• float gpus = 28

• float idle_gpus = 29

Used in: facility.AllocFindHostsRequest, HostGetHostsRequest

• repeated string hosts = 1

• repeated string regex = 2

• repeated string substr = 3

• repeated string ids = 4

• repeated string allocs = 5

• optional HardwareStateSeq states = 6

• optional LockStateSeq lock_states = 7

Used in: facility.AllocFindHostsResponse, facility.AllocGetHostsResponse, facility.AllocReparentHostsRequest, HostGetHostsResponse, OwnerGetHostsResponse

• repeated Host hosts = 1

• MANUAL = 0

• HARDWARE = 1

• ALLOC = 2

• HOSTNAME = 3

Used in: Host, LockStateSeq, NestedHost

• OPEN = 0

• LOCKED = 1

• NIMBY_LOCKED = 2

Used in: HostSearchCriteria

• repeated LockState state = 1

Used in: NestedHostSeq, NestedProc

• string id = 1

• string name = 2

• string alloc_name = 3

• bool nimby_enabled = 4

• bool has_comment = 5

• float cores = 6

• float idle_cores = 7

• int64 memory = 8

• int64 idle_memory = 9

• int64 gpu_memory = 10

• int64 idle_gpu_memory = 11

• int64 total_swap = 12

• int64 total_memory = 13

• int64 total_gpu_memory = 14

• int64 total_mcp = 15

• int64 free_swap = 16

• int64 free_memory = 17

• int64 free_mcp = 18

• int64 free_gpu_memory = 19

• int32 load = 20

• int32 boot_time = 21

• int32 ping_time = 22

• string os = 23

• repeated string tags = 24

• HardwareState state = 25

• LockState lock_state = 26

• ThreadMode thread_mode = 27

• optional NestedProcSeq procs = 28

• float gpus = 29

• float idle_gpus = 30

Used in: HostGetHostWhiteboardResponse

• repeated NestedHost nested_hosts = 1

Used in: NestedProcSeq

• string id = 1

• string name = 2

• string show_name = 3

• string job_name = 4

• string frame_name = 5

• string group_name = 6

• int32 ping_time = 7

• int32 bookedTime = 8

• int32 dispatch_time = 9

• int64 reserved_memory = 10

• int64 reserved_gpu_memory = 11

• int64 used_memory = 12

• float reserved_cores = 13

• bool unbooked = 14

• string log_path = 15

• string redirect_target = 16

• repeated string services = 17

• optional NestedHost parent = 18

• int64 used_gpu_memory = 19

• float reserved_gpus = 20

Used in: NestedHost

• repeated NestedProc nested_procs = 1

Used in: DeedGetOwnerResponse, HostGetOwnerResponse, OwnerDeleteRequest, OwnerGetDeedsRequest, OwnerGetHostsRequest, OwnerGetOwnerResponse, OwnerSetShowRequest, OwnerTakeOwnershipRequest, show.ShowCreateOwnerResponse

• string id = 1

• string name = 2

• string show = 3

• int32 host_count = 4

Used in: ProcClearRedirectRequest, ProcGetFrameRequest, ProcGetHostRequest, ProcGetJobRequest, ProcGetLayerRequest, ProcKillRequest, ProcRedirectToGroupRequest, ProcRedirectToJobRequest, ProcSeq, ProcUnbookRequest

• string id = 1

• string name = 2

• string show_name = 3

• string job_name = 4

• string frame_name = 5

• string group_name = 6

• int32 ping_time = 7

• int32 bookedTime = 8

• int32 dispatch_time = 9

• int64 reserved_memory = 10

• int64 reserved_gpu_memory = 11

• int64 used_memory = 12

• float reserved_cores = 13

• bool unbooked = 14

• string log_path = 15

• string redirect_target = 16

• repeated string services = 17

• int64 used_gpu_memory = 18

• float reserved_gpus = 19

• bytes child_processes = 20

Used in: ProcGetProcsRequest, ProcUnbookProcsRequest, ProcUnbookToGroupRequest, ProcUnbookToJobRequest

• repeated string hosts = 1

  An array of host names to match.

• repeated string jobs = 2

  An array of job names to match.

• repeated string layers = 3

  An array of layer names to match.

• repeated string shows = 4

  An array of show names to match.

• repeated string allocs = 5

  An array of allocation names to match.

• repeated criterion.InRangeIntegerSearchCriterion memory_range = 6

  A range of memory usage. Values are in KB.

• repeated criterion.GreaterThanIntegerSearchCriterion memory_greater_than = 10

  Less than memory usage. Values are in KB.

• repeated criterion.GreaterThanIntegerSearchCriterion memory_less_than = 11

  Greater than memory usage. Values are in KB.

• repeated criterion.InRangeIntegerSearchCriterion duration_range = 7

  A duration range. Values are in seconds.

• repeated int32 max_results = 8

  The maximum number of results.

• int32 first_result = 9

  The offset of the first result.

Used in: HostGetProcsResponse, ProcGetProcsResponse

• repeated Proc procs = 1

Proc redirects can have two different types of destinations, jobs and groups.

• JOB_REDIRECT = 0

• GROUP_REDIRECT = 1

Defines the possible states for a core or proc

• IDLE = 0

  Entity is idle, which means it can be booked.

• BOOKED = 1

  Entity is booked, which means its in use on a render proc

Used in: Host, HostSetThreadModeRequest, NestedHost

• AUTO = 0

  Auto determines the number of threads to use automatically based on the amount of memory used by the frame.

• ALL = 1

  All always uses all of the cores available on the proc. These hosts are always booked on threadable layers.

• VARIABLE = 2

  All mode during the day, auto-mode at night.