Package com.xensource.xenapi
Class PVSServer
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.PVSServer
individual machine serving provisioning (block) data
First published in XenServer 7.1.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a PVSServer -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
If obj is a PVSServer, compares XenAPI references for equality.void
forget
(Connection c) forget a PVS server Minimum allowed role: pool-operator First published in XenServer 7.1.forget a PVS server Minimum allowed role: pool-operator First published in XenServer 7.1.Get the addresses field of the given PVS_server.getAll
(Connection c) Return a list of all the PVS_servers known to the system.static Map<PVSServer,
PVSServer.Record> Return a map of PVS_server references to PVS_server records for all PVS_servers known to the system.static PVSServer
getByUuid
(Connection c, String uuid) Get a reference to the PVS_server instance with the specified UUID.Get the first_port field of the given PVS_server.Get the last_port field of the given PVS_server.Get a record containing the current state of the given PVS_server.Get the site field of the given PVS_server.Get the uuid field of the given PVS_server.int
hashCode()
static PVSServer
introduce new PVS server Minimum allowed role: pool-operator First published in XenServer 7.1.static Task
introduceAsync
(Connection c, Set<String> addresses, Long firstPort, Long lastPort, PVSSite site) introduce new PVS server Minimum allowed role: pool-operator First published in XenServer 7.1.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a PVSServer, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public PVSServer.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a record containing the current state of the given PVS_server. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByUuid
public static PVSServer getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a reference to the PVS_server instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the uuid field of the given PVS_server. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAddresses
public Set<String> getAddresses(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the addresses field of the given PVS_server. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getFirstPort
public Long getFirstPort(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the first_port field of the given PVS_server. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getLastPort
public Long getLastPort(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the last_port field of the given PVS_server. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getSite
public PVSSite getSite(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the site field of the given PVS_server. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
introduceAsync
public static Task introduceAsync(Connection c, Set<String> addresses, Long firstPort, Long lastPort, PVSSite site) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException introduce new PVS server Minimum allowed role: pool-operator First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onaddresses
- IPv4/IPv6 addresses of the serverfirstPort
- first UDP port accepted by this serverlastPort
- last UDP port accepted by this serversite
- PVS site this server is a part of- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
introduce
public static PVSServer introduce(Connection c, Set<String> addresses, Long firstPort, Long lastPort, PVSSite site) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException introduce new PVS server Minimum allowed role: pool-operator First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onaddresses
- IPv4/IPv6 addresses of the serverfirstPort
- first UDP port accepted by this serverlastPort
- last UDP port accepted by this serversite
- PVS site this server is a part of- Returns:
- the new PVS server
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
forgetAsync
public Task forgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException forget a PVS server Minimum allowed role: pool-operator First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
forget
public void forget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException forget a PVS server Minimum allowed role: pool-operator First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAll
public static Set<PVSServer> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a list of all the PVS_servers known to the system. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAllRecords
public static Map<PVSServer,PVSServer.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a map of PVS_server references to PVS_server records for all PVS_servers known to the system. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-