ols-ucentral-schema/schema/interface.ipv4.yml

description:
  This section describes the IPv4 properties of a logical interface.
type: object
properties:
  addressing:
    description:
      This option defines the method by which the IPv4 address of the interface
      is chosen.
    type: string
    enum:
      - dynamic
      - static
      - none
    examples:
    - static
  subnet:
    description:
      This option defines a list of CONNECTED routes (with VRF id) in CIDR notation.
    type: array
    items:
      type: object
      properties:
        prefix:
          description:
            Defines a CONNECTED route's prefix (network).
          type: string
          format: uc-cidr4
          examples:
          - 192.168.1.0/24
        vrf:
          description:
            VRF id.
          type: integer
  gateway:
    description:
      This option defines the static IPv4 gateway of the logical interface.
    type: array
    items:
      type: object
      properties:
        prefix:
          description:
            Defines a NEXTHOP route's prefix (network).
          type: string
          format: uc-cidr4
          examples:
          - 192.168.1.0/24
        nexthop:
          description:
            Gateway (nexthop) address.
          type: string
          format: ipv4
          examples:
          - 192.168.1.1
        vrf:
          description:
            VRF id.
          type: integer
        metric:
          description:
            Optional metric value (define a NH route's weight / metric).
          type: number
  broadcast:
    description:
      This option defines a list of BROADCAST routes (with VRF id) in CIDR notation.
    type: array
    items:
      type: object
      properties:
        prefix:
          description:
            Defines a BROADCAST route's prefix (network).
          type: string
          format: uc-cidr4
          examples:
          - 192.168.1.0/24
        vrf:
          description:
            VRF id.
          type: integer
  multicast:
    type: object
    properties:
      unknown-multicast-flood-control:
        description:
          The unknown multicast flood control feature enables the system to forward unknown multicast packets only to a multicast router (mrouter).
        type: boolean
        default: true
      igmp:
        type: object
        properties:
          snooping-enable:
            description:
              Enable or disable IGMP snooping on per-VLAN basis.
            type: boolean
            default: true
          version:
            description:
              Configures the IGMP version. Configurable versions are IGMPv1, IGMPv2, and IGMPv3
            type: integer
            enum:
            - 1
            - 2
            - 3
            examples:
            - 3
            default: 3
          querier-enable:
            description:
              Configure this interface to act as a querier (multicast router)
            type: boolean
            default: false
          fast-leave-enable:
            description:
              Removes the group state when it receives an IGMP Leave report without sending an IGMP query message
            type: boolean
            default: false
          query-interval:
            description:
              Defines the interval between sending IGMP general queries
            type: integer
            default: 1000
          last-member-query-interval:
            description:
              Defines the maximum response time (milliseconds) advertised in IGMP group-specific queries
            type: integer
            default: 1000
          max-response-time:
            description:
              Configures a query maximum response time (in seconds) that is advertised on IGMP queries.
            type: integer
            default: 10
          static-mcast-groups:
            description:
              Configures a Layer 2 port of a VLAN as a static member of an IGMP multicast group(s).
            type: array
            items:
              type: object
              properties:
                egress-ports:
                  description:
                    Specify egress port(s) to forward mcast traffc of static group to.
                  type: array
                  items:
                    type: string
                address:
                  description:
                    Specify IPV4 address (group) this interface is statically configured to be member of.
                  type: string
                  format: ipv4
                  examples:
                  - 225.0.0.1
      mvr:
        type: object
        description: MVR attributes on a given interface
        properties:
          mvr-intf-mvr-role:
            type: string
            description: Configure an interface as an MVR receiver or source port. A port which is not configured as an MVR receiver or source port can use IGMP snooping to join or leave multicast groups using the standard rules for multicast filtering.
            enum:
              - none
              - source
              - receiver
          mvr-intf-immed-leave:
            type: string
            description: Switch to immediately remove an interface from a multicast stream as soon as it receives a leave message for that group. Applies to only receiver role ports.
            enum:
              - none
              - by-host-ip
              - by-group
            default: by-group
          mvr-intf-assoc-domain:
            type: integer
            description: Map the port to a specific domain.
            maximum: 10
            minimum: 1
        required:
          - mvr-intf-mvr-role
          - mvr-intf-immed-leave
          - mvr-intf-assoc-domain
  send-hostname:
    description:
      include the devices hostname inside DHCP requests
    type: boolean
    default: true
    examples:
    - true
  use-dns:
    description:
      Define which DNS servers shall be used. This can either be a list of
      static IPv4 addresse or dhcp (use the server provided by the DHCP lease)
    type: array
    items:
      type: string
      format: ipv4
      examples:
      - 8.8.8.8
      - 4.4.4.4
  dhcp-snoop-vlan-enable:
    description: "Enables DHCP Snooping on a VLAN"
    type: boolean
    default: false
  ip-arp-inspect-vlan:
      $ref: "https://ucentral.io/schema/v1/interface/ipv4/arp-inspect/"
  dhcp:
    $ref: "https://ucentral.io/schema/v1/interface/ipv4/dhcp/"
  dhcp-leases:
    type: array
    items:
      $ref: "https://ucentral.io/schema/v1/interface/ipv4/dhcp-lease/"
  port-forward:
    type: array
    items:
      $ref: "https://ucentral.io/schema/v1/interface/ipv4/port-forward/"