Reference for ValidatePortSettings

Url: settings/portSettings

HTTP Method: PUT

Message direction Format Body
Request XML Example,Schema
Response XML Example,Schema

The following is an example request XML body:

<?xml version="1.0" encoding="utf-16"?>
<coreSettings xmlns="http://apprecovery.com/management/api/2010/05">
  <allowCsvfsProtection>true</allowCsvfsProtection>
  <allowLocalization>true</allowLocalization>
  <allowVerifyRepositoryIntegrity>true</allowVerifyRepositoryIntegrity>
  <clientTimeoutSettings>
    <ConnectionUITimeout>P428DT10H30M12.3S</ConnectionUITimeout>
    <connectionTimeout>P428DT10H30M12.3S</connectionTimeout>
    <readWriteTimeout>P428DT10H30M12.3S</readWriteTimeout>
    <readWriteUITimeout>P428DT10H30M12.3S</readWriteUITimeout>
  </clientTimeoutSettings>
  <dirtyShutdown>CoreWasStoppedSuccessfully</dirtyShutdown>
  <disablePerformanceLogging>true</disablePerformanceLogging>
  <displayName>String content</displayName>
  <enableHttpTracking>true</enableHttpTracking>
  <enableWinApiServiceMetadata>true</enableWinApiServiceMetadata>
  <installPath>String content</installPath>
  <lastShutdown>CoreWasStoppedSuccessfully</lastShutdown>
  <maxIOThreads>2147483647</maxIOThreads>
  <maxThreads>2147483647</maxThreads>
  <protectedMachineConnectVerificationTimeout>P428DT10H30M12.3S</protectedMachineConnectVerificationTimeout>
  <repairAgentsAfterCertificatesUpgrade>true</repairAgentsAfterCertificatesUpgrade>
  <requestTimeOnServiceStart>P428DT10H30M12.3S</requestTimeOnServiceStart>
  <runRepositoryIntegrityCheckAfterUpgrade>true</runRepositoryIntegrityCheckAfterUpgrade>
  <servicePort>2147483647</servicePort>
  <shutdownTimeout>P428DT10H30M12.3S</shutdownTimeout>
  <webServerPort>2147483647</webServerPort>
</coreSettings>

The following is an example response XML body:

No Xml response output for this method.

The following is the request XML Schema:

<?xml version="1.0" encoding="utf-16"?>
<Schemas>
  <xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="anyType" nillable="true" type="xs:anyType" />
    <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
    <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
    <xs:element name="boolean" nillable="true" type="xs:boolean" />
    <xs:element name="byte" nillable="true" type="xs:byte" />
    <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
    <xs:element name="decimal" nillable="true" type="xs:decimal" />
    <xs:element name="double" nillable="true" type="xs:double" />
    <xs:element name="float" nillable="true" type="xs:float" />
    <xs:element name="int" nillable="true" type="xs:int" />
    <xs:element name="long" nillable="true" type="xs:long" />
    <xs:element name="QName" nillable="true" type="xs:QName" />
    <xs:element name="short" nillable="true" type="xs:short" />
    <xs:element name="string" nillable="true" type="xs:string" />
    <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
    <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
    <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
    <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
    <xs:element name="char" nillable="true" type="tns:char" />
    <xs:simpleType name="char">
      <xs:restriction base="xs:int" />
    </xs:simpleType>
    <xs:element name="duration" nillable="true" type="tns:duration" />
    <xs:simpleType name="duration">
      <xs:restriction base="xs:duration">
        <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
        <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
        <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="guid" nillable="true" type="tns:guid" />
    <xs:simpleType name="guid">
      <xs:restriction base="xs:string">
        <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
      </xs:restriction>
    </xs:simpleType>
    <xs:attribute name="FactoryType" type="xs:QName" />
    <xs:attribute name="Id" type="xs:ID" />
    <xs:attribute name="Ref" type="xs:IDREF" />
  </xs:schema>
  <xs:schema xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Settings" />
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:complexType name="coreSettings">
      <xs:sequence>
        <xs:element minOccurs="0" name="allowCsvfsProtection" type="xs:boolean" />
        <xs:element minOccurs="0" name="allowLocalization" type="xs:boolean" />
        <xs:element minOccurs="0" name="allowVerifyRepositoryIntegrity" type="xs:boolean" />
        <xs:element minOccurs="0" name="clientTimeoutSettings" nillable="true" type="tns:clientTimeoutSettings" />
        <xs:element minOccurs="0" name="dirtyShutdown" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Settings" type="q1:CoreDirtyShutdownState" />
        <xs:element minOccurs="0" name="disablePerformanceLogging" type="xs:boolean" />
        <xs:element minOccurs="0" name="displayName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="enableHttpTracking" type="xs:boolean" />
        <xs:element minOccurs="0" name="enableWinApiServiceMetadata" type="xs:boolean" />
        <xs:element minOccurs="0" name="installPath" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="lastShutdown" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Settings" type="q2:CoreDirtyShutdownState" />
        <xs:element minOccurs="0" name="maxIOThreads" type="xs:int" />
        <xs:element minOccurs="0" name="maxThreads" type="xs:int" />
        <xs:element minOccurs="0" name="protectedMachineConnectVerificationTimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="repairAgentsAfterCertificatesUpgrade" type="xs:boolean" />
        <xs:element minOccurs="0" name="requestTimeOnServiceStart" type="ser:duration" />
        <xs:element minOccurs="0" name="runRepositoryIntegrityCheckAfterUpgrade" type="xs:boolean" />
        <xs:element minOccurs="0" name="servicePort" type="xs:int" />
        <xs:element minOccurs="0" name="shutdownTimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="webServerPort" type="xs:int" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="coreSettings" nillable="true" type="tns:coreSettings" />
    <xs:complexType name="clientTimeoutSettings">
      <xs:sequence>
        <xs:element minOccurs="0" name="ConnectionUITimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="connectionTimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="readWriteTimeout" type="ser:duration" />
        <xs:element minOccurs="0" name="readWriteUITimeout" type="ser:duration" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="clientTimeoutSettings" nillable="true" type="tns:clientTimeoutSettings" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Settings" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Settings" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="CoreDirtyShutdownState">
      <xs:restriction base="xs:string">
        <xs:enumeration value="CoreWasStoppedSuccessfully" />
        <xs:enumeration value="CoreWasStoppedWithDirtyShutdown" />
        <xs:enumeration value="AllRepositoriesShouldBeChecked" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="CoreDirtyShutdownState" nillable="true" type="tns:CoreDirtyShutdownState" />
  </xs:schema>
</Schemas>

The following is the response XML Schema:

The response body is empty.