Extend Application Mediation Device Command Reference Guide

Transcription

1 Extend Application Mediation Device Command Reference Guide Version 2.0x Part Number CG-EXT Rev by Kentrox, Inc. All rights reserved.

2 Copyright 2008 by Kentrox, Inc. All Rights Reserved. The material discussed in this publication is the proprietary property of Kentrox, Inc. Kentrox retains all rights to reproduction and distribution of this publication. Kentrox is a registered trademark of Kentrox, Inc. Applied Innovation, Applied Innovation Inc., the AI logo, and other names are the intellectual property of Kentrox. All other product names are trademarks or registered trademarks of their respective owners. Information published here is current as of this document s date of publication, but is subject to change without notice. You may verify product information by contacting our headquarters in Oregon. Kentrox is an Equal Opportunity/Affirmative Action employer. Kentrox, Inc Innovation Dr. Dublin, Ohio USA Toll Free: (800) International: +1 (614) Fax: +1 (614) NW Tanasbourne Dr. Hillsboro, Oregon USA Toll Free: (800) Direct: (503)

3 About this Document This document provides a reference for all the commands in the Extend application mediation device command line interface (CLI). Extend system administrators should have a working knowledge of: Telecommunications networks, system architecture, and network topology Devices on the network FTP tools Extend script developers should also have a working knowledge of: The Python script language XML syntax The development environment (Linux, UNIX, or cygwin tools on Windows) i

4 About this Document: Document Conventions Document Conventions Table 1 describes the text conventions used in this document. Table 1 Document Conventions Convention Screen Text, Menu Items, System Prompts, Messages and Reports Static Command Text Variable Command Text Meaning This style indicates configuration screen text, menu items, system prompts, messages, and reports. In a command statement, this style indicates text that should be entered exactly as shown at a command line. In a command statement, this style indicates user-specified text.... In a command statement, ellipses (...) signify that the preceding parameter can be repeated a number of times. [ ] [ ] In a command statement, square brackets indicate an optional parameter. Two or more parameters in square brackets with a vertical bar ( ) between them indicate a choice of optional parameters. { } In a command statement, two or more parameters in braces with a vertical bar ( ) between them indicate a choice of required parameters. Menus and Menu Commands Dialog Boxes, Tabs, Fields, Check Boxes, and Command Buttons Variable Field Text KEYS Labels This style indicates menu and menu commands. A vertical bar ( ) separates the menus from the submenus or menu commands. The vertical bar also indicates the order in which you should click the menus, submenus, and menu commands. This style indicates dialog boxes, tabs, fields, check boxes, and command buttons. This style indicates variable information you type in a dialog box field. Uppercase body text indicates keys on a keyboard, such as the TAB or ENTER keys. Keys used in combination are connected with a plus symbol (+). This style designates physical components on Kentrox products such as jumpers, switches, and cable connectors. ii

5 About this Document: Document Conventions Table 1 Document Conventions (Continued) Convention Note: Important: Tip: CAUTION: WARNING: Meaning Note messages emphasize or supplement important points of the main text. Important messages provide information that is essential to the completion of a task. Tip messages provide information that assists users in operating equipment more effectively. Caution messages indicate that failure to take a specified action could result in loss of data and/or harm to the software or hardware. Warning messages indicate that failure to take a specified action could result in physical harm to the user. iii

6 About this Document: Using this Document Using this Document The following information about commands is provided in this document: Formats Parameters Command Defaults Required User Profiles Examples See Also This section includes a detailed description of the command. Formats This section lists all valid format statements for the command. For example, the config timeout command has three valid formats: config timeout minutes config default timeout config no timeout The config, timeout, default, and no parameters, which are shown in bold command font, are all commands or static parameters. Enter these values exactly as shown in the format statements. The minutes parameter, which is shown in italicized command font, is a variable parameter. Substitute the amount of time that can elapse before a Extend session expires for this variable parameter. Parameters This section lists and describes possible parameters for the command. Valid values for each parameter are also provided, if applicable. Command Defaults This section provides the default values of the command, if applicable. Required User Profiles This section lists the user profiles needed to execute the command. Examples This section provides screen captures depicting actual command executions. An explanation of each example is provided. iv

7 About this Document: Using this Document See Also This section lists commands that you may want to reference while executing the command. For example, if you plan to use the config timeout command to configure the session timeout, you may want to use the show timeout command to display the existing session timeout value. v

8 About this Document: Customer Assistance Customer Assistance Kentrox offers technical support 24 hours a day, seven days a week. Before you contact Kentrox for assistance, please have the following information available: The type of hardware and software you are using The error number and exact wording of any messages that appeared on your screen What happened and what you were doing when the problem occurred How you tried to solve the problem Web Site Support Support is available 24 hours a day using our Web site at: Support support is available 24 hours a day. When you use support, please be sure to include the details of your problem within the . To contact Technical Support, send to: techsupport@aiinet.com Phone Support Phone support is available. When you call Kentrox for support, please be sure you are at your computer and have the details of your problem available. To contact Technical Support, call (866) Kentrox Product Documentation To order documentation, please contact your sales representative at (800) or +1 (614) You can also access and view the most current versions of Kentrox product documentation on our Web site at: vi

