← Back to index

opnsense_settings_gateway (Data Source)

Look up an existing gateway under System → Gateways → Single by UUID.

Schema

Required

  • id (String) UUID of the gateway.

Read-Only

  • data_length (Number) Monitoring data length.
  • default_gateway (Boolean) Whether the gateway is the default for this protocol.
  • description (String) Gateway description.
  • disabled (Boolean) Whether the gateway is disabled.
  • far_gateway (Boolean) Whether the gateway may exist outside the interface subnet.
  • force_down (Boolean) Whether the gateway is forced down.
  • gateway (String) Gateway IP address.
  • interface (String) Interface identifier.
  • interval (Number) Monitoring interval.
  • ip_protocol (String) IP protocol handled by the gateway.
  • latency_high (Number) High latency threshold.
  • latency_low (Number) Low latency threshold.
  • loss_high (Number) High loss threshold.
  • loss_interval (Number) Monitoring loss interval.
  • loss_low (Number) Low loss threshold.
  • monitor (String) Monitor IP or host.
  • monitor_disable (Boolean) Whether gateway monitoring is disabled.
  • monitor_kill_states (Boolean) Whether states are cleared when the gateway is down.
  • monitor_kill_states_priority (Number) Priority for the kill-states action.
  • monitor_no_route (Boolean) Whether monitoring routes are skipped.
  • name (String) Gateway name.
  • priority (Number) Gateway priority.
  • time_period (Number) Monitoring time period.
  • weight (Number) Gateway weight.