Project: /_project.yaml Book: /_book.yaml

fuchsia.net.dhcp

PROTOCOLS

Client {:#Client}

Defined in fuchsia.net.dhcp/client.fidl

Client provides control operations on a DHCP client.

Start {:#Start}

Start runs the DHCP client represented by this protocol.

Errors

In the case that the interface this client represents no longer exists, the server end of this protocol's channel will be closed.

Start returns no other errors currently, but callers should check the error value in case new errors are returned in the future.

Request

Response

Stop {:#Stop}

Stops the DHCP client (if it is running).

Errors

In the case that the interface this client represents no longer exists, the server end of this protocol's channel will be closed.

Stop returns no other errors currently, but callers should check the error value in case new errors are returned in the future.

Request

Response

Server {:#Server}

Defined in fuchsia.net.dhcp/server.fidl

Provides methods for DHCP Server configuration.

GetOption {:#GetOption}

Returns the requested Option if it is supported.

  • request code the code of an Option whose value has been requested.
  • response value the value of the requested Option.
  • error a zx.status indicating why the value could not be retrieved.

Request

Response

GetParameter {:#GetParameter}

Returns the requested Parameter if it is supported.

  • request name the name of a Parameter whose value has been requested.
  • response value the value of the requested Parameter.
  • error a zx.status indicating why the value could not be retrieved.

Request

Response

SetOption {:#SetOption}

Sets the Option to the argument. Each SetOption call is treated as its own atomic transaction. On success, a SetOption will take effect immediately.

  • request value an Option whose value will be set to the value of this argument.
  • error a zx.status indicating the cause of failure.

Request

Response

SetParameter {:#SetParameter}

Sets the Parameter to the argument. Each SetParameter call is treated as its own atomic transaction. On success, a SetParameter will take effect immediately.

  • request value a Parameter whose value will be set to the value of this argument.
  • error a zx.status indicating the cause of failure.

Request

Response

ListOptions {:#ListOptions}

Lists all DHCP options for which the Server has a value. Any option which does not have a value will be omitted from the returned list. ListOptions provides administrators a means to print a server's configuration as opposed to querying the value of a single Option.

  • response options a vector containing all of the options for which the Server has a value. Bounded to 256 as options are identified by a 1 octet code and 256 is the maximum number of such codes.
  • error a zx.status indicating the cause of failure.

Request

Response

ListParameters {:#ListParameters}

Lists all DHCP server parameters. ListParameters provides administrators a means to print a server's configuration as opposed to querying the value of a single Parameter.

  • response parameter a vector containing the values of all of the Server's parameters. Bounded to 256 to provide a generous upper limit on the number of server parameters while being of the same size as ListOptions.
  • error a zx.status indicating the cause of failure.

Request

Response

Client {:#Client}

Defined in fuchsia.net.dhcp/client.fidl

Client provides control operations on a DHCP client.

Start {:#Start}

Start runs the DHCP client represented by this protocol.

Errors

In the case that the interface this client represents no longer exists, the server end of this protocol's channel will be closed.

Start returns no other errors currently, but callers should check the error value in case new errors are returned in the future.

Request

Response

Stop {:#Stop}

Stops the DHCP client (if it is running).

Errors

In the case that the interface this client represents no longer exists, the server end of this protocol's channel will be closed.

Stop returns no other errors currently, but callers should check the error value in case new errors are returned in the future.

Request

Response

Server {:#Server}

Defined in fuchsia.net.dhcp/server.fidl

Provides methods for DHCP Server configuration.

GetOption {:#GetOption}

Returns the requested Option if it is supported.

  • request code the code of an Option whose value has been requested.
  • response value the value of the requested Option.
  • error a zx.status indicating why the value could not be retrieved.

Request

Response

GetParameter {:#GetParameter}

Returns the requested Parameter if it is supported.

  • request name the name of a Parameter whose value has been requested.
  • response value the value of the requested Parameter.
  • error a zx.status indicating why the value could not be retrieved.

Request

Response

SetOption {:#SetOption}

Sets the Option to the argument. Each SetOption call is treated as its own atomic transaction. On success, a SetOption will take effect immediately.

  • request value an Option whose value will be set to the value of this argument.
  • error a zx.status indicating the cause of failure.

Request

Response

SetParameter {:#SetParameter}

Sets the Parameter to the argument. Each SetParameter call is treated as its own atomic transaction. On success, a SetParameter will take effect immediately.

  • request value a Parameter whose value will be set to the value of this argument.
  • error a zx.status indicating the cause of failure.

Request

Response

ListOptions {:#ListOptions}

Lists all DHCP options for which the Server has a value. Any option which does not have a value will be omitted from the returned list. ListOptions provides administrators a means to print a server's configuration as opposed to querying the value of a single Option.

  • response options a vector containing all of the options for which the Server has a value. Bounded to 256 as options are identified by a 1 octet code and 256 is the maximum number of such codes.
  • error a zx.status indicating the cause of failure.

Request

Response

ListParameters {:#ListParameters}

Lists all DHCP server parameters. ListParameters provides administrators a means to print a server's configuration as opposed to querying the value of a single Parameter.

  • response parameter a vector containing the values of all of the Server's parameters. Bounded to 256 to provide a generous upper limit on the number of server parameters while being of the same size as ListOptions.
  • error a zx.status indicating the cause of failure.

Request

Response

STRUCTS

Client_Start_Response {:#Client_Start_Response}

generated

Client_Stop_Response {:#Client_Stop_Response}

generated

Server_GetOption_Response {:#Server_GetOption_Response}

generated

Server_GetParameter_Response {:#Server_GetParameter_Response}

generated

Server_SetOption_Response {:#Server_SetOption_Response}

generated

Server_SetParameter_Response {:#Server_SetParameter_Response}

generated

Server_ListOptions_Response {:#Server_ListOptions_Response}

generated

Server_ListParameters_Response {:#Server_ListParameters_Response}

generated

Client_Start_Response {:#Client_Start_Response}

generated

Client_Stop_Response {:#Client_Stop_Response}

generated

Server_GetOption_Response {:#Server_GetOption_Response}

generated

Server_GetParameter_Response {:#Server_GetParameter_Response}

generated

Server_SetOption_Response {:#Server_SetOption_Response}

generated

Server_SetParameter_Response {:#Server_SetParameter_Response}

generated

Server_ListOptions_Response {:#Server_ListOptions_Response}

generated

Server_ListParameters_Response {:#Server_ListParameters_Response}

generated

ENUMS

OptionOverloadValue {:#OptionOverloadValue}

Type: uint8

Defined in fuchsia.net.dhcp/options.fidl

A indication of which DHCP message field should be used to store additional options.

MessageType {:#MessageType}

Type: uint8

Defined in fuchsia.net.dhcp/options.fidl

The type of DHCP message. The DHCP protocol requires that all messages identify their type by including the MessageType option. These values are specified in https://tools.ietf.org/html/rfc2132#section-9.6.

OptionCode {:#OptionCode}

Type: uint32

Defined in fuchsia.net.dhcp/options.fidl

The code of a DHCP option to be retrieved by Server.GetOption(). The code values are from https://tools.ietf.org/html/rfc2132 and the enum variants have been listed in the order they are presented in the RFC.

ParameterName {:#ParameterName}

Type: uint32

Defined in fuchsia.net.dhcp/server.fidl

The name of the Parameter to be retrieved by Server.GetParameter().

OptionOverloadValue {:#OptionOverloadValue}

Type: uint8

Defined in fuchsia.net.dhcp/options.fidl

A indication of which DHCP message field should be used to store additional options.

MessageType {:#MessageType}

Type: uint8

Defined in fuchsia.net.dhcp/options.fidl

The type of DHCP message. The DHCP protocol requires that all messages identify their type by including the MessageType option. These values are specified in https://tools.ietf.org/html/rfc2132#section-9.6.

OptionCode {:#OptionCode}

Type: uint32

Defined in fuchsia.net.dhcp/options.fidl

The code of a DHCP option to be retrieved by Server.GetOption(). The code values are from https://tools.ietf.org/html/rfc2132 and the enum variants have been listed in the order they are presented in the RFC.

ParameterName {:#ParameterName}

Type: uint32

Defined in fuchsia.net.dhcp/server.fidl

The name of the Parameter to be retrieved by Server.GetParameter().

TABLES

AddressPool {:#AddressPool}

Defined in fuchsia.net.dhcp/server.fidl

The pool of addresses managed by a DHCP server and from which leases are supplied.

LeaseLength {:#LeaseLength}

Defined in fuchsia.net.dhcp/server.fidl

The duration of leases offered by the server.

StaticAssignment {:#StaticAssignment}

Defined in fuchsia.net.dhcp/server.fidl

A static IP address assignment for a host or device on the network managed by Server.

AddressPool {:#AddressPool}

Defined in fuchsia.net.dhcp/server.fidl

The pool of addresses managed by a DHCP server and from which leases are supplied.

LeaseLength {:#LeaseLength}

Defined in fuchsia.net.dhcp/server.fidl

The duration of leases offered by the server.

StaticAssignment {:#StaticAssignment}

Defined in fuchsia.net.dhcp/server.fidl

A static IP address assignment for a host or device on the network managed by Server.

UNIONS

Client_Start_Result {:#Client_Start_Result}

generated

Client_Stop_Result {:#Client_Stop_Result}

generated

Server_GetOption_Result {:#Server_GetOption_Result}

generated

Server_GetParameter_Result {:#Server_GetParameter_Result}

generated

Server_SetOption_Result {:#Server_SetOption_Result}

generated

Server_SetParameter_Result {:#Server_SetParameter_Result}

generated

Server_ListOptions_Result {:#Server_ListOptions_Result}

generated

Server_ListParameters_Result {:#Server_ListParameters_Result}

generated

Client_Start_Result {:#Client_Start_Result}

generated

Client_Stop_Result {:#Client_Stop_Result}

generated

Server_GetOption_Result {:#Server_GetOption_Result}

generated

Server_GetParameter_Result {:#Server_GetParameter_Result}

generated

Server_SetOption_Result {:#Server_SetOption_Result}

generated

Server_SetParameter_Result {:#Server_SetParameter_Result}

generated

Server_ListOptions_Result {:#Server_ListOptions_Result}

generated

Server_ListParameters_Result {:#Server_ListParameters_Result}

generated

XUNIONS

Option {:#Option}

Defined in fuchsia.net.dhcp/options.fidl

A generic representation of client configuration parameters and DHCP settings. Options are the mechanism by which the DHCP protocol communicates configuration parameters from a repository on a DHCP server to DHCP clients, or by which DHCP clients and servers communicate data relevant to a DHCP transaction. All DHCP option values must have a length which can fit within a single byte, i.e. less than 256. Options for which there is no reasonable administrator-configurable value have been omitted from this xunion. The omitted options are:

  • Pad - never has a value
  • End - never has a value
  • RequestedIpAddress - value always selected by the DHCP client.
  • DhcpMessageType - value always determined by state of transaction between DHCP client and server.
  • ServerIdentifier - value always determined by address to which the server is bound.
  • ParameterRequestList - value always selected by the DHCP client.
  • Message - value determined in response to runtime error.
  • VendorClassIdentifer - value always selected by the DHCP client.
  • ClientIdentifier - value always selected by the DHCP client.

Parameter {:#Parameter}

Defined in fuchsia.net.dhcp/server.fidl

The configurable server parameters.

Option {:#Option}

Defined in fuchsia.net.dhcp/options.fidl

A generic representation of client configuration parameters and DHCP settings. Options are the mechanism by which the DHCP protocol communicates configuration parameters from a repository on a DHCP server to DHCP clients, or by which DHCP clients and servers communicate data relevant to a DHCP transaction. All DHCP option values must have a length which can fit within a single byte, i.e. less than 256. Options for which there is no reasonable administrator-configurable value have been omitted from this xunion. The omitted options are:

  • Pad - never has a value
  • End - never has a value
  • RequestedIpAddress - value always selected by the DHCP client.
  • DhcpMessageType - value always determined by state of transaction between DHCP client and server.
  • ServerIdentifier - value always determined by address to which the server is bound.
  • ParameterRequestList - value always selected by the DHCP client.
  • Message - value determined in response to runtime error.
  • VendorClassIdentifer - value always selected by the DHCP client.
  • ClientIdentifier - value always selected by the DHCP client.

Parameter {:#Parameter}

Defined in fuchsia.net.dhcp/server.fidl

The configurable server parameters.

BITS

NodeTypes {:#NodeTypes}

Type: uint8

NodeTypes {:#NodeTypes}

Type: uint8