IBM Support

Introduction to Caja (ECJx) PDU's command-line interface management

How To


Summary

New Caja (ECJx) PDU's management and monitoring functionality that uses command-line interface. New enhancements could be interesting addition to some clients automation processes.

Objective

  • Caja (ECJx) PDU's command-line interface access steps
  • Few examples of the commands output
  • Complete commands reference list
  • Related PDU's materials reference

Environment

  • Command-line interface is implemented only on PDU types (ECJJ, ECJL, ECJN, ECJQ).
  • It will be available since system board firmware level version AD24032J_S10044.   
image-20230315162053-1   

Steps

Caja (ECJx) PDUs command-line interface access.

Run ssh session to PDU:
image-20221202145111-1

Select option "99. Command Line Interface" to obtain command prompt.
image-20221202145641-1

Commands output example:
 

{"name":"PDU","description":"DESC","date":"2022-12-13","dateFormat":"YYYY-MM-DD","time":"10:05:02","timeFormat":"hh:mm:ss","phoneNumber":"XXX-XXX-XXXX","countryRegion":"country region","streetAddress":"street address","city":"city","stateProvince":"state province","postalCode":"postal code","building":"building","floor":"floor","roomNumber":"xxx","row":"xxx","aisle":"xxx","displaceHeight":"0","altitude":"0","otherInformation":"other information"}

Additional Information

