com.quantum.dxi.rest.network

Class EthernetPortStates

java.lang.Object

Base

com.quantum.dxi.rest.network.EthernetPortStates

public class EthernetPortStates
extends Base

The EthernetPortStates resource represents the state of the Ethernet network ports on the system. The EthernetPortStates interface includes services for getting the state of the Ethernet ports.

The schema that defines the EthernetPortStates resource is presented below.

 
    <xs:element name="EthernetPortStates">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="EthernetPortState" maxOccurs="unbounded">
                    <xs:annotation>
                        <xs:documentation>Contains real-time Ethernet port states.</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="PortStateType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="UP"/>
            <xs:enumeration value="DOWN"/>
            <xs:enumeration value="UNKNOWN"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:element name="EthernetPortState">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="InterfaceName" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>Uniquely identifies an EthernetPortState entry.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="OperationalState" type="PortStateType">
                    <xs:annotation>
                        <xs:documentation>Corresponds to an Interface's link status.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="ConnectionState" type="PortStateType">
                    <xs:annotation>
                        <xs:documentation>Corresponds to an Interface's carrier status.</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="EthernetPortStateColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="OperationalState"/>
            <xs:enumeration value="ConnectionState"/>
            <xs:enumeration value="InterfaceName"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
EthernetPortStates()

Method Summary

Modifier and Type	Method and Description
Object	getEthernetPortStates(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String actionString, String filterString, String errorType) GET /rest/EthernetPortStates
NumericScalarType	getEthernetPortStatesCount(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString, String errorType) GET /rest/EthernetPortStates/getRowCount

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EthernetPortStates

public EthernetPortStates()

Method Detail

getEthernetPortStatesCount

public NumericScalarType getEthernetPortStatesCount(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    int start,
                                                    int limit,
                                                    String filterString,
                                                    String errorType)

GET /rest/EthernetPortStates/getRowCount

Get the number of the Ethernet ports on the system.

getEthernetPortstatesCount supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="EthernetPortStateColumnName">

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.1

getEthernetPortStates

public Object getEthernetPortStates(@Context
                                    javax.servlet.http.HttpServletRequest request,
                                    int start,
                                    int limit,
                                    String sortColumn,
                                    String sortDirection,
                                    @Deprecated
                                    String actionString,
                                    String filterString,
                                    String errorType)

GET /rest/EthernetPortStates

Get the state of the Ethernet ports on the system.

Response Entity type: <xs:element name="EthernetPortStates">

<xs:element name="EthernetPortStates"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:element name="EthernetPortStateColumnName">

Deprecated as of 1.1:
The "action" query parameter is deprecated.
?action=getRowCount replaced by getEthernetPortStatesCount(HttpServletRequest, int, int, String, String)

Response Entity type: <xs:element name="NumericScalarType"> for query parameter ?action=getRowCount