netconfcentral logo

ietf-dhcpv6-client

HTML

ietf-dhcpv6-client@2018-09-04



  module ietf-dhcpv6-client {

    yang-version 1.1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-dhcpv6-client";

    prefix dhcpv6-client;

    import ietf-dhcpv6-options {
      prefix dhcpv6-options;
    }
    import ietf-dhcpv6-types {
      prefix dhcpv6-types;
    }
    import ietf-interfaces {
      prefix if;
    }

    organization "DHC WG";

    contact
      "cuiyong@tsinghua.edu.cn
    wangh13@mails.tsinghua.edu.cn
    lh.sunlinh@gmail.com
    ian.farrer@telekom.de
    sladjana.zechlin@telekom.de
    hezihao9512@gmail.com  ";

    description
      "This model defines a YANG data model that can be
    used to configure and manage a DHCPv6 client.";

    revision "2018-09-04" {
      description "";
      reference
        "I-D: draft-ietf-dhc-dhcpv6-yang";

    }

    revision "2018-03-04" {
      description
        "Resolved most issues on the DHC official
    github";
      reference
        "I-D: draft-ietf-dhc-dhcpv6-yang";

    }

    revision "2017-12-22" {
      description
        "Resolve most issues on Ian's github.";
      reference
        "I-D: draft-ietf-dhc-dhcpv6-yang";

    }

    revision "2017-11-24" {
      description
        "First version of the separated client specific
        YANG model.";
      reference
        "I-D: draft-ietf-dhc-dhcpv6-yang";

    }


    container client {
      presence "Enables the client";
      description "dhcpv6 client portion";
      container client-config {
        description
          "configuration tree of client";
        container duid {
          description "Sets the DUID";
          uses dhcpv6-types:duid;
        }  // container duid

        list client-if {
          key "if-name";
          description
            "A client may have several interfaces, it is more reasonable to
          configure and manage parameters on the interface-level. The list defines
          specific client interfaces and their data. Different interfaces are
          distinguished by the key which is a configurable string value.";
          leaf if-name {
            type if:interface-ref;
            mandatory true;
            description "interface name";
          }

          leaf cli-id {
            type uint32;
            mandatory true;
            description "client id";
          }

          leaf pd-function {
            type boolean;
            mandatory true;
            description
              "Whether the client can act as a requesting router
            to request prefixes using prefix delegation ([RFC3633]).";
          }

          leaf rapid-commit {
            type boolean;
            mandatory true;
            description
              "'true' indicates a client can initiate a Solicit-Reply message
            exchange by adding a Rapid Commit option in Solicit message. 'false' means
            the client is not allowed to add a Rapid Commit option to request
            addresses in a two-message exchange pattern.";
          }

          container client-configured-options {
            description
              "client configured options";
            uses dhcpv6-options:client-option-definitions;
          }  // container client-configured-options
        }  // list client-if
      }  // container client-config

      container client-state {
        config false;
        description "state tree of client";
        container if-other-params {
          description
            "A client can obtain extra configuration
          data other than address and prefix information through
          DHCPv6. This container describes such data the client
          was configured. The potential configuration data may
          include DNS server addresses, SIP server domain names, etc.";
          uses dhcpv6-options:server-option-definitions;
        }  // container if-other-params

        container packet-stats {
          config false;
          description
            "A container records
          all the packet status information
          of a specific interface.";
          leaf solicit-count {
            type uint32;
            mandatory true;
            description "solicit counter";
          }

          leaf request-count {
            type uint32;
            mandatory true;
            description "request counter";
          }

          leaf renew-count {
            type uint32;
            mandatory true;
            description "renew counter";
          }

          leaf rebind-count {
            type uint32;
            mandatory true;
            description "rebind counter";
          }

          leaf decline-count {
            type uint32;
            mandatory true;
            description "decline counter";
          }

          leaf release-count {
            type uint32;
            mandatory true;
            description "release counter";
          }

          leaf info-req-count {
            type uint32;
            mandatory true;
            description
              "information request counter";
          }

          leaf advertise-count {
            type uint32;
            mandatory true;
            description "advertise counter";
          }

          leaf confirm-count {
            type uint32;
            mandatory true;
            description "confirm counter";
          }

          leaf reply-count {
            type uint32;
            mandatory true;
            description "reply counter";
          }

          leaf reconfigure-count {
            type uint32;
            mandatory true;
            description
              "reconfigure counter";
          }
        }  // container packet-stats
      }  // container client-state
    }  // container client

    notification notifications {
      description
        "dhcpv6 client notification module";
      container dhcpv6-client-event {
        description "dhcpv6 client event";
        container ia-lease-event {
          description
            "raised when the client was allocated
          a new IA from the server or it renew/rebind/release
          its current IA";
          leaf event-type {
            type enumeration {
              enum "allocation" {
                value 0;
                description "allocate";
              }
              enum "rebind" {
                value 1;
                description "rebind";
              }
              enum "renew" {
                value 2;
                description "renew";
              }
              enum "release" {
                value 3;
                description "release";
              }
            }
            mandatory true;
            description "event type";
          }

          container duid {
            description "Sets the DUID";
            uses dhcpv6-types:duid;
          }  // container duid

          leaf iaid {
            type uint32;
            mandatory true;
            description "IAID";
          }

          leaf serv-name {
            type string;
            description "server name";
          }

          leaf description {
            type string;
            description
              "description of event";
          }
        }  // container ia-lease-event

        container invalid-ia-detected {
          description
            "raised when the identity association of the
          client can be proved to be invalid.  Possible condition
          includes duplicated address, illegal address, etc.";
          container duid {
            description "Sets the DUID";
            uses dhcpv6-types:duid;
          }  // container duid

          leaf cli-duid {
            type uint32;
            mandatory true;
            description "duid of client";
          }

          leaf iaid {
            type uint32;
            mandatory true;
            description "IAID";
          }

          leaf serv-name {
            type string;
            description "server name";
          }

          leaf description {
            type string;
            description
              "description of the event";
          }
        }  // container invalid-ia-detected

        container retransmission-failed {
          description
            "raised when the retransmission mechanism defined
          in [RFC3315] is failed.";
          container duid {
            description "Sets the DUID";
            uses dhcpv6-types:duid;
          }  // container duid

          leaf description {
            type enumeration {
              enum "MRC failed" {
                value 0;
                description "MRC failed";
              }
              enum "MRD failed" {
                value 1;
                description "MRD failed";
              }
            }
            mandatory true;
            description
              "description of failure";
          }
        }  // container retransmission-failed

        container failed-status-turn-up {
          description
            "raised when the client receives a message includes
          an unsuccessful Status Code option.";
          container duid {
            description "Sets the DUID";
            uses dhcpv6-types:duid;
          }  // container duid

          leaf status-code {
            type enumeration {
              enum "1" {
                value 0;
                description "UnspecFail";
              }
              enum "2" {
                value 1;
                description "NoAddrAvail";
              }
              enum "3" {
                value 2;
                description "NoBinding";
              }
              enum "4" {
                value 3;
                description "NotOnLink";
              }
              enum "5" {
                value 4;
                description "UseMulticast";
              }
            }
            mandatory true;
            description
              "employed status code";
          }
        }  // container failed-status-turn-up
      }  // container dhcpv6-client-event
    }  // notification notifications
  }  // module ietf-dhcpv6-client