Complete commands reference:
Command> Office
help Show all available commands
quit Disconnect
logout Disconnect
exit Exit from current mode
history Show a list of previously run commands
add group Add new group. Example: add group NewGroup.
remove group Remove existing group. Example: remove group SomeGroup
get pdu Get PDU's meta information.
get pdu name
get pdu description
get pdu date
get pdu dateFormat
get pdu time
get pdu timeFormat
get pdu phoneNumber
get pdu countryRegion
get pdu streetAddress
get pdu city
get pdu stateProvince
get pdu postalCode
get pdu building
get pdu floor
get pdu roomNumber
get pdu row
get pdu aisle
get pdu displaceHeight
get pdu altitude
get pdu otherInformation
get counter Get PDU's performance counter information.
get counter cpu
get counter datalog
get counter eventlog
get sensor Get PDU's sensor information.
get sensor thermal
get sensor humidity
get sensor door1
get sensor door2
get sensor tempUnit
get sensor door1Normal
get sensor door2Normal
get outlet Get outlet information, all or specific. Example: get outlet, get outlet 2
get epo Get PDU's EPO configuration.
get epo t1
get epo t2
get epo recoveryState
get ungrouped Get ungrouped outlet information.
get group Get group information, all or specific. Example: get group, get group User
get network Get network configuration.
get network MACAddress
get network v6enable
get network v4
get network v4 origin
get network v4 address
get network v4 gateway
get network v4 netmask
get network v6
get network v6 origin
get network v6 address
get network v6 gateway
get network v6 prefix
get network v6 linkLocalAddress
get sntp Get SNTP configuration.
get sntp enable
get sntp server
get sntp port
get smtp Get SMTP configuration.
get smtp enable
get smtp server
get smtp port
get smtp loginAuth
get smtp userName
get smtp password
get smtp subjectPrefix
get smtp fromAddress
get smtp toAddress1
get smtp toAddress2
get smtp toAddress3
get smtp toAddress4
get snmp Get SNMP configuration.
get snmp v1v2Enable
get snmp v1v2WriteEnable
get snmp readCommunity
get snmp writeCommunity
get snmp trapCommunity
get snmp v4Trap1
get snmp v4Trap2
get snmp v3Enable
get snmp usm1
get snmp usm2
get snmp usm3
get snmp usm4
get alarm-list Get occuring alarm list.
get alarm Get alarm configuration.
get alarm powerFactorLowEnable
get alarm powerFactorLow
get alarm voltageHigh
get alarm voltageLow
get alarm currentHigh1
get alarm currentHigh2
get alarm currentHigh3
get alarm currentHigh4
get alarm currentHigh5
get alarm currentHigh6
get alarm currentHigh7
get alarm currentHigh8
get alarm currentHigh9
get alarm currentHigh10
get alarm currentHigh11
get alarm currentHigh12
get alarm thermalWarning
get alarm thermalCritical
get alarm humidityWarning
get alarm humidityCritical
get eventlog Get eventlog by providing start and count. Example: get eventlog 1 20
get eventlog info
get account Get current logged in account information.
get firmware-upgrade Get TFTP firmware upgrade configuration.
get firmware-upgrade server
get firmware-upgrade filename
get firmware-upgrade state
set pdu Set PDU's meta information.
set pdu name
set pdu description
set pdu date
set pdu time
set pdu phoneNumber
set pdu countryRegion
set pdu streetAddress
set pdu city
set pdu stateProvince
set pdu postalCode
set pdu building
set pdu floor
set pdu roomNumber
set pdu row
set pdu aisle
set pdu displaceHeight
set pdu altitude
set pdu otherInformation
set outlet Set specific outlet state. Example: set outlet 1 [on|off|epo]
set epo t1 Set T1-delay time before EPO starts. Unit in second. Example: set epo t1 3
set epo t2 Set T2-turn off time during EPO. Unit in second. Example: set epo t2 5
set epo recoveryState Set the recovery state after EPO. Example: set epo recoveryState [allOn|revious}
set group Set group configuration.
set network v6enable Set network IPv6 enable. Example: set network v6enable [enable|disable]
set network v4 origin Set network IPv4 origin. Example: set network v4 origin [dhcp|static]
set network v4 address
set network v4 gateway
set network v4 netmask
set network v6 origin
set network v6 address
set network v6 gateway
set network v6 prefix
set sntp enable
set sntp disable
set sntp server
set sntp port
set smtp enable
set smtp disable
set smtp server
set smtp port
set smtp loginAuth enable
set smtp loginAuth disable
set smtp userName
set smtp password
set smtp subjectPrefix
set smtp fromAddress
set smtp toAddress1
set smtp toAddress2
set smtp toAddress3
set smtp toAddress4
set snmp v1v2Enable
set snmp v1v2WriteEnable
set snmp readCommunity
set snmp writeCommunity
set snmp trapCommunity
set snmp v4Trap1
set snmp v4Trap2
set snmp v3Enable
set snmp usm1 name
set snmp usm1 authMethod
set snmp usm1 authPassword
set snmp usm1 privMethod
set snmp usm1 privPassword
set snmp usm2 name
set snmp usm2 authMethod
set snmp usm2 authPassword
set snmp usm2 privMethod
set snmp usm2 privPassword
set snmp usm3 name
set snmp usm3 authMethod
set snmp usm3 authPassword
set snmp usm3 privMethod
set snmp usm3 privPassword
set snmp usm4 name
set snmp usm4 authMethod
set snmp usm4 authPassword
set snmp usm4 privMethod
set snmp usm4 privPassword
set alarm powerFactorLowEnable
set alarm powerFactorLow
set alarm voltageHigh
set alarm voltageLow
set alarm currentHigh1
set alarm currentHigh2
set alarm currentHigh3
set alarm currentHigh4
set alarm currentHigh5
set alarm currentHigh6
set alarm currentHigh7
set alarm currentHigh8
set alarm currentHigh9
set alarm currentHigh10
set alarm currentHigh11
set alarm currentHigh12
set alarm thermalWarning
set alarm thermalCritical
set alarm humidityWarning
set alarm humidityCritical
set sensor tempUnit Set temperature unit to celsius of fahrenheit. Example: set sensor tempUnit [c|f]
set sensor door1Normal Set door1 normal state. Example: set sensor door1Normal [open|close]
set sensor door2Normal Set door2 normal state. Example: set sensor door2Normal [open|close]
set firmware-upgrade server
set firmware-upgrade filename
set firmware-upgrade state Set firmware upgrade state. Example: set firmware-upgrade state [normal|trigger]
set account name Set name of currently logged in user. Example: set account name new-name
set account password Modify password of currently logged in user. Example: set account password old-password new-password confirm-new-password
menu Switch to menu based operation.

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB57","label":"Power"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"POWER9","label":"IBM Power9"},"ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}]},{"Type":"MASTER","Line of Business":{"code":"LOB57","label":"Power"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"POWER10","label":"IBM Power10"},"ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}]},{"Type":"MASTER","Line of Business":{"code":"LOB57","label":"Power"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SSWB3U","label":"Power System Series Rack (7965-S42)"},"ARM Category":[{"code":"a8m0z000000bowJAAQ","label":"CEC \u0026 Power"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
16 March 2023

UID

ibm16844195