Previous Topic: Component ControlNext Topic: Volume Management


Interface Control

This section describes commands that control the interfaces for a component.

This section contains the following topics:

interface disable

interface enable

interface info

interface list

interface reset

interface disable

Disable a terminal interface on a component.

Syntax
interface disable name  
Arguments
name

Name of interface. name should be of the form application name:component name.interface name

Examples
interface disable lamp:main.config.http

Disable interface 'http' of component 'main.config' of application 'lamp'

interface enable

Enable a terminal interface on a component.

Syntax
interface enable name  
Arguments
name

Name of interface. name should be of the form application name:component name.interface name

Examples
interface enable lamp:main.config.http

Enable interface 'http' of component 'main.config' of application 'lamp'

interface info

Retrieve information for a terminal interface

Syntax
interface info name [ --batch ][ --verbose ]  
Parameters
name

Name of interface. name should be of the form application name:component name.interface name

--batch

Display output in UDL format

--verbose

Display additional information

Examples
interface info lamp:main.config.cifs

Display information for interface 'cifs' of component 'main.config' of application 'lamp'


interface info Output

This topic contains command output specification.

The output of this command is the following:

Non-Batch Output
Name              : <val>
Type              : <val>
State             : <val>
IP                : <val>
MAC               : <val>
VLAN ID           : <val> (only if --verbose)
Metered RX Packets: val   (only if --verbose and maintainer)
Metered TX Packets: val   (only if --verbose and maintainer)
Metered RX Bytes  : val   (only if --verbose and maintainer)
Metered TX Bytes  : val   (only if --verbose and maintainer)
Connections       :       (only if --verbose)
   Local IP        Remote IP       Type            Local Addr        Remote Addr
   <val>           <val>           <val>           <val>             <val>
Batch Output
interface <name>
   {
   type       = <val>
   state      = <val>
   ip         = <val>
   mac        = <val>
   device     = <val>
   vlan_id    = <val>        (only if --verbose)
   metered_rx_pkts  = <val>  (only if --verbose and maintainer)
   metered_tx_pkts  = <val>  (only if --verbose and maintainer)
   metered_rx_bytes = <val>  (only if --verbose and maintainer)
   metered_tx_bytes = <val>  (only if --verbose and maintainer)
   connections (only if --verbose)
      [
      loc_ip = <val>, rem_ip = <val>, type = <val>, loc_addr = <val>, rem_addr = <val>
      ]
   }

interface list

List terminal interfaces for a component.

Syntax
interface list name [ --batch ][ --verbose ]  
Arguments
name

Name of component. name should be of the form application name:component name

--batch

Display output in UDL format

--verbose

Display additional information

Examples
interface list lamp:main.config

List interfaces for component 'main.config' in application 'lamp'

Note: A specification of the output of this command can be found here.

interface list Output
This topic contains command output specification.
Non-batch Output
 Table with the following headings:
        Name
        Type
        State
        VLAN ID (only if --verbose is specified)
        MAC (only if --verbose is specified)
        IP  (only if --verbose is specified)
Batch Output
component <name>
   {
   interface <name> : type = <val>, state = <val>, vlan_id=<val>, mac=val, ip=val
   …
   }

Note: Mac and ip only display if --verbose is also specified.

interface reset

Reset a terminal interface on a component.

Syntax
interface reset name  
Arguments
name

Name of interface. name should be of the form application name:component name.interface name

Examples
interface reset lamp:main.config.http

Reset interface 'http' of component 'main.config' of application 'lamp'