Class Cisco

Description

Cisco

  • version: Release: @package_version@
  • deprecated: Class deprecated in Release 2.0.0

Located in /Cisco.php (line 40)


	
			
Method Summary
object Cisco __construct (string $hostname, string $password, [string $username = ""], [integer $timeout = 10])
array|boolean availableVlans ()
void close ()
void connect ()
void disable ()
boolean enable (string $password)
string|boolean ping (string $host)
mixed|boolean showArp ()
array|boolean showInterface (string $int)
mixed|boolean showInterfacesStatus ()
mixed|boolean showIpv6Neighbors ()
mixed|boolean showIpv6Routers ()
mixed|boolean showLogging ()
mixed|boolean showMacAddressTable ()
string|boolean traceroute (string $host)
array|boolean trunkInterfaces ()
Methods
Constructor __construct (line 59)

Class Constructor

  • return: object
  • access: public
object Cisco __construct (string $hostname, string $password, [string $username = ""], [integer $timeout = 10])
  • string $hostname: Hostname or IP address of the device
  • string $password: Password used to connect
  • string $username: (Optional) Username used to connect
  • integer $timeout: Connetion timeout (seconds)
availableVlans (line 750)

List VLANs available through STP

  • return: On success returns an array, false on failure.
  • access: public
array|boolean availableVlans ()
close (line 94)

Close an active connection

  • access: public
void close ()
connect (line 70)

Establish a connection to the device

  • access: public
void connect ()
disable (line 155)

Disable (exit privileged user mode if enabled)

  • access: public
void disable ()
enable (line 136)

Enable (enter privileged user mode)

  • return: True on success
  • access: public
boolean enable (string $password)
  • string $password: Enable password
ping (line 697)

Ping (execute an IOS "ping $host" command)

  • return: On success returns the string output of the command, false on failure.
  • access: public
string|boolean ping (string $host)
  • string $host: The hostname or IP address to ping.
showArp (line 522)

Show ARP (execute an IOS "show arp" command)

Result Array:

Array ( [n] => Array ( [ip] => string [mac_address] => string [age] => string ) )

[..]

  • return: On success returns an array of associative arrays, false on failure.
  • access: public
mixed|boolean showArp ()
showInterface (line 316)

Show Interface (execute an IOS "show int $int" command)

Result Array:

Array ( [n] => Array ( [interface] => string [status] => string [description] => string [mtu] => string [bandwidth] => string [dly] => string [duplex] => string [speed] => string [type] => string [in_rate] => string [in_packet_rate] => string [out_rate] => string [out_packet_rate] => string [in_packet] => string [in] => string [broadcast] => string [runt] => string [giant] => string [throttle] => string [in_error] => string [crc] => string [frame] => string [overrun] => string [ignored] => string [watchdog] => string [multicast] => string [pause_in] => string [in_dribble] => string [out_packet] => string [out] => string [underrun] => string [out_error] => string [collision] => string [reset] => string [babble] => string [late_collision] => string [deferred] => string [lost_carrier] => string [no_carrier] => string [pause_out] => string [out_buffer_fail] => string [out_buffer_swap] => string ) )

[..]

  • return: On success returns an associative array, false on failure.
  • access: public
array|boolean showInterface (string $int)
  • string $int: The interface to query
showInterfacesStatus (line 228)

Show Interfaces Status (execute an IOS "show int status" command)

Result Array:

Array ( [n] => Array ( [interface] => string [description] => string [status] => string [vlan] => string [duplex] => string [speed] => string [type] => string ) )

[..]

  • return: On success returns an array of associative arrays, false on failure.
  • access: public
mixed|boolean showInterfacesStatus ()
showIpv6Neighbors (line 629)

Show IPv6 Neighbor Table (execute an IOS "show ipv6 neighbors" command)

This is the IPv6 equivilant of the ARP table.

Result Array:

Array ( [n] => Array ( [ipv6] [mac_address] [age] ) )

[..]

  • return: On success returns an array of associative arrays, false on failure.
  • access: public
mixed|boolean showIpv6Neighbors ()
showIpv6Routers (line 668)

Show IPv6 Routers (execute an IOS "show ipv6 routers" command)

Used to detect IPv6 RA (Router Advertisement)

Result Array:

Array ( [n] => Array ( [router] [prefix] ) )

[..]

  • return: On success returns an array of associative arrays, false on failure.
  • access: public
mixed|boolean showIpv6Routers ()
showLogging (line 182)

Show Logging (execute an IOS "show log" command)

Result Array:

Array ( [n] => Array ( [timestamp] => string [type] => string [message] => string ) )

[..]

  • return: On success returns an array of associative arrays, false on failure.
  • access: public
mixed|boolean showLogging ()
showMacAddressTable (line 567)

Show MAC address-table (execute an IOS "show mac address-table" command)

This command is modified to ignore trunk ports. This keeps the reported address table isolated to the local switch, provided all uplinks are configured as trunk ports.

Support for XL-series switches is included (e.g. 3500-XL)

Result Array:

Array ( [n] => Array ( [mac_address] => string [interface] => string ) )

[..]

  • return: On success returns an array of associative arrays, false on failure.
  • access: public
mixed|boolean showMacAddressTable ()
traceroute (line 713)

Traceroute (execute an IOS "traceroute $host" command)

  • return: On success returns the string output of the command, false on failure.
  • access: public
string|boolean traceroute (string $host)
  • string $host: The hostname or IP address to trace to.
trunkInterfaces (line 728)

List Trunk Interfaces

  • return: On success returns an array, false on failure.
  • access: public
array|boolean trunkInterfaces ()

Documentation generated on Thu, 09 Apr 2009 22:06:34 -0400 by phpDocumentor 1.4.2