A.1. “example-jukebox”的YANG模块

  1. module example-jukebox {
  3.    namespace "http://example.com/ns/example-jukebox";
  4.    prefix "jbox";
  6.    organization "Example, Inc.";
  7.    contact "support at example.com";
  8.    description "Example Jukebox Data Model Module.";
  9.    revision "2016-08-15" {
  10.      description "Initial version.";
  11.      reference "example.com document 1-4673.";
  12.    }
  14.    identity genre {
  15.      description
  16.        "Base for all genre types.";
  17.    }
  19.    // abbreviated list of genre classifications
  20.    identity alternative {
  21.      base genre;
  22.      description
  23.        "Alternative music.";
  24.    }
  25.    identity blues {
  26.      base genre;
  27.      description
  28.        "Blues music.";
  29.    }
  30.    identity country {
  31.      base genre;
  32.      description
  33.        "Country music.";
  34.    }
  35.    identity jazz {
  36.      base genre;
  37.      description
  38.        "Jazz music.";
  39.    }
  40.    identity pop {
  41.      base genre;
  42.      description
  43.        "Pop music.";
  44.    }
  46.    identity rock {
  47.      base genre;
  48.      description
  49.        "Rock music.";
  50.    }
  52.    container jukebox {
  53.      presence
  54.        "An empty container indicates that the jukebox
  55.         service is available.";
  57.      description
  58.        "Represents a 'jukebox' resource, with a library, playlists,
  59.         and a 'play' operation.";
  61.      container library {
  63.        description
  64.          "Represents the 'jukebox' library resource.";
  66.        list artist {
  67.          key name;
  68.          description
  69.            "Represents one 'artist' resource within the
  70.             'jukebox' library resource.";
  72.          leaf name {
  73.            type string {
  74.              length "1 .. max";
  75.            }
  76.            description
  77.              "The name of the artist.";
  78.          }
  80.          list album {
  81.            key name;
  82.            description
  83.              "Represents one 'album' resource within one
  84.               'artist' resource, within the jukebox library.";
  86.            leaf name {
  87.              type string {
  88.                length "1 .. max";
  89.              }
  90.              description
  91.                "The name of the album.";
  92.            }
  95.            leaf genre {
  96.              type identityref { base genre; }
  97.              description
  98.                "The genre identifying the type of music on
  99.                 the album.";
  100.            }
  102.            leaf year {
  103.              type uint16 {
  104.                range "1900 .. max";
  105.              }
  106.              description
  107.                "The year the album was released.";
  108.            }
  110.            container admin {
  111.              description
  112.                "Administrative information for the album.";
  114.              leaf label {
  115.                type string;
  116.                description
  117.                  "The label that released the album.";
  118.              }
  119.              leaf catalogue-number {
  120.                type string;
  121.                description
  122.                  "The album's catalogue number.";
  123.              }
  124.            }
  126.            list song {
  127.              key name;
  128.              description
  129.                "Represents one 'song' resource within one
  130.                 'album' resource, within the jukebox library.";
  132.              leaf name {
  133.                type string {
  134.                   length "1 .. max";
  135.                }
  136.                description
  137.                  "The name of the song.";
  138.              }
  141.              leaf location {
  142.                type string;
  143.                mandatory true;
  144.                description
  145.                  "The file location string of the
  146.                   media file for the song.";
  147.              }
  148.              leaf format {
  149.                type string;
  150.                description
  151.                  "An identifier string for the media type
  152.                   for the file associated with the
  153.                   'location' leaf for this entry.";
  154.              }
  155.              leaf length {
  156.                type uint32;
  157.                units "seconds";
  158.                description
  159.                  "The duration of this song in seconds.";
  160.              }
  161.            }   // end list 'song'
  162.          }   // end list 'album'
  163.        }  // end list 'artist'
  165.        leaf artist-count {
  166.           type uint32;
  167.           units "artists";
  168.           config false;
  169.           description
  170.             "Number of artists in the library.";
  171.        }
  172.        leaf album-count {
  173.           type uint32;
  174.           units "albums";
  175.           config false;
  176.           description
  177.             "Number of albums in the library.";
  178.        }
  179.        leaf song-count {
  180.           type uint32;
  181.           units "songs";
  182.           config false;
  183.           description
  184.             "Number of songs in the library.";
  185.        }
  186.      }  // end library
  189.      list playlist {
  190.        key name;
  191.        description
  192.          "Example configuration data resource.";
  194.        leaf name {
  195.          type string;
  196.          description
  197.            "The name of the playlist.";
  198.        }
  199.        leaf description {
  200.          type string;
  201.          description
  202.            "A comment describing the playlist.";
  203.        }
  204.        list song {
  205.          key index;
  206.          ordered-by user;
  208.          description
  209.            "Example nested configuration data resource.";
  211.          leaf index {    // not really needed
  212.            type uint32;
  213.            description
  214.              "An arbitrary integer index for this playlist song.";
  215.          }
  216.          leaf id {
  217.            type instance-identifier;
  218.            mandatory true;
  219.            description
  220.              "Song identifier.  Must identify an instance of
  221.               /jukebox/library/artist/album/song/name.";
  222.          }
  223.        }
  224.      }
  226.      container player {
  227.        description
  228.          "Represents the jukebox player resource.";
  230.        leaf gap {
  231.          type decimal64 {
  232.            fraction-digits 1;
  233.            range "0.0 .. 2.0";
  234.          }
  235.          units "tenths of seconds";
  236.          description
  237.            "Time gap between each song.";
  238.        }
  239.      }
  240.    }
  242.    rpc play {
  243.      description
  244.        "Control function for the jukebox player.";
  245.      input {
  246.        leaf playlist {
  247.          type string;
  248.          mandatory true;
  249.          description
  250.            "The playlist name.";
  251.        }
  252.        leaf song-number {
  253.          type uint32;
  254.          mandatory true;
  255.          description
  256.            "Song number in playlist to play.";
  257.        }
  258.      }
  259.    }
  260. }