brocade-tpvm

Provide the Third Party Virtual Machine (TPVM) administration commands.

Top-level container

module: brocade-tpvm
    +--rw tpvm
      +---x install         
      |  +---w input     
      |  |  +---w tpvmid?   string
      |  |  +---w blade?    bladeType
      |  |  +---w debug?    boolean
      |  +--ro output    
      |     +--ro tpvm-install-msg?   string
      +---x uninstall       
      |  +---w input     
      |  |  +---w tpvmid?   string
      |  |  +---w force?    empty
      |  |  +---w blade?    bladeType
      |  |  +---w debug?    boolean
      |  +--ro output    
      |     +--ro tpvm-uninstall-msg?   string
      +---x download        
      |  +---w input     
      |  |  +---w protocol     enumeration
      |  |  +---w user         string
      |  |  +---w password     string
      |  |  +---w host         inet:host
      |  |  +---w directory    string
      |  |  +---w filename     string
      |  |  +---w use-vrf?     common-def:use-vrf
      |  |  +---w sanity?      string
      |  |  +---w block?       empty
      |  +--ro output    
      |     +--ro tpvm-filename?   string
      |     +--ro tpvm-version?    string
      |     +--ro tpvm-length?     string
      |     +--ro tpvm-status?     string
      +---x fileinfo        
      |  +--ro output    
      |     +--ro tpvm-filename?   string
      |     +--ro tpvm-version?    string
      |     +--ro tpvm-length?     string
      |     +--ro tpvm-status?     string
      +---x upgrade         
      |  +---w input     
      |  |  +---w tpvmid?         string
      |  |  +---w (file-options)
      |  |  |  +--:(local)
      |  |  |  |  +---w uselocalfile    empty
      |  |  |  +--:(remote)
      |  |  |     +---w protocol        enumeration
      |  |  |     +---w user            string
      |  |  |     +---w password        string
      |  |  |     +---w host            inet:host
      |  |  |     +---w directory       string
      |  |  |     +---w filename        string
      |  |  |     +---w use-vrf?        common-def:use-vrf
      |  |  +---w snapshot?       empty
      |  |  +---w incremental?    empty
      |  +--ro output    
      |     +--ro tpvm-upgrade-msg?   string
      +---x password        
      |  +---w input     
      |  |  +---w blade?   bladeType
      |  |  +---w debug?   boolean
      |  +--ro output    
      |     +--ro tpvm-update-password-msg?   string
      +---x start           
      |  +---w input     
      |  |  +---w tpvmid?   string
      |  |  +---w blade?    bladeType
      |  |  +---w debug?    boolean
      |  +--ro output    
      |     +--ro tpvm-start-msg?   string
      +---x stop            
      |  +---w input     
      |  |  +---w tpvmid?   string
      |  |  +---w blade?    bladeType
      |  |  +---w debug?    boolean
      |  +--ro output    
      |     +--ro tpvm-stop-msg?   string
      +--rw auto-boot
      |  +---x enable     
      |  |  +---w input     
      |  |  |  +---w blade?   bladeType
      |  |  |  +---w debug?   boolean
      |  |  +--ro output    
      |  |     +--ro tpvm-enable-on-boot-msg?   string
      |  +---x disable    
      |     +---w input     
      |     |  +---w blade?   bladeType
      |     |  +---w debug?   boolean
      |     +--ro output    
      |        +--ro tpvm-disable-on-boot-msg?   string
      +--rw service-port
      |  +---x enable    
      |     +---w input     
      |     |  +---w blade?   bladeType
      |     |  +---w debug?   boolean
      |     +--ro output    
      |        +--ro tpvm-sp-enable-msg?   string
      +--rw disk
      |  +---x add       
      |  |  +---w input     
      |  |  |  +---w name     union
      |  |  |  +---w size     diskSize
      |  |  |  +---w blade?   bladeType
      |  |  |  +---w debug?   boolean
      |  |  +--ro output    
      |  |     +--ro tpvm-add-disk-msg?   string
      |  +---x remove    
      |     +---w input     
      |     |  +---w name     union
      |     |  +---w blade?   bladeType
      |     |  +---w debug?   boolean
      |     +--ro output    
      |        +--ro tpvm-remove-disk-msg?   string
      +--rw deploy
      |  +---x mgmt            
      |  |  +---w input     
      |  |  |  +---w (options)
      |  |  |  |  +--:(dhcp)
      |  |  |  |  |  +---w dhcp            empty
      |  |  |  |  +--:(ipaddr)
      |  |  |  |     +---w ipaddr          union
      |  |  |  |     +---w gw?             tpvm-ipv4-address
      |  |  |  +---w allow-pwless?   empty
      |  |  |  +---w admin-pwd?      string
      |  |  |  +---w confirm-pwd?    string
      |  |  +--ro output    
      |  |     +--ro tpvm-mgmt-deploy-msg?   string
      |  +--rw insight-intf
      |     +---x insight    
      |        +---w input     
      |           +---w ipaddr          union
      |           +---w gw?             tpvm-ipv4-address
      |           +---w allow-pwless?   empty
      |           +---w admin-pwd?      string
      |           +---w confirm-pwd?    string
      +--rw config
      |  +--rw ldap
      |  |  +---x add        
      |  |  |  +---w input     
      |  |  |     +---w ldap-server
      |  |  |     |  +---w host?                  inet:host
      |  |  |     |  +---w ldap-server-options
      |  |  |     |     +---w port?     uint16
      |  |  |     |     +---w secure?   empty
      |  |  |     +---w basedn?        string
      |  |  |     +---w rootdn?        string
      |  |  |     +---w rootdnpw?      string
      |  |  +---x remove     
      |  |  |  +---w input     
      |  |  |     +---w ldap-server
      |  |  |     |  +---w host?                  inet:host
      |  |  |     |  +---w ldap-server-options
      |  |  |     |     +---w port?     empty
      |  |  |     |     +---w secure?   empty
      |  |  |     +---w basedn?        empty
      |  |  |     +---w rootdn?        empty
      |  |  |     +---w rootdnpw?      empty
      |  |  +--rw ca-cert
      |  |     +---x import    
      |  |     |  +---w input     
      |  |     |     +---w protocol     enumeration
      |  |     |     +---w user         string
      |  |     |     +---w password?    string
      |  |     |     +---w host         inet:host
      |  |     |     +---w directory    string
      |  |     |     +---w filename     string
      |  |     +---x remove    
      |  +--rw ntp
      |  |  +---x add        
      |  |  |  +---w input     
      |  |  |     +---w server    tpvm-ntp-server
      |  |  +---x remove     
      |  |  |  +---w input     
      |  |  |     +---w server    tpvm-ntp-server
      |  |  +---x default    
      |  +--rw dns
      |  |  +---x add       
      |  |  |  +---w input     
      |  |  |     +---w dns
      |  |  |        +---w dns-server              inet:ipv4-address
      |  |  |        +---w secondary-dns-server?   inet:ipv4-address
      |  |  |        +---w domain
      |  |  |           +---w domain-name?   string
      |  |  +---x remove    
      |  +--rw system-attributes
      |  |  +---x hostname    
      |  |  |  +---w input     
      |  |  |     +---w name    string
      |  |  +---x timezone    
      |  |     +---w input     
      |  |        +---w zone    common-def:timezone
      |  +--rw trusted-peer
      |     +---x add       
      |     |  +---w input     
      |     |     +---w pwless
      |     |        +---w peer-ip        inet:ipv4-address
      |     |        +---w credentials
      |     |           +---w peer-password    string
      |     |           +---w peer-sudoer?     string
      |     +---x remove    
      |        +---w input     
      |           +---w pwless
      |              +---w peer-ip        inet:ipv4-address
      |              +---w credentials
      |                 +---w peer-password    string
      |                 +---w peer-sudoer?     string
      +--rw snapshot
         +---x create    
         |  +---w input     
         |  |  +---w tpvmid?    string
         |  |  +---w withefa?   boolean
         |  +--ro output    
         |     +--ro tpvm-snapshot-action-result?   tpvmActionResult
         |     +--ro tpvm-snapshot-msg?             string
         +---x delete    
         |  +---w input     
         |  |  +---w tpvmid?   string
         |  +--ro output    
         |     +--ro tpvm-snapshot-action-result?   tpvmActionResult
         |     +--ro tpvm-snapshot-msg?             string
         +---x revert    
            +---w input     
            |  +---w tpvmid?   string
            +--ro output    
               +--ro tpvm-snapshot-action-result?   tpvmActionResult
               +--ro tpvm-snapshot-msg?             string

