systemFileCmdUri
IBM-BCCUSTOM-MIB ·
.1.3.6.1.4.1.2.6.215.4.2.4
Object
scalar
r/w
OctetString
This is a URI string that specifies the location and various parameters to be
used by the switch to perform a get or put operation using any of the supported
protocols TFTP, FTP, sFTP, SFTP and FTP are mandatory and TFTP is
recommended to support various user update tools. The IOM must report the
protocols supported for the level of executing firmware in the IOM capabilities
field of the VPD EEPROM. In this context the CMM (or remote host) acts as the
server and the IOM acts as the client. The format of this string is as follows:
<protocol>://<username>:<password>@<IP address or hostname>:<port>/<path>/<filename>
An example of a fully qualified address for the firmware packet file would be:
ftp://USERID:PASSW0RD@192.168.0.2:30045/tmp/service.log
or
ftp://USERID:PASSW0RD@[fe80::290:27ff:fe29:6019]:30045/tmp/service.log
or
sftp://USERID:PASSW0RD@192.168.0.2:30045/tmp/service.log
or
sftp://USERID:PASSW0RD@[fe80::290:27ff:fe29:6019]:30045/tmp/service.log
where the FTP or sFTP protocol will be used for transferring the packet file,
username is USERID, password is PASSW0RD, host IP address is
fe80::290:27ff:fe29:6019 or 192.168.0.2, port number is 30045, and /tmp is the
full pathname to the packet file service.log. Note: The URI may or may not have
a port number. If the port number is not included the default port number for that
protocol will be used.
Some protocols do not need the username, password, and the port number, so
the minimum requirement for a fully qualified address would be:
<protocol>://<IP address or hostname>/<path</<filename>
An example of a fully qualified address for the firmware packet file can be:
tftp://192.168.0.2:2022/1527 tmp/service.log
Note: CMM sets the systemFileCmdUri to provide the URI that includes the IP
address, protocol, filename.filetype and any authentication parameters.
a. If the IOM currently has a file contained in the IOM's file-system then the URI
will contain the appropriate filename.filetype
b. If the IOM does not generate the file until the file transfer, the CMM will create
the URI with a prefix filename.filetype such as IOM3_service_.txt. The IOM is
then responsible to parse the file name for a the category of file being requested
by the CMM (_'service_' or '_config_' or '_syslog_'). Then concatenate to the
MM's
created prefix the IOM's VPD part-number and a timestamp. For example the
IOM would use the prefix created by CMM 'IOM3_service_.txt'
to 'IOM3_service_02R1014_20110916-004651.tgz'. (generic format is;
<IOM(slot number)>_service_<IOM Part Number>_<date: 4 digit year 2 digit
month 2 digit day>-<time: 2 digit hour 2 digit minutes 2 digit seconds>
Note: file-type used is completely up to the IOM.
Notes on sftp file transfers:
(1) Summary: CMM will provide to the IOM the fingerprint of the CMM sftp
server's public key as part of the other parameters in the URI for the file
transfer.
(2) CMM 'sets' to the IOM the URI which will contain the fingerprint (128bit MD5
fingerprint). For example assume the 128bit MD5 fingerprint of the 1024-bit
RSA key is '00:6d:75:9e:f3:38:2b:6b:2e:e7:a8:87:9f:ea:26:03'. CMM issues
a 'set' of the URI to the IOM of form:
<protocol>://<username>:<password>;<fingerprint>@<IP
address>:<port>/<path>/<filename.
Then the URI would be: sftp://USERID:PASSW0RD;
00:6d:75:9e:f3:38:2b:6b:2e:e7:a8:87:9f:ea:26:03@
[fe80::290:27ff:fe29:6019]:30045/tmp/application.img
(3) The fingerprint character string then will be used by IOM to create the
CMM's sftp servers public key and add to the IOM's known host key file.
(4) IOM sftp client then connects to the CMM sftp server. Since IOM has the
CMM sftp servers public key fingerprint the IOM sftp client will look into it's
known host key file. IOM begins the sftp transfer of application.img using the
user credentials (for example USERID, PASSW0RD) and CMM's sftp server
key.
Note - As of 5/1/2013 this specification assumes that the fingerprint in the
URI will be for a RSA key only. Therefore all IOM sftp client's when
connecting to the sftp server will respond to the sftp server and indicate in
the 'server_host_key_algorithms' list that a RSA key is the preferred key by
listing this first in the 'server_host_key_algorithms' parameter name-list. '
The sftp client and server then will be required to use a RSA key for the file
transfer. In the future the URI syntax will be changed to allow the user to
specify which type of key (RSA or DSA) the fingerprint is for.
Context
- MIB
- IBM-BCCUSTOM-MIB
- OID
.1.3.6.1.4.1.2.6.215.4.2.4- Type
- scalar
- Access
- readwrite
- Status
- current
- Parent
- systemFileCmd
- Siblings
- 8
Syntax
OctetString
Values & Constraints
Object Constraints
range: 0-1024
Related Objects
Sibling Objects
| Object | Type | Syntax | OID |
|---|---|---|---|
| systemFileCmdCnt The I/O Module must indicate the number of system files that it has available to
user. For an example a value of 0 should be used if it has no system file, a value
of 1 should be … | scalar | Integer32 | .1.3.6.1.4.1.2.6.215.4.2.1 |
| systemFileCmdFilename deprecated The system file name and category of the file set by AMM that the I/O Module
must use to perform an operation on the file. The string format of this command
is defined:
1366 File… | scalar | OctetString | .1.3.6.1.4.1.2.6.215.4.2.2 |
| systemFileCmdMaxSize The AMM will set the maximum file size allowable for the IOM system file when
IOM upload its system file to a remote server. IOM must not exceed this file size
limit. The file siz… | scalar | Integer32 | .1.3.6.1.4.1.2.6.215.4.2.3 |
| systemFileCmdSftpRsaKey deprecated Contains the public 1024 bit RSA key used for a secure a file transfer utilizing sFTP over a SSH
connection. The CMM will issue a set (write) of this object with
the CMMs current… | scalar | OctetString | .1.3.6.1.4.1.2.6.215.4.2.5 |
| systemFileCmdExecuteOp The action the I/O Module must take on the system file MAX-ACCESS operation. Upon
receiving this command IOM must immediately execute the operation with all the
necessary informat… | scalar | Enumeration | .1.3.6.1.4.1.2.6.215.4.2.6 |
| systemFileOperationStatus The status of the system file operation:
0: No operation pending.
1-100: the percentage of completion of the operation.
101: success.
201: failed | scalar | Enumeration | .1.3.6.1.4.1.2.6.215.4.2.7 |
| systemFileOpStatusString This is a string of information about the final result of system file operation. It will
further qualify in detail the information provided by the system file operation
status and… | scalar | OctetString | .1.3.6.1.4.1.2.6.215.4.2.8 |
| systemFileActivation This object is used only for configuration files. After the transfer of the
configuration file is completed to the IOM the CMM can use this object to
immediately activate the conf… | scalar | Enumeration | .1.3.6.1.4.1.2.6.215.4.2.9 |