3 cli command reference conventions, 4 general commands, 1 help – Dell POWEREDGE M1000E User Manual

Page 14: Cli command reference conventions, General commands 3.4.1 help

Advertising
background image

Software User’s Manual

Rev 1.00

14

3.3

CLI Command Reference Conventions

This section describes the PTM CLI commands.

For each command, the following information is provided:
• Synopsys:

Lists the command name and any required or optional parameters. Variable parameters (like port
numbers) are shown in italics. Optional parameters are shown in square brackets, e.g.
[optional_parameter]. Required parameters are shown with no brackets.

• Description:

Provides a detailed description of the command and of all its parameters

• Example:

Usage example and command output.

• For purpose of automation, the symbol ‘#’ is used to indicate a comment that extends until the

next new-line character.

3.4

General Commands

3.4.1 help

Synopsys:

help

set port test

Sets port test mode attributes

Section 3.7.1, “set port test
(ADMIN),” on page 18

show port link

Shows port link state

Section 3.7.2, “show port link,” on
page 18

show port module Shows uplink module parameters

Section 3.7.3, “show port module,” on
page 19

show port test

Shows ports test mode status

Section 3.7.4, “show port test
(ADMIN),” on page 20

Debug Commands

cr_read

To read a 32 bit register from device num-
ber device_num.

Section 3.8.1, “cr_read (ADMIN),” on
page 20

cr_write

To write a data_dword to address
0xHex_address to device number
device_num.

Section 3.8.2, “cr_write (ADMIN),”
on page 20

Table 5 - List of Commands

Command

name

Short Description

Reference

Advertising