Class Pool


public class Pool extends XenAPIObject
Pool-wide information First published in XenServer 4.0.
Author:
Cloud Software Group, Inc.
  • Field Details

    • ref

      protected final String ref
      The XenAPI reference (OpaqueRef) to this object.
  • Method Details

    • toWireString

      public String toWireString()
      Specified by:
      toWireString in class XenAPIObject
      Returns:
      The XenAPI reference (OpaqueRef) to this object.
    • equals

      public boolean equals(Object obj)
      If obj is a Pool, compares XenAPI references for equality.
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • getRecord

      public Pool.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get a record containing the current state of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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 Pool getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get a reference to the pool instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      uuid - 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 pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getNameLabel

      public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the name_label field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getNameDescription

      public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the name_description field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getMaster

      public Host getMaster(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the master field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getDefaultSR

      public SR getDefaultSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the default_SR field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getSuspendImageSR

      public SR getSuspendImageSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the suspend_image_SR field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getCrashDumpSR

      public SR getCrashDumpSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the crash_dump_SR field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getOtherConfig

      public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the other_config field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getHaEnabled

      public Boolean getHaEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ha_enabled field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getHaConfiguration

      public Map<String,String> getHaConfiguration(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ha_configuration field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getHaStatefiles

      public Set<String> getHaStatefiles(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ha_statefiles field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getHaHostFailuresToTolerate

      public Long getHaHostFailuresToTolerate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ha_host_failures_to_tolerate field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getHaPlanExistsFor

      public Long getHaPlanExistsFor(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ha_plan_exists_for field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getHaAllowOvercommit

      public Boolean getHaAllowOvercommit(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ha_allow_overcommit field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getHaOvercommitted

      public Boolean getHaOvercommitted(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ha_overcommitted field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getBlobs

      public Map<String,Blob> getBlobs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the blobs field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getTags

      public Set<String> getTags(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the tags field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getGuiConfig

      public Map<String,String> getGuiConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the gui_config field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.
      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.
    • getHealthCheckConfig

      public Map<String,String> getHealthCheckConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the health_check_config field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.
      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.
    • getWlbUrl

      public String getWlbUrl(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the wlb_url field of the given pool. Minimum allowed role: read-only First published in XenServer 5.5.
      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.
    • getWlbUsername

      public String getWlbUsername(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the wlb_username field of the given pool. Minimum allowed role: read-only First published in XenServer 5.5.
      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.
    • getWlbEnabled

      public Boolean getWlbEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the wlb_enabled field of the given pool. Minimum allowed role: read-only First published in XenServer 5.5.
      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.
    • getWlbVerifyCert

      @Deprecated public Boolean getWlbVerifyCert(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Get the wlb_verify_cert field of the given pool. Minimum allowed role: read-only First published in XenServer 5.5.
      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.
    • getRedoLogEnabled

      public Boolean getRedoLogEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the redo_log_enabled field of the given pool. Minimum allowed role: read-only First published in XenServer 5.6.
      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.
    • getRedoLogVdi

      public VDI getRedoLogVdi(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the redo_log_vdi field of the given pool. Minimum allowed role: read-only First published in XenServer 5.6.
      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.
    • getVswitchController

      @Deprecated public String getVswitchController(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Get the vswitch_controller field of the given pool. Minimum allowed role: read-only First published in XenServer 5.6.
      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.
    • getRestrictions

      public Map<String,String> getRestrictions(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the restrictions field of the given pool. Minimum allowed role: read-only First published in XenServer 5.6.
      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.
    • getMetadataVDIs

      public Set<VDI> getMetadataVDIs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the metadata_VDIs field of the given pool. Minimum allowed role: read-only First published in XenServer 6.0.
      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.
    • getHaClusterStack

      public String getHaClusterStack(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ha_cluster_stack field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.
      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.
    • getAllowedOperations

      public Set<Types.PoolAllowedOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the allowed_operations field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getCurrentOperations

      public Map<String,Types.PoolAllowedOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the current_operations field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getGuestAgentConfig

      public Map<String,String> getGuestAgentConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the guest_agent_config field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.
      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.
    • getCpuInfo

      public Map<String,String> getCpuInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the cpu_info field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.
      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.
    • getPolicyNoVendorDevice

      public Boolean getPolicyNoVendorDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the policy_no_vendor_device field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.
      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.
    • getLivePatchingDisabled

      public Boolean getLivePatchingDisabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the live_patching_disabled field of the given pool. 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.
    • getIgmpSnoopingEnabled

      public Boolean getIgmpSnoopingEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the igmp_snooping_enabled field of the given pool. Minimum allowed role: read-only First published in XenServer 7.3.
      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.
    • getUefiCertificates

      public String getUefiCertificates(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the uefi_certificates field of the given pool. Minimum allowed role: read-only First published in Citrix Hypervisor 8.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.
    • getCustomUefiCertificates

      public String getCustomUefiCertificates(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the custom_uefi_certificates field of the given pool. Minimum allowed role: read-only Experimental. First published in 24.1.0.
      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.
    • getIsPsrPending

      public Boolean getIsPsrPending(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the is_psr_pending field of the given pool. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2 Hotfix 2.
      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.
    • getTlsVerificationEnabled

      public Boolean getTlsVerificationEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the tls_verification_enabled field of the given pool. Minimum allowed role: read-only First published in 1.290.0.
      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.
    • getRepositories

      public Set<Repository> getRepositories(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the repositories field of the given pool. Minimum allowed role: read-only First published in 1.301.0.
      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.
    • getClientCertificateAuthEnabled

      public Boolean getClientCertificateAuthEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the client_certificate_auth_enabled field of the given pool. Minimum allowed role: read-only First published in 1.318.0.
      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.
    • getClientCertificateAuthName

      public String getClientCertificateAuthName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the client_certificate_auth_name field of the given pool. Minimum allowed role: read-only First published in 1.318.0.
      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.
    • getRepositoryProxyUrl

      public String getRepositoryProxyUrl(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the repository_proxy_url field of the given pool. Minimum allowed role: read-only First published in 21.3.0.
      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.
    • getRepositoryProxyUsername

      public String getRepositoryProxyUsername(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the repository_proxy_username field of the given pool. Minimum allowed role: read-only First published in 21.3.0.
      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.
    • getRepositoryProxyPassword

      public Secret getRepositoryProxyPassword(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the repository_proxy_password field of the given pool. Minimum allowed role: read-only First published in 21.3.0.
      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.
    • getMigrationCompression

      public Boolean getMigrationCompression(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the migration_compression field of the given pool. Minimum allowed role: read-only Experimental. First published in 22.33.0.
      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.
    • getCoordinatorBias

      public Boolean getCoordinatorBias(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the coordinator_bias field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.
      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.
    • getLocalAuthMaxThreads

      public Long getLocalAuthMaxThreads(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the local_auth_max_threads field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.27.0.
      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.
    • getExtAuthMaxThreads

      public Long getExtAuthMaxThreads(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the ext_auth_max_threads field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.27.0.
      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.
    • getTelemetryUuid

      public Secret getTelemetryUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the telemetry_uuid field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.9.0.
      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.
    • getTelemetryFrequency

      public Types.TelemetryFrequency getTelemetryFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the telemetry_frequency field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.9.0.
      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.
    • getTelemetryNextCollection

      public Date getTelemetryNextCollection(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the telemetry_next_collection field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.9.0.
      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.
    • getLastUpdateSync

      public Date getLastUpdateSync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the last_update_sync field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.18.0.
      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.
    • getUpdateSyncFrequency

      public Types.UpdateSyncFrequency getUpdateSyncFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the update_sync_frequency field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.18.0.
      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.
    • getUpdateSyncDay

      public Long getUpdateSyncDay(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the update_sync_day field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.18.0.
      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.
    • getUpdateSyncEnabled

      public Boolean getUpdateSyncEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Get the update_sync_enabled field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.18.0.
      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.
    • setNameLabel

      public void setNameLabel(Connection c, String nameLabel) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the name_label field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      nameLabel - New value to set
      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.
    • setNameDescription

      public void setNameDescription(Connection c, String nameDescription) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the name_description field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      nameDescription - New value to set
      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.
    • setDefaultSR

      public void setDefaultSR(Connection c, SR defaultSR) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the default_SR field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      defaultSR - New value to set
      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.
    • setSuspendImageSR

      public void setSuspendImageSR(Connection c, SR suspendImageSR) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the suspend_image_SR field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      suspendImageSR - New value to set
      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.
    • setCrashDumpSR

      public void setCrashDumpSR(Connection c, SR crashDumpSR) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the crash_dump_SR field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      crashDumpSR - New value to set
      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.
    • setOtherConfig

      public void setOtherConfig(Connection c, Map<String,String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the other_config field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      otherConfig - New value to set
      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.
    • addToOtherConfig

      public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Add the given key-value pair to the other_config field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      key - Key to add
      value - Value to add
      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.
    • removeFromOtherConfig

      public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove the given key and its corresponding value from the other_config field of the given pool. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      key - Key to remove
      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.
    • setHaAllowOvercommit

      public void setHaAllowOvercommit(Connection c, Boolean haAllowOvercommit) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the ha_allow_overcommit field of the given pool. Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      haAllowOvercommit - New value to set
      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.
    • setTags

      public void setTags(Connection c, Set<String> tags) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the tags field of the given pool. Minimum allowed role: vm-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      tags - New value to set
      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.
    • addTags

      public void addTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      value - New value to add
      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.
    • removeTags

      public void removeTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      value - Value to remove
      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.
    • setGuiConfig

      public void setGuiConfig(Connection c, Map<String,String> guiConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the gui_config field of the given pool. Minimum allowed role: vm-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      guiConfig - New value to set
      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.
    • addToGuiConfig

      public void addToGuiConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Add the given key-value pair to the gui_config field of the given pool. Minimum allowed role: vm-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      key - Key to add
      value - Value to add
      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.
    • removeFromGuiConfig

      public void removeFromGuiConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove the given key and its corresponding value from the gui_config field of the given pool. If the key is not in that Map, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      key - Key to remove
      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.
    • setHealthCheckConfig

      public void setHealthCheckConfig(Connection c, Map<String,String> healthCheckConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the health_check_config field of the given pool. Minimum allowed role: pool-operator First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      healthCheckConfig - New value to set
      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.
    • addToHealthCheckConfig

      public void addToHealthCheckConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Add the given key-value pair to the health_check_config field of the given pool. Minimum allowed role: pool-operator First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      key - Key to add
      value - Value to add
      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.
    • removeFromHealthCheckConfig

      public void removeFromHealthCheckConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove the given key and its corresponding value from the health_check_config field of the given pool. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      key - Key to remove
      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.
    • setWlbEnabled

      public void setWlbEnabled(Connection c, Boolean wlbEnabled) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the wlb_enabled field of the given pool. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      wlbEnabled - New value to set
      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.
    • setWlbVerifyCert

      @Deprecated public void setWlbVerifyCert(Connection c, Boolean wlbVerifyCert) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Set the wlb_verify_cert field of the given pool. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      wlbVerifyCert - New value to set
      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.
    • setPolicyNoVendorDevice

      public void setPolicyNoVendorDevice(Connection c, Boolean policyNoVendorDevice) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the policy_no_vendor_device field of the given pool. Minimum allowed role: pool-operator First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      policyNoVendorDevice - New value to set
      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.
    • setLivePatchingDisabled

      public void setLivePatchingDisabled(Connection c, Boolean livePatchingDisabled) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the live_patching_disabled field of the given pool. Minimum allowed role: pool-operator First published in XenServer 7.1.
      Parameters:
      c - The connection the call is made on
      livePatchingDisabled - New value to set
      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.
    • setIsPsrPending

      public void setIsPsrPending(Connection c, Boolean isPsrPending) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the is_psr_pending field of the given pool. Minimum allowed role: pool-operator First published in Citrix Hypervisor 8.2 Hotfix 2.
      Parameters:
      c - The connection the call is made on
      isPsrPending - New value to set
      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.
    • setMigrationCompression

      public void setMigrationCompression(Connection c, Boolean migrationCompression) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the migration_compression field of the given pool. Minimum allowed role: pool-operator Experimental. First published in 22.33.0.
      Parameters:
      c - The connection the call is made on
      migrationCompression - New value to set
      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.
    • setCoordinatorBias

      public void setCoordinatorBias(Connection c, Boolean coordinatorBias) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the coordinator_bias field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      coordinatorBias - New value to set
      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.
    • joinAsync

      public static Task joinAsync(Connection c, String masterAddress, String masterUsername, String masterPassword) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.JoiningHostCannotContainSharedSrs
      Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      masterAddress - The hostname of the master of the pool to join
      masterUsername - The username of the master (for initial authentication)
      masterPassword - The password for the master (for initial authentication)
      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.
      Types.JoiningHostCannotContainSharedSrs - The server joining the pool cannot contain any shared storage.
    • join

      public static void join(Connection c, String masterAddress, String masterUsername, String masterPassword) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.JoiningHostCannotContainSharedSrs
      Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      masterAddress - The hostname of the master of the pool to join
      masterUsername - The username of the master (for initial authentication)
      masterPassword - The password for the master (for initial authentication)
      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.
      Types.JoiningHostCannotContainSharedSrs - The server joining the pool cannot contain any shared storage.
    • joinForceAsync

      public static Task joinForceAsync(Connection c, String masterAddress, String masterUsername, String masterPassword) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      masterAddress - The hostname of the master of the pool to join
      masterUsername - The username of the master (for initial authentication)
      masterPassword - The password for the master (for initial authentication)
      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.
    • joinForce

      public static void joinForce(Connection c, String masterAddress, String masterUsername, String masterPassword) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      masterAddress - The hostname of the master of the pool to join
      masterUsername - The username of the master (for initial authentication)
      masterPassword - The password for the master (for initial authentication)
      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.
    • ejectAsync

      public static Task ejectAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Instruct a pool master to eject a host from the pool Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      host - The host to eject
      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.
    • eject

      public static void eject(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Instruct a pool master to eject a host from the pool Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      host - The host to eject
      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.
    • emergencyTransitionToMaster

      public static void emergencyTransitionToMaster(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Instruct host that's currently a slave to transition to being master Minimum allowed role: pool-operator First published in XenServer 4.0.
      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.
    • emergencyResetMaster

      public static void emergencyResetMaster(Connection c, String masterAddress) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Instruct a slave already in a pool that the master has changed Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      masterAddress - The hostname of the master
      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.
    • recoverSlavesAsync

      public static Task recoverSlavesAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M. Minimum allowed role: pool-operator First published in XenServer 4.0.
      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.
    • recoverSlaves

      public static Set<Host> recoverSlaves(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      list of hosts whose master address were successfully reset
      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.
    • createVLANAsync

      public static Task createVLANAsync(Connection c, String device, Network network, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VlanTagInvalid
      Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create_VLAN_from_PIF instead. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      device - physical interface on which to create the VLAN interface
      network - network to which this interface should be connected
      VLAN - VLAN tag for the new interface
      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.
      Types.VlanTagInvalid - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094. The parameter echoes the VLAN tag you gave.
    • createVLAN

      public static Set<PIF> createVLAN(Connection c, String device, Network network, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VlanTagInvalid
      Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create_VLAN_from_PIF instead. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      device - physical interface on which to create the VLAN interface
      network - network to which this interface should be connected
      VLAN - VLAN tag for the new interface
      Returns:
      The references of the created PIF 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.
      Types.VlanTagInvalid - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094. The parameter echoes the VLAN tag you gave.
    • managementReconfigureAsync

      Reconfigure the management network interface for all Hosts in the Pool Minimum allowed role: pool-operator First published in XenServer 7.3.
      Parameters:
      c - The connection the call is made on
      network - The network
      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.
      Types.HaIsEnabled - The operation could not be performed because HA is enabled on the Pool
      Types.PifNotPresent - This host has no PIF on the given network.
      Types.CannotPlugBondSlave - This PIF is a bond member and cannot be plugged.
      Types.PifIncompatiblePrimaryAddressType - The primary address types are not compatible
      Types.PifHasNoNetworkConfiguration - PIF has no IP configuration (mode currently set to 'none')
      Types.PifHasNoV6NetworkConfiguration - PIF has no IPv6 configuration (mode currently set to 'none')
    • managementReconfigure

      Reconfigure the management network interface for all Hosts in the Pool Minimum allowed role: pool-operator First published in XenServer 7.3.
      Parameters:
      c - The connection the call is made on
      network - The network
      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.
      Types.HaIsEnabled - The operation could not be performed because HA is enabled on the Pool
      Types.PifNotPresent - This host has no PIF on the given network.
      Types.CannotPlugBondSlave - This PIF is a bond member and cannot be plugged.
      Types.PifIncompatiblePrimaryAddressType - The primary address types are not compatible
      Types.PifHasNoNetworkConfiguration - PIF has no IP configuration (mode currently set to 'none')
      Types.PifHasNoV6NetworkConfiguration - PIF has no IPv6 configuration (mode currently set to 'none')
    • createVLANFromPIFAsync

      public static Task createVLANFromPIFAsync(Connection c, PIF pif, Network network, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VlanTagInvalid
      Create a pool-wide VLAN by taking the PIF. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      pif - physical interface on any particular host, that identifies the PIF on which to create the (pool-wide) VLAN interface
      network - network to which this interface should be connected
      VLAN - VLAN tag for the new interface
      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.
      Types.VlanTagInvalid - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094. The parameter echoes the VLAN tag you gave.
    • createVLANFromPIF

      public static Set<PIF> createVLANFromPIF(Connection c, PIF pif, Network network, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VlanTagInvalid
      Create a pool-wide VLAN by taking the PIF. Minimum allowed role: pool-operator First published in XenServer 4.0.
      Parameters:
      c - The connection the call is made on
      pif - physical interface on any particular host, that identifies the PIF on which to create the (pool-wide) VLAN interface
      network - network to which this interface should be connected
      VLAN - VLAN tag for the new interface
      Returns:
      The references of the created PIF 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.
      Types.VlanTagInvalid - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094. The parameter echoes the VLAN tag you gave.
    • enableHaAsync

      public static Task enableHaAsync(Connection c, Set<SR> heartbeatSrs, Map<String,String> configuration) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Turn on High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      heartbeatSrs - Set of SRs to use for storage heartbeating
      configuration - Detailed HA configuration to apply
      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.
    • enableHa

      public static void enableHa(Connection c, Set<SR> heartbeatSrs, Map<String,String> configuration) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Turn on High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      heartbeatSrs - Set of SRs to use for storage heartbeating
      configuration - Detailed HA configuration to apply
      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.
    • disableHaAsync

      public static Task disableHaAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Turn off High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.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.
    • disableHa

      public static void disableHa(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Turn off High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.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.
    • syncDatabaseAsync

      public static Task syncDatabaseAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Forcibly synchronise the database now Minimum allowed role: pool-operator First published in XenServer 4.0.
      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.
    • syncDatabase

      public static void syncDatabase(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Forcibly synchronise the database now Minimum allowed role: pool-operator First published in XenServer 4.0.
      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.
    • designateNewMasterAsync

      public static Task designateNewMasterAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Perform an orderly handover of the role of master to the referenced host. Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      host - The host who should become the new master
      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.
    • designateNewMaster

      public static void designateNewMaster(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Perform an orderly handover of the role of master to the referenced host. Minimum allowed role: pool-operator First published in XenServer 4.1.
      Parameters:
      c - The connection the call is made on
      host - The host who should become the new master
      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.
    • haPreventRestartsFor

      public static void haPreventRestartsFor(Connection c, Long seconds) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      When this call returns the VM restart logic will not run for the requested number of seconds. If the argument is zero then the restart thread is immediately unblocked Minimum allowed role: pool-operator First published in XenServer 5.0 Update 1.
      Parameters:
      c - The connection the call is made on
      seconds - The number of seconds to block the restart thread for
      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.
    • haFailoverPlanExists

      public static Boolean haFailoverPlanExists(Connection c, Long n) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Returns true if a VM failover plan exists for up to 'n' host failures Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      n - The number of host failures to plan for
      Returns:
      true if a failover plan exists for the supplied number of host failures
      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.
    • haComputeMaxHostFailuresToTolerate

      public static Long haComputeMaxHostFailuresToTolerate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      Returns:
      maximum value for ha_host_failures_to_tolerate given current configuration
      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.
    • haComputeHypotheticalMaxHostFailuresToTolerate

      public static Long haComputeHypotheticalMaxHostFailuresToTolerate(Connection c, Map<VM,String> configuration) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs Minimum allowed role: read-only First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      configuration - Map of protected VM reference to restart priority
      Returns:
      maximum value for ha_host_failures_to_tolerate given provided configuration
      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.
    • haComputeVmFailoverPlan

      public static Map<VM,Map<String,String>> haComputeVmFailoverPlan(Connection c, Set<Host> failedHosts, Set<VM> failedVms) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Return a VM failover plan assuming a given subset of hosts fail Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      failedHosts - The set of hosts to assume have failed
      failedVms - The set of VMs to restart
      Returns:
      VM failover plan: a map of VM to host to restart the host 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.
    • setHaHostFailuresToTolerateAsync

      public Task setHaHostFailuresToTolerateAsync(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the maximum number of host failures to consider in the HA VM restart planner Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      value - New number of host failures to consider
      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.
    • setHaHostFailuresToTolerate

      public void setHaHostFailuresToTolerate(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the maximum number of host failures to consider in the HA VM restart planner Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      value - New number of host failures to consider
      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.
    • createNewBlobAsync

      public Task createNewBlobAsync(Connection c, String name, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      name - The name associated with the blob
      mimeType - The mime type for the data. Empty string translates to application/octet-stream
      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.
    • createNewBlob

      public Blob createNewBlob(Connection c, String name, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      name - The name associated with the blob
      mimeType - The mime type for the data. Empty string translates to application/octet-stream
      Returns:
      The reference of the blob, needed for populating its data
      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.
    • createNewBlobAsync

      public Task createNewBlobAsync(Connection c, String name, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      name - The name associated with the blob
      mimeType - The mime type for the data. Empty string translates to application/octet-stream
      _public - True if the blob should be publicly available First published in XenServer 6.1.
      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.
    • createNewBlob

      public Blob createNewBlob(Connection c, String name, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.
      Parameters:
      c - The connection the call is made on
      name - The name associated with the blob
      mimeType - The mime type for the data. Empty string translates to application/octet-stream
      _public - True if the blob should be publicly available First published in XenServer 6.1.
      Returns:
      The reference of the blob, needed for populating its data
      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.
    • enableExternalAuth

      public void enableExternalAuth(Connection c, Map<String,String> config, String serviceName, String authType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call enables external authentication on all the hosts of the pool Minimum allowed role: pool-admin First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      config - A list of key-values containing the configuration data
      serviceName - The name of the service
      authType - The type of authentication (e.g. AD for Active Directory)
      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.
    • disableExternalAuth

      public void disableExternalAuth(Connection c, Map<String,String> config) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call disables external authentication on all the hosts of the pool Minimum allowed role: pool-admin First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      config - Optional parameters as a list of key-values containing the configuration data
      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.
    • detectNonhomogeneousExternalAuth

      public void detectNonhomogeneousExternalAuth(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts Minimum allowed role: pool-operator First published in XenServer 5.5.
      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.
    • initializeWlbAsync

      public static Task initializeWlbAsync(Connection c, String wlbUrl, String wlbUsername, String wlbPassword, String xenserverUsername, String xenserverPassword) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Initializes workload balancing monitoring on this pool with the specified wlb server Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      wlbUrl - The ip address and port to use when accessing the wlb server
      wlbUsername - The username used to authenticate with the wlb server
      wlbPassword - The password used to authenticate with the wlb server
      xenserverUsername - The username used by the wlb server to authenticate with the xenserver
      xenserverPassword - The password used by the wlb server to authenticate with the xenserver
      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.
    • initializeWlb

      public static void initializeWlb(Connection c, String wlbUrl, String wlbUsername, String wlbPassword, String xenserverUsername, String xenserverPassword) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Initializes workload balancing monitoring on this pool with the specified wlb server Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      wlbUrl - The ip address and port to use when accessing the wlb server
      wlbUsername - The username used to authenticate with the wlb server
      wlbPassword - The password used to authenticate with the wlb server
      xenserverUsername - The username used by the wlb server to authenticate with the xenserver
      xenserverPassword - The password used by the wlb server to authenticate with the xenserver
      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.
    • deconfigureWlbAsync

      public static Task deconfigureWlbAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Permanently deconfigures workload balancing monitoring on this pool Minimum allowed role: pool-operator First published in XenServer 5.5.
      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.
    • deconfigureWlb

      public static void deconfigureWlb(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Permanently deconfigures workload balancing monitoring on this pool Minimum allowed role: pool-operator First published in XenServer 5.5.
      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.
    • sendWlbConfigurationAsync

      public static Task sendWlbConfigurationAsync(Connection c, Map<String,String> config) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Sets the pool optimization criteria for the workload balancing server Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      config - The configuration to use in optimizing this pool
      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.
    • sendWlbConfiguration

      public static void sendWlbConfiguration(Connection c, Map<String,String> config) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Sets the pool optimization criteria for the workload balancing server Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      config - The configuration to use in optimizing this pool
      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.
    • retrieveWlbConfigurationAsync

      public static Task retrieveWlbConfigurationAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Retrieves the pool optimization criteria from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.
      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.
    • retrieveWlbConfiguration

      public static Map<String,String> retrieveWlbConfiguration(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Retrieves the pool optimization criteria from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      Returns:
      The configuration used in optimizing this pool
      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.
    • retrieveWlbRecommendationsAsync

      public static Task retrieveWlbRecommendationsAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Retrieves vm migrate recommendations for the pool from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.
      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.
    • retrieveWlbRecommendations

      public static Map<VM,Set<String>> retrieveWlbRecommendations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Retrieves vm migrate recommendations for the pool from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      Returns:
      The list of vm migration recommendations
      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.
    • sendTestPostAsync

      public static Task sendTestPostAsync(Connection c, String host, Long port, String body) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer. Minimum allowed role: pool-admin First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      host - No description
      port - No description
      body - No description
      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.
    • sendTestPost

      public static String sendTestPost(Connection c, String host, Long port, String body) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer. Minimum allowed role: pool-admin First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      host - No description
      port - No description
      body - No description
      Returns:
      The response
      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.
    • certificateInstallAsync

      @Deprecated public static Task certificateInstallAsync(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Install a TLS CA certificate, pool-wide. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      name - A name to give the certificate
      cert - The certificate in PEM format
      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.
    • certificateInstall

      @Deprecated public static void certificateInstall(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Install a TLS CA certificate, pool-wide. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      name - A name to give the certificate
      cert - The certificate in PEM format
      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.
    • certificateUninstallAsync

      @Deprecated public static Task certificateUninstallAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Remove a pool-wide TLS CA certificate. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      name - The certificate name
      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.
    • certificateUninstall

      @Deprecated public static void certificateUninstall(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Remove a pool-wide TLS CA certificate. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      name - The certificate name
      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.
    • certificateListAsync

      @Deprecated public static Task certificateListAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      List the names of all installed TLS CA certificates. Minimum allowed role: pool-operator First published in XenServer 5.5.
      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.
    • certificateList

      @Deprecated public static Set<String> certificateList(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      List the names of all installed TLS CA certificates. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      Returns:
      All installed certificates
      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.
    • installCaCertificateAsync

      public static Task installCaCertificateAsync(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Install a TLS CA certificate, pool-wide. Minimum allowed role: pool-operator First published in 1.290.0.
      Parameters:
      c - The connection the call is made on
      name - A name to give the certificate
      cert - The certificate in PEM format
      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.
    • installCaCertificate

      public static void installCaCertificate(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Install a TLS CA certificate, pool-wide. Minimum allowed role: pool-operator First published in 1.290.0.
      Parameters:
      c - The connection the call is made on
      name - A name to give the certificate
      cert - The certificate in PEM format
      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.
    • uninstallCaCertificateAsync

      public static Task uninstallCaCertificateAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove a pool-wide TLS CA certificate. Minimum allowed role: pool-operator First published in 1.290.0.
      Parameters:
      c - The connection the call is made on
      name - The certificate name
      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.
    • uninstallCaCertificate

      public static void uninstallCaCertificate(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove a pool-wide TLS CA certificate. Minimum allowed role: pool-operator First published in 1.290.0.
      Parameters:
      c - The connection the call is made on
      name - The certificate name
      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.
    • crlInstallAsync

      public static Task crlInstallAsync(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Install a TLS CA-issued Certificate Revocation List, pool-wide. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      name - A name to give the CRL
      cert - The CRL
      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.
    • crlInstall

      public static void crlInstall(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Install a TLS CA-issued Certificate Revocation List, pool-wide. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      name - A name to give the CRL
      cert - The CRL
      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.
    • crlUninstallAsync

      public static Task crlUninstallAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove a pool-wide TLS CA-issued Certificate Revocation List. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      name - The CRL name
      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.
    • crlUninstall

      public static void crlUninstall(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove a pool-wide TLS CA-issued Certificate Revocation List. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      name - The CRL name
      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.
    • crlListAsync

      public static Task crlListAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      List the names of all installed TLS CA-issued Certificate Revocation Lists. Minimum allowed role: pool-operator First published in XenServer 5.5.
      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.
    • crlList

      public static Set<String> crlList(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      List the names of all installed TLS CA-issued Certificate Revocation Lists. Minimum allowed role: pool-operator First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      Returns:
      The names of all installed CRLs
      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.
    • certificateSyncAsync

      public static Task certificateSyncAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Copy the TLS CA certificates and CRLs of the master to all slaves. Minimum allowed role: pool-operator First published in XenServer 5.5.
      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.
    • certificateSync

      public static void certificateSync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Copy the TLS CA certificates and CRLs of the master to all slaves. Minimum allowed role: pool-operator First published in XenServer 5.5.
      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.
    • enableTlsVerification

      public static void enableTlsVerification(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Enable TLS server certificate verification Minimum allowed role: pool-admin First published in 1.290.0.
      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.
    • enableRedoLogAsync

      public static Task enableRedoLogAsync(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Enable the redo log on the given SR and start using it, unless HA is enabled. Minimum allowed role: pool-operator First published in XenServer 5.6.
      Parameters:
      c - The connection the call is made on
      sr - SR to hold the redo log.
      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.
    • enableRedoLog

      public static void enableRedoLog(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Enable the redo log on the given SR and start using it, unless HA is enabled. Minimum allowed role: pool-operator First published in XenServer 5.6.
      Parameters:
      c - The connection the call is made on
      sr - SR to hold the redo log.
      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.
    • disableRedoLogAsync

      public static Task disableRedoLogAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Disable the redo log if in use, unless HA is enabled. Minimum allowed role: pool-operator First published in XenServer 5.6.
      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.
    • disableRedoLog

      public static void disableRedoLog(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Disable the redo log if in use, unless HA is enabled. Minimum allowed role: pool-operator First published in XenServer 5.6.
      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.
    • setVswitchControllerAsync

      @Deprecated public static Task setVswitchControllerAsync(Connection c, String address) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Set the IP address of the vswitch controller. Minimum allowed role: pool-operator First published in XenServer 5.6.
      Parameters:
      c - The connection the call is made on
      address - IP address of the vswitch controller.
      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.
    • setVswitchController

      @Deprecated public static void setVswitchController(Connection c, String address) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Set the IP address of the vswitch controller. Minimum allowed role: pool-operator First published in XenServer 5.6.
      Parameters:
      c - The connection the call is made on
      address - IP address of the vswitch controller.
      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.
    • testArchiveTarget

      public String testArchiveTarget(Connection c, Map<String,String> config) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call tests if a location is valid Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.
      Parameters:
      c - The connection the call is made on
      config - Location config settings to test
      Returns:
      An XMLRPC result
      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.
    • enableLocalStorageCachingAsync

      public Task enableLocalStorageCachingAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call attempts to enable pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.
      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.
    • enableLocalStorageCaching

      public void enableLocalStorageCaching(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call attempts to enable pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.
      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.
    • disableLocalStorageCachingAsync

      public Task disableLocalStorageCachingAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call disables pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.
      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.
    • disableLocalStorageCaching

      public void disableLocalStorageCaching(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call disables pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.
      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.
    • getLicenseStateAsync

      public Task getLicenseStateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call returns the license state for the pool Minimum allowed role: read-only First published in XenServer 6.2.
      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.
    • getLicenseState

      public Map<String,String> getLicenseState(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call returns the license state for the pool Minimum allowed role: read-only First published in XenServer 6.2.
      Parameters:
      c - The connection the call is made on
      Returns:
      The pool's license state
      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.
    • applyEditionAsync

      public Task applyEditionAsync(Connection c, String edition) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Apply an edition to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 6.2.
      Parameters:
      c - The connection the call is made on
      edition - The requested edition
      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.
    • applyEdition

      public void applyEdition(Connection c, String edition) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Apply an edition to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 6.2.
      Parameters:
      c - The connection the call is made on
      edition - The requested edition
      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.
    • enableSslLegacyAsync

      @Deprecated public Task enableSslLegacyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. Minimum allowed role: pool-operator First published in XenServer 7.0.
      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.
    • enableSslLegacy

      @Deprecated public void enableSslLegacy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. Minimum allowed role: pool-operator First published in XenServer 7.0.
      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.
    • disableSslLegacyAsync

      @Deprecated public Task disableSslLegacyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Sets ssl_legacy false on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. Minimum allowed role: pool-operator First published in XenServer 7.0.
      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.
    • disableSslLegacy

      @Deprecated public void disableSslLegacy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Sets ssl_legacy false on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. Minimum allowed role: pool-operator First published in XenServer 7.0.
      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.
    • setIgmpSnoopingEnabledAsync

      public Task setIgmpSnoopingEnabledAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Enable or disable IGMP Snooping on the pool. Minimum allowed role: pool-operator First published in XenServer 7.3.
      Parameters:
      c - The connection the call is made on
      value - Enable or disable IGMP Snooping on the pool
      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.
    • setIgmpSnoopingEnabled

      public void setIgmpSnoopingEnabled(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Enable or disable IGMP Snooping on the pool. Minimum allowed role: pool-operator First published in XenServer 7.3.
      Parameters:
      c - The connection the call is made on
      value - Enable or disable IGMP Snooping on the pool
      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.
    • hasExtensionAsync

      public Task hasExtensionAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Return true if the extension is available on the pool Minimum allowed role: pool-admin First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      name - The name of the API call
      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.
    • hasExtension

      public Boolean hasExtension(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Return true if the extension is available on the pool Minimum allowed role: pool-admin First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      name - The name of the API call
      Returns:
      True if the extension exists, false otherwise
      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.
    • addToGuestAgentConfigAsync

      public Task addToGuestAgentConfigAsync(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Add a key-value pair to the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      key - The key to add
      value - The value to add
      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.
    • addToGuestAgentConfig

      public void addToGuestAgentConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Add a key-value pair to the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      key - The key to add
      value - The value to add
      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.
    • removeFromGuestAgentConfigAsync

      public Task removeFromGuestAgentConfigAsync(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove a key-value pair from the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      key - The key to remove
      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.
    • removeFromGuestAgentConfig

      public void removeFromGuestAgentConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove a key-value pair from the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.
      Parameters:
      c - The connection the call is made on
      key - The key to remove
      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.
    • rotateSecretAsync

      Minimum allowed role: pool-admin First published in Citrix Hypervisor 8.2 Hotfix 2.
      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.
      Types.InternalError - The server failed to handle your request, due to an internal error. The given message may give details useful for debugging the problem.
      Types.HostIsSlave - You cannot make regular API calls directly on a supporter. Please pass API calls via the coordinator host.
      Types.CannotContactHost - Cannot forward messages because the server cannot be contacted. The server may be switched off or there may be network connectivity problems.
      Types.HaIsEnabled - The operation could not be performed because HA is enabled on the Pool
      Types.NotSupportedDuringUpgrade - This operation is not supported during an upgrade.
    • rotateSecret

      Minimum allowed role: pool-admin First published in Citrix Hypervisor 8.2 Hotfix 2.
      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.
      Types.InternalError - The server failed to handle your request, due to an internal error. The given message may give details useful for debugging the problem.
      Types.HostIsSlave - You cannot make regular API calls directly on a supporter. Please pass API calls via the coordinator host.
      Types.CannotContactHost - Cannot forward messages because the server cannot be contacted. The server may be switched off or there may be network connectivity problems.
      Types.HaIsEnabled - The operation could not be performed because HA is enabled on the Pool
      Types.NotSupportedDuringUpgrade - This operation is not supported during an upgrade.
    • setRepositoriesAsync

      public Task setRepositoriesAsync(Connection c, Set<Repository> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set enabled set of repositories Minimum allowed role: pool-operator First published in 1.301.0.
      Parameters:
      c - The connection the call is made on
      value - The set of repositories to be enabled
      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.
    • setRepositories

      public void setRepositories(Connection c, Set<Repository> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set enabled set of repositories Minimum allowed role: pool-operator First published in 1.301.0.
      Parameters:
      c - The connection the call is made on
      value - The set of repositories to be enabled
      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.
    • addRepositoryAsync

      public Task addRepositoryAsync(Connection c, Repository value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Add a repository to the enabled set Minimum allowed role: pool-operator First published in 1.301.0.
      Parameters:
      c - The connection the call is made on
      value - The repository to be added to the enabled set
      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.
    • addRepository

      public void addRepository(Connection c, Repository value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Add a repository to the enabled set Minimum allowed role: pool-operator First published in 1.301.0.
      Parameters:
      c - The connection the call is made on
      value - The repository to be added to the enabled set
      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.
    • removeRepositoryAsync

      public Task removeRepositoryAsync(Connection c, Repository value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove a repository from the enabled set Minimum allowed role: pool-operator First published in 1.301.0.
      Parameters:
      c - The connection the call is made on
      value - The repository to be removed
      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.
    • removeRepository

      public void removeRepository(Connection c, Repository value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Remove a repository from the enabled set Minimum allowed role: pool-operator First published in 1.301.0.
      Parameters:
      c - The connection the call is made on
      value - The repository to be removed
      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.
    • syncUpdatesAsync

      public Task syncUpdatesAsync(Connection c, Boolean force, String token, String tokenId) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Sync with the enabled repository Minimum allowed role: pool-operator First published in 1.329.0.
      Parameters:
      c - The connection the call is made on
      force - If true local mirroring repo will be removed before syncing
      token - The token for repository client authentication
      tokenId - The ID of the token
      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.
    • syncUpdates

      public String syncUpdates(Connection c, Boolean force, String token, String tokenId) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Sync with the enabled repository Minimum allowed role: pool-operator First published in 1.329.0.
      Parameters:
      c - The connection the call is made on
      force - If true local mirroring repo will be removed before syncing
      token - The token for repository client authentication
      tokenId - The ID of the token
      Returns:
      The SHA256 hash of updateinfo.xml.gz
      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.
    • checkUpdateReadinessAsync

      public Task checkUpdateReadinessAsync(Connection c, Boolean requiresReboot) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Check if the pool is ready to be updated. If not, report the reasons. Minimum allowed role: pool-operator First published in 1.304.0.
      Parameters:
      c - The connection the call is made on
      requiresReboot - Assume that the update will require host reboots
      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.
    • checkUpdateReadiness

      public Set<Set<String>> checkUpdateReadiness(Connection c, Boolean requiresReboot) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Check if the pool is ready to be updated. If not, report the reasons. Minimum allowed role: pool-operator First published in 1.304.0.
      Parameters:
      c - The connection the call is made on
      requiresReboot - Assume that the update will require host reboots
      Returns:
      A set of error codes with arguments, if the pool is not ready to update. An empty list means the pool can be updated.
      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.
    • enableClientCertificateAuthAsync

      public Task enableClientCertificateAuthAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Enable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.
      Parameters:
      c - The connection the call is made on
      name - The name (CN/SAN) that an incoming client certificate must have to allow authentication
      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.
    • enableClientCertificateAuth

      public void enableClientCertificateAuth(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Enable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.
      Parameters:
      c - The connection the call is made on
      name - The name (CN/SAN) that an incoming client certificate must have to allow authentication
      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.
    • disableClientCertificateAuthAsync

      public Task disableClientCertificateAuthAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Disable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.
      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.
    • disableClientCertificateAuth

      public void disableClientCertificateAuth(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Disable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.
      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.
    • configureRepositoryProxyAsync

      public Task configureRepositoryProxyAsync(Connection c, String url, String username, String password) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Configure proxy for RPM package repositories. Minimum allowed role: pool-operator First published in 21.3.0.
      Parameters:
      c - The connection the call is made on
      url - The URL of the proxy server
      username - The username used to authenticate with the proxy server
      password - The password used to authenticate with the proxy server
      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.
    • configureRepositoryProxy

      public void configureRepositoryProxy(Connection c, String url, String username, String password) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Configure proxy for RPM package repositories. Minimum allowed role: pool-operator First published in 21.3.0.
      Parameters:
      c - The connection the call is made on
      url - The URL of the proxy server
      username - The username used to authenticate with the proxy server
      password - The password used to authenticate with the proxy 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.
    • disableRepositoryProxyAsync

      public Task disableRepositoryProxyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Disable the proxy for RPM package repositories. Minimum allowed role: pool-operator First published in 21.4.0.
      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.
    • disableRepositoryProxy

      public void disableRepositoryProxy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Disable the proxy for RPM package repositories. Minimum allowed role: pool-operator First published in 21.4.0.
      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.
    • setUefiCertificatesAsync

      @Deprecated public Task setUefiCertificatesAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Set the UEFI certificates for a pool and all its hosts. Deprecated: use set_custom_uefi_certificates instead Minimum allowed role: pool-admin First published in 22.16.0.
      Parameters:
      c - The connection the call is made on
      value - The certificates to apply to the pool and its hosts
      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.
    • setUefiCertificates

      @Deprecated public void setUefiCertificates(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Deprecated.
      Set the UEFI certificates for a pool and all its hosts. Deprecated: use set_custom_uefi_certificates instead Minimum allowed role: pool-admin First published in 22.16.0.
      Parameters:
      c - The connection the call is made on
      value - The certificates to apply to the pool and its hosts
      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.
    • setCustomUefiCertificatesAsync

      public Task setCustomUefiCertificatesAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set custom UEFI certificates for a pool and all its hosts. Need `allow-custom-uefi-certs` set to true in conf. If empty: default back to Pool.uefi_certificates Minimum allowed role: pool-admin Experimental. First published in 24.1.0.
      Parameters:
      c - The connection the call is made on
      value - The certificates to apply to the pool and its hosts
      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.
    • setCustomUefiCertificates

      public void setCustomUefiCertificates(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set custom UEFI certificates for a pool and all its hosts. Need `allow-custom-uefi-certs` set to true in conf. If empty: default back to Pool.uefi_certificates Minimum allowed role: pool-admin Experimental. First published in 24.1.0.
      Parameters:
      c - The connection the call is made on
      value - The certificates to apply to the pool and its hosts
      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.
    • setHttpsOnlyAsync

      public Task setHttpsOnlyAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      updates all the host firewalls in the pool to open or close port 80 depending on the value Minimum allowed role: pool-operator Experimental. First published in 22.27.0.
      Parameters:
      c - The connection the call is made on
      value - true - http port 80 will be blocked, false - http port 80 will be open for the hosts in the pool
      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.
    • setHttpsOnly

      public void setHttpsOnly(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      updates all the host firewalls in the pool to open or close port 80 depending on the value Minimum allowed role: pool-operator Experimental. First published in 22.27.0.
      Parameters:
      c - The connection the call is made on
      value - true - http port 80 will be blocked, false - http port 80 will be open for the hosts in the pool
      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.
    • setTelemetryNextCollectionAsync

      public Task setTelemetryNextCollectionAsync(Connection c, Date value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the timestamp for the next telemetry data collection. Minimum allowed role: pool-admin Experimental. First published in 23.9.0.
      Parameters:
      c - The connection the call is made on
      value - The earliest timestamp (in UTC) when the next round of telemetry collection can be carried out.
      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.
    • setTelemetryNextCollection

      public void setTelemetryNextCollection(Connection c, Date value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Set the timestamp for the next telemetry data collection. Minimum allowed role: pool-admin Experimental. First published in 23.9.0.
      Parameters:
      c - The connection the call is made on
      value - The earliest timestamp (in UTC) when the next round of telemetry collection can be carried out.
      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.
    • resetTelemetryUuidAsync

      public Task resetTelemetryUuidAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Assign a new UUID to telemetry data. Minimum allowed role: pool-admin Experimental. First published in 23.9.0.
      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.
    • resetTelemetryUuid

      public void resetTelemetryUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Assign a new UUID to telemetry data. Minimum allowed role: pool-admin Experimental. First published in 23.9.0.
      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.
    • configureUpdateSyncAsync

      public Task configureUpdateSyncAsync(Connection c, Types.UpdateSyncFrequency updateSyncFrequency, Long updateSyncDay) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Configure periodic update synchronization to sync updates from a remote CDN Minimum allowed role: pool-operator Experimental. First published in 23.18.0.
      Parameters:
      c - The connection the call is made on
      updateSyncFrequency - The frequency at which updates are synchronized from a remote CDN: daily or weekly.
      updateSyncDay - The day of the week the update synchronization will happen, based on pool's local timezone. Valid values are 0 to 6, 0 being Sunday. For 'daily' schedule, the value is ignored.
      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.
    • configureUpdateSync

      public void configureUpdateSync(Connection c, Types.UpdateSyncFrequency updateSyncFrequency, Long updateSyncDay) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Configure periodic update synchronization to sync updates from a remote CDN Minimum allowed role: pool-operator Experimental. First published in 23.18.0.
      Parameters:
      c - The connection the call is made on
      updateSyncFrequency - The frequency at which updates are synchronized from a remote CDN: daily or weekly.
      updateSyncDay - The day of the week the update synchronization will happen, based on pool's local timezone. Valid values are 0 to 6, 0 being Sunday. For 'daily' schedule, the value is ignored.
      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.
    • setUpdateSyncEnabledAsync

      public Task setUpdateSyncEnabledAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      enable or disable periodic update synchronization depending on the value Minimum allowed role: pool-operator Experimental. First published in 23.18.0.
      Parameters:
      c - The connection the call is made on
      value - true - enable periodic update synchronization, false - disable it
      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.
    • setUpdateSyncEnabled

      public void setUpdateSyncEnabled(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      enable or disable periodic update synchronization depending on the value Minimum allowed role: pool-operator Experimental. First published in 23.18.0.
      Parameters:
      c - The connection the call is made on
      value - true - enable periodic update synchronization, false - disable it
      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.
    • setLocalAuthMaxThreads

      public void setLocalAuthMaxThreads(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Minimum allowed role: pool-operator Experimental. First published in 23.27.0.
      Parameters:
      c - The connection the call is made on
      value - The new maximum
      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.
    • setExtAuthMaxThreads

      public void setExtAuthMaxThreads(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Minimum allowed role: pool-operator Experimental. First published in 23.27.0.
      Parameters:
      c - The connection the call is made on
      value - The new maximum
      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<Pool> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Return a list of all the pools known to the system. Minimum allowed role: read-only First published in XenServer 4.0.
      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<Pool,Pool.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      Return a map of pool references to pool records for all pools known to the system. Minimum allowed role: read-only First published in XenServer 4.0.
      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.