9 Using the CLI Extend Version 2.0x Command Reference Guide Using the CLI This section explains the structure and use of the CLI. It also explains the CLI navigation keys and methods, as well as the available help screens. Command Types There are four groups of Extend commands: Configuration Commands Diagnostic Commands Show Commands Utility Commands Configuration Commands Configuration commands set up Extend. They usually require parameters and generally have default values. To specify configuration, use command config. For example, enter config users add with the following specifications to add a new Extend user: User name userb Profile supervisor Password secretword (AI)>config users add userb supervisor secretword secretword (AI)> Diagnostic Commands Diagnostic commands display system-wide diagnostics. They can display information about logged in users and running processes. To specify Extend diagnostics, use command diag. For example, enter diag who to display all users logged into Extend. (AI)>diag who test ttys0 Aug 9 14:12 brb22 pts/0 Aug 9 17:03 ( ) (AI)> 1

10 Using the CLI Show Commands Show commands display options, statuses, and settings. They do not have default values and generally only require optional parameters. To use show commands, enter command show. For example, enter command show interfaces to display all configured interfaces. (AI)>show interfaces ethernet 0/0 address= ;mask= status=enabled system-name=eth0_0 link-state=up ethernet 0/1 address= ;mask= status=enabled system-name=eth0_1 link-state=up desc=inthetraffic ethernet 0/2 address= ;mask= status=enabled system-name=eth0_2 link-state=down ethernet 0/3 address= ;mask= status=enabled system-name=eth0_3 link-state=down (AI)> Utility Commands Utility commands handle administrative tasks such as copying files, displaying the running configuration, and logging out of Extend. All are executable from any level of the CLI. For example, enter trace-route from the interface configuration level to view a traceroute to an address. (AI) config interface ethernet 0/2>trace-route traceroute to ( ), 30 hops max, 40 byte packets ( ) ms ms ms (AI) config interface ethernet 0/2> CLI Navigation and Command Entry Specific keys can be used to navigate backward or forward in the CLI, edit command line entries, or execute command entry shortcuts. Navigation Keys Navigation keys and key combinations are available for quickly moving backward and forward through the CLI. Those that are available for Extend appear in Table 1. Table 1 CLI Keystrokes Key Combinations DELETE or BACKSPACE CTRL+a CTRL+e Action Deletes a previous character. Places the cursor at the beginning of a line. Places the cursor at the end of a line. 2

11 Using the CLI Table 1 CLI Keystrokes (Continued) Key Combinations RIGHT ARROW or CTRL+f LEFT ARROW or CTRL+b CTRL+d CTRL+u CTRL+k CTRL+t UP ARROW or CTRL+p DOWN ARROW or CTRL+n CTRL+z TAB exit Action Moves forward one character. Moves backward one character. Deletes the current character. Deletes the entire line. Deletes to the end of the line. Reverses the order of the current character and the previous character. Moves to the previous line in the history buffer. Moves to the next line in the history buffer. Returns to the root command prompt. Completes the command line entry. Moves to next higher level in the CLI.? Displays related command choices and command usage statements. Note: Some key combinations might not be available for all types of terminal emulation software. TAB Key The TAB key lets you quickly enter words in a command without typing the full command name. For example, to enter the config command, you can type the first three letters and press TAB to see the entire command name. Note: For TAB completion to work correctly, enter a unique character set so that the CLI can distinguish the desired command name from other possible command names. 3

12 Using the CLI When pressed twice at a stopping point, the TAB key displays a list of all commands available from the stopping point along with all available global commands. (AI) config interface ethernet 0/0> description enable no disable ip Global Commands config exec-job ping trace-route copy exit reload debug halt running-config diag help show erase logout telnet (AI) config interface ethernet 0/0> Parameter Values with Spaces Use quotes to enclose command parameters that contain a space or spaces. Note: This applies only to parameters that accept alphanumeric values. For example, parameter val 2 in command config jobs name property will generate an error if it is not enclosed in quotes. (AI)>config jobs name job1 property prop1 val 2 [UCLI0032] Error unknown command "2". (AI)>config jobs name job1 property prop1 "val 2" (AI)> Note: Extend accepts either single quotes ( ) or double quotes ( ) for enclosing parameters. Abbreviated Command Entry The CLI recognizes commands by the first few characters entered in the command name. Extend recognizes the unique abbreviated entry and executes the command exactly as if it had been entered fully. For example, enter sh us as an abbreviated form of command show users to display all configured Extend users. (AI)>sh us Login Name Profile 1. techcomm supervisor 2. userb supervisor (AI)> Note: Optional parameter names required by some commands can also be abbreviated. 4

13 Using the CLI Use of abbreviated interface parameter names is also allowed. In the following example, a user configures an Ethernet interface in slot 0/port 0. (AI)>con int eth 0/0 (AI) config interface ethernet 0/0> Command Help Command help is available for navigating the CLI command hierarchy and for assistance with specific commands. Enter help or? for command help. Help Enter help to see the basic Extend help information. The following example displays the help screen. (AI)>help You can request help for a command at any time by entering a question mark ('?'). The '?' displays the following types of information for commands and/or command inputs: - Usage statements - Available subcommands - Matching commands for partial inputs - Available local and global commands The type of information displayed depends on where you enter the '?'. For more information on using help, refer to the command reference guide. (AI)>? Help Command The? displays information for individual commands and command inputs. Displaying Command Usage Statements Use the? directly following a command name to display that command s usage statement. 5

