OC Platform
Modules
Packages:
- openconfig-platform-linecard.yang
- openconfig-platform-port.yang
- openconfig-platform-transceiver.yang
- openconfig-platform.yang
Dependencies:
- openconfig-platform.yang
- openconfig-platform.yang
- openconfig-if-ethernet
- iana-if-type
- ietf-interfaces
- ietf-yang-types
- openconfig-platform.yang
- openconfig-transport-types.yang
- openconfig-extensions.yang
- openconfig-interfaces.yang
- openconfig-yang-types.yang
- openconfig-types.yang
- openconfig-platform-types.yang
Querying the Module Power Config-Related Info and Poweroff Modules
Querying the Module Power Config-Related Info and Poweroff Modules
Request:
NETCONF SEND get-config
Source: running
<filter>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<linecard xmlns="http://openconfig.net/yang/platform/linecard"/>
</component>
</components>
</filter>
Response:
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:58f140c4-e306-4c7f-ae59-2a5bb9f8f6d1">
<data>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>8</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>8</slot-id>
</state>
</linecard>
</component>
<component>
<name>6</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>6</slot-id>
</state>
</linecard>
</component>
<component>
<name>4</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>4</slot-id>
</state>
</linecard>
</component>
<component>
<name>1</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>1</slot-id>
</state>
</linecard>
</component>
<component>
<name>2</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<slot-id>2</slot-id>
</state>
</linecard>
</component>
<component>
<name>7</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>7</slot-id>
</state>
</linecard>
</component>
<component>
<name>5</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>5</slot-id>
</state>
</linecard>
</component>
<component>
<name>3</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<config>
<power>POWER_DISABLED</power>
</config>
</linecard>
</component>
<component>
<name>25</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<slot-id>25</slot-id>
</state>
</linecard>
</component>
<component>
<name>21</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<slot-id>21</slot-id>
</state>
</linecard>
</component>
<component>
<name>26</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>26</slot-id>
</state>
</linecard>
</component>
<component>
<name>24</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>24</slot-id>
</state>
</linecard>
</component>
<component>
<name>23</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>23</slot-id>
</state>
</linecard>
</component>
<component>
<name>22</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>22</slot-id>
</state>
</linecard>
</component>
<component>
<name>28</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>28</slot-id>
</state>
</linecard>
</component>
<component>
<name>27</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>27</slot-id>
</state>
</linecard>
</component>
<component>
<name>29</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>29</slot-id>
</state>
</linecard>
</component>
<component>
<name>30</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<state>
<power>POWER_ENABLED</power>
<slot-id>30</slot-id>
</state>
</linecard>
</component>
</components>
</data>
</rpc-reply>
Type: State
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right.
show run | grep –i poweroff
Configuring a Poweroff Module
Configuring a Poweroff Module
Request:
<config>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>1</name>
<linecard xmlns="http://openconfig.net/yang/platform/linecard">
<config>
<power>POWER_DISABLED</power>
</config>
</linecard>
</component>
</components>
</config>
Response:
Response: commit Ok
Type: Data
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right.
poweroff module <x>
Configuring Breakout on Supported Interfaces
Configuring Breakout on Supported Interfaces
Request:
RPC request:
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
<edit-config>
<target>
<running/>
</target>
<config>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>eth1/51</name>
<port>
<breakout-mode xmlns="http://openconfig.net/yang/platform/port">
<config>
<num-channels xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="merge">2</num-channels>
<channel-speed xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="merge">oc-eth:SPEED_50GB</channel-speed>
</config>
</breakout-mode>
</port>
</component>
</components>
</config>
</edit-config>
</rpc>
Response:
Response:
NETCONF Reply OK
Type: State
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right.
interface breakout mod 1 port 53 map 50g-2x
Configuring 10G Breakout
Configuring 10G Breakout
Request:
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
<edit-config>
<target>
<running/>
</target>
<config>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>eth1/53</name>
<port>
<breakout-mode xmlns="http://openconfig.net/yang/platform/port">
<config>
<num-channels xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="merge">4</num-channels>
<channel-speed xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="merge">oc-eth:SPEED_10GB</channel-speed>
</config>
</breakout-mode>
</port>
</component>
</components>
</config>
</edit-config>
</rpc>
Response:
NETCONF Reply OK
Response:
Response : commit Ok
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right.
interface breakout module 1 port 53 map 10g-4x
Querying Transceiver Related Info Using RPC Requests
Querying Transceiver Related Info Using RPC Requests
Request:
<filter>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>eth1/51</name>
<transceiver xmlns="http://openconfig.net/yang/platform/transceiver">
<state>
<present/>
<form-factor/>
<vendor/>
<vendor-part/>
<vendor-rev/>
<serial-no/>
<date-code/>
</state>
</transceiver>
</component>
</components>
</filter>
Response:
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:88d2397e-ab3c-4866-9538-45ae265420a1">
<data>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>eth1/51</name>
<transceiver xmlns="http://openconfig.net/yang/platform/transceiver">
<state>
<present>PRESENT</present>
<form-factor>QSFP</form-factor>
<vendor>CISCO-FINISAR</vendor>
<vendor-part>FTLC1151RDPL-C1</vendor-part>
<vendor-rev>B</vendor-rev>
<serial-no>FNS20161EET</serial-no>
<date-code>2016-04-16T00:00:00Z+00:00</date-code>
</state>
</transceiver>
</component>
</components>
</data>
</rpc-reply>
Deviations:
- physical-channels
- **channel **
- **connector-type **
- **enabled **
- **ethernet-pmd **
- **ethernet-pmd-preconf **
- **fault-condition **
- **form-factor-preconf **
- input-power
- **internal-temp **
- laser-bias-current
- **otn-compliance-code **
- output-power
- sonet-sdh-compliance-code
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right.
show int e1/51 trans
Querying Module-related Info Using openconfig-platform Requests
Querying Module-related Info Using openconfig-platform Request
Request:
<filter>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>1</name>
</component>
</components>
</filter>
Response:
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:41d03567-8506-48ba-8255-d0e0615e02dd">
<data>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>1</name>
<state>
<name>N9K-X9732C-EXM</name>
<description>32x100G Ethernet Module</description>
<hardware-version>0.1220</hardware-version>
<id>1</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-18429-01</part-no>
<serial-no>FOC20444YCE</serial-no>
<software-version>9.2(0.108)</software-version>
<type>LINECARD</type>
</state>
</component>
</components>
</data>
</rpc-reply>
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right.
show mod 1
Querying All Module Info
Querying All Module Info
Request:
<filter>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<state/>
</component>
</components>
</filter>
Response:
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:3f014bc7-6865-4767-b234-134c09014e28">
<data>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>4</name>
<state>
<name>N9K-X9732C-EXM</name>
<description>32x100G Ethernet Module</description>
<hardware-version>0.1230</hardware-version>
<id>4</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-18429-01</part-no>
<serial-no>FOC205114M4</serial-no>
<software-version>9.2(0.108)</software-version>
<type>LINECARD</type>
</state>
</component>
<component>
<name>1</name>
<state>
<name>N9K-X9732C-EXM</name>
<description>32x100G Ethernet Module</description>
<hardware-version>0.1220</hardware-version>
<id>1</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-18429-01</part-no>
<serial-no>FOC20444YCE</serial-no>
<software-version>9.2(0.108)</software-version>
<type>LINECARD</type>
</state>
</component>
<component>
<name>2</name>
<state>
<name>N9K-X9736C-FX</name>
<description>36x40/100G Ethernet Module</description>
<hardware-version>0.3030</hardware-version>
<id>2</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-18315-03</part-no>
<serial-no>FOC21127NR2</serial-no>
<software-version>9.2(0.108)</software-version>
<type>LINECARD</type>
</state>
</component>
<component>
<name>3</name>
<state>
<name>N9K-X9736C-FX</name>
<description>36x40/100G Ethernet Module</description>
<hardware-version>0.3060</hardware-version>
<id>3</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-18315-03</part-no>
<serial-no>FOC21234PKU</serial-no>
<software-version>9.2(0.108)</software-version>
<type>LINECARD</type>
</state>
</component>
<component>
<name>25</name>
<state>
<id>25</id>
<type>FABRIC</type>
</state>
</component>
<component>
<name>21</name>
<state>
<id>21</id>
<type>FABRIC</type>
</state>
</component>
<component>
<name>26</name>
<state>
<name>N9K-C9504-FM-E</name>
<description>4-slot Fabric Module</description>
<hardware-version>1.0</hardware-version>
<id>26</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-17450-02</part-no>
<serial-no>SAL2024RSSH</serial-no>
<software-version>9.2(0.108)</software-version>
<type>FABRIC</type>
</state>
</component>
<component>
<name>24</name>
<state>
<name>N9K-C9504-FM-E</name>
<description>4-slot Fabric Module</description>
<hardware-version>1.0</hardware-version>
<id>24</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-17450-02</part-no>
<serial-no>SAL2024RSSE</serial-no>
<software-version>9.2(0.108)</software-version>
<type>FABRIC</type>
</state>
</component>
<component>
<name>23</name>
<state>
<name>N9K-C9504-FM-E</name>
<description>4-slot Fabric Module</description>
<hardware-version>1.0</hardware-version>
<id>23</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-17450-02</part-no>
<serial-no>FOC21070SAQ</serial-no>
<software-version>9.2(0.108)</software-version>
<type>FABRIC</type>
</state>
</component>
<component>
<name>22</name>
<state>
<name>N9K-C9504-FM-E</name>
<description>4-slot Fabric Module</description>
<hardware-version>1.0</hardware-version>
<id>22</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>INACTIVE</oper-status>
<part-no>73-17450-02</part-no>
<serial-no>FOC21070RB9</serial-no>
<software-version>9.2(0.108)</software-version>
<type>FABRIC</type>
</state>
</component>
<component>
<name>28</name>
<state>
<id>28</id>
<type>CPU</type>
</state>
</component>
<component>
<name>27</name>
<state>
<name>N9K-SUP-B</name>
<description>Supervisor Module</description>
<hardware-version>0.1020</hardware-version>
<id>27</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>02</part-no>
<serial-no>SAL1826VG0K</serial-no>
<software-version>9.2(0.108)</software-version>
<type>CPU</type>
</state>
</component>
<component>
<name>29</name>
<state>
<name>N9K-SC-A</name>
<description>System Controller</description>
<hardware-version>1.4</hardware-version>
<id>29</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-15294-02</part-no>
<serial-no>SAL1917DYUQ</serial-no>
<software-version>9.2(0.108)</software-version>
<type>FRU</type>
</state>
</component>
<component>
<name>30</name>
<state>
<name>N9K-SC-A</name>
<description>System Controller</description>
<hardware-version>1.4</hardware-version>
<id>30</id>
<mfg-name>Cisco Systems, Inc.</mfg-name>
<oper-status>ACTIVE</oper-status>
<part-no>73-15294-02</part-no>
<serial-no>SAL1917DYTA</serial-no>
<software-version>9.2(0.108)</software-version>
<type>FRU</type>
</state>
</component>
</components>
</data>
</rpc-reply>
Deviations:
- Temperature : instant | avg | min | max
- Property : config / state
- Firmware-version
- Temperature
- Cpu
- Memory
- Subcomponent
- Fan
- Power-supply
- Fabric
- Storage
- Cpu
- Integrated circuit
- backplane
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right.
show module
Fan
Packages:
- platform-fan.yang
Verifying Induvidual Fan Speed Details
Verifying Induvidual Fan Speed Details
Request:
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
<get>
<filter>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>fan1/1</name>
<fan>
<state/>
</fan>
</component>
</components>
</filter>
</get>
</rpc>
Response:
<rpc-reply xmlns:if="http://www.cisco.com/nxos:1.0:if_manager" xmlns:nfcli="http://www.cisco.com/nxos:1.0:nfcli" xmlns:nxos="http://www.cisco.com/nxos:1.0" xmlns:vlan_mgr_cli="http://www.cisco.com/nxos:1.0:vlan_mgr_cli" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:8e0757d3-0078-4398-8f45-ba96063652b8">
<data>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>fan1/1</name>
<fan>
<state>
<speed xmlns="http://openconfig.net/yang/platform/fan">5875</speed>
</state>
</fan>
</component>
</components>
</data>
</rpc-reply>
Note: This example was added in Release 9.3(3).
Container: openconfig-platform-fan
Type: State Data
CLI Output |
---|
|
CPU
Packages:
- platform-cpu.yang
- cisco-nx-openconfig-platform-cpu-deviations.yang
Verifying Induvidual CPU Utilization Details
Verifying Induvidual CPU Utilization Details
Request:
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
<get>
<filter>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>cpu1</name>
<cpu>
<utilization xmlns="http://openconfig.net/yang/platform/cpu">
<state/>
</utilization>
</cpu>
</component>
</components>
</filter>
</get>
</rpc>
Response:
<rpc-reply xmlns:if="http://www.cisco.com/nxos:1.0:if_manager" xmlns:nfcli="http://www.cisco.com/nxos:1.0:nfcli" xmlns:nxos="http://www.cisco.com/nxos:1.0" xmlns:vlan_mgr_cli="http://www.cisco.com/nxos:1.0:vlan_mgr_cli" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:532903da-b20a-4337-912f-73cade722c0f">
<data>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>cpu1</name>
<cpu>
<utilization xmlns="http://openconfig.net/yang/platform/cpu">
<state>
<avg>2</avg>
<instant>3</instant>
<max>5</max>
<min>0</min>
<max-time>1574201007</max-time>
<min-time>1574200983</min-time>
</state>
</utilization>
</cpu>
</component>
</components>
</data>
</rpc-reply>
CPU utilization is the sum of user and kernel utilization values. This value will be approximately equal to the sum of user and kernel percentages displayed in show system resources
output.
The min, max, average, min time and max time values are calculated over a 30 second moving window. In this 30 second window, CPU utilization is calculated every 5 seconds and min, max and average values are calculated over these 6 samples.
The time instant at which the minimum and maximum values occur within the last 30 second window are displayed in epoch time format.
Note: This example was added in Release 9.3(3).
Container: openconfig-platform-cpu
Type: State Data
Deviations: CPU State: openconfig-platform-cpu-utilization: interval is not supported
CLI Output |
---|
|
PSU
Packages:
- platform-psu.yang, cisco-nx-openconfig-platform-psu-deviations.yang
Verifying Induvidual PSU Utilization Details
Verifying Induvidual PSU Utilization Details
Request:
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
<get>
<filter>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>psu1</name>
<power-supply>
<state/>
</power-supply>
</component>
</components>
</filter>
</get>
</rpc>
Response:
<rpc-reply xmlns:if="http://www.cisco.com/nxos:1.0:if_manager" xmlns:nfcli="http://www.cisco.com/nxos:1.0:nfcli" xmlns:nxos="http://www.cisco.com/nxos:1.0" xmlns:vlan_mgr_cli="http://www.cisco.com/nxos:1.0:vlan_mgr_cli" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:d1f2e858-f235-4fca-aefd-cd79dad36488">
<data>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>psu1</name>
<power-supply>
<state>
<enabled xmlns="http://openconfig.net/yang/platform/psu">true</enabled>
<capacity xmlns="http://openconfig.net/yang/platform/psu">01000100100101100000000000000000</capacity>
<input-current xmlns="http://openconfig.net/yang/platform/psu">00111111101000000000000000000000</input-current>
<input-voltage xmlns="http://openconfig.net/yang/platform/psu">01000011011011100000000000000000</input-voltage>
<output-current xmlns="http://openconfig.net/yang/platform/psu">01000001101100100000000000000000</output-current>
<output-power xmlns="http://openconfig.net/yang/platform/psu">01000011100001010000000000000000</output-power>
<output-voltage xmlns="http://openconfig.net/yang/platform/psu">01000001010000000100000000000000</output-voltage>
</state>
</power-supply>
</component>
</components>
</data>
</rpc-reply>
As per openconfig standard, the output of the GET response is in oc-types:ieeefloat32 format.
Container: openconfig-platform-psu
Type: State Data
Deviations: Power-supply config: oc-platform-psu: enabled is not supported
CLI Output |
---|
|
Port
OC Port
OC Port
Netconf
REQUEST
<rpc>
<edit-config>
<target>
<running/>
</target>
<config>
<components xmlns="http://openconfig.net/yang/platform">
<component>
<name>eth1/49</name>
<port>
<breakout-mode xmlns="http://openconfig.net/yang/platform/port">
<groups>
<group>
<index>0</index>
<config>
<index xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="create">0</index>
<num-breakouts xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="create">4</num-breakouts>
<breakout-speed xmlns:oc-eth="http://openconfig.net/yang/interfaces/ethernet" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="create">oc-eth:SPEED_10GB</breakout-speed>
</config>
</group>
</groups>
</breakout-mode>
</port>
</component>
</components>
</config>
</edit-config>
</rpc>
RESPONSE
<rpc-reply>
<ok/>
</rpc-reply>
Note: This example was added in Release 10.4(1)F.
CLI Command
interface breakout module 1 port 49 map 10x-4g
Guidelines and Limitations
Following are the guidelines and limitations for port.
- Index should always be set to 0.
- From CLI map value of 10g-4x splits in : num-breakouts = 4 and breakout-speed=SPEED_10GB.
- Replace will have the following behavior. This is in sync with the CLI.
- Replace when no value exists will create breakout
- Replace when a breakout already exists will error if the current breakout configuration doesn't match the new configuration.