com.quantum.dxi.rest.network

Class EthernetInterfaces

java.lang.Object

Base

com.quantum.dxi.rest.network.EthernetInterfaces

public class EthernetInterfaces
extends Base

The EthernetInterfaces resource represents configuration of Ethernet network interfaces on the system. The interface includes CRUD services for manipulating the interfaces' configuration.

The schema that defines the EthernetInterfaces resource is presented below.

 
    <xs:element name="EthernetInterfaces">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="EthernetInterface" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="EthernetInterface">
        <xs:annotation>
            <xs:documentation>Describes L2/L3 interface configuration.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Device" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>The device or bond name and optionally a level 3 interface number after a semicolon. Examples: "eth0", "p1p2:2" "bond0:1".</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="MaxSpeed" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only field. Interface's physical max speed.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Mtu" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>The frame size: can be any value from 68 through 9192. The standard size is 1500. Note! Changing MTU for one L3 interface (example: eth1:2) changes it for all interfaces on the same physical interface (eth1:1, eth1:3, etc.).</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="OperationalState" type="PortStateType" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only field. Corresponds to an interface's link status.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="ConnectionState" type="PortStateType" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only field. Corresponds to an interface's carrier status.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Configured" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only field. An interface is configured if it has IP addresses associated with it.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Type" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only field. "PORT" indicates a standalone port, "BOND" indicates an interface with slaves, "SLAVE" indicates an interface belongs to a bond.</xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="PORT"/>
                            <xs:enumeration value="BOND"/>
                            <xs:enumeration value="SLAVE"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <!-- There appears to be a bug in CLI, so that this field never has a value.-->
                <xs:element name="BondMaster" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only field. Indicates Master Bond for a "SLAVE" type interface. Note! This field is not yet supported.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="BondSlaves" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Comma delimited list of slaves for a "BOND" type interface.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="BondAlgorithm" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Algorithm/bonding mode for a "BOND" type interface.</xs:documentation>
                    </xs:annotation>
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="RR">
                                <xs:annotation>
                                    <xs:documentation>Bonding  mode 0 (Round Robin).</xs:documentation>
                                </xs:annotation>
                            </xs:enumeration>
                            <xs:enumeration value="AB">
                                <xs:annotation>
                                    <xs:documentation>Bonding  mode 1 (Active Backup).</xs:documentation>
                                </xs:annotation>
                            </xs:enumeration>
                            <xs:enumeration value="LACP">
                                <xs:annotation>
                                    <xs:documentation>Bonding  mode 4 (Link Aggregate, 802.3ad).</xs:documentation>
                                </xs:annotation>
                            </xs:enumeration>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="DhcpEnabled" type="xs:boolean" minOccurs="0"/>
                <xs:element name="IpAddress" type="xs:string" minOccurs="0"/>
                <xs:element name="Netmask" type="xs:string" minOccurs="0"/>
                <xs:element name="Gateway" type="xs:string" minOccurs="0"/>
                <xs:element name="ExtHostIp" type="xs:boolean" minOccurs="0"/>
                <xs:element name="NatIp" type="xs:string" minOccurs="0"/>
                <xs:element ref="StaticRoutes" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read-only structure. Contains static routes for the interface.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="TrafficTypes" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Lists traffic types (network segments) that this interface is used for.</xs:documentation>
                    </xs:annotation>
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="TrafficType" type="TrafficType" maxOccurs="3"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:simpleType name="EthernetInterfaceColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Device"/>
            <xs:enumeration value="MaxSpeed"/>
            <xs:enumeration value="Mtu"/>
            <xs:enumeration value="OperationalState"/>
            <xs:enumeration value="ConnectionState"/>
            <xs:enumeration value="Configured"/>
            <xs:enumeration value="Type"/>
            <xs:enumeration value="BondMaster"/>
            <xs:enumeration value="BondSlaves"/>
            <xs:enumeration value="BondAlgorithm"/>
            <xs:enumeration value="DhcpEnabled"/>
            <xs:enumeration value="IpAddress"/>
            <xs:enumeration value="Netmask"/>
            <xs:enumeration value="Gateway"/>
            <xs:enumeration value="ExtHostIp"/>
            <xs:enumeration value="NatIp"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="TrafficType">
        <xs:annotation>
            <xs:documentation>Contains traffic types/segments for an L3 interface.</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:enumeration value="MGMT"/>
            <xs:enumeration value="REP"/>
            <xs:enumeration value="DATA"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:element name="StaticRoutes">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="StaticRoute" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="StaticRoute">
        <xs:complexType>
            <xs:annotation>
                <xs:documentation>Contains static routes for an L3 interface.</xs:documentation>
            </xs:annotation>
            <xs:sequence>
                <xs:element name="Network" type="xs:string"/>
                <xs:element name="Netmask" type="xs:string"/>
                <xs:element name="Gateway" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:simpleType name="StaticRouteColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Network"/>
            <xs:enumeration value="Netmask"/>
            <xs:enumeration value="Gateway"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
EthernetInterfaces()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addEthernetInterface(javax.servlet.http.HttpServletRequest request, EthernetInterface ethernetInterface, java.lang.String errorType) POST /rest/EthernetInterfaces
void	deleteEthernetInterface(javax.servlet.http.HttpServletRequest request, java.lang.String device, java.lang.String errorType) DELETE /rest/EthernetInterfaces/{device}
EthernetInterface	getEthernetInterface(javax.servlet.http.HttpServletRequest request, java.lang.String device, java.lang.String configuration, java.lang.String errorType) GET /rest/EthernetInterfaces/{device}
com.quantum.dxi.dao.types.EthernetInterfaces	getEthernetInterfaces(javax.servlet.http.HttpServletRequest request, java.lang.String configuration, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/EthernetInterfaces
NumericScalarType	getEthernetInterfacesCount(javax.servlet.http.HttpServletRequest request, java.lang.String configuration, java.lang.String filterString, java.lang.String errorType) GET /rest/EthernetInterfaces/getRowCount
BooleanScalarType	isSegmented(javax.servlet.http.HttpServletRequest request) GET /rest/EthernetInterfaces/segmented
EthernetInterface	updateEthernetInterface(javax.servlet.http.HttpServletRequest request, java.lang.String device, EthernetInterface ethernetInterface, java.lang.String errorType) PUT /rest/EthernetInterfaces/{device}

Methods inherited from class java.lang.Object

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

Constructor Detail

EthernetInterfaces

public EthernetInterfaces()

Method Detail

addEthernetInterface

public javax.ws.rs.core.Response addEthernetInterface(@Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      EthernetInterface ethernetInterface,
                                                      java.lang.String errorType)

POST /rest/EthernetInterfaces

Configure level 3 Ethernet interface on the system. Note: Fields, documented as read-only, are ignored in POST - no need to set them.

Request Entity type: <xs:element name="EthernetInterface">

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

Since:

1.1

getEthernetInterfacesCount

public NumericScalarType getEthernetInterfacesCount(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    java.lang.String configuration,
                                                    java.lang.String filterString,
                                                    java.lang.String errorType)

GET /rest/EthernetInterfaces/getRowCount

Get the number of Ethernet interfaces on the system. The "configuration" query parameter allows to choose between "pending" (the default) and "runtime" views.

getEthernetInterfacesCount supports the table query parameters for filtering. Column names are defined in <xs:simpleType name="EthernetInterfaceColumnNameType">

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

Since:

1.1

getEthernetInterface

public EthernetInterface getEthernetInterface(@Context
                                              javax.servlet.http.HttpServletRequest request,
                                              java.lang.String device,
                                              java.lang.String configuration,
                                              java.lang.String errorType)

GET /rest/EthernetInterfaces/{device}

Get the specified Ethernet interface. The "configuration" query parameter allows to choose between "pending" (the default) and "runtime" views.

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

Since:

1.1

getEthernetInterfaces

public com.quantum.dxi.dao.types.EthernetInterfaces getEthernetInterfaces(@Context
                                                                          javax.servlet.http.HttpServletRequest request,
                                                                          java.lang.String configuration,
                                                                          int start,
                                                                          int limit,
                                                                          java.lang.String sortColumn,
                                                                          java.lang.String sortDirection,
                                                                          java.lang.String filterString,
                                                                          java.lang.String errorType)

GET /rest/EthernetInterfaces

Get Ethernet interfaces on the system. The "configuration" query parameter allows to choose between "pending" (the default) and "runtime" views.

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

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

Since:

1.1

updateEthernetInterface

public EthernetInterface updateEthernetInterface(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String device,
                                                 EthernetInterface ethernetInterface,
                                                 java.lang.String errorType)

PUT /rest/EthernetInterfaces/{device}

Adjust level 3 Ethernet interface configuration. Note: Fields, documented as read-only, are ignored in PUT - no need to set them.

Request Entity type: <xs:element name="EthernetInterface">

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

Since:

1.1

deleteEthernetInterface

public void deleteEthernetInterface(@Context
                                    javax.servlet.http.HttpServletRequest request,
                                    java.lang.String device,
                                    java.lang.String errorType)

DELETE /rest/EthernetInterfaces/{device}

Remove the level 3 interface, identified by {device}.

Since:

1.1

isSegmented

public BooleanScalarType isSegmented(@Context
                                     javax.servlet.http.HttpServletRequest request)

GET /rest/EthernetInterfaces/segmented

Returns true if the network traffic is segmented.

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

Since:

1.2.4