RPCs

rpcs:
   +---x get-tpvm-detail    
      +---w input     
      |  +---w tpvm-instance-id?   string
      +--ro output    
         +--ro tpvm
            +--ro tpvm-state?             tpvmStateType
            +--ro additional-status?      string
            +--ro version?                string
            +--ro auto-boot-enabled?      empty
            +--ro allow-pwless-enabled?   empty
            +--ro password?               string
            +--ro hostname?               string
            +--ro timezone?               string
            +--ro ldap
            |  +--ro host?       string
            |  +--ro port?       uint16
            |  +--ro secure?     empty
            |  +--ro basedn?     string
            |  +--ro rootdn?     string
            |  +--ro rootdnpw?   string
            +--ro dns
            |  +--ro primary?     union
            |  +--ro secondary?   union
            |  +--ro domain?      string
            +--ro ntp* [server]
            |  +--ro server    string
            +--ro trusted-peer
            |  +--ro (options)
            |  |  +--:(peer-ip)
            |  |  |  +--ro peer-ip          inet:ipv4-address
            |  |  +--:(peer-ipv6)
            |  |     +--ro peer-ipv6        inet:ipv6-address
            |  +--ro sudo-user?       string
            |  +--ro peer-password?   string
            +--ro disk* [disk-name]
            |  +--ro disk-name    string
            |  +--ro disk-size?   string
            +--ro interface* [interface-name]
               +--ro interface-name    string
               +--ro ipv4-address?     string
               +--ro gateway?          inet:ipv4-address
               +--ro ipv6-address?     string
               +--ro gateway-v6?       inet:ipv6-address