board_sw
Handles status and upgrade of device boards and media gateways.
Format
- -status -bpos xx [-extdev]
- -status -mgw xx [-boardid yy] [-extdev]
- -version type [-lim xx|-mgw yy|-bpos zz]
- -sesboards -mgw xx
- -load (-bpos xx| -mgw yy -boardid zz) [-ind ii] [-add “abc”] -file file
- -netload (-bpos xx| -mgw yy -boardid zz) [-ind ii] [-add “abc”] -path p -host n [-port x] [-protocol p] [-user u -password p]
- -activate (-bpos xx |-mgw yy -boardid zz)[-ind ii ] [-add "abc"]|
- -confirm (-bpos xx | -mgw yy -boardid zz)[-ind ii] [-add "abc"]
- -change (-bpos xx | -mgw yy -boardid zz)[-ind ii] [-add "abc"]
Function
The board_sw command is used to administrate loadable software on boards and some gateways. A board or an individual attached to the board can be loaded with new software, changed to the newly loaded version, or reverted back to the previous version with command. The present software status can be investigated, to verify the software status. The board name and revision information string can also be updated. Do not use the all option (omitted -mgw parameter) unless you know that all media gateways are of the same type. You can only load/activate one media gateway type at a time.
Parameters
- -activate
Will change the program version that is active to the new version.
- -add
Additional information text string that is sent to the board. If omitted an empty string is sent. String maximum 15 character.
- -boarddata
Will upgrade the string describing the board name, revision, and so on.
- -boardid
Identity of the boards that will be handled. Integer.
- -bpos
Board position has the format X-Y-Z where X=lim number+gateway, Y=magazine, Z=position
Example: 1A-0-10
- -brdnam
The name of the board. String maximum 15 character.
- -change
Will remove passive software. If kept, the unit will by in “OLD” state, otherwise it will be removed.
- -confirm
Will change the status of the newly loaded and active program, so that it will be the default choice at later starts.
- -extdev
Used to print information from external devices connected to this board.
- -file
File name including path where the software is stored that will be loaded to the stated device. String.
- -gateway
The target for the command is a media gateway.
- -host
Computer name or IP address of the host where the update file(s) reside(s).
- -ind
Individual on the board to handle. Integer.
- -lim
LIM number range: 1-124
Example: 1
- -load
Will load the stated board(s) with a new version of software.
- -mgw
Media gateway has the format LLLG where LLL=lim number [range: 1-124], G=gateway letter [range: A-O].
Example: 2B
- -netload
The device board shall load the new program version over the network.
- -password
Password to be used when fetching files from the host.
- -path
Path to the directory where the software is stored that shall be loaded to the board, is stored. String.
- -port
Port to use when fetching file on host, if other than default.
- -prodno
The product number of the board. String maximum 20 character.
- -protocol
Protocol to use when fetching a file from the host.(by http, ftp, and so on). Http is default value.
- -rev
The revision state of the board. String maximum 8 character.
- -sesboards
Will print information from boards that has no switch position. In general LSU and DSU boards.
- -status
Will print the hardware id and software status of the stated boards.
- -user
User name to be used when fetching a file from the host.
- -version
Will print the hardware and software version. Argument values can be: format= Printout of board data warning= Mismatch with configuration file faulty= Mismatch with configuration file raw= Raw format on info from boards.
Examples
- Investigate a board software status.
board_sw -status -bpos 1C-0-60
- Start loading new operating system software file.
board_sw -load -bpos 1C-0-60 -file /usr/firmware/elf31_r7a
- Change to the new version of software.
board_sw -activate -bpos 1c-0-60
- Confirm that the new version was tested and should be used as default:
board_sw -confirm -bpos 1C-0-60
- Revert back to the previous version.
board_sw -change -bpos 1C-0-60
- Update the revision information of the board.
board_sw -boarddata -bpos 1C-0-60 -boardid 17 -prodno “ROF 123 345" -rev R2A -brdnam “ELU99”
- Update the software on a Media Gateway by network.
board_sw -gateway -netload -path MGU/0.1.234 -protocol http -host 203.0.113.40 -mgw 2A
- Update the software on several Media Gateways by network. Note that if you have a mix of different types of media gateways, you should not try to update more than one type of media gateway at a time, or else you will get a partly failed command, with negative responses from the media gateways of faulty type. Here the MGUs are updated, but Media Servers would need a different path.
board_sw -gateway -netload -path MGU/0.1.234 -protocol http -host 203.0.113.40 -mgw 1A...1D,1F
- Activate the software on a Media Gateway
board_sw -gateway -activate -mgw 2A
Activate the software on several Media Gateways. Note that if you have a mix of different types of media gateways, you should not try to activate more than one type of media gateway at a time, or else you will get a partly failed command, with negative responses from the media gateways of faulty type.
Here the -mgw parameter is omitted, so the command will try activating all media gateways.
board_sw -gateway -activate
Notes:
"exe" -Executing.
"exes" -Executing, after activation of new sw.
"exet" -Executing, after restart forcing old sw back.
"pas" -Passive.
"sby" -Stand By, The sw that will become "exet".
"fb" -Forced back, The sw that will become "old".
"old" -Old state, Dormant sw that will be overwritten.