14 Using the CLI For example, enter config interface? at the main prompt to display the following usage statement. (AI)>config interface Usage: interface <interface type> <slot number>/<port number> no interface { <interface type> <slot number>/<port number> * } <interface type> Type of interface to configure Valid Value: ethernet <slot number> Standard port group (0) or slot number Valid Value: 0 <port number> Port number Range: 0 to 3 no Deletes the configuration for the specified interface or all interfaces. * Deletes the configuration for all interfaces. (AI)>config interface ethernet Displaying Available Subcommands Use the? after a command that requires subcommands to display all its corresponding subcommands. There must be a space between the? and the preceding command name. Note: A + after a command specifies that a subcommand is required. For example, enter show ip? to list all subcommands under show ip. (AI)>show ip Commands (AI)>show ip arp domain-name forward name-server route Displays the ARP cache. Displays the domain name. Displays the state of IP forwarding. Displays DNS servers. Displays routes. 6

15 Using the CLI Displaying Matching Commands for Partial Inputs Use the? at any point in a partially entered command to display a list of matching command names. For example, enter i? at the prompt after command config to display all commands that begin with i and can be entered at the prompt. (AI) config>i Commands (AI) config>i interface(+) ip(+) irb-combine Configures an interface. Configures IP settings. Combines or splits the IRB and interface ethernet 0/3. Displaying Available Local and Global Commands Enter a? at a stopping point to display a list of local commands that can be issued from that stopping point. (AI) config interface ethernet 0/0 ip> Commands address Configures the IP address for an interface. Enter? to see available global commands. (AI) config interface ethernet 0/0 ip> 7

16 Using the CLI Enter another? from the stopping point to display a list of all global commands. (AI) config interface ethernet 0/0 ip> Global Commands config(+) Configures parameters. copy Creates a copy of a configuration file. debug(+) Enables or disables session log output. diag(+) Displays system diagnostics. erase Erases (removes) a configuration file. exec-job(+) Controls the execution of jobs. exit Exits up one level in the command hierarchy. halt Shuts down the system. help Describes how to access help. logout Logs out and ends the session. ping Tests network connectivity to a remote host. reload Resets the system. running-config Displays the current operating configuration. show(+) Displays parameters. telnet Establishes a Telnet session. trace-route Traces network routing to a remote host. (AI) config interface ethernet 0/0 ip> 8

17 config apply-patch config apply-patch This command adds a configuration fragment to an existing configuration file. This functionality allows users to apply a group of configuration commands without individually entering each one in the CLI. Additionally, applying a patch does not overwrite the existing configuration file. Patch files are transferred to their own directory on Extend (/config/patches) using an FTP utility. Once a patch file is in this directory, the user can show, copy, or erase it using the existing CLI commands. Note: For more information about creating patch files, refer to the Extend Application Mediation Device Configuration Guide. Formats config apply-patch patch_file config_file Parameters patch_file config_file Specifies an existing patch file. Note: All patch files in the /config/patches directory have a.pat extension. However, you should not include the extension when entering the patch file name in the CLI. For example, config1.pat would be entered as config1. Defines the user-defined or special configuration file to modify. For information about the available special configuration files, refer to command copy on page 83. Required User Profiles management, supervisor Examples The following example displays the modification of configuration file running-startup with patch file ConfigUpdate5-10. (AI)>config (AI) config>apply-patch ConfigUpdate5-10 running-startup (AI) config> 9

18 config apply-patch See Also copy erase running-config show config-file 10

19 config banner config banner This command configures the banner for Extend. The banner appears when connecting to Extend. Formats config banner delimiting_character For resetting the banner: config default banner Parameters delimiting_character default Defines the beginning and ending of the banner. Most characters, such (, ), #, ~, %, and *, can be applied as the delimiting character. Important: Do not use the following characters for the delimiting character: d, s, l, m, n, o, r, t, u, U, V,,, and \ Resets the banner to the default AI banner. This command accepts escape codes that are used to include variable text within the banner. For more information on the escape codes, refer to Table 2. Table 2 Escape Codes Codes s \d Includes the current date in the banner. \s Includes the name of the operating system in the banner. \l Includes the name of the logical terminal from which the user is operating. \m Includes the architecture of the system (for example, i686), in the banner. \n Includes the host name of the system (for example, localhost) in the banner. \o Includes the domain name of the system in the banner. \r Includes the release number of the Linux kernel in the banner. \t Includes the current time in the banner. 11

20 config banner Table 2 Escape Codes (Continued) Codes s \u Includes the number of users currently logged into Extend in the banner. \U Includes the number of users currently logged into Extend with the addition of the words user or users (for example, 10 users) following the number in the banner. \v Includes the build date of the Linux kernel in the banner. Command Default AI banner. _ / Applied Innovation Inc. _ / _ _ AIextend login: Required User Profiles management, supervisor Examples This example displays the configuration of the delimiting character as #, the banner text as This is my banner., the current date (\d), and the time (\t). (AI)>config (AI) config>banner # Enter the banner text. End the banner with a # character. This is my banner. \d \t # (AI) config> See Also show banner 12

