Atom Startup Properties object
The Atom Startup Properties object represents the start-up properties for a runtime, Runtime cluster, or Runtime cloud. These properties come from the Java virtual machine (JVM) to which you deploy the runtime, Runtime cluster, or Runtime cloud.
The fields in the Atom Startup Properties object correspond to properties listed on the Startup Properties panel of the Runtime Management page. The specific fields returned depend on the system configuration and can vary from one Atom to the next.
note
This API is not applicable for atoms attached to clouds.
Structure
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:AtomStartupProperties xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" id="5117c8f6-a446-4a39-8235-4382b2bdd0a5">
<bns:Property name="PROPERTY_NAME" value="PROPERTY_VALUE"/>
...
</bns:AtomStartupProperties>
| Field | Type | Description |
|---|---|---|
| id | string | A unique ID for the runtime, Runtime cluster, or Runtime cloud. (This API is not applicable for atoms attached to clouds) |
| propertyName | string | Name of property. See table below. |
| propertyValue | string | Value of property. |
Startup Properties Reference
| Property | Type | Description |
|---|---|---|
| atomArch | string | The architecture of the runtime, Runtime cluster, or Runtime cloud — either 64-bit or 32-bit. |
| atomFreeDiskSpace | long | The amount of free disk space, in bytes, on the drive that holds the runtime, Runtime cluster, or Runtime cloud installation directory. Some systems do not report this information. |
| atomHome | string | The installation directory of the runtime, Runtime cluster, or Runtime cloud. |
| atomTimeZone | string | The Java timezone for the runtime. |
| atomType | string | The type of runtime (Runtime, Runtime cluster, Cloud). Cloud attachments are not applicable for the API. |
| containerImageVersion | string | The Docker image version for containerized runtimes. |
| customProcbrowserScript | string | The customized procbrowser script file name. |
| customProcrunnerScript | string | The customized procrunner script file name. |
| customProcworkerScript | string | The customized procworker script file name. |
| customRestartScript | string | The customized restart script file name. |
| fileEncoding | string | Default character encoding for data processed by the runtime, Runtime cluster, or Runtime cloud. Common values are UTF-8, Windows-1252, and US-ASCII. |
| infrastructureProvider | string | The infrastructure provider where the runtime, Runtime cluster, or Runtime cloud is running. Possible values are: - AWS (Amazon Web Services) - Azure (Microsoft Azure) - Docker - Legacy Docker (for Docker installations that occurred before the April 2020 release) - GCE (Google Compute Engine) - Kubernetes - QUICKSTART |
| isContainerized | boolean | If true, the runtime is running in a Docker container. |
| isUsingExternalJDK | boolean | If true, the runtime is using an external Java installation that is not managed by Boomi. |
| javaHome | string | The Java installation directory. This is the path that your runtime, Runtime cluster, or Runtime cloud uses to access the Java Runtime. |
| javaVendor | string | The vendor of the Java installation used by the runtime. |
| javaVersion | string | The version number of the Java Runtime (in the case of a Runtime) or the JDK (in the case of a Runtime cluster or Runtime cloud ) in which the runtime, Runtime cluster, or Runtime cloud runs. |
| javaVMName | string | The name of the Java virtual machine to which you deploy the runtime, Runtime cluster, or Runtime cloud. |
| jreFolderJavaVersion | string | The Java version of the runtime's managed Java installation. |
| lastAtomUpdateTime | dateTime (yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2014-02-05T15:32:00Z) | Displays the last time a Runtime Java was upgraded in the Java Version page. |
| lastRestartTime | dateTime (yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2014-02-05T15:32:00Z) | The date and time the runtime, Runtime cluster, or Runtime cloud was last started or restarted. |
| localFreeDiskSpace | long | It is the total amount of free disk space left in the local directory where working data is stored. This will be displayed only when localDir is enabled. See Managing local and work directories for more information. |
| maxCpuTime | long | The average amount of time that a process takes to complete. The upper limit is typically set to unlimited and is represented in seconds. |
| maxDataSize | long | Specified in kilobytes; this property indicates the maximum size of the process' data segment. |
| maxFileLocks | long | The maximum number of locks that a process may establish. |
| maxFileSize | long | The maximum file or folder size that the process can create. |
| maxMemory | long | The maximum amount of RAM, in bytes, available to processes deployed to the runtime, Runtime cluster, or Runtime cloud. |
| maxOpenFiles | int | In Linux only, the maximum number of files that you can open simultaneously. Open files include those that are open for read and write activity and open network connections. |
| maxProcesses | long | The maximum number of processes that are possible for creation within the system. |
| maxStackSize | long | Specified in kilobytes; this property indicates the amount of memory a process can allocate on the stack. |
| osArch | string | The architecture implemented for the microprocessor running the runtime, Runtime cluster, or Runtime cloud. Common values are amd64, i386, ppc, x86, x86_64. |
| osName | string | The operating system on which you deploy the runtime, Runtime cluster, or Runtime cloud. |
| osVersion | string | The version of the operating system in which you deploy the runtime, Runtime cluster, or Runtime cloud. |
| prevJavaVersion | string | Rollback version. The Atom’s Java version prior to the last upgrade. Used as the rollback version in the rollback widget. |
| proxyHost | string | The host name of the HTTP proxy server. |
| proxyPassSet | boolean | If true, there is a password set for the defined proxy. |
| proxyPort | int | The HTTP port number. The default is 80. |
| securityPolicyLevel | string | The Java security policy of the Runtime cluster or Atom cloud (LOW, HIGH). |
| sslProxyHost | string | The host name of the HTTPS proxy server. |
| sslProxyPort | int | The HTTPS port number. The default is 443. |
| systemCpuCount | int | The number of central processing units (CPUs) in the system on which you install the runtime, Runtime cluster, or Runtime cloud. |
| systemTotalMemory | long | The total amount of memory, in bytes, in the system on which you install the runtime, Runtime cluster, or Runtime cloud. Some systems do not report this information. |
| tempFreeDiskSpace | long | The amount of free disk space, in bytes, on the drive that holds the system’s Temporary directory. Some systems do not report this information. |
| unlimitedCrypto | boolean | The default is false, meaning the Java installation has limited strength cryptography. Certain functionality requires full-strength cryptography. Set this to true if you installed the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files. |
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
| Supported | Not supported | Not supported | Not supported | Not supported | Not supported |
The ordinary GET operation retrieves the startup properties for the runtime, Runtime cluster, or Runtime cloud with the specified ID. The bulk GET operation retrieves the startup properties for the Runtimes, Runtime clusters, or Runtime clouds with the specified IDs, to a maximum of 100.
SOAP implementation
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header>
<wsse:Security
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<api:get>
<api:objectType>AtomStartupProperties</api:objectType>
<api:objectId>3456789a-bcde-f012-3456-789abcdef012</api:objectId>
</api:get>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<bns:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<bns:result xsi:type="bns:AtomStartupProperties" id="3456789a-bcde-f012-3456-789abcdef012">
<bns:Property value="2014-02-05T00:20:16Z" name="lastRestartTime"/>
<bns:Property value="true" name="unlimitedCrypto"/>
<bns:Property value="amd64" name="osArch"/>
<bns:Property value="3.11.0-12-generic" name="osVersion"/>
<bns:Property value="Java HotSpot(TM) 64-Bit Server VM" name="javaVMName"/>
<bns:Property value="UTF-8" name="fileEncoding"/>
<bns:Property value="477233152" name="maxMemory"/>
<bns:Property value="8777" name="sslProxyPort"/>
<bns:Property value="385110880256" name="atomFreeDiskSpace"/>
<bns:Property value="8777" name="proxyPort"/>
<bns:Property value="localhost" name="proxyHost"/>
<bns:Property value="387596926976" name="tempFreeDiskSpace"/>
<bns:Property value="/usr/lib/jvm/java-8-oracle/jre" name="javaHome"/>
<bns:Property value="localhost" name="sslProxyHost"/>
<bns:Property value="8579248128" name="systemTotalMemory"/>
<bns:Property value="/home/user/boomi_atomSphere/atom-MyLocalAtom" name="atomHome"/>
<bns:Property value="4" name="systemCpuCount"/>
<bns:Property value="-b13" name="javaVersion"/>
<bns:Property value="64" name="atomArch"/>
<bns:Property value="Linux" name="osName"/>
<bns:Property value="false" name="proxyPassSet"/>
<bns:Property value="AWS" name="infrastructureProvider"/>
<bns:Property value="4096" name="maxOpenFiles"/>
</bns:result>
</bns:getResponse>
</S:Body>
</S:Envelope>
Was this topic helpful?
