<br />

Added: 18

## **PROTOCOLS**

## Controller

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=32)*

### ClearSyscallLogFilters

Clears all syscall log filters.
Added: HEAD

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_ClearSyscallLogFilters_Result` |

### GetJobHandle

Returns the job handle of the container.
Added: HEAD

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_GetJobHandle_Result` |

### GetVmoReferences

Returns all processes that have open files that are backed by a vmo with koid.
Added: HEAD

#### Request

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#ControllerGetVmoReferencesRequest` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_GetVmoReferences_Result` |

### SendSignal

Sends the provided signal to the process with the given pid.
Added: HEAD

#### Request

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#ControllerSendSignalRequest` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_SendSignal_Result` |

### SetSyscallLogFilter

Sets a filter to log syscalls at INFO level for processes matching `process_name`.
Added: HEAD

#### Request

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#ControllerSetSyscallLogFilterRequest` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_SetSyscallLogFilter_Result` |

### SpawnConsole

Spawn a console for debugging in the container. For testing, prefer launching Linux programs
as components with the `starnix_container` runner.

Returns when the console exits.

#### Request

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#ControllerSpawnConsoleRequest` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_SpawnConsole_Result` |

### VsockConnect

Connects `bridge_socket` to a vsocket at `port` in the container.

#### Request

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#ControllerVsockConnectRequest` |

## Info

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=113)*
Added: HEAD

<br />

### GetJobKoid

Returns the Zircon job KOID of the container.

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Info_GetJobKoid_Result` |

## **STRUCTS**

### ConsoleWindowSize

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=9)*

| Field | Type | Description | Default |
|---|---|---|---|
| `rows` | `uint16` |   | No default |
| `cols` | `uint16` |   | No default |
| `x_pixels` | `uint16` |   | No default |
| `y_pixels` | `uint16` |   | No default |

### Controller_ClearSyscallLogFilters_Response

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=85)*

\<EMPTY\>

### Controller_SendSignal_Response

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=73)*

\<EMPTY\>

### Controller_SetSyscallLogFilter_Response

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=80)*

\<EMPTY\>

### Controller_SpawnConsole_Response

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=50)*

| Field | Type | Description | Default |
|---|---|---|---|
| `exit_code` | `uint8` |   | No default |

## **ENUMS**

### SetSyscallLogFilterError [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

Type: `uint32`

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=89)*
Added: HEAD

<br />

| Name | Value | Description |
|---|---|---|
| ### MISSING_PROCESS_NAME | `1` | The process name was missing in the request. |

### SignalError [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

Type: `uint32`

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=95)*
Added: HEAD

<br />

| Name | Value | Description |
|---|---|---|
| ### INVALID_TARGET | `1` | Invalid target process. |
| ### INVALID_SIGNAL | `2` | Invalid signal. |

### SpawnConsoleError [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

Type: `uint32`

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=103)*

| Name | Value | Description |
|---|---|---|
| ### INVALID_ARGS | `1` | A required table field was missing or otherwise invalid. |
| ### CANCELED | `2` | The console process exited without a normal return code. |

## **TABLES**

### ControllerGetVmoReferencesRequest

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=56)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `koid` | `uint64` |   |

### ControllerSendSignalRequest

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=70)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `pid` | `int32` |   |
| ### 2 | `signal` | `uint64` |   |

### ControllerSetSyscallLogFilterRequest

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=77)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `process_name` | `string` | The process name (or substring) to match. |

### ControllerSpawnConsoleRequest [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=43)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `console_in` | `handle<socket>` |   |
| ### 2 | `console_out` | `handle<socket>` |   |
| ### 3 | `binary_path` | `string` |   |
| ### 4 | `argv` | `vector<string>` |   |
| ### 5 | `environ` | `vector<string>` |   |
| ### 6 | `window_size` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#ConsoleWindowSize` |   |

### ControllerVsockConnectRequest [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=34)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `port` | `uint32` |   |
| ### 2 | `bridge_socket` | `handle<socket>` |   |

### Controller_GetJobHandle_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=64)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `job` | `handle<job>` |   |

### Controller_GetVmoReferences_Response

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=58)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `references` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#VmoReference>` |   |

### Info_GetJobKoid_Response

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=115)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `koid` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Koid` |   |

### VmoReference

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=17)*
Added: HEAD

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `process_name` | `string` | The name of the process containing a file backed by the vmo. |
| ### 2 | `pid` | `uint64` | The Starnix pid of the process containing a file backed by the vmo. |
| ### 3 | `fd` | `int32` | The file descriptor number in the process that refers to the vmo. |
| ### 4 | `koid` | `uint64` | The koid of the vmo. |

## **UNIONS**

### Controller_ClearSyscallLogFilters_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=85)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_ClearSyscallLogFilters_Response` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

### Controller_GetJobHandle_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=64)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_GetJobHandle_Response` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

### Controller_GetVmoReferences_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=58)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_GetVmoReferences_Response` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

### Controller_SendSignal_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=73)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_SendSignal_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#SignalError` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

### Controller_SetSyscallLogFilter_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=80)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_SetSyscallLogFilter_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#SetSyscallLogFilterError` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

### Controller_SpawnConsole_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=50)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Controller_SpawnConsole_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#SpawnConsoleError` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

### Info_GetJobKoid_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.starnix.container/controller.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.starnix.container/controller.fidl;l=115)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.starnix.container#Info_GetJobKoid_Response` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />