com.quantum.dxi.rest.network

Class StaticRoutes

java.lang.Object

Base

com.quantum.dxi.rest.network.StaticRoutes

public class StaticRoutes
extends Base

The StaticRoutes resource represents network static routes currently configured on Enternet interfaces. The StaticRoutes interface includes services for creating, reading and deleting static routes.

The schema that defines the StaticRoutes resource is defined below.

 
    <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
StaticRoutes()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addStaticRoute(javax.servlet.http.HttpServletRequest request, StaticRoute staticRoute, java.lang.String l3Interface, java.lang.String errorType) POST /rest/StaticRoutes/{l3Interface}
void	deleteStaticRoute(javax.servlet.http.HttpServletRequest request, java.lang.String l3Interface, java.lang.String network, java.lang.String errorType) DELETE /rest/StaticRoutes/{l3Interface}/{network}
StaticRoute	getStaticRoute(javax.servlet.http.HttpServletRequest request, java.lang.String l3Interface, java.lang.String network, java.lang.String errorType) GET /rest/StaticRoutes/{l3Interface}/{network}
com.quantum.dxi.dao.types.StaticRoutes	getStaticRoutes(javax.servlet.http.HttpServletRequest request, java.lang.String l3Interface, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString, java.lang.String errorType) GET /rest/StaticRoutes/{l3Interface}
NumericScalarType	getStaticRoutesCount(javax.servlet.http.HttpServletRequest request, java.lang.String l3Interface, java.lang.String filterString, java.lang.String errorType) GET /rest/StaticRoutes/{l3Interface}/getRowCount

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticRoutes

public StaticRoutes()

Method Detail

addStaticRoute

public javax.ws.rs.core.Response addStaticRoute(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                StaticRoute staticRoute,
                                                java.lang.String l3Interface,
                                                java.lang.String errorType)

POST /rest/StaticRoutes/{l3Interface}

Create a new static route for the interface.

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

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

Since:

1.1

getStaticRoutesCount

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

GET /rest/StaticRoutes/{l3Interface}/getRowCount

Get the number of static routes for the specific interface.

getStaticRoutesCount supports the table query parameters for filtering. Column names are defined in <xs:element name="StaticRouteColumnNameType">

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

Since:

1.1

getStaticRoute

public StaticRoute getStaticRoute(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  java.lang.String l3Interface,
                                  java.lang.String network,
                                  java.lang.String errorType)

GET /rest/StaticRoutes/{l3Interface}/{network}

Get static route {network} for the specific {interface}.

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

Since:

1.1

getStaticRoutes

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

GET /rest/StaticRoutes/{l3Interface}

Get static routes for the specific interface.

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

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

Since:

1.1

deleteStaticRoute

public void deleteStaticRoute(@Context
                              javax.servlet.http.HttpServletRequest request,
                              java.lang.String l3Interface,
                              java.lang.String network,
                              java.lang.String errorType)

DELETE /rest/StaticRoutes/{l3Interface}/{network}

Delete the static route for {network} on {l3Interface}.

Since:

1.1