Struct BfdSessionEnable 

pub struct BfdSessionEnable {
    pub detection_threshold: u8,
    pub local: Option<IpAddr>,
    pub mode: BfdMode,
    pub remote: IpAddr,
    pub required_rx: u64,
    pub switch: Name,
}

Information about a bidirectional forwarding detection (BFD) session.

JSON schema

{
 "description": "Information about a bidirectional forwarding detection
(BFD) session.",
 "type": "object",
 "required": [
   "detection_threshold",
   "mode",
   "remote",
   "required_rx",
   "switch"
 ],
 "properties": {
   "detection_threshold": {
     "description": "The negotiated Control packet transmission
interval, multiplied by this variable, will be the Detection Time for
this session (as seen by the remote system)",
     "type": "integer",
     "format": "uint8",
     "minimum": 0.0
   },
   "local": {
     "description": "Address the Oxide switch will listen on for BFD
traffic. If `None` then the unspecified address (0.0.0.0 or ::) is
used.",
     "type": [
       "string",
       "null"
     ],
     "format": "ip"
   },
   "mode": {
     "description": "Select either single-hop (RFC 5881) or multi-hop
(RFC 5883)",
     "allOf": [
       {
         "$ref": "#/components/schemas/BfdMode"
       }
     ]
   },
   "remote": {
     "description": "Address of the remote peer to establish a BFD
session with.",
     "type": "string",
     "format": "ip"
   },
   "required_rx": {
     "description": "The minimum interval, in microseconds, between
received BFD Control packets that this system requires",
     "type": "integer",
     "format": "uint64",
     "minimum": 0.0
   },
   "switch": {
     "description": "The switch to enable this session on. Must be
`switch0` or `switch1`.",
     "allOf": [
       {
         "$ref": "#/components/schemas/Name"
       }
     ]
   }
 }
}

Fields

detection_threshold: u8

The negotiated Control packet transmission interval, multiplied by this variable, will be the Detection Time for this session (as seen by the remote system)

local: Option<IpAddr>

Address the Oxide switch will listen on for BFD traffic. If None then the unspecified address (0.0.0.0 or ::) is used.

mode: BfdMode

Select either single-hop (RFC 5881) or multi-hop (RFC 5883)

remote: IpAddr

Address of the remote peer to establish a BFD session with.

required_rx: u64

The minimum interval, in microseconds, between received BFD Control packets that this system requires

switch: Name

The switch to enable this session on. Must be switch0 or switch1.

Implementations

impl BfdSessionEnable

pub fn builder() -> BfdSessionEnable

Trait Implementations

impl Clone for BfdSessionEnable

fn clone(&self) -> BfdSessionEnable

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BfdSessionEnable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BfdSessionEnable

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&BfdSessionEnable> for BfdSessionEnable

fn from(value: &BfdSessionEnable) -> Self

Converts to this type from the input type.

impl From<BfdSessionEnable> for BfdSessionEnable

fn from(value: BfdSessionEnable) -> Self

Converts to this type from the input type.

impl JsonSchema for BfdSessionEnable

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for BfdSessionEnable

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<BfdSessionEnable> for BfdSessionEnable

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: BfdSessionEnable) -> Result<Self, ConversionError>

Performs the conversion.