Summary

  
  
Organization DHC WG
  
Module ietf-dhcpv6-client
Version 2018-09-04
File ietf-dhcpv6-client@2018-09-04.yang
  
Prefix dhcpv6-client
Namespace urn:ietf:params:xml:ns:yang:ietf-dhcpv6-client
  
Cooked /cookedmodules/ietf-dhcpv6-client/2018-09-04
YANG /src/ietf-dhcpv6-client@2018-09-04.yang
XSD /xsd/ietf-dhcpv6-client@2018-09-04.xsd
  
Abstract This model defines a YANG data model that can be used to configure and manage a DHCPv6 client.
  
Contact
cuiyong@tsinghua.edu.cn
wangh13@mails.tsinghua.edu.cn
lh.sunlinh@gmail.com
ian.farrer@telekom.de
sladjana.zechlin@telekom.de
hezihao9512@gmail.com  

Description

 
This model defines a YANG data model that can be
used to configure and manage a DHCPv6 client.

Objects

Type Key
Mandatory config
Optional config
Not config
Object Type Abstract
client container dhcpv6 client portion
   client-config container configuration tree of client
      client-if list A client may have several interfaces, it is more reasonable to configure and manage parameters on the interface-level. The list defines specific client interfaces and their data. Different interfaces are distinguished by the key which is a configurable st...
         cli-id leaf client id
         client-configured-options container client configured options
            client-arch-type-option container OPTION_CLIENT_ARCH_TYPE (61) Client System Architecture Type Option
               architecture-types list architecture types
                  most-preferred leaf most preferred flag
                  type-id leaf type id
            client-fqdn-option container OPTION_CLIENT_FQDN (39) The Dynamic Host Configuration Protocol for IPv6 (DHCPv6) Client Fully Qualified Domain Name (FQDN) Option
               client-initiate-update leaf whether client initiate
               fqdn leaf fqdn
               server-initiate-update leaf whether server initiate
            client-link-layer-addr-option container OPTION_CLIENT_LINKLAYER_ADDR (79) DHCPv6 Client Link-Layer Address Option
               link-layer-addr leaf Client link-layer address
               link-layer-type leaf Client link-layer address type. The link-layer type MUST be a valid hardware type assigned by the IANA, as described in [RFC0826]
            client-network-interface-identifier-option container OPTION_NII (62) Client Network Interface Identifier Option
               major leaf major
               minor leaf minor
               type leaf type
            kbr-principal-name-option container OPTION_KRB_PRINCIPAL_NAME (75) Kerberos Principal Name Option
               principle-name list principle name
                  name-string leaf This field encodes a sequence of components that form a name, each component encoded as a KerberoString
                  name-type leaf This field specifies the type of name that follows.
                  principle-name-id leaf principle name id
            kbr-realm-name-option container OPTION_KRB_REALM_NAME (76) Kerberos Realm Name Option
               realm-name leaf realm name
            new-or-standard-cli-option list new or standard client option
               option-code leaf option code
               option-description leaf description of client option
               option-name leaf option name
               option-reference leaf the reference of option
               option-value leaf the option value
            option-request-option container OPTION_ORO (6) Option Request Option
               oro-option list oro option
                  description leaf description of oro options
                  option-code leaf option code
            user-class-option container OPTION_USER_CLASS (15) User Class Option
               user-class list user class
                  user-class-data leaf The information contained in the data area of this option is contained in one or more opaque fields that represent the user class or classes of which the client is a member.
                  user-class-id leaf user class id
            vendor-class-option container OPTION_VENDOR_CLASS (16) Vendor Class Option
               enterprise-number leaf enterprise number
               vendor-class list vendor class
                  vendor-class-data leaf The vendor-class-data is composed of a series of separate items, each of which describes some characteristic of the client's hardware configuration. Examples of vendor-class-data instances might include the version of the operating system the client is ru...
                  vendor-class-id leaf vendor class id
         if-name leaf interface name
         pd-function leaf Whether the client can act as a requesting router to request prefixes using prefix delegation ([RFC3633]).
         rapid-commit leaf 'true' indicates a client can initiate a Solicit-Reply message exchange by adding a Rapid Commit option in Solicit message. 'false' means the client is not allowed to add a Rapid Commit option to request addresses in a two-message exchange pattern.
      duid container Sets the DUID
         duid-type choice Selects the format for the DUID.
            duid-en case DUID Assigned by Vendor Based on Enterprise Number (Type 2 - DUID-EN)
               duid-en-enterprise-number leaf Vendor's registered Private Enterprise Number as maintained by IANA
               duid-en-identifier leaf Identifier, unique to the device that is using it
            duid-ll case DUID Based on Link-layer Address (Type 3 - DUID-LL)
               duid-ll-hardware-type leaf Hardware type as assigned by IANA (RFC826).
               duid-ll-link-layer-addr leaf Link-layer address as described in RFC2464
            duid-llt case DUID Based on Link-layer Address Plus Time (Type 1 - DUID-LLT)
               duid-llt-hardware-type leaf Hardware type as assigned by IANA (RFC826).
               duid-llt-link-layer-addr leaf Link-layer address as described in RFC2464
               duid-llt-time leaf The time value is the time that the DUID is generated represented in seconds since midnight (UTC), January 1, 2000, modulo 2^32.
            duid-unknown case DUID based on free raw bytes
               data leaf The bits to be used as the identifier
            duid-uuid case DUID Based on Universally Unique Identifier (Type 4 - DUID-UUID)
               uuid leaf A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters
         type-code leaf Type code of this DUID
   client-state container state tree of client
      if-other-params container A client can obtain extra configuration data other than address and prefix information through DHCPv6. This container describes such data the client was configured. The potential configuration data may include DNS server addresses, SIP server domain names...
         addr-selection-option container OPTION_ADDRSEL (84) and OPTION_ADDRSEL_TABLE (85)
            a-bit-set leaf a bit
            p-bit-set leaf p bit
            policy-table list policy table
               label leaf label
               policy-id leaf policy id
               precedence leaf precedence
               prefix leaf prefix
               prefix-len leaf prefix length
         aftr-name-option container OPTION_AFTR_NAME (64) AFTR-Name DHCPv6 Option
            tunnel-endpoint-name leaf aftr name
         boot-file-param-option container OPT_BOOTFILE_PARAM (60) Boot File Parameters Option
            boot-file-params list boot file parameters
               param-id leaf parameter id
               parameter leaf parameter value
         boot-file-url-option container OPT_BOOTFILE_URL (59) Boot File URL Option
            boot-file list boot file info
               boot-file-id leaf boot file id
               boot-file-url leaf url for boot file
               suitable-arch-type leaf-list architecture type
               suitable-net-if leaf-list network interface
         client-fqdn-option container OPTION_CLIENT_FQDN (39) DHCPv6 Client FQDN Option
            client-initiate-update leaf client initiate
            modify-name-from-cli leaf modify by client
            server-initiate-update leaf server initiate
         dns-servers-option container OPTION_DNS_SERVERS (23) DNS recursive Name Server option
            dns-server list dns server info
               dns-serv-addr leaf DNS server address.
               dns-serv-id leaf DNS server list entry ID.
         domain-searchlist-option container OPTION_DOMAIN_LIST (24) Domain Search List Option
            domain-searchlist list dns server info
               domain-search-list-entry leaf Domain search list entry.
               domain-searchlist-id leaf Domain seachlist entry ID.
         inf-max-rt-option container OPTION_INF_MAX_RT (83) inf max rt option
            inf-max-rt-value leaf inf max rt value
         info-refresh-time-option container OPTION_INFORMATION_REFRESH_TIME (32) Information Refresh Time option.
            info-refresh-time leaf The refresh time.
         kbr-default-name-option container OPTION_KRB_DEFAULT_REALM_NAME (77) Kerberos Default Realm Name Option
            default-realm-name leaf default realm name
         kbr-kdc-option container OPTION_KRB_KDC (78) Kerberos KDB Option
            kdc-info list kdc info
               kdc-id leaf kdc id
               kdc-ipv6-addr leaf kdc ipv6 addr
               port-number leaf port number
               priority leaf priority
               realm-name leaf realm name
               transport-type leaf transport type
               weight leaf weight
         nis-config-option container OPTION_NIS_SERVERS (27) Network Information Service (NIS) Servers Option.
            nis-server list nis server info
               nis-serv-addr leaf nis server addr
               nis-serv-id leaf nis server id
         nis-domain-name-option container OPTION_NIS_DOMAIN_NAME (29) Network Information Service (NIS) Domain Name Option
            nis-domain-name leaf The Network Information Service (NIS) Domain Name option is used by the server to convey client's NIS Domain Name info to the client.
         nis-plus-config-option container OPTION_NISP_SERVERS (28): Network Information Service V2 (NIS+) Servers Option.
            nis-plus-server list NIS+ server information.
               nis-plus-serv-addr leaf nisp server addr
               nis-plus-serv-id leaf nisp server id
         nis-plus-domain-name-option container OPTION_NISP_DOMAIN_NAME (30) Network Information Service V2 (NIS+) Domain Name Option
            nis-plus-domain-name leaf The Network Information Service V2 (NIS+) Domain Name option is used by the server to convey client's NIS+ Domain Name info to the client.
         ntp-server-option container OPTION_NTP_SERVER (56) NTP Server Option for DHCPv6
            ntp-server list ntp server info
               ntp-serv-id leaf NTP server id
               ntp-time-source-suboption choice Select a NTP time source suboption.
                  server-address case ntp-serv-addr-suboption
                     ntp-serv-addr-suboption leaf-list NTP server addr
                  server-fqdn case ntp-serv-fqdn-suboption
                     ntp-serv-fqdn-suboption leaf-list NTP server fqdn
                  server-multicast-address case ntp-serv-mul-addr-suboption
                     ntp-serv-mul-addr-suboption leaf-list NTP server multicast addr
         pcp-server-option container OPTION_V6_PCP_SERVER (86) pcp server option
            pcp-server list pcp server info
               pcp-serv-addr leaf pcp server addr
               pcp-serv-id leaf pcp server id
         posix-timezone-option container OPTION_NEW_POSIX_TIMEZONE (41) Posix Timezone option
            tz-posix leaf TZ Posix IEEE 1003.1 String
         s46-br-option container OPTION_S46_BR (90) S46 BR Option
            br list br info
               br-id leaf br id
               br-ipv6-addr leaf br ipv6 addr
         s46-dmr-option container OPTION_S46_DMR (91) S46 DMR Option
            dmr list dmr info
               dmr-id leaf dmr id
               dmr-ipv6-prefix leaf dmr ipv6 prefix
               dmr-prefix-len leaf dmr prefix length
         s46-rule-option container OPTION_S46_RULE (89) S46 rule option
            s46-rule list s46 rule
               ipv4-prefix leaf ipv4 prefix
               ipv6-prefix leaf ipv6 prefix
               port-parameter container port parameter
                  offset leaf offset in a port set
                  psid leaf psid value
                  psid-len leaf length of a psid
               prefix4-len leaf ipv4 prefix length
               prefix6-len leaf ipv6 prefix length
               rule-id leaf rule id
               rule-type leaf rule type
         s46-v4-v6-binding-option container OPTION_S46_V4V6BIND (92) S46 IPv4/IPv6 Address Binding option
            ce list ce info
               bind-ipv6-prefix leaf bind ipv6 prefix
               bind-prefix6-len leaf bind ipv6 prefix length
               ce-id leaf ce id
               ipv4-addr leaf ce ipv4 addr
               port-parameter container port parameter
                  offset leaf offset in a port set
                  psid leaf psid value
                  psid-len leaf length of a psid
         server-unicast-option container OPTION_UNICAST (12) Server Unicast Option
            server-address leaf server ipv6 address
         sip-server-address-list-option container OPTION_SIP_SERVER_A (22) SIP Servers IPv6 Address List
            sip-server list sip server info
               sip-serv-addr leaf sip server addr
               sip-serv-id leaf sip server id
         sip-server-domain-name-list-option container OPTION_SIP_SERVER_D (21) SIP Servers Domain Name List
            sip-serv-domain-name leaf sip server domain name
         sntp-server-option container OPTION_SNTP_SERVERS (31) Simple Network Time Protocol (SNTP) Servers Option
            sntp-server list sntp server info
               sntp-serv-addr leaf sntp server addr
               sntp-serv-id leaf sntp server id
         sol-max-rt-option container OPTION_SOL_MAX_RT (82) sol max rt option
            sol-max-rt-value leaf sol max rt value
         tzdb-timezone-option container OPTION_NEW_TZDB_TIMEZONE (42) Timezone Database option
            tz-database leaf Reference to the TZ Database
      packet-stats container A container records all the packet status information of a specific interface.
         advertise-count leaf advertise counter
         confirm-count leaf confirm counter
         decline-count leaf decline counter
         info-req-count leaf information request counter
         rebind-count leaf rebind counter
         reconfigure-count leaf reconfigure counter
         release-count leaf release counter
         renew-count leaf renew counter
         reply-count leaf reply counter
         request-count leaf request counter
         solicit-count leaf solicit counter

Notifications

Notification Abstract
notifications dhcpv6 client notification module