The architecture of your OS:
all: Use this value for AIX and z/OS. Defaults to x86 for other OS types.
x86: x86 architecture.
ppc: PowerPC architecture, only supported for AIX.
ppcle: PowerPC Little Endian architecture, only supported for Linux.
sparc: Sparc architecture, only supported for Solaris.
arm: ARM architecture, only supported for Linux.
s390: S/390 architecture, only supported for Linux.
Only applicable to the paas and paas-sh installer types.
The bitness of your OS. Must be supported by the OS.
Only applicable to the paas and paas-sh installer types.
The flavor of your Linux distribution:
musl for Linux distributions, which are using the musl C standard library, for example Alpine Linux.
multidistro for Linux distributions, which are using musl C and glibc standard library.
default for Linux distributions, which are using glibc standard library.
Only applicable to the paas and paas-sh installer types.
The code modules to be included to the installer. You can specify several modules in the following format: include=java&include=dotnet.
Only applicable to the paas and paas-sh installer types.
The type of the installer:
default: Self-extracting installer for manual installation. Downloads an .exe file for Windows or an .sh file for Unix.default-unattended: Self-extracting installer for unattended installation. Windows only. Downloads a .zip archive, containing the .msi installer and the batch file. This option is deprecated with OneAgent version 1.173mainframe: Downloads all code modules for z/OS combined in a single \\*.pax archive.paas: Code modules installer. Downloads a \\*.zip archive, containing the manifest.json file with meta information or a .jar file for z/OS.paas-sh: Code modules installer. Downloads a self-extracting shell script with the embedded tar.gz archive.Set true to omit the OneAgent connectivity information from the installer.
Only applicable to the paas and paas-sh installer types.
The required version of the OneAgent in 1.155.275.20181112-084458 format.
You can retrieve the list of available versions with the GET available versions of OneAgent call.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The payload contains the installer file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n0.1.0.20200925-120822 format. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The payload contains the installer file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n0.1.0.20200925-120822 format. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The payload contains the installer file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nSet true to omit the OneAgent connectivity information from the installer.
If not set, false is used.
The required version of the OneAgent in the 1.155.275.20181112-084458 format.
You can retrieve the list of available versions with the GET available versions of BOSH tarballs call.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The payload contains the BOSH release tarball file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nThe architecture of your OS:
all: Defaults to amd64.amd64: amd64 architecture.s390: S/390 architecture, only supported for Linux.arm64: arm64 architecture, only supported for Linux.The required version of the ActiveGate installer, in 1.155.275.20181112-084458 format.
You can retrieve the list of available versions with the GET available versions of ActiveGate call.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The payload contains the installer file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nThe architecture of your OS:
all: Use this value for AIX and z/OS. Defaults to x86 for other OS types.
x86: x86 architecture.
ppc: PowerPC architecture, only supported for AIX.
ppcle: PowerPC Little Endian architecture, only supported for Linux.
sparc: Sparc architecture, only supported for Solaris.
arm: ARM architecture, only supported for Linux.
s390: S/390 architecture, only supported for Linux.
Only applicable to the paas and paas-sh installer types.
The bitness of your OS. Must be supported by the OS.
Only applicable to the paas and paas-sh installer types.
The flavor of your Linux distribution:
musl for Linux distributions, which are using the musl C standard library, for example Alpine Linux.
multidistro for Linux distributions, which are using musl C and glibc standard library.
default for Linux distributions, which are using glibc standard library.
Only applicable to the paas and paas-sh installer types.
The code modules to be included to the installer. You can specify several modules in the following format: include=java&include=dotnet.
Only applicable to the paas and paas-sh installer types.
The type of the installer:
default: Self-extracting installer for manual installation. Downloads an .exe file for Windows or an .sh file for Unix.default-unattended: Self-extracting installer for unattended installation. Windows only. Downloads a .zip archive, containing the .msi installer and the batch file. This option is deprecated with OneAgent version 1.173mainframe: Downloads all code modules for z/OS combined in a single \\*.pax archive.paas: Code modules installer. Downloads a \\*.zip archive, containing the manifest.json file with meta information or a .jar file for z/OS.paas-sh: Code modules installer. Downloads a self-extracting shell script with the embedded tar.gz archive.Set true to omit the OneAgent connectivity information from the installer.
Only applicable to the paas and paas-sh installer types.
The architecture of your OS:
all: Defaults to amd64.amd64: amd64 architecture.s390: S/390 architecture, only supported for Linux.arm64: arm64 architecture, only supported for Linux.The architecture of your OS:
all: Defaults to amd64.amd64: amd64 architecture.s390: S/390 architecture, only supported for Linux.arm64: arm64 architecture, only supported for Linux.true to perform a fallback to the default network zone if the provided network zone does not exist. |\n|config.networkZone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The network zone you want the result to be configured with. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ActiveGateConnectionInfo](#activegateconnectioninfo)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nThe architecture of your OS:
all: Use this value for AIX and z/OS. Defaults to x86 for other OS types.
x86: x86 architecture.
ppc: PowerPC architecture, only supported for AIX.
ppcle: PowerPC Little Endian architecture, only supported for Linux.
sparc: Sparc architecture, only supported for Solaris.
arm: ARM architecture, only supported for Linux.
s390: S/390 architecture, only supported for Linux.
Only applicable to the paas and paas-sh installer types.
The flavor of your Linux distribution:
musl for Linux distributions, which are using the musl C standard library, for example Alpine Linux.
multidistro for Linux distributions, which are using musl C and glibc standard library.
default for Linux distributions, which are using glibc standard library.
Only applicable to the paas and paas-sh installer types.
The type of the installer:
default: Self-extracting installer for manual installation. Downloads an .exe file for Windows or an .sh file for Unix.default-unattended: Self-extracting installer for unattended installation. Windows only. Downloads a .zip archive, containing the .msi installer and the batch file. This option is deprecated with OneAgent version 1.173mainframe: Downloads all code modules for z/OS combined in a single \\*.pax archive.paas: Code modules installer. Downloads a \\*.zip archive, containing the manifest.json file with meta information or a .jar file for z/OS.paas-sh: Code modules installer. Downloads a self-extracting shell script with the embedded tar.gz archive.true to perform a fallback to the default network zone if the provided network zone does not exist. |\n|config.networkZone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The network zone you want the result to be configured with. |\n|config.version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the OneAgent for which you're requesting connectivity information, in the 1.221 format.
Set this parameter to get the best format of endpoint list for optimal performance.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ConnectionInfo](#connectioninfo)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\ntrue to perform a fallback to the default network zone if the provided network zone does not exist. |\n|config.networkZone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nThe architecture of your OS:
all: Use this value for AIX and z/OS. Defaults to x86 for other OS types.
x86: x86 architecture.
ppc: PowerPC architecture, only supported for AIX.
ppcle: PowerPC Little Endian architecture, only supported for Linux.
sparc: Sparc architecture, only supported for Solaris.
arm: ARM architecture, only supported for Linux.
s390: S/390 architecture, only supported for Linux.
Only applicable to the paas and paas-sh installer types.
The bitness of your OS. Must be supported by the OS.
Only applicable to the paas and paas-sh installer types.
The flavor of your Linux distribution:
musl for Linux distributions, which are using the musl C standard library, for example Alpine Linux.
multidistro for Linux distributions, which are using musl C and glibc standard library.
default for Linux distributions, which are using glibc standard library.
Only applicable to the paas and paas-sh installer types.
The type of the installer:
default: Self-extracting installer for manual installation. Downloads an .exe file for Windows or an .sh file for Unix.default-unattended: Self-extracting installer for unattended installation. Windows only. Downloads a .zip archive, containing the .msi installer and the batch file. This option is deprecated with OneAgent version 1.173mainframe: Downloads all code modules for z/OS combined in a single \\*.pax archive.paas: Code modules installer. Downloads a \\*.zip archive, containing the manifest.json file with meta information or a .jar file for z/OS.paas-sh: Code modules installer. Downloads a self-extracting shell script with the embedded tar.gz archive.The architecture of your OS:
all: Use this value for AIX and z/OS. Defaults to x86 for other OS types.
x86: x86 architecture.
ppc: PowerPC architecture, only supported for AIX.
ppcle: PowerPC Little Endian architecture, only supported for Linux.
sparc: Sparc architecture, only supported for Solaris.
arm: ARM architecture, only supported for Linux.
s390: S/390 architecture, only supported for Linux.
Only applicable to the paas and paas-sh installer types.
The bitness of your OS. Must be supported by the OS.
Only applicable to the paas and paas-sh installer types.
The flavor of your Linux distribution:
musl for Linux distributions, which are using the musl C standard library, for example Alpine Linux.
multidistro for Linux distributions, which are using musl C and glibc standard library.
default for Linux distributions, which are using glibc standard library.
Only applicable to the paas and paas-sh installer types.
The code modules to be included to the installer. You can specify several modules in the following format: include=java&include=dotnet.
Only applicable to the paas and paas-sh installer types.
The required version of the OneAgent in 1.155.275.20181112-084458 format.
You can retrieve the list of available versions with the GET available versions of OneAgent call.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[OneAgentInstallerChecksum](#oneagentinstallerchecksum)|200|Success. The payload contains the installer file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nSet true to omit the OneAgent connectivity information from the installer.
If not set, false is used.
The required version of the OneAgent in the 1.155.275.20181112-084458 format.
You can retrieve the list of available versions with the GET available versions of BOSH tarballs call.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[BoshReleaseChecksum](#boshreleasechecksum)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nThe architecture of your OS:
all: Defaults to amd64.amd64: amd64 architecture.s390: S/390 architecture, only supported for Linux.arm64: arm64 architecture, only supported for Linux.The architecture of your OS:
x86: x86 architecture.arm: ARM architecture.Filters the resulting set of hosts to those that are currently connected to the ActiveGate with the specified ID.
Use DIRECT_COMMUNICATION keyword to find the hosts not connected to any ActiveGate.
|\n|config.agentVersionIs|\"EQUAL\" | \"GREATER\" | \"GREATER_EQUAL\" | \"LOWER\" | \"LOWER_EQUAL\"|Filters the resulting set of hosts to those that have a certain OneAgent version deployed on the host.
Specify the comparison operator here.
|\n|config.agentVersionNumber|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of hosts to those that have a certain OneAgent version deployed on the host.
Specify the version in the <major>.<minor>.<revision> format, for example 1.182.0. You can fetch the list of available versions with the GET available versions call.
Filters the resulting set of hosts by the availability state of OneAgent.
MONITORED: Hosts where OneAgent is enabled and active.UNMONITORED: Hosts where OneAgent is disabled and inactive.CRASHED: Hosts where OneAgent has returned a crash status code.LOST: Hosts where it is impossible to establish connection with OneAgent.PRE_MONITORED: Hosts where OneAgent is being initialized for monitoring.SHUTDOWN: Hosts where OneAgent is shutting down in a controlled process.UNEXPECTED_SHUTDOWN: Hosts where OneAgent is shutting down in an uncontrolled process.UNKNOWN: Hosts where the state of OneAgent is unknown.Filters the resulting set of hosts by the detailed availability state of OneAgent.
UNKNOWN: Hosts where the state of OneAgent is unknown.PRE_MONITORED: Hosts where OneAgent is being initialized for monitoring.CRASHED_UNKNOWN: Hosts where OneAgent has crashed for unknown reason.CRASHED_FAILURE: Hosts where OneAgent has returned a crash status code.LOST_UNKNOWN: Hosts where it is impossible to establish connection with OneAgent for unknown reason.LOS","readmeFilename":"README.md"}