21 config bootp config bootp This command enables or disables the BOOTP protocol on Extend. When the BOOTP protocol is enabled, Extend obtains its IP address from a BOOTP server and the BOOTP server sends Extend the IP address of the TFTP server. Extend then contacts the TFTP server and automatically downloads its configuration. When the BOOTP protocol is disabled, Extend does not contact the TFTP server to download its configuration. Important: When configuring a remote BOOTP server (BOOTP server that is not an AI198 common logic controller), locate and use the MAC address listed on the sticker affixed to the Extend motherboard as the MAC address for interface Ethernet 0/0 (for example, 00:40:72:01:62:00). Add 1 to this address for interface Ethernet 0/1 (for example, 00:40:72:01:62:01). Add 2 to this address for interface Ethernet 0/2 (for example, 00:40:72:01:62:02). Add 3 to this address for interface Ethernet 0/3 (for example, 00:40:72:01:62:03). Tip: In many cases, AI198 acts as the TFTP server for Extend. In this situation, the Extend configuration must be saved to AI198 (using command copy on page 83) before Extend is hot-swapped. Extend is not supported by all versions of AI198. Extend cannot be hot-swapped when the BOOTP protocol is disabled. Formats config bootp disable enable Parameters disable enable Disables the BOOTP protocol. Enables the BOOTP protocol. Command Default Disabled Required User Profiles management, supervisor 13

22 config bootp Examples This example displays the enabling of the BOOTP protocol on Extend. (AI)>config (AI) config>bootp (AI) config bootp>enabling (AI) config bootp> See Also show bootp 14

23 config clock config clock This command configures clock and timestamp settings for Extend. Formats config clock local-time { hh:mm:ss MM/DD/YYYY hh:mm:ss MM/DD/YYYY } timestamp { GMT local-time } timezone { [ custom ] timezone_string hh_offset:mm_offset from-file indicator } Parameters default local-time Resets the timestamp to its default value (local-time). Configures the date and/or local time in 24-hour format for Extend. Local time is defined by the configured timezone and daylight savings. Either the date or local time must be configured. Note: Users cannot modify the local time if NTP is enabled. For more information about NTP, refer to config ntp on page 51. The following parameters are accepted: hh Defines the hour value of the local time. This parameter accepts values 0 to 23. mm Defines the minute value of the local time. This parameter accepts values 0 to 59. ss Defines the second value of the local time. This parameter accepts values 0 to 59. MM Defines the month value of the date. This parameter accepts values 1 to 12. DD Defines the day value of the date. This parameter accepts values from 1 to the total number of days in the month specified in MM. YYYY Defines the year value of the date. Valid values are 1970 to timestamp Configures the logging timestamp option. The following parameters are accepted: GMT Displays logging timestamps in Greenwich Mean Time. local-time Displays logging timestamps in standard local time. This is the default setting. 15

24 config clock timezone Configures the timezone for Extend. The default is standard GMT +0:00. The following parameters are accepted: custom Puts command config clock daylight-savings into custom mode. This allows users to configure their own daylight savings time parameters. For information on configurable parameters when the timezone is in custom mode, refer to command config clock daylight savings on page 18. timezone_string Defines text to represent the desired timezone, which accepts alphabetic strings of 1 to 10 characters in length. hh_offset Defines a value to represent the number of hours difference between the desired timezone and default timezone, which is standard GMT Values take the form of hh or -hh and must be between 0 and 12. mm_offset Defines a value to represent the number of minutes difference between the desired timezone and the default timezone, which is standard GMT Values take the form of mm and must be between 0 and 59. from-file Loads and applies timezone information from file timezones.def, which contains associated daylight savings rules. For information on accessing or updating the timezone definition file, refer to the Extend Application Mediation Device Configuration Guide. Note: When a user invokes the from-file keyword, command config clock daylight-savings becomes unavailable in the CLI. If an indicator in the timezone definition file becomes unavailable, the timezone will default to GMT and generate a log message. indicator Specifies a timezone indicator (1 to 10 alphanumeric characters) in file timezones.def. Required User Profiles management, supervisor 16

25 config clock Examples The following clock settings are configured: Local time 16:45:30 and date 12/14/2006 Timestamp option gmt Timezone custom EST -5:00. (AI)>config (AI) config>clock (AI) config clock>local-time 16:45:30 12/14/2006 (AI) config clock>timestamp gmt (AI) config clock>timezone custom EST -5:00 (AI) config clock> See Also config clock daylight savings show clock 17

26 config clock daylight savings config clock daylight savings This command configures daylight savings time settings. Notes: When the timezone on Extend is set to custom, users can enter specific parameters for the daylight savings start time, end time, and length. For more information on configuring the timezone on Extend, refer to command config clock on page 15. When the timezone information is loaded and applied from file timezones.def, all daylight savings configuration options are disabled in the CLI. Formats When Extend is in standard mode: config clock daylight-savings indicator When Extend is in custom mode: config clock daylight-savings end-day { day occurrence day_of_week } end-month month end-time hh:mm:ss indicator indicator save-amount hh:mm:ss start-day { day occurrence day_of_week } start-month month start-time hh:mm:ss config clock no daylight-savings Parameters indicator Defines a name (up to 10 alphanumeric characters) to be displayed when daylight savings time is in effect. 18

27 config clock daylight savings end-day end-month end-time indicator save-amount Configures the day when daylight savings time ends. The following parameters are accepted: day Defines the day of the month when daylight savings time ends. Valid values are 1 to 31. occurrence Defines the occurrence of a day in a month when daylight savings time ends. Valid values are first, second, third, fourth, and last. day_of_week Defines the day of the week when daylight savings time ends. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. Configures the month when daylight savings time ends. The following parameter is accepted: month Defines the month that daylight savings time ends. Configures the time when daylight savings time ends: hh Defines the hour when daylight savings time ends. This parameter accepts values 0 to 23. mm Defines the minute when daylight savings time ends. This parameter accepts values 0 to 59. ss Defines the second when daylight savings time ends. This parameter accepts values 0 to 59. Configures the name (up to 10 alphanumeric characters) to be displayed when daylight savings time is in effect. The following parameter is accepted: indicator Defines the name to be displayed when daylight savings time is in effect. Maximum length is 10 alphanumeric characters. Configures the amount of time to save during daylight savings time. The following parameters are accepted: hh Defines the number of hours to save. This parameter accepts values 0 to 23. mm Defines the number of minutes to save. This parameter accepts values 0 to 59. ss Defines the number of seconds to save. This parameter accepts values 0 to

28 config clock daylight savings start-day start-month start-time no Configures the day when daylight savings time starts. The following parameters are accepted: day Defines the day of the month when daylight savings time starts. Valid values are 1 to 31. occurrence Defines the occurrence of a day in a month when daylight savings time starts. Valid values are first, second, third, fourth, and last. day_of_week Defines the day of the week when daylight savings time starts. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. Configures the month when daylight savings time starts. The following parameter is accepted: month Defines the month that daylight savings time starts. Configures the time when daylight savings time starts: hh Defines the hour when daylight savings time starts. This parameter accepts values 0 to 23. mm Defines the minute when daylight savings time starts. This parameter accepts values 0 to 59. ss Defines the second when daylight savings time starts. This parameter accepts values 0 to 59. Disables daylight savings and the display of the daylight savings time indicator. Required User Profiles management, supervisor Examples In the following standard example, the daylight savings indicator is set to DST: (AI)>config (AI) config>clock (AI) config clock>daylight-savings DST (AI) config clock> 20

29 config clock daylight savings In the following custom example, daylight savings time settings are configured: Indicator EDT Start month march Start day 23 Start time 1:00:00 (AM) End month november End day last Sunday End time 02:00:00 (AM) Time to save 01:45:00. (AI)>config (AI) config>clock (AI) config clock>daylight-savings (AI) config clock daylight-savings ->indicator EDT (AI) config clock daylight-savings ->start-month march (AI) config clock daylight-savings ->start-day 23 (AI) config clock daylight-savings ->start-time 01:00:00 (AI) config clock daylight-savings ->end-month november (AI) config clock daylight-savings ->end-time 02:00:00 (AI) config clock daylight-savings ->save-amount 01:45:00 (AI) config clock daylight-savings -> See Also config clock show clock 21

30 config controller ethernet config controller ethernet This command configures an Extend Ethernet controller and its associated settings. An Ethernet controller describes the hardware and associated system software that manages an Ethernet link. Formats config controller ethernet 0/port assign default { hardware-address speed } description text disable enable hardware-address mac_address proxy-arp { enable disable } speed { auto 10h 10f 10hx 10fx 100h 100f 100hx 100fx } unassign For resetting Ethernet controllers: config default controller { ethernet 0/port ethernet * * } Parameters * Specifies all controllers or all Ethernet controllers. port assign default description Defines the physical connector associated with a controller on Extend. Valid values are 0 to 3 for the Extend card. The IRB is port 0. Specifies that the Ethernet controller should be tracked as a resource. This lets the user determine Ethernet port availability. Resets a specified parameter to its default value. Configures a controller description. The following parameter is accepted: text Defines the text description for the Ethernet controller. Maximum length is 60 characters. 22

31 config controller ethernet disable enable hardware-address Disables the specified Ethernet port from passing data. Note: When a port is disabled, its link state may still be listed as up in command show controllers ethernet on page 151. The link state represents the presence of a cable connection on the port, whereas the port status represents the port s ability to pass data. Enables the specified Ethernet port to pass data. Configures the hardware address for an Extend Ethernet controller. A hardware address is a data-link layer address associated with a particular network device. It is entered in hexadecimal form. The default hardware address is 00:40:72:01:62:18. The following parameter is accepted: mac_address Defines the hardware (MAC) address value. Enter MAC addresses as 6-byte, hexadecimal formatted values with a colon separating each byte (for example, 00:e0:52:cc:0b:00). no proxy-arp Deletes a specified parameter. Configures proxy ARP on an Ethernet controller. Proxy ARP is the technique by which a host answers ARP requests intended for another machine. By doing this, the host accepts responsibility for routing packets to a destination. Proxy ARP can help machines on a subnet reach remote subnets without configuring routing or a default gateway. The following parameters are accepted: disable Disables proxy ARP on an Ethernet controller. Proxy ARP is disabled by default. enable Enables proxy ARP on an Ethernet controller. 23

32 config controller ethernet speed This command configures the following settings for an Ethernet controller: Speed (in megabits per second) Duplex operation Refers to the simultaneous transmission and reception of signals by a single device. Half duplex operation allows a controller to transmit and receive, but not at the same time. Full duplex operation allows a controller to transmit and receive simultaneously. Tip: For full duplex operation, the controller must have full duplex capabilities. MDI-X capabilities Refers to a physical connection in a controller that includes an internal crossover of transmit and receive signals. This capability lets like devices communicate with each other directly, without crossover cables or switches. The default controller speed is auto, which automatically negotiates for the fastest controller speed possible between the controller and the remote device. unassign Specifies that the Ethernet controller should no longer be tracked as a resource. Required User Profiles management, supervisor Examples The following Ethernet controller settings are configured for controller ethernet 0/2: Enabled controller ethernet 0/2 00:E0:52:CC:0B:00 for the MAC address 10h for the speed Enabled proxy ARP Resource tracking assigned Ethernet 2 for the description. (AI)>config (AI) config>controller ethernet 0/2 (AI) config controller ethernet 0/2>enable (AI) config controller ethernet 0/2>hardware-address 00:E0:52:CC:0B:00 (AI) config controller ethernet 0/2>speed 10h (AI) config controller ethernet 0/2>proxy-arp enable (AI) config controller ethernet 0/2>assign (AI) config controller ethernet 0/2>description Ethernet 2 (AI) config controller ethernet 0/2> 24

33 config controller ethernet See Also config controller ethernet mac-security show controllers ethernet 25

34 config controller ethernet mac-security config controller ethernet mac-security This command configures MAC security settings for an Ethernet controller. Formats config controller ethernet 0/port mac-security address mac_address capture { count number start time duration } disable enable no address { mac_address * } For removing MAC security: config controller ethernet 0/port no mac-security Parameters * Specifies all MAC addresses. address Configures a MAC address table entry for the Ethernet controller. A MAC address table is a list containing the MAC addresses of all devices permitted access to Extend through a controller. A MAC address table can contain a maximum of 32 MAC addresses. The following parameter is accepted: mac_address Defines the MAC address. Enter MAC addresses as 6-byte, hexadecimal formatted values with a colon separating each byte (for example, 00:e0:52:cc:0b:00). 26

35 config controller ethernet mac-security capture Captures and adds any MAC addresses heard on a controller to the MAC address table. The following parameters are accepted: count Configures the number of MAC addresses an Ethernet controller will learn before they are captured and added to the controller's MAC address table. A MAC address table can contain a maximum of 32 MAC addresses. Important: MAC addresses cannot be captured when MAC security is enabled on a controller. number Defines the number of MAC addresses an Ethernet controller will learn before they are captured and added to the controller s MAC address table. Valid values are 1 to 32. start Configures an Ethernet controller to listen to traffic and capture MAC addresses in the controller s MAC address table. Extend captures MAC addresses until CTRL+c is pressed. time Configures the amount of time for a Ethernet controller to listen to traffic. Note: When the MAC address table fills up, a message is displayed that says Maximum number of MAC addresses has been reached. duration Defines the number of seconds a controller will listen for MAC addresses. Valid values are 1 to 300. disable enable no Disables MAC security on an Ethernet controller. Enables MAC security on an Ethernet controller. Deletes a specified parameter. Required User Profiles management, supervisor 27

36 config controller ethernet mac-security Examples The following MAC security settings are configured for controller ethernet 0/2: MAC security is disabled MAC address 00:e0:52:cc:0b:00 is added to the MAC address table Capture count is set to 26 Capture time is set to 55 seconds The controller starts capturing MAC addresses. (AI)>config (AI) config>controller ethernet 0/2 (AI) config controller ethernet 0/2>mac-security (AI) config controller ethernet 0/2 mac-security ->disable (AI) config controller ethernet 0/2 mac-security ->address 00:e0:52:cc:0b:00 (AI) config controller ethernet 0/2 mac-security ->capture count 26 Existing address:00:e0:52:cc:0b:00 Press ctrl-c to terminate capture (AI) config controller ethernet 0/2 mac-security ->capture time 55 Existing address:00:e0:52:cc:0b:00 Press ctrl-c to terminate capture (AI) config controller ethernet 0/2 mac-security ->capture start Existing address:00:e0:52:cc:0b:00 Press ctrl-c to terminate capture (AI) config controller ethernet 0/2 mac-security -> See Also config controller ethernet running-config show controllers ethernet 28

37 config dhcp-relay config dhcp-relay This command configures BOOTP/DHCP relay on Extend. When BOOTP/DHCP relay is enabled, Extend acts as a BOOTP/DHCP relay agent, passing BOOTP/DHCP configuration information between BOOTP/DHCP clients and servers. Formats config dhcp-relay [ disable enable server ip_address ] config dhcp-relay no server { ip_address * } Parameters disable enable server ip_address no Disables BOOTP/DHCP relay on Extend. When BOOTP/DHCP relay is disabled, Extend does not act as a BOOTP/DHCP relay agent, therefore, it does not pass BOOTP/DHCP configuration information between BOOTP/DHCP clients and servers. This is the default value. Enables BOOTP/DHCP relay on Extend. When BOOTP/DHCP relay is enabled, Extend acts as a BOOTP/DHCP relay agent, passing BOOTP/DHCP configuration information between BOOTP/DHCP clients and servers. Configures the BOOTP/DHCP server(s) to which Extend forwards BOOTP and DHCP packets when BOOTP/DHCP relay is enabled. A maximum of three BOOTP/DHCP server(s) can be configured. Defines the IP address of the BOOTP/DHCP server being added or deleted. Initiates the deletion of a BOOTP/DHCP server or all BOOTP/DHCP servers. * Deletes all BOOTP/DHCP servers. Required User Profiles management, supervisor 29

38 config dhcp-relay Examples This example displays the enabling of BOOTP/DHCP relay and the configuration of a BOOTP/DHCP server with IP address (AI)>config (AI) config>dhcp-relay (AI) config dhcp-relay>enable (AI) config dhcp-relay>server (AI) config dhcp-relay> See Also show dhcp-relay 30

39 config hostname config hostname This command configures a hostname for Extend. Formats config hostname hostname Parameters hostname Defines the hostname to assign to Extend. A hostname can consist of alphanumeric characters or hyphens (-); however, the first character cannot be a dash. The maximum length for a hostname is 30 characters. Command Defaults AI Required User Profiles management, supervisor Examples This example displays the configuration of hostname DublinCo for Extend. Notice that the command prompt changes from AI to DublinCo. (AI)>config (AI) config>hostname DublinCo (DublinCo) config> 31

40 config interface ethernet config interface ethernet These commands configure settings for an Ethernet interface. An interface is a source and sink for IP packets that is associated with a controller. Formats config interface ethernet 0/port description text disable enable ip address { ip_address subnet_mask ip_address/subnet_mask_length } [ secondary ] ip no address [ ip_address * ] no description For deleting Ethernet interfaces: config no interface { ethernet 0/port ethernet * * } Parameters * Specifies all interfaces from the Extend configuration. description disable enable ip address no Configures a description for an Ethernet interface. The following parameter is accepted: text Defines the description for the Ethernet interface. Disables an Ethernet interface. Enables an Ethernet interface. Configures an IP address for an Ethernet interface. The following parameters are accepted: ip_address Defines the IP address for the interface. subnet_mask Defines the subnet mask for the interface in dotted decimal format. subnet_mask_length Defines the length of the subnet mask. Valid values are 1 to 32. secondary Designates an IP address as a backup to the primary IP address. Deletes a specified parameter. Required User Profiles management, supervisor 32

41 config interface ethernet Examples The following settings are configured for interface ethernet 0/3: Enabled interface ethernet 0/3 Ethernet 3 IP address and subnet mask length 16. (AI)>config (AI) config>interface ethernet 0/3 (AI) config interface ethernet 0/3>enable (AI) config interface ethernet 0/3>description Ethernet 3 (AI) config interface ethernet 0/3>ip (AI) config interface ethernet 0/3 ip ->address /16 (AI) config interface ethernet 0/3 ip -> See Also running-config show interfaces ethernet 33

42 config ip Extend Version 2.0x Command Reference Guide config ip This command configures various IP settings for Extend. Formats config ip arp ip_address mac_address default gateway_address domain-name domain_name forward name-server ip_address no { arp ip_address domain-name name-server { ip_address * } } route { destination_address subnet_mask destination_address/subnet_mask_length } { gateway_address interface type instance } [ preference ] For deleting a route: config ip no route { destination_address subnet_mask destination_address/subnet_mask_length default * } Parameters * Specifies all IP addresses or routes. arp default domain-name Configures an Extend ARP cache entry. The following parameters are accepted: ip_address Defines an IP address. mac_address Defines a MAC address. This parameter must be entered as a 6-byte, hexadecimal formatted value with a colon separating each byte (for example, 00:E0:52:CC:0B:00). Sets a default static route, which is used to route a packet to a destination when there is no better route in the IP routing table. Configures a domain name for Extend. Domain names are used to represent IP addresses on a network and are formatted as a series of characters separated by periods (for example, domain_name Defines the name of the configured domain (up to 80 characters). This parameter will accept any text value that is entered. 34

43 config ip forward name-server no route Enable or disable IP forwarding for Extend. IP forwarding allows IP packets received on an interface to be forwarded to other interfaces. The default is disabled IP forwarding. Adds or deletes DNS servers. A DNS server translates domain names into corresponding IP addresses. Primary and secondary DNS servers are configurable. The first instance of this command configures the primary server and the second instance configures the secondary server. The following parameter is accepted: ip_address Defines the IP address of the DNS server. Deletes a specified parameter. Configures or deletes a static route. The following parameters are accepted: destination_address Defines an IP address for a network. subnet_mask Defines the number used to identify a subnetwork. A subnet mask is needed so that an IP address can be shared on a LAN. subnet_mask_length Defines the subnet mask length. Valid values are 1 to 32. gateway_address Defines the IP address of the next node location in a route. interface Defines the IP interface name for the next node in a route and: <type> is the type of network interface <instance> is an instance of the type of network interface preference Defines a preference value for a configured route. Extend selects configured routes with low preference values before routes with high preference values. Valid values are 0 to 255. Required User Profiles management, supervisor 35

44 config ip Examples The following IP settings are configured: An ARP cache entry with IP address and MAC address 00:01:03:1C:A2:E4 Domain name DNS server Default route (AI)>config (AI) config>ip (AI) config ip>arp :01:03:1C:A2:E4 (AI) config ip>domain-name (AI) config ip>name-server (AI) config ip>route default (AI) config ip> See Also show ip 36

45 config irb-combine config irb-combine This command splits or combines the IRB and Ethernet 0/3 interface for Extend. Combining the IRB and Ethernet 0/3 interface gives the user access to the IRB and backplane through the Ethernet 0/3 interface. Formats config irb-combine config no irb-combine Parameters no Splits the IRB from interface Ethernet 0/3. Command Default IRB split from the Ethernet 0/3 interface Required User Profiles management, supervisor Examples This example displays the combining of the IRB with Ethernet interface 0/3. (AI)>config (AI) config>irb-combine (AI) config> This example displays the splitting of the IRB from Ethernet interface 0/3. (AI)>config (AI) config>no irb-combine (AI) config> See Also show irb-combine 37

46 config jobs config jobs These commands configure job history and statistics settings. Formats config jobs default history-runs history-runs count no history reset-stats Parameters default Resets the history run count to its default of 25. history-runs Sets the number of job runs for which Extend keeps records. This feature cannot be disabled. The following parameter is accepted: count Defines the number of job runs for which Extend saves history. Valid values are 1 to 100. Notes: History entries that exceed the maximum run count are deleted every 15 minutes. If you execute command show jobs on page 165 within 15 minutes of the maximum run count being exceeded, you could see more job runs listed than the amount specified in the maximum run count. Error information can fill the history database to capacity if many jobs have histories with abnormal runs. When the history database reaches its capacity, Extend will not be able to record the results of completed jobs. If this is the case, you should remove unneeded history entries. You should also correct the problem causing the abnormal job terminations. If the problem cannot be corrected and the history database continues to reach capacity, you should decrease the number of job runs that get recorded to history. no history reset-stats Purges the history of all jobs for Extend Resets the statistical counts displayed by command show jobs on page 165. Command Defaults 25 runs 38

47 config jobs Required User Profiles management, supervisor Examples The following job history and statistics settings are configured: 13 history runs Reset job statistics. (AI)>config (AI) config>jobs (AI) config jobs>history-runs 13 (AI) config jobs>reset-stats (AI) config jobs> This example displays the configuration of the history run count to its default value. (AI)>config (AI) config>jobs (AI) config jobs>default history-runs (AI) config jobs> See Also config jobs name show jobs show jobs name 39

48 config jobs name config jobs name This command configures a job and its associated settings. Important: You must stop running jobs before deleting them with this command. Formats config jobs name job_name capture cron-start default { memory start-attempts } history run_id memory mem_limit [ stack_size ] no { capture cron-start history { run_id * } property property start-at start_index start-boot title } property property prop_value script package script [ min_version ] start-at month day hour minute weekday start-attempts count start-boot title title For deleting a job: config jobs no name job_name Parameters * Specifies that all history for a job will be deleted. capture cron-start default Enables the capture of job standard output (stdout) and standard error (stderr) into job.out and job.err files when the job is run. By performing the capture, users can review the standard output and standard error information for debugging purposes. Job capture is disabled by default. Configures a job to start automatically after a specific event has occurred, such as arrival at a specified time/date. The job can still be run manually after this command has been enabled. Cron-start is disabled by default. Resets a parameter to its default setting. 40

49 config jobs name history job_name memory no property Specifies the history of all Extend jobs. The following parameter is accepted: run_id Defines the specific execution of a job for which history will be purged. Defines the name of the job being added or deleted. Job names are stored in lowercase. Valid entries are alphanumeric characters and underscores (_). Configures the amount of dynamic memory (in kilobytes) allowed for storing and running a particular job. The following parameters are accepted: mem_limit Defines the number of kilobytes being allocated for storing and running a particular job. Valid values are 1200 to The default memory limit is 2560 kilobytes. stack_size Defines the number of kilobytes being allocated for the stack per thread. Valid values are 128 to The default stack per thread is 1024 kilobytes. Note: Memory is not unlimited. Concurrently running jobs cannot exceed a total of kilobytes of memory. Deletes a specified parameter. Configures a property for a job. Properties are parameters defined in a script that control or alter the operation of a job. The following parameters are accepted: property Defines the property that will be configured for a job. Acceptable values for the job property are based on parameters defined in the script. prop_value Defines the value of the configured property. Acceptable values are dependent on the indicated property. Tip: In order to have spaces in the value, the value must be in quotes. 41