ARX::Network

Introduced : ARX V5.02.000
The Network interface lets applications retrieve ARX network interface information.

Methods

Method Description Introduced
get_definition Returns a list of network interface definitions for the specified network interfaces. ARX V5.02.000
get_gigabit_interface_configuration Returns the list of gigabit interface configurations for the specified gigabit interfaces. CLI References: show interface gigabit …. ARX V6.02.000
get_gigabit_interface_list Returns the list of gigabit interface ports. CLI References: show interface summary. ARX V6.02.000
get_gigabit_interface_statistics Returns the list of gigabit interface statistics for the specified gigabit interfaces. CLI References: show interface gigabit … stats. ARX V6.02.000
get_gigabit_interface_status Returns the list of gigabit interface statuses for the specified gigabit interfaces. CLI References: show interface gigabit …. ARX V6.02.000
get_interface_spanning_tree_configuration Returns the list of spanning-tree configurations for the specified network interfaces. CLI References: show spanning-tree interface. ARX V6.02.000
get_interface_spanning_tree_statistics Returns the list of spanning tree statistics for the specified interfaces. CLI References: show spanning-tree interface. ARX V6.02.000
get_ip_domain_list Returns a search list of domain names for the ARX to use in its DNS lookups. CLI References: show ip domain. ARX V6.02.000
get_ip_name_server_list Returns a list of DNS server that the ARX can use for DNS lookups. CLI References: show ip domain. ARX V6.02.000
get_ip_proxy_configuration Returns the list of ip proxy address configurations for the specified ip proxy addresses. CLI References: show ip proxy-addresses. ARX V6.02.000
get_ip_proxy_list Returns the list of ip proxy addresses. CLI References: show ip proxy-addresses. ARX V6.02.000
get_ip_proxy_status Returns the list of ip proxy address statuses for the specified ip proxy addresses. CLI References: show ip proxy-addresses. ARX V6.02.000
get_list Returns the list of network interfaces. ARX V5.02.000
get_mgmt_interface_configuration Returns the management interface configuration. CLI References: show interface mgmt. ARX V6.02.000
get_mgmt_interface_statistics Returns the management interface statistics. CLI References: show interface mgmt stats. ARX V6.02.000
get_mgmt_interface_status Returns the management interface statuse. CLI References: show interface mgmt. ARX V6.02.000
get_stats Returns a list of network interface statistics for the specified network interfaces. ARX V5.02.000
get_ten_gigabit_interface_configuration Returns the list of ten gigabit interface configurations for the specified gigabit interfaces. CLI References: show interface ten-gigabit …. ARX V6.02.000
get_ten_gigabit_interface_list Returns the list of ten gigabit interface ports. CLI References: show interface summary. ARX V6.02.000
get_ten_gigabit_interface_statistics Returns the list of ten gigabit interface statistics for the specified gigabit interfaces. CLI References: show interface ten-gigabit … stats. ARX V6.02.000
get_ten_gigabit_interface_status Returns the list of ten gigabit interface statuses for the specified gigabit interfaces. CLI References: show interface ten-gigabit …. ARX V6.02.000
get_vlan_interface_configuration Returns the list of network interface VLAN configurations for the specified VLANs. CLI References: show interface vlan. ARX V6.02.000
get_vlan_interface_list Returns the list of VLAN interfaces. CLI References: show interface. ARX V6.02.000

Structures

Structure

Description

IfConfiguration

A structure that contains the configuration of a network interface. CLI References: Layer 2.

IfSpanningTreeConfiguration

A structure that identifies the spanning-tree configurations of a network interface. CLI References: interface gigabit (cfg), interface ten-gigabit (cfg).

IfStatistics

A structure that contains the statistics of a network interface. CLI References: show interface … stats.

IfStatus

A structure that contains the status of a interface. CLI References: show interface gigabit, show interface ten-gigabit, show interface mgmt.

IpProxyConfiguration

A structure that contains the configuration of a proxy ip address. CLI References: ip proxy-address (cfg).

IpProxyStatus

A structure that contains the status of a proxy ip address. CLI References: show ip proxy]addresses.

MgmtIfConfiguration

A structure that contains the configuration of a out-of-band management interface. CLI References: Layer 3 (Network Layer).

Port

A structure that identifies a layer-2 port. CLI References: interface gigabit (cfg), interface ten-gigabit (cfg).

Speed

A structure that identifies the speed, line-type, and duplex configuration on a specified port. CLI References: speed (cfg-if-gig), speed (cfg-mgmt).

Subnet

A structure that identifies a subnet.

VlanIfConfiguration

A structure that contains the configuration of a management interface for a VLAN. CLI References: Layer 3 (Network Layer).


Enumerations

Enumeration Description
LinkStateType An enumeration of the state of the network interface. CLI References: show interface mgmt.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
IfConfigurationSequence IfConfiguration [] A sequence of IfConfiguration
IfSpanningTreeConfigurationSequence IfSpanningTreeConfiguration [] A sequence of IfSpanningTreeConfiguration
IfStatisticsSequence IfStatistics [] A sequence of IfStatistics
IfStatusSequence IfStatus [] A sequence of IfStatus
IpProxyConfigurationSequence IpProxyConfiguration [] A sequence of IpProxyConfiguration
IpProxyStatusSequence IpProxyStatus [] A sequence of IpProxyStatus
LinkStateTypeSequence LinkStateType [] A sequence of LinkStateType
MgmtIfConfigurationSequence MgmtIfConfiguration [] A sequence of MgmtIfConfiguration
PortSequence Port [] A sequence of Port
SpeedSequence Speed [] A sequence of Speed
SubnetSequence Subnet [] A sequence of Subnet
VlanIfConfigurationSequence VlanIfConfiguration [] A sequence of VlanIfConfiguration

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.