com.quantum.dxi.rest.system

Class Veeam

java.lang.Object

Base

com.quantum.dxi.rest.system.Veeam

public class Veeam
extends Base

The Veeam resource represents the configuration of the Veeam Data Mover Server (VDMS) feature. The Veeam resource includes services to get and update the Veeam configuration.

The schema that defines the Veeam resource is defined below.

 
    <xs:simpleType name="AeStateType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="aeNone"/>
            <xs:enumeration value="aeDaeRebootRequired"/>
            <xs:enumeration value="aeDaeActive"/>
            <xs:enumeration value="aeDaeRunning"/>
            <xs:enumeration value="aeVeeamRebootRequired"/>
            <xs:enumeration value="aeVeeamActive"/>
            <xs:enumeration value="aeVeeamRunning"/>
            <xs:enumeration value="aeIscRebootRequired"/>
            <xs:enumeration value="aeIscActive"/>
            <xs:enumeration value="aeIscRunning"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:element name="Veeam">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="AeState" type="AeStateType" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Read only, returned by GET.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Enabled" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>PUT will enable or disable the feature, GET returns the setting.
                            Enabling or disabling this feature will require a system reboot.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="UsePassword" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>When used in PUT will enable or disable the use of a password, must be enabled when enabling the feature,
                            may be set to false after public ssh keys are uploaded. Use POST /rest/PublicKeys to upload public keys. GET returns the setting.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Password" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Must be used in PUT when enabling the feature, not returned with GET.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="MemMonEnabled" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            PUT will enable or disable memory threshold monitoring, GET returns the setting.
                            The AeState must be aeVeeamRunning to enable monitoring.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="MemMonThreshold" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            Used in PUT to set the memory monitoring threshold, specified in GiB.  Get returns the setting in bytes.
                            Memory monitoring must be enabled to set the threshold.  Both settings may be specified.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
Veeam()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.Veeam	getVeeamXml(javax.servlet.http.HttpServletRequest request) GET /rest/Veeam
com.quantum.dxi.dao.types.Veeam	setVeeam(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.Veeam veeam, boolean delayReboot) Deprecated. As of 1.1, replaced by #updateVeeam(HttpServletRequest, com.quantum.dxi.dao.types.Veeam)
com.quantum.dxi.dao.types.Veeam	updateVeeam(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.Veeam veeam, boolean delayReboot) PUT /rest/Veeam

Methods inherited from class java.lang.Object

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

Constructor Detail

Veeam

public Veeam()

Method Detail

getVeeamXml

public com.quantum.dxi.dao.types.Veeam getVeeamXml(@Context
                                                   javax.servlet.http.HttpServletRequest request)

GET /rest/Veeam

Get the Veeam configuration from the system.

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

updateVeeam

public com.quantum.dxi.dao.types.Veeam updateVeeam(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   com.quantum.dxi.dao.types.Veeam veeam,
                                                   boolean delayReboot)

PUT /rest/Veeam

Update the Veeam configuration on the system.
Enabling or disabling this feature will require a system reboot.

Supported query parameters are:

• ?delayReboot=true Delay the reboot until a more convenient time. In order for changes to take effect the system must be rebooted.

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

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

Since:

1.1

setVeeam

public com.quantum.dxi.dao.types.Veeam setVeeam(@Context
                                                javax.servlet.http.HttpServletRequest request,
                                                com.quantum.dxi.dao.types.Veeam veeam,
                                                boolean delayReboot)

Deprecated. As of 1.1, replaced by #updateVeeam(HttpServletRequest, com.quantum.dxi.dao.types.Veeam)

POST /rest/Veeam

Update the Veeam configuration on the system.
Enabling or disabling this feature will require a system reboot.

Supported query parameters are:

• ?delayReboot=true Delay the reboot until a more convenient time. In order for changes to take effect the system must be rebooted.

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

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