HostInterface

A network interface associated with a host.

Configuration ManagementLifecycle ManagementPatch ManagementSubscription ManagementSystems Management

Properties

Name	Type	Description
id	integer
mac	stringnull
ip	stringnull
ip6	stringnull
type	string
name	stringnull
subnet_id	integernull
subnet6_id	integernull
domain_id	integernull
identifier	stringnull	Device identifier (e.g., eth0, ens192).
managed	boolean
primary	boolean
provision	boolean
virtual	boolean
tag	stringnull	VLAN tag.
mtu	integernull	Maximum transmission unit.
attached_to	stringnull	Parent interface identifier.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HostInterface",
  "title": "HostInterface",
  "type": "object",
  "description": "A network interface associated with a host.",
  "properties": {
    "id": {
      "type": "integer",
      "example": "abc123"
    },
    "mac": {
      "type": [
        "string",
        "null"
      ],
      "example": "example_value"
    },
    "ip": {
      "type": [
        "string",
        "null"
      ],
      "format": "ipv4",
      "example": "example_value"
    },
    "ip6": {
      "type": [
        "string",
        "null"
      ],
      "format": "ipv6",
      "example": "example_value"
    },
    "type": {
      "type": "string",
      "enum": [
        "interface",
        "bmc",
        "bond",
        "bridge"
      ],
      "example": "interface"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "example": "Example Title"
    },
    "subnet_id": {
      "type": [
        "integer",
        "null"
      ],
      "example": "500123"
    },
    "subnet6_id": {
      "type": [
        "integer",
        "null"
      ],
      "example": "500123"
    },
    "domain_id": {
      "type": [
        "integer",
        "null"
      ],
      "example": "500123"
    },
    "identifier": {
      "type": [
        "string",
        "null"
      ],
      "description": "Device identifier (e.g., eth0, ens192).",
      "example": "example_value"
    },
    "managed": {
      "type": "boolean",
      "example": true
    },
    "primary": {
      "type": "boolean",
      "example": true
    },
    "provision": {
      "type": "boolean",
      "example": true
    },
    "virtual": {
      "type": "boolean",
      "example": true
    },
    "tag": {
      "type": [
        "string",
        "null"
      ],
      "description": "VLAN tag.",
      "example": "example_value"
    },
    "mtu": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Maximum transmission unit.",
      "example": "example_value"
    },
    "attached_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "Parent interface identifier.",
      "example": "example_value"
    }
  }
}