ols-ucentral-schema/schema/interface.ssid.pass-point.yml

description:
  Enable Hotspot 2.0 support.
type: object
properties:
  venue-name:
    description:
      This parameter can be used to configure one or more Venue Name Duples
      for Venue Name ANQP information.
    type: array
    items:
      type: string
  venue-group:
    description:
      The available values are defined in 802.11u.
    type: integer
    maximum: 32
  venue-type:
    description:
      The available values are defined in IEEE Std 802.11u-2011, 7.3.1.34
    type: integer
    maximum: 32
  venue-url:
    description:
      This parameter can be used to configure one or more Venue URL Duples to
      provide additional information corresponding to Venue Name information.
    type: array
    items:
      type: string
      format: uri
  auth-type:
    description:
      This parameter indicates what type of network authentication is used in
      the network.
    type: object
    properties:
      type:
        description:
          Specifies the specific network authentication type in use.
        type: string
        enum:
        - "terms-and-conditions"
        - "online-enrollment"
        - "http-redirection"
        - "dns-redirection"
      uri:
        description:
          Specifies the redirect URL applicable to the indicated authentication type.
        type: string
        format: uri
        examples:
        - https://operator.example.org/wireless-access/terms-and-conditions.html
        - http://www.example.com/redirect/me/here/
    minLength: 2
    maxLength: 2
  domain-name:
    description:
      The IEEE 802.11u Domain Name.
    type: array
    items:
      type: string
      format: hostname
  nai-realm:
    description:
      NAI Realm information
    type: array
    items:
      type: string
  osen:
    description:
      OSU Server-Only Authenticated L2 Encryption Network;
    type: boolean
  anqp-domain:
    description:
      ANQP Domain ID, An identifier for a set of APs in an ESS that share the
      same common ANQP information.
    type: integer
    maximum: 65535
    minimum: 0
  anqp-3gpp-cell-net:
    description:
      The ANQP 3GPP Cellular Network information.
    type: array
    items:
      type: string
  friendly-name:
    description:
      This parameter can be used to configure one or more Operator Friendly
      Name Duples.
    type: array
    items:
      type: string
  access-network-type:
    description:
      Indicate the type of network. This is part of the interworking IE.
    type: integer
    maximum: 15
    default: 0
  internet:
    description:
      Whether the network provides connectivity to the Internet
    type: boolean
    default: true
  asra:
    description:
      Additional Step Required for Access.
    type: boolean
    default: false
  esr:
    description:
      Emergency services reachable.
    type: boolean
    default: false
  uesa:
    description:
      Unauthenticated emergency service accessible.
    type: boolean
    default: false
  hessid:
    description:
      Homogeneous ESS identifier
    type: string
    example: 00:11:22:33:44:55
  roaming-consortium:
    description:
      Roaming Consortium OIs can be configured here. Each OI is between 3 and 15
      octets and is configured as a hexstring.
    type: array
    items:
      type: string
  disable-dgaf:
    description:
      Disable Downstream Group-Addressed Forwarding. This can be used to configure
      a network where no group-addressed frames are allowed.
    type: boolean
    default: false
  ipaddr-type-available:
    description:
      IP Address Type Availability.
    type: integer
    maximum: 255
  connection-capability:
    description:
      This can be used to advertise what type of IP traffic can be sent through the
      hotspot.
    type: array
    items:
      type: string
  icons:
    description:
      The operator icons.
    type: array
    items:
      type: object
      properties:
        width:
          type: integer
          description: The width of the operator icon in pixel
          examples:
          - 64
        height:
          type: integer
          description: The height of the operator icon in pixel
          examples:
          - 64
        type:
          type: string
          description: The mimetype of the operator icon
          examples:
          - image/png
        icon:
          type: string
          format: uc-base64
          description: The base64 encoded image
        language:
          type: string
          description: ISO 639-2 language code of the icon
          pattern: "^[a-z][a-z][a-z]$"
          examples:
          - eng
          - fre
          - ger
          - ita
      examples:
      - width: 32
        height: 32
        type: image/png
        language: eng
        icon: R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAkAABAALAAAAAAQABAAAAVVICSOZGlCQAosJ6mu7fiyZeKqNKToQGDsM8hBADgUXoGAiqhSvp5QAnQKGIgUhwFUYLCVDFCrKUE1lBavAViFIDlTImbKC5Gm2hB0SlBCBMQiB0UjIQA7
  wan-metrics:
    description:
      A description of the wan metric offered by this device.
    type: object
    properties:
      info:
        description:
          The state of the devices uplink
        type: string
        enum:
        - up
        - down
        - testing
      downlink:
        description:
          Estimate of WAN backhaul link current downlink speed in kbps.
        type: integer
      uplink:
        description:
          Estimate of WAN backhaul link current uplink speed in kbps.
        type: integer