extreme-firmware

Provides a data model for managing the download of firmware and for reporting firmware download status.

This module supports the custom actions listed in the table below.

Table 1. Custom actions for firmware version management
Action Purpose
<ftp> Download firmware with FTP.
<scp> Download firmware with SCP.
<usb> Download firmware from a USB device.
<interactive> Download firmware interactively.
<commit> Commits a firmware upgrade after evaluation.
<restore> Restores a firmware version.
<sync> Synchronizes the firmware with its peer.
<fastboot> Reboots the control processor (CP), bypassing the power-on self-test (POST).

Top-level container

module: extreme-firmware
   +--rw firmware
   |  +--rw download
   |  |  +---x ftp               
   |  |  |  +---w input     
   |  |  |  |  +---w user          string
   |  |  |  |  +---w password?     string
   |  |  |  |  +---w host          string
   |  |  |  |  +---w directory     string
   |  |  |  |  +---w file?         string
   |  |  |  |  +---w (options)?
   |  |  |  |  |  +--:(manual)
   |  |  |  |  |  |  +---w manual?       empty
   |  |  |  |  |  |  +---w noreboot?     empty
   |  |  |  |  |  |  +---w nocommit?     empty
   |  |  |  |  |  +--:(noactivate)
   |  |  |  |  |  |  +---w noactivate?   empty
   |  |  |  |  |  +--:(coldboot)
   |  |  |  |  |     +---w coldboot?     empty
   |  |  |  |  +---w use-vrf?      common-def:vrf-name
   |  |  |  +--ro output    
   |  |  |     +--ro fwdl-tid?      int32
   |  |  |     +--ro fwdl-status?   int32
   |  |  |     +--ro fwdl-msg?      string
   |  |  +---x scp               
   |  |  |  +---w input     
   |  |  |  |  +---w user          string
   |  |  |  |  +---w password?     string
   |  |  |  |  +---w host          string
   |  |  |  |  +---w directory     string
   |  |  |  |  +---w file?         string
   |  |  |  |  +---w (options)?
   |  |  |  |  |  +--:(manual)
   |  |  |  |  |  |  +---w manual?       empty
   |  |  |  |  |  |  +---w noreboot?     empty
   |  |  |  |  |  |  +---w nocommit?     empty
   |  |  |  |  |  +--:(noactivate)
   |  |  |  |  |  |  +---w noactivate?   empty
   |  |  |  |  |  +--:(coldboot)
   |  |  |  |  |     +---w coldboot?     empty
   |  |  |  |  +---w use-vrf?      common-def:vrf-name
   |  |  |  +--ro output    
   |  |  |     +--ro fwdl-tid?      int32
   |  |  |     +--ro fwdl-status?   int32
   |  |  |     +--ro fwdl-msg?      string
   |  |  +---x tftp              
   |  |  |  +---w input     
   |  |  |  |  +---w host          string
   |  |  |  |  +---w directory     string
   |  |  |  |  +---w file?         string
   |  |  |  |  +---w (options)?
   |  |  |  |     +--:(manual)
   |  |  |  |     |  +---w manual?       empty
   |  |  |  |     |  +---w noreboot?     empty
   |  |  |  |     |  +---w nocommit?     empty
   |  |  |  |     +--:(noactivate)
   |  |  |  |     |  +---w noactivate?   empty
   |  |  |  |     +--:(coldboot)
   |  |  |  |        +---w coldboot?     empty
   |  |  |  +--ro output    
   |  |  |     +--ro fwdl-tid?      int32
   |  |  |     +--ro fwdl-status?   int32
   |  |  |     +--ro fwdl-msg?      string
   |  |  +---x sftp              
   |  |  |  +---w input     
   |  |  |  |  +---w user              string
   |  |  |  |  +---w password?         string
   |  |  |  |  +---w host              string
   |  |  |  |  +---w directory         string
   |  |  |  |  +---w file?             string
   |  |  |  |  +---w (options)?
   |  |  |  |  |  +--:(manual)
   |  |  |  |  |  |  +---w manual?           empty
   |  |  |  |  |  |  +---w noreboot?         empty
   |  |  |  |  |  |  +---w nocommit?         empty
   |  |  |  |  |  +--:(noactivate)
   |  |  |  |  |  |  +---w noactivate?       empty
   |  |  |  |  |  +--:(coldboot)
   |  |  |  |  |     +---w coldboot?         empty
   |  |  |  |  +---w port?             int32
   |  |  |  |  +---w host-key-check?   empty
   |  |  |  |  +---w use-vrf?          common-def:vrf-name
   |  |  |  +--ro output    
   |  |  |     +--ro fwdl-tid?      int32
   |  |  |     +--ro fwdl-status?   int32
   |  |  |     +--ro fwdl-msg?      string
   |  |  +---x usb               
   |  |  |  +---w input     
   |  |  |  |  +---w directory     string
   |  |  |  |  +---w (options)?
   |  |  |  |     +--:(manual)
   |  |  |  |     |  +---w manual?       empty
   |  |  |  |     |  +---w noreboot?     empty
   |  |  |  |     |  +---w nocommit?     empty
   |  |  |  |     +--:(noactivate)
   |  |  |  |     |  +---w noactivate?   empty
   |  |  |  |     +--:(coldboot)
   |  |  |  |        +---w coldboot?     empty
   |  |  |  +--ro output    
   |  |  |     +--ro fwdl-tid?      int32
   |  |  |     +--ro fwdl-status?   int32
   |  |  |     +--ro fwdl-msg?      string
   |  |  +---x interactive       
   |  |  |  +--ro output    
   |  |  |     +--ro result?   string
   |  |  +--rw default-config
   |  |  |  +---x ftp     
   |  |  |  |  +---w input     
   |  |  |  |  |  +---w user         string
   |  |  |  |  |  +---w password?    string
   |  |  |  |  |  +---w host         string
   |  |  |  |  |  +---w directory    string
   |  |  |  |  |  +---w file?        string
   |  |  |  |  |  +---w manual?      empty
   |  |  |  |  |  +---w noreboot?    empty
   |  |  |  |  |  +---w use-vrf?     common-def:vrf-name
   |  |  |  |  +--ro output    
   |  |  |  |     +--ro fwdl-tid?      int32
   |  |  |  |     +--ro fwdl-status?   int32
   |  |  |  |     +--ro fwdl-msg?      string
   |  |  |  +---x scp     
   |  |  |  |  +---w input     
   |  |  |  |  |  +---w user         string
   |  |  |  |  |  +---w password?    string
   |  |  |  |  |  +---w host         string
   |  |  |  |  |  +---w directory    string
   |  |  |  |  |  +---w file?        string
   |  |  |  |  |  +---w manual?      empty
   |  |  |  |  |  +---w noreboot?    empty
   |  |  |  |  |  +---w use-vrf?     common-def:vrf-name
   |  |  |  |  +--ro output    
   |  |  |  |     +--ro fwdl-tid?      int32
   |  |  |  |     +--ro fwdl-status?   int32
   |  |  |  |     +--ro fwdl-msg?      string
   |  |  |  +---x sftp    
   |  |  |  |  +---w input     
   |  |  |  |  |  +---w user         string
   |  |  |  |  |  +---w password?    string
   |  |  |  |  |  +---w host         string
   |  |  |  |  |  +---w directory    string
   |  |  |  |  |  +---w file?        string
   |  |  |  |  |  +---w manual?      empty
   |  |  |  |  |  +---w noreboot?    empty
   |  |  |  |  |  +---w use-vrf?     common-def:vrf-name
   |  |  |  |  +--ro output    
   |  |  |  |     +--ro fwdl-tid?      int32
   |  |  |  |     +--ro fwdl-status?   int32
   |  |  |  |     +--ro fwdl-msg?      string
   |  |  |  +---x tftp    
   |  |  |  |  +---w input     
   |  |  |  |  |  +---w host         string
   |  |  |  |  |  +---w directory    string
   |  |  |  |  |  +---w file?        string
   |  |  |  |  |  +---w manual?      empty
   |  |  |  |  |  +---w noreboot?    empty
   |  |  |  |  +--ro output    
   |  |  |  |     +--ro fwdl-tid?      int32
   |  |  |  |     +--ro fwdl-status?   int32
   |  |  |  |     +--ro fwdl-msg?      string
   |  |  |  +---x usb     
   |  |  |     +---w input     
   |  |  |     |  +---w directory    string
   |  |  |     |  +---w manual?      empty
   |  |  |     |  +---w noreboot?    empty
   |  |  |     +--ro output    
   |  |  |        +--ro fwdl-tid?      int32
   |  |  |        +--ro fwdl-status?   int32
   |  |  |        +--ro fwdl-msg?      string
   |  |  +--rw fullinstall
   |  |     +---x ftp     
   |  |     |  +---w input     
   |  |     |  |  +---w user         string
   |  |     |  |  +---w password?    string
   |  |     |  |  +---w host         string
   |  |     |  |  +---w directory    string
   |  |     |  |  +---w file?        string
   |  |     |  |  +---w manual?      empty
   |  |     |  |  +---w use-vrf?     common-def:vrf-name
   |  |     |  +--ro output    
   |  |     |     +--ro fwdl-tid?      int32
   |  |     |     +--ro fwdl-status?   int32
   |  |     |     +--ro fwdl-msg?      string
   |  |     +---x scp     
   |  |     |  +---w input     
   |  |     |  |  +---w user         string
   |  |     |  |  +---w password?    string
   |  |     |  |  +---w host         string
   |  |     |  |  +---w directory    string
   |  |     |  |  +---w file?        string
   |  |     |  |  +---w manual?      empty
   |  |     |  |  +---w use-vrf?     common-def:vrf-name
   |  |     |  +--ro output    
   |  |     |     +--ro fwdl-tid?      int32
   |  |     |     +--ro fwdl-status?   int32
   |  |     |     +--ro fwdl-msg?      string
   |  |     +---x sftp    
   |  |     |  +---w input     
   |  |     |  |  +---w user         string
   |  |     |  |  +---w password?    string
   |  |     |  |  +---w host         string
   |  |     |  |  +---w directory    string
   |  |     |  |  +---w file?        string
   |  |     |  |  +---w manual?      empty
   |  |     |  |  +---w use-vrf?     common-def:vrf-name
   |  |     |  +--ro output    
   |  |     |     +--ro fwdl-tid?      int32
   |  |     |     +--ro fwdl-status?   int32
   |  |     |     +--ro fwdl-msg?      string
   |  |     +---x tftp    
   |  |     |  +---w input     
   |  |     |  |  +---w host         string
   |  |     |  |  +---w directory    string
   |  |     |  |  +---w file?        string
   |  |     |  |  +---w manual?      empty
   |  |     |  +--ro output    
   |  |     |     +--ro fwdl-tid?      int32
   |  |     |     +--ro fwdl-status?   int32
   |  |     |     +--ro fwdl-msg?      string
   |  |     +---x usb     
   |  |        +---w input     
   |  |        |  +---w directory    string
   |  |        |  +---w manual?      empty
   |  |        +--ro output    
   |  |           +--ro fwdl-tid?      int32
   |  |           +--ro fwdl-status?   int32
   |  |           +--ro fwdl-msg?      string
   |  +--rw install
   |  |  +---x ftp    
   |  |  |  +---w input     
   |  |  |  |  +---w user         string
   |  |  |  |  +---w password?    string
   |  |  |  |  +---w host         string
   |  |  |  |  +---w directory    string
   |  |  |  |  +---w file?        string
   |  |  |  |  +---w manual?      empty
   |  |  |  |  +---w use-vrf?     common-def:vrf-name
   |  |  |  +--ro output    
   |  |  |     +--ro fwdl-tid?      int32
   |  |  |     +--ro fwdl-status?   int32
   |  |  |     +--ro fwdl-msg?      string
   |  |  +---x scp    
   |  |     +---w input     
   |  |     |  +---w user         string
   |  |     |  +---w password?    string
   |  |     |  +---w host         string
   |  |     |  +---w directory    string
   |  |     |  +---w file?        string
   |  |     |  +---w manual?      empty
   |  |     |  +---w use-vrf?     common-def:vrf-name
   |  |     +--ro output    
   |  |        +--ro fwdl-tid?      int32
   |  |        +--ro fwdl-status?   int32
   |  |        +--ro fwdl-msg?      string
   |  +---x commit                      
   |  |  +--ro output    
   |  |     +--ro result?   string
   |  +---x restore                     
   |  |  +--ro output    
   |  |     +--ro result?   string
   |  +---x sync                        
   |  |  +--ro output    
   |  |     +--ro result?   string
   |  +---x activate                    
   |  |  +--ro output    
   |  |     +--ro overall-status?      int32
   |  |     +--ro overall-error-msg?   string
   |  |     +--ro status?              int32
   |  +---x recover                     
   |  |  +--ro output    
   |  |     +--ro result?   string
   |  +--rw auto-sync
   |  |  +---x enable     
   |  |  |  +--ro output    
   |  |  |     +--ro result?   string
   |  |  +---x disable    
   |  |     +--ro output    
   |  |        +--ro result?   string
   |  +--rw peripheral-update-option
   |     +---x peripheral-update-cpld          
   |     +---x peripheral-update-fpga          
   |     +--rw peripheral-update-bmc-option
   |        +---x peripheral-update-bmc-all            
   |        +---x peripheral-update-bmc-boot           
   |        +---x peripheral-update-bmc-application    
   +--rw write
   |  +---x erase    
   |     +---w input     
   |     |  +---w erase_all?   empty
   |     +--ro output    
   |        +--ro fwdl-tid?      int32
   |        +--ro fwdl-status?   int32
   |        +--ro fwdl-msg?      string
   +--rw reboot
   |  +---x fastboot    
   +--rw dhcp
      +--rw ztp
         +---x log       
         |  +--ro output    
         |     +--ro dad-cmd-msg?   string
         +---x cancel    
            +--ro output    
               +--ro dad-cmd-msg?   string

RPCs

+---x fwdl-status          
   |  +---w input     
   |  |  +---w fwdl-tid?   int32
   |  +--ro output    
   |     +--ro number-of-entries?   uint32
   |     +--ro fwdl-state?          enumeration
   |     +--ro fwdl-entries*
   |        +--ro index?                uint32
   |        +--ro message-id?           int32
   |        +--ro date-and-time-info?   string
   |        +--ro message?              string
   |        +--ro blade-slot?           int32
   |        +--ro blade-swbd?           int32
   |        +--ro blade-name?           string
   |        +--ro blade-state?          enumeration
   |        +--ro blade-app?            string
   +---x activate-status      
   |  +--ro output    
   |     +--ro overall-status?      int32
   |     +--ro overall-error-msg?   string
   |     +--ro status?              int32
   +---x firmware-download    
      +---w input     
      |  +---w (protocol-type)?
      |  |  +--:(scp-protocol)
      |  |  |  +---w scp
      |  |  |     +---w user         string
      |  |  |     +---w password?    string
      |  |  |     +---w host         string
      |  |  |     +---w directory    string
      |  |  |     +---w file?        string
      |  |  +--:(ftp-protocol)
      |  |  |  +---w ftp
      |  |  |     +---w user         string
      |  |  |     +---w password?    string
      |  |  |     +---w host         string
      |  |  |     +---w directory    string
      |  |  |     +---w file?        string
      |  |  +--:(sftp-protocol)
      |  |  |  +---w sftp
      |  |  |     +---w user              string
      |  |  |     +---w password?         string
      |  |  |     +---w host              string
      |  |  |     +---w directory         string
      |  |  |     +---w file?             string
      |  |  |     +---w port?             int32
      |  |  |     +---w host-key-check?   empty
      |  |  +--:(usb-protocol)
      |  |     +---w usb
      |  |        +---w directory    string
      |  +---w coldboot?   empty
      +--ro output    
         +--ro fwdl-cmd-status?   int32
         +--ro fwdl-cmd-msg?      string
         +--ro cluster-output*
            +--ro fwdl-status?   int32
            +--ro fwdl-msg?      string