Health endpoints EdgeCmd scripts
- Last UpdatedMay 09, 2025
- 1 minute read
The following EdgeCmd commands configure specific facets of the Health endpoints:
|
EdgeCmd command |
Description |
Examples |
|---|---|---|
|
edgecmd get HealthEndpoints [-file <filepath>] |
Get the Health endpoints configuration. |
edgecmd get HealthEndpoints |
|
edgecmd set HealthEndpoints [-file <filepath>] |
Import the Health endpoints configuration. |
edgecmd set HealthEndpoints -file C:\Users\TestUser\HealthEndpoints\Configuration.json |
|
edgecmd add HealthEndpoints [-id <string>] [-Endpoint <endpointUrl>] [-UserName <userName>] [-Password <password>] [-ClientId <clientId>] [-ClientSecret <clientSecret>] [-TokenEndpoint <tokenEndpoint>] [-ValidateEndpointCertificate <true/false>] |
Add a Health endpoint. |
edgecmd add HealthEndpoints -id OCS -Endpoint https://OCS_OMF_endpoint -ClientId TestUser -ClientSecret TestPassword |
|
edgecmd edit HealthEndpoints [-id <string>] [-Endpoint <endpointUrl>] [-UserName <userName>] [-Password <password>] [-ClientId <clientId>] [-ClientSecret <clientSecret>] [-TokenEndpoint <tokenEndpoint>] [-ValidateEndpointCertificate <true/false>] |
Change a Health endpoint. |
edgecmd edit HealthEndpoints -id OCS -Endpoint https://OCS_OMF_endpoint -ClientId TestUser -ClientSecret TestPassword |
|
edgecmd remove HealthEndpoints [-id <string>] [-y] |
Remove a Health endpoint. |
edgecmd remove HealthEndpoints -id OCS |
|
edgecmd help HealthEndpoints |
Display help output for the Health endpoints configuration. |
Use the EdgeCmd utility to add and remove the adapter, and to configure facets of the components.
Note: The examples in this topic are using the default port number 5590. If you specified a different port number for your adapter, you need to add it in the command. For example: edgecmd -port 5591 <RestOfTheCommand>
If a command contains slashes, you must add escape characters as follows:
In Windows , add a second slash. style="box-sizing: inherit;">
Example: TestUser\OilCompany becomes TestUser\\OilCompany
In Linux , add three additional slashes. style="box-sizing: inherit;">
Example: TestUser\OilCompany becomes TestUser\\\\OilCompany