opendaylight/netconf/tools/netconf-cli/src/main/resources/schema/local/netconf-cli.yang

   1 module netconf-cli {
   2
   3   namespace "netconf:cli";
   4   prefix ncli;
   5
   6   import ietf-inet-types { prefix inet; revision-date 2010-09-24; }
   7   import netconf-cli-ext { prefix cliext; revision-date 2014-05-26; }
   8
   9
  10     revision 2014-05-22 {
  11       description
  12        "Initial revision.";
  13     }
  14
  15   extension java-class {
  16       description
  17           "This could be used to link between rpc yang definition and custom command implementation";
  18
  19       argument "name";
  20   }
  21
  22   rpc help {
  23     description
  24         "Display help";
  25
  26     output {
  27       list commands {
  28
  29         key "id";
  30         leaf id {
  31             type string;
  32         }
  33         leaf description {
  34             type string;
  35         }
  36       }
  37     }
  38   }
  39
  40   rpc close {
  41       description
  42           "Close the whole cli";
  43   }
  44
  45   rpc connect {
  46
  47         description
  48             "Connect to a remote netconf device, if not connected yet. Connection initialization is blocking and might take some time, depending on amount of yang schemas in remote device.";
  49
  50       input {
  51
  52          // TODO yangtools keep input arguments unordered so the ordering in cli is random
  53          leaf address-name {
  54            type inet:host;
  55            default localhost;
  56          }
  57
  58          leaf address-port {
  59            type inet:port-number;
  60            default 830;
  61          }
  62
  63           leaf user-name {
  64            type string;
  65          }
  66
  67         leaf user-password {
  68             cliext:argument-handler org.opendaylight.controller.netconf.cli.reader.custom.PasswordReader;
  69             type string;
  70         }
  71       }
  72
  73       output {
  74         leaf status {
  75             type string;
  76         }
  77
  78         leaf-list remote-commands {
  79             type string;
  80         }
  81       }
  82   }
  83
  84
  85   rpc disconnect {
  86
  87       description
  88           "Disconnect from a netconf device that is currently connected";
  89
  90       output {
  91         leaf status {
  92             type string;
  93         }
  94       }
  95     }
  96
  97 }