openapi: 3.0.0
info:
title: Installed Apps
version: '2.0'
description: APIs for installed apps
contact:
name: OpsRamp Support
url: 'https://www.opsramp.com/about-opsramp/contact-us/'
email: support@OpsRamp.com
tags:
- name: installed-apps
description: Documentation of the API for installing the apps and its profiles.
externalDocs:
url: 'https://develop.opsramp.com/installed-apps/'
servers:
- url: 'https://custom-branded-domain.api.opsramp.com'
paths:
'/api/v3/tenants/{tenantId}/apps/install':
x-new-path: true
description: Install the published apps for the tenant
summary: apps
parameters:
- name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
post:
summary: Installs the given app
operationId: post-api-v2-tenants-tenantId-apps
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/installedApp'
examples:
installed-apps:
value:
id: INTG-66d552b2-1e1c-499f-b375-a98e746d6ace
displayName: hpe-alletra-6000-G-1744285851289
category: SDK APP
installedBy: superadmin
installedTime: '2025-05-27T03:56:19-0700'
status: Install Request Sent
profile:
id: 2
name: G-1744285851289
status: DOWN
registered: false
uuId: 8b309651-77ed-48a8-869b-10bab7518b60
delete: false
connectedStatus: 0
monitoredMetricsCount: 0
assignedTemplatesCount: 0
app: hpe-alletra-6000
version: 1.0.0
updateAvailable: false
state: Installed
forceDeleteStaleEntries: false
skipDeleteResources: false
multiConfigsAvailable: false
multiAppsDiscoveryEnabled: true
enableGlobalPolicies: false
keepAgentInstalledResources: false
deleteAssociatedChildAccounts: false
streamExportsEnabled: false
acceptConditions: false
logManagementEnabled: false
traceManagementEnabled: false
installed-apps-kubernetes-2.0:
value:
id: INTG-c2ea297f-f2eb-4879-9c00-1f4bdc3eaba6
displayName: Kubernetes-2.0
category: SDK APP
installedBy: opsramp_api_user
installedTime: '2025-12-03T06:43:55+0000'
status: Installed
app: Kubernetes-2.0
version: 2.0.0
updateAvailable: false
forceDeleteStaleEntries: false
skipDeleteResources: false
multiConfigsAvailable: false
multiAppsDiscoveryEnabled: false
enableGlobalPolicies: false
keepAgentInstalledResources: false
deleteAssociatedChildAccounts: false
streamExportsEnabled: false
acceptConditions: false
logManagementEnabled: false
traceManagementEnabled: false
vmwareRealTimeMonitoring: false
description: Installs the app as requested in the payload.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/appDetails'
examples:
installed-apps:
value:
app: hpe-alletra-6000
profile:
uuId: 8b309651-77ed-48a8-869b-10bab7518b60
version: 1.0.0
multiAppsDiscoveryEnabled: true
installed-apps-kubernetes-2.0:
value:
app: KUBERNETES-2.0
version: 2.0.0
tags:
- installed-apps
'/api/v3/tenants/{tenantId}/apps/install/{id}':
description: Manage the installed Apps. Get details or deletes the installed apps.
summary: 'apps/install/{id}'
x-new-path: true
parameters:
- name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: Installed app uuid
get:
summary: Get installed apps details.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/installedApp'
examples:
Installed-App-details:
value:
id: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
displayName: SNMP Monitoring App
installedBy: opsramp_api_user
installedTime: '2021-09-09T14:39:59+0100'
profile:
id: 10135
name: Gateway18.04
status: DOWN
uuId: 359ed62c-6e4a-4bf4-8305-463ac320e013
delete: false
app: snmp
version: 2.0.0
updateAvailable: false
title: SNMP
state: Installed
operationId: query-installed-apps
description: Retrieve the information of the app with the app uuid
tags:
- installed-apps
delete:
summary: Uninstalls apps
operationId: deleteapi-v2-tenants-tenantId-apps
responses:
'200':
description: OK
description: Removes the installed app
requestBody:
content:
application/json:
schema:
description: ''
type: object
properties:
uninstallReason:
type: string
minLength: 1
required:
- uninstallReason
x-examples:
example-1:
uninstallReason: Test
examples:
example-uninstall-apps:
value:
uninstallReason: Test app only
tags:
- installed-apps
'/api/v3/tenants/{tenantId}/apps/install/{id}/{actions}':
description: Upgrades the installed app with latest version
summary: 'apps/install/{id}/{actions}'
x-new-path: true
parameters:
- name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
- schema:
type: string
enum:
- upgrade
name: actions
in: path
required: true
description: Perform permitted actions on the installed apps. For eg. upgrade
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: Installed app uuid
post:
summary: Actions on installed apps
operationId: app=actions
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/installedApp'
examples:
installed-apps:
value:
id: INTG-98990ba8-0245-4b44-88be-2eb16560219c
displayName: hpe-alletra-6000-GatewayRCB
category: SDK APP
installedBy: opsramp_api_user
installedTime: '2025-05-07T23:58:35-0700'
status: Upgrade Request sent
profile:
id: 1
name: GatewayRCB
status: UP
registered: true
uuId: fbacbcd8-dcea-42ad-ac1d-c41be1e22b68
delete: false
connectedStatus: 0
monitoredMetricsCount: 0
assignedTemplatesCount: 0
app: hpe-alletra-6000
version: 1.0.0
draftVersion: 2.0.0
updateAvailable: true
state: Deployed
forceDeleteStaleEntries: false
skipDeleteResources: false
multiConfigsAvailable: false
multiAppsDiscoveryEnabled: true
enableGlobalPolicies: false
keepAgentInstalledResources: false
deleteAssociatedChildAccounts: false
streamExportsEnabled: false
acceptConditions: false
modifiedTime: '2025-05-27T03:58:35-0700'
modifiedBy: superadmin
logManagementEnabled: false
traceManagementEnabled: false
description: Performs the appropirate actions ( upgrade)
requestBody:
content:
application/json:
schema:
description: ''
type: object
properties:
app:
type: string
minLength: 1
version:
type: string
minLength: 1
required:
- app
- version
x-examples:
example-1:
app: hpe-alletra-6000
version: 2.0.0
examples:
example-installed-apps-actions:
value:
app: hpe-alletra-6000
version: 2.0.0
description: Initiates the requested action on the installed app. For eg. Upgrading the app
tags:
- installed-apps
'/api/v3/tenants/{tenantId}/apps/install/{id}/config':
description: |
Retrieve and update the installed app profiles.
Note: This API is also used to configure synthetic monitoring integrations.
summary: 'apps/install/{id}/config'
x-new-path: true
post:
summary: Update a given profile details of the app
operationId: update-profiles
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
name:
type: string
minLength: 1
config:
type: object
properties:
url:
type: string
method:
type: string
timeout:
type: integer
checkType:
type: string
credentials:
type: array
items:
type: object
properties:
uniqueId:
type: string
syntheticProxyCredSet:
type: array
items:
type: object
properties:
uniqueId:
type: string
followRedirects:
type: boolean
description: >
Indicates whether HTTP or HTTPS redirects should be followed during the synthetic check.
Allowed values: true or false.
maxRedirects:
type: integer
description: >
Specifies the maximum number of redirects to follow.
- Required when followRedirects is true.
- Must be between 1 and 50 (inclusive) when followRedirects is true.
- Must be 0 or omitted when followRedirects is false.
httpHeaders:
type: string
httpParams:
type: string
validateSSL:
type: boolean
shouldContain:
type: string
shouldNotContain:
type: string
expectedResponseCode:
type: string
resourceName:
type: string
resourceType:
type: string
syntheticProxyServerUrl:
type: string
payloadRegularExpression:
type: string
proxyConfigurationSettings:
type: boolean
syntheticProxyServerAuthType:
type: string
syntheticProxyServerConfigType:
type: string
locationUuids:
type: array
items:
type: string
port:
type: string
minLength: 1
protocol:
type: string
minLength: 1
ipAddress:
type: string
minLength: 1
vcenterName:
type: string
minLength: 1
nativeTypes:
type: object
properties:
vm:
type: object
properties:
metrics:
type: object
properties:
system_memory_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_network_interface_utilization:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
host:
type: object
properties:
metrics:
type: object
properties:
system_disk_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
system_cpu_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_memory_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
installedAppId:
type: string
minLength: 1
schedule:
type: object
properties:
patternType:
type: string
minLength: 1
pattern:
type: string
minLength: 1
startTime:
type: string
minLength: 1
examples:
example-app-profile:
value:
id: ADAPTER-MANIFEST-9895c9a6-73fa-4399-956e-08f2b9d32899
name: Update SNMP Moniotring App
config:
discoveryType: IP Range
ipRange: 192.168.56.101
options:
cdp: true
credential1:
snmp_version: V1
port: '9445'
community: test
credential2:
snmp_version: V2
port: '8843'
advancedOptions:
scanDiscovered: true
installedAPPId: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
schedule:
patternType: MINUTES
pattern: '30'
startTime: '30'
frequency: 5
state: ENABLED
example-add-config:
value:
id: ADAPTER-MANIFEST-e7586677-b878-483d-baaa-389e3ee3329a
name: test_config
config:
port: '45000'
ipAddress: 192.168.56.121
vcenterName: vCenter
protocol: http
credentials:
- SByTpYg7fauQtPfkzM6pDbpf
nativeTypes:
vm:
metrics:
system_memory_usage_utilization:
name: system_memory_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory usage Utilization in percentage
displayName: system_memory_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_network_interface_utilization:
name: system_network_interface_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system network interface utilization
displayName: system_network_interface_utilization
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
frequency: '5'
resourceType: Server
host:
metrics:
system_disk_usage_usedspace:
name: system_disk_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system disk usage
displayName: system_disk_usage_usedspace
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
formatAlertValue: true
system_cpu_usage_utilization:
name: system_cpu_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '65'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system cpu usage Utilization in percentage
displayName: system_cpu_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_memory_usage_usedspace:
name: system_memory_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory used sapce
displayName: system_memory_usage_usedspace
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
frequency: '5'
resourceType: Server
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
schedule:
patternType: MINUTES
pattern: '20'
startTime: '20'
frequency: 20
state: ENABLED
example-snmp-config:
$ref: ./models/opsramp-installed-apps/sample-snmp-config-response-v1.yaml
example-ssh-config:
value:
id: ADAPTER-MANIFEST-8d199c0b-f556-485d-a7bf-a7f2d20e2022
name: test_ssh_1
config:
ipRange: 172.21.12.10
credentials:
- pWP2qpdZh3g6d6yxFHbsnPyx
installedAPPId: INTG-512fccca-23bf-457c-a643-a554483f90da
schedule:
patternType: HOURLY
pattern: '1'
startTime: '1'
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 2203
example-wmi-config:
value:
id: ADAPTER-MANIFEST-8d199c0b-f556-485d-a7bf-a7f2d20e2022
name: test_emi_1
config:
ipRange: 172.21.12.10
credentials:
- pWP2qpdZh3g6d6yxFHbsnPyx
installedAPPId: INTG-512fccca-23bf-457c-a643-a554483f90da
schedule:
patternType: HOURLY
pattern: '1'
startTime: '1'
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 2203
example-HTTPS-payload:
value:
id: ADAPTER-MANIFEST-93dceac4-928e-4946-82e8-b2527e95f13e
name: HTTPS_TEST
config:
resourceName: HTTPS_TEST
resourceType: SYNTHETIC
credentials:
- uniqueId: 8np6Yc3gXVjfr3sNXhwfuXZx
checkType: HTTPS
locationUuids:
- 51970699-4a8f-44b7-bdcd-2773803ab84a
syntheticProxyServerConfigType: Custom
url: 'https://www.google.com/'
timeout: 60
syntheticProxyServerAuthType: Basic
shouldContain: Test
shouldNotContain: User
validateSSL: true
httpHeaders: '{"Accept":"application/json"}'
httpParams: '{"Content-Type":"application/json"}'
expectedResponseCode: '200'
payloadRegularExpression: "\bAbout\b"
method: GET
syntheticProxyCredSet:
- uniqueId: 8gcp9GtFCpEtyVtQyEVsqYCM
followRedirects: true
maxRedirects: 10
proxyConfigurationSettings: true
syntheticProxyServerUrl: 'http://172.25.251.124:3128'
installedAPPId: INTG-11ad0daf-d102-48e1-9e49-2a9400017ab3
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 66719a6f-424b-4bd9-abc0-caae534d0ea9
allResources: false
thirdPartyCiMappable: false
availabilityEnabled: false
lastScanTime: 0
example-HTTP-payload:
value:
id: ADAPTER-MANIFEST-641765e6-160f-4938-9497-1215a143b190
name: HTTP_TEST
config:
resourceName: HTTP_TEST
resourceType: SYNTHETIC
credentials:
- uniqueId: 8np6Yc3gXVjfr3sNXhwfuXZx
checkType: HTTP
locationUuids:
- 51970699-4a8f-44b7-bdcd-2773803ab84a
syntheticProxyServerConfigType: Custom
url: 'http://www.google.com/'
timeout: 60
syntheticProxyServerAuthType: Basic
shouldContain: Test
shouldNotContain: dummy
httpHeaders: '{"Accept":"application/json"}'
httpParams: '{"Content-Type":"application/json"}'
expectedResponseCode: '200'
payloadRegularExpression: \bAbout\b
method: GET
syntheticProxyCredSet:
- uniqueId: 8gcp9GtFCpEtyVtQyEVsqYCM
followRedirects: true
maxRedirects: 10
proxyConfigurationSettings: true
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
installedAPPId: INTG-11ad0daf-d102-48e1-9e49-2a9400017ab3
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: aec3109d-d1b4-4485-8c56-65d97468600e
allResources: false
thirdPartyCiMappable: false
availabilityEnabled: false
lastScanTime: 0
example-DNS-payload:
value:
id: ADAPTER-MANIFEST-a0d58fbb-2b4e-48d6-ba1e-cdcc2cf47f50
name: DNS_Testcase1
config:
url: www.hpe.com
timeout: 500
checkType: DNS
resourceName: DNS Test
resourceType: SYNTHETIC
expectedIp: 16.193.213.4
nameServer: 8.8.8.8
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 96fa9a0e-be39-4adc-8da6-8187a04758eb
allResources: false
lastScanTime: 0
example-PING-payload:
value:
id: ADAPTER-MANIFEST-61e00abe-4a80-4e5f-8c49-104c9d9d3efa
name: PING_Test
config:
url: www.google.com
timeout: 500
checkType: PING
resourceName: PING_NEW
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 7d6ff2d7-954f-43e4-8413-252f7d48e7af
allResources: false
lastScanTime: 0
example-FTP-payload:
value:
id: ADAPTER-MANIFEST-6263afaa-3320-45ee-8b37-5ebec2b2a6c0
name: ftp_upload
config:
url: ftp://ftp-localserver.com
port: 21
timeout: 500
checkType: FTP
credential:
uniqueId: xGjU8SKCAdbY6NyvPvMfc7KE
credentials:
- uniqueId: xGjU8SKCAdbY6NyvPvMfc7KE
resourceName: ftp_upload
resourceType: SYNTHETIC
uploadStream: RGFzaGJvYXJkIDIuMDoNCkF1dGhlbnRpY2F0aW9uLm1kCQ0KQnVsa19VcGRhdGVfVGlsZXMubWQJ
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
uploadFileName: test.txt
destinationFilePath: 'C:/Users/Desktop'
syntheticProxyCredSet:
- uniqueId: 3EwgVqvPyjV9F93MK7yxEDfN
syntheticProxyServerUrl: 'http://172.26.111.16:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 411201b2-7593-44fb-a923-2aec9bc0c6dd
allResources: false
lastScanTime: 0
example-SSL-payload:
value:
id: ADAPTER-MANIFEST-533a7315-25cf-4224-ac65-39284417a26f
name: SSL_Test
config:
url: www.google.com
timeout: 500
checkType: SSL
resourceName: SSL_new
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: 3EwgVqvPyjV9F93MK7yxEDfN
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 09ae8d4c-1d07-44d5-b1c8-bb7e1074a239
allResources: false
lastScanTime: 0
example-TCP-payload:
value:
id: ADAPTER-MANIFEST-72de2983-86ff-45b6-a37a-8df1ff77173c
name: TCP_Test
config:
url: www.google.com
port: 80
timeout: 500
checkType: TCP
resourceName: TCP
resourceType: SYNTHETIC
messageToSend: Test
shouldContain: test1
shouldNotContain: user
validateSSL: true
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 05248043-882d-4c46-bb42-6bff1db451f5
allResources: false
lastScanTime: 0
example-UDP-payload:
value:
id: ADAPTER-MANIFEST-9ebcccd9-e3bc-443b-b41d-717ba7794c8f
name: UDP_Test
config:
url: www.google.com
port: 67
timeout: 400
checkType: UDP
credentials: []
resourceName: UDP
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
messageToSend: Test1
shouldContain: instance1
shouldNotContain: Test12
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 5eaedd45-6072-4516-b760-542860712dc7
allResources: false
lastScanTime: 0
example-SMTP-payload:
value:
id: ADAPTER-MANIFEST-1292eac6-fb0d-4000-8464-add1fe13ae2c
name: SMTP_Test
config:
resourceName: smtp
resourceType: SYNTHETIC
credentials:
- uniqueId: Jmzz2bAQkwQkkZnNcF9N27WE
checkType: SMTP
syntheticProxyServerConfigType: Custom
url: www.Test.com
timeout: 500
port: 222
messageToSend: Test
recipientList: Test@hpe.com
syntheticProxyServerAuthType: Basic
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
proxyConfigurationSettings: true
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
credential:
uniqueId: Jmzz2bAQkwQkkZnNcF9N27WE
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: a3c36311-c6d6-403f-8a05-03b5d0f9efa8
allResources: false
lastScanTime: 0
example-POP3-payload:
value:
id: ADAPTER-MANIFEST-f85cb983-9cc0-4f43-abab-8d03337b527d
name: POP3_Test
config:
url: pop3://pop3-host.com
port: 22
timeout: 500
checkType: POP3
credential:
uniqueId: R83HrRsxncuZK7XtZ2nueRuJ
credentials:
- uniqueId: R83HrRsxncuZK7XtZ2nueRuJ
resourceName: POP3 Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.20.24.200:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 9b5b7c9d-96c1-4795-af5c-0d8b1598ee11
allResources: false
lastScanTime: 0
example-IMAP-payload:
value:
id: ADAPTER-MANIFEST-e3dfaf31-4ec1-45a2-88e9-a75cdc588057
name: IMAP_Test
config:
url: imap://imap.com
port: '222'
timeout: 500
checkType: IMAP
credential:
uniqueId: gFEzdPH6RmMgGWDpwkKwVp23
credentials:
- uniqueId: gFEzdPH6RmMgGWDpwkKwVp23
resourceName: IMAP_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 3129eb02-bb28-4122-bf49-d7394b660148
allResources: false
lastScanTime: 0
example-RTT-payload:
value:
id: ADAPTER-MANIFEST-5bf18e4b-0f39-4a91-a2d8-7678aaf1bbcd
name: RTT_Test
config:
url: smtp://smtp.host.com
port: 34
timeout: 500
checkType: RTT
credential:
uniqueId: yWG7YxYNZrGqRDeKqkaQnyQs
credentials:
- uniqueId: yWG7YxYNZrGqRDeKqkaQnyQs
resourceName: RTT_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
receiverHostPort: 22
receiverHost: test
emailReceiverType: IMAP
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.20.24.200:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 8e729534-363b-4e92-98cc-a69ee09c831b
allResources: false
lastScanTime: 0
example-SCRIPT-payload:
value:
id: ADAPTER-MANIFEST-28bf03ce-91ad-4063-8a9c-840e8e854b43
name: script_Test
config:
resourceName: script_Test
resourceType: SYNTHETIC
credentials: []
checkType: SCRIPT
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
timeout: 500
webBrowserType: Google Chrome
absoluteTime: true
seleniumJsonScript: |-
{
"id": "65d49a98-5f1c-4150-bae7-65d360b30e7d",
"version": "2.0",
"name": "sample UAT",
"url": "https://test.hpe.com",
"tests": [{
"id": "9d684ee3-261d-4201-8195-f8434f17d35a",
"name": "sample UAT",
"commands": [{
"id": "c07c35b0-40df-4c52-a9f4-a89bbdc17dd6",
"comment": "",
"command": "open",
"target": "/tenancy/web/login?cb=/loginResponse.do",
"targets": [],
"value": ""
}, {
"id": "022c0c5f-bd3a-4381-a5bf-531d12684bb4",
"comment": "",
"command": "setWindowSize",
"target": "1382x744",
"targets": [],
"value": ""
}, {
"id": "4ebba6c2-026e-489b-9c3a-1c36470959cf",
"comment": "",
"command": "click",
"target": "id=login_username",
"targets": [
["id=login_username", "id"],
["name=username", "name"],
["css=#login_username", "css:finder"],
["xpath=//input[@id='login_username']", "xpath:attributes"],
["xpath=//div[@id='username_grp']/input", "xpath:idRelative"],
["xpath=//input", "xpath:position"]
],
"value": ""
}, {
"id": "251d20d4-196d-4105-b9dd-779ccccf5e39",
"comment": "",
"command": "type",
"target": "id=login_username",
"targets": [
["id=login_username", "id"],
["name=username", "name"],
["css=#login_username", "css:finder"],
["xpath=//input[@id='login_username']", "xpath:attributes"],
["xpath=//div[@id='username_grp']/input", "xpath:idRelative"],
["xpath=//input", "xpath:position"]
],
"value": "testn_API1"
}, {
"id": "ce5ef51d-d841-427f-afaf-4feb01ec8a15",
"comment": "",
"command": "click",
"target": "id=leftContentDiv",
"targets": [
["id=leftContentDiv", "id"],
["css=#leftContentDiv", "css:finder"],
["xpath=//div[@id='leftContentDiv']", "xpath:attributes"],
["xpath=//div[2]/div", "xpath:position"]
],
"value": ""
}, {
"id": "72f89614-145b-46a9-8fb4-0d7f48ef3314",
"comment": "",
"command": "click",
"target": "id=login_password",
"targets": [
["id=login_password", "id"],
["name=password", "name"],
["css=#login_password", "css:finder"],
["xpath=//input[@id='login_password']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[2]/input", "xpath:idRelative"],
["xpath=//div[2]/input", "xpath:position"]
],
"value": ""
}, {
"id": "87eef95a-cc26-42d5-8934-79115e64a715",
"comment": "",
"command": "type",
"target": "id=login_password",
"targets": [
["id=login_password", "id"],
["name=password", "name"],
["css=#login_password", "css:finder"],
["xpath=//input[@id='login_password']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[2]/input", "xpath:idRelative"],
["xpath=//div[2]/input", "xpath:position"]
],
"value": "Pass@1234"
}, {
"id": "434f89f7-ddb8-4b08-8b3b-bc17d45e8705",
"comment": "",
"command": "click",
"target": "id=login_btn",
"targets": [
["id=login_btn", "id"],
["css=#login_btn", "css:finder"],
["xpath=//button[@id='login_btn']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[3]/button", "xpath:idRelative"],
["xpath=//div[3]/button", "xpath:position"]
],
"value": ""
}, {
"id": "7520be9f-add6-4a22-b158-3bb23c5fa1e5",
"comment": "",
"command": "mouseOver",
"target": "id=addWidgetImg",
"targets": [
["id=addWidgetImg", "id"],
["css=#addWidgetImg", "css:finder"],
["xpath=//span[@id='addWidgetImg']", "xpath:attributes"],
["xpath=//div[@id='dashboardTools']/span", "xpath:idRelative"],
["xpath=//div[4]/span", "xpath:position"],
["xpath=//span[contains(.,' Add Widget')]", "xpath:innerText"]
],
"value": ""
}, {
"id": "07a7679d-5975-4329-a744-16d4b390cc59",
"comment": "",
"command": "mouseOut",
"target": "css=#setupTab .ops-nav-label",
"targets": [
["css=#setupTab .ops-nav-label", "css:finder"],
["xpath=//div[@id='setupTab']/button/div[2]", "xpath:idRelative"],
["xpath=//div[7]/button/div[2]", "xpath:position"]
],
"value": ""
}, {
"id": "445cc58a-35cc-46a5-886b-8ad93a79acf3",
"comment": "",
"command": "close",
"target": "",
"targets": [],
"value": ""
}]
}],
"suites": [{
"id": "948c156a-7c72-4945-ab4f-cfbd656a6c91",
"name": "Default Suite",
"persistSession": false,
"parallel": false,
"timeout": 300,
"tests": ["9d684ee3-261d-4201-8195-f8434f17d35a"]
}],
"urls": ["https://test.hpe.com/"],
"plugins": []
}
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 402d0954-75fe-4463-8ec1-57b1aaa14acc
allResources: false
lastScanTime: 0
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
schedule:
type: object
properties:
patternType:
type: string
minLength: 1
pattern:
type: string
minLength: 1
startTime:
type: string
minLength: 1
config:
type: object
properties:
url:
type: string
method:
type: string
timeout:
type: integer
checkType:
type: string
credentials:
type: array
items:
type: object
properties:
uniqueId:
type: string
syntheticProxyCredSet:
type: array
items:
type: object
properties:
uniqueId:
type: string
followRedirects:
type: boolean
description: >
Indicates whether HTTP or HTTPS redirects should be followed during the synthetic check.
Allowed values: true or false.
maxRedirects:
type: integer
description: >
Specifies the maximum number of redirects to follow.
- Required when followRedirects is true.
- Must be between 1 and 50 (inclusive) when followRedirects is true.
- Must be 0 or omitted when followRedirects is false.
httpHeaders:
type: string
httpParams:
type: string
validateSSL:
type: boolean
shouldContain:
type: string
shouldNotContain:
type: string
expectedResponseCode:
type: string
resourceName:
type: string
resourceType:
type: string
syntheticProxyServerUrl:
type: string
payloadRegularExpression:
type: string
proxyConfigurationSettings:
type: boolean
syntheticProxyServerAuthType:
type: string
syntheticProxyServerConfigType:
type: string
locationUuids:
type: array
items:
type: string
discoveryType:
type: string
minLength: 1
enum:
- IP Range
- Iprange
ipRange:
type: string
minLength: 1
options:
type: object
properties:
cdp:
type: boolean
ospf:
type: boolean
bgp:
type: boolean
bridge:
type: boolean
loadBalancer:
type: boolean
revDnsLookUp:
type: boolean
discoverVoipPhones:
type: boolean
credential1:
type: object
properties:
snmp_version:
type: string
minLength: 1
port:
type: string
minLength: 1
community:
type: string
minLength: 1
credential2:
type: object
properties:
snmp_version:
type: string
minLength: 1
port:
type: string
minLength: 1
advancedOptions:
type: object
properties:
scanDiscovered:
type: boolean
snmpEnabledDevice:
type: boolean
nativeTypes:
type: object
properties:
vm:
type: object
properties:
metrics:
type: object
properties:
system_memory_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_network_interface_utilization:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
host:
type: object
properties:
metrics:
type: object
properties:
system_disk_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
system_cpu_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_memory_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
examples:
example-add-config:
value:
name: test_config
schedule:
patternType: MINUTES
pattern: '20'
startTime: '00:20:00'
config:
port: '45000'
ipAddress: 192.168.56.121
vcenterName: vCenter
protocol: http
credentials:
- SByTpYg7fauQtPfkzM6pDbpf
nativeTypes:
vm:
metrics:
system_memory_usage_utilization:
name: system_memory_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory usage Utilization in percentage
displayName: system_memory_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_network_interface_utilization:
name: system_network_interface_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system network interface utilization
displayName: system_network_interface_utilization
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
frequency: '5'
resourceType: Server
host:
metrics:
system_disk_usage_usedspace:
name: system_disk_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system disk usage
displayName: system_disk_usage_usedspace
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
formatAlertValue: true
system_cpu_usage_utilization:
name: system_cpu_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '65'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system cpu usage Utilization in percentage
displayName: system_cpu_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_memory_usage_usedspace:
name: system_memory_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory used sapce
displayName: system_memory_usage_usedspace
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
frequency: '5'
resourceType: Server
example-snmp-config:
$ref: ./models/opsramp-installed-apps/sample-snmp-config-request-v1.yaml
example-ssh-config:
value:
name: test_ssh_1
schedule:
patternType: HOURLY
pattern: '1'
startTime: '1:00:00'
config:
ipRange: 172.22.212.01
credentials:
- pWP2qpdZh3g6d6yxFHbsnPyx
sshEnabled: true
scheduleNone: false
example-wmi-config:
value:
name: test_wmi_1
schedule:
patternType: HOURLY
pattern: '1'
startTime: '1:00:00'
config:
ipRange: 172.21.12.10
credentials:
- pWP2qpdZh3g6d6yxFHbsnPyx
wmiEnabled: true
scheduleNone: false
example-HTTPS-payload:
value:
name: HTTPS_TEST
config:
resourceName: HTTPS_TEST
resourceType: SYNTHETIC
credentials:
- uniqueId: 8np6Yc3gXVjfr3sNXhwfuXZx
checkType: HTTPS
locationUuids:
- 51970699-4a8f-44b7-bdcd-2773803ab84a
syntheticProxyServerConfigType: Custom
url: 'https://www.google.com/'
timeout: 60
syntheticProxyServerAuthType: Basic
shouldContain: Test
shouldNotContain: User
validateSSL: true
httpHeaders: '{"Accept":"application/json"}'
httpParams: '{"Content-Type":"application/json"}'
expectedResponseCode: '200'
payloadRegularExpression: "\bAbout\b"
method: GET
syntheticProxyCredSet:
- uniqueId: 8gcp9GtFCpEtyVtQyEVsqYCM
followRedirects: true
maxRedirects: 10
proxyConfigurationSettings: true
syntheticProxyServerUrl: 'http://172.25.251.124:3128'
example-HTTP-payload:
value:
name: HTTP_TEST
config:
resourceName: HTTP_TEST
resourceType: SYNTHETIC
credentials:
- uniqueId: 8np6Yc3gXVjfr3sNXhwfuXZx
checkType: HTTP
locationUuids:
- 51970699-4a8f-44b7-bdcd-2773803ab84a
syntheticProxyServerConfigType: Custom
url: 'http://www.google.com/'
timeout: 60
syntheticProxyServerAuthType: Basic
shouldContain: Test
shouldNotContain: dummy
httpHeaders: '{"Accept":"application/json"}'
httpParams: '{"Content-Type":"application/json"}'
expectedResponseCode: '200'
payloadRegularExpression: "\bAbout\b"
method: GET
syntheticProxyCredSet:
- uniqueId: 8gcp9GtFCpEtyVtQyEVsqYCM
followRedirects: true
maxRedirects: 10
proxyConfigurationSettings: true
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
example-DNS-payload:
value:
name: DNS_Testcase1
config:
url: www.opsramp.com
timeout: 500
checkType: DNS
resourceName: DNS Test
resourceType: SYNTHETIC
expectedIp: 16.193.213.4
nameServer: 8.8.8.8
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
example-PING-payload:
value:
name: PING_Test
config:
url: www.google.com
timeout: 500
checkType: PING
resourceName: PING_NEW
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
example-FTP-payload:
value:
name: ftp_upload
config:
url: ftp://ftp-localserver.com
port: 21
timeout: 500
checkType: FTP
credential:
uniqueId: xGjU8SKCAdbY6NyvPvMfc7KE
credentials:
- uniqueId: xGjU8SKCAdbY6NyvPvMfc7KE
resourceName: ftp_upload
resourceType: SYNTHETIC
uploadStream: RGFzaGJvYXJkIDIuMDoNCkF1dGhlbnRpY2F0aW9uLm1kCQ0KQnVsa19VcGRhdGVfVGlsZXMubWQJ
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
uploadFileName: test.txt
destinationFilePath: 'C:/Users/Desktop'
syntheticProxyCredSet:
- uniqueId: 3EwgVqvPyjV9F93MK7yxEDfN
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-SSL-payload:
value:
name: SSL_Test
config:
url: www.google.com
timeout: 500
checkType: SSL
resourceName: SSL_new
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: 3EwgVqvPyjV9F93MK7yxEDfN
syntheticProxyServerUrl: 'http://17.25.25.10:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-TCP-payload:
value:
name: TCP_Test
config:
url: www.google.com
port: 80
timeout: 500
checkType: TCP
resourceName: TCP
resourceType: SYNTHETIC
messageToSend: Test
shouldContain: test1
shouldNotContain: user
validateSSL: true
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
example-UDP-payload:
value:
name: UDP_Test
config:
url: www.google.com
port: 67
timeout: 400
checkType: UDP
credentials: []
resourceName: UDP
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
messageToSend: Test1
shouldContain: instance1
shouldNotContain: Test12
example-SMTP-payload:
value:
name: SMTP_Test
config:
resourceName: smtp
resourceType: SYNTHETIC
credentials:
- uniqueId: Jmzz2bAQkwQkkZnNcF9N27WE
checkType: SMTP
syntheticProxyServerConfigType: Custom
url: www.Test.com
timeout: 500
port: 222
messageToSend: Test
recipientList: Test@opsramp.com
syntheticProxyServerAuthType: Basic
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
proxyConfigurationSettings: true
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
credential:
uniqueId: Jmzz2bAQkwQkkZnNcF9N27WE
example-POP3-payload:
value:
name: POP3_Test
config:
url: pop3://pop3-host.com
port: 22
timeout: 500
checkType: POP3
credential:
uniqueId: R83HrRsxncuZK7XtZ2nueRuJ
credentials:
- uniqueId: R83HrRsxncuZK7XtZ2nueRuJ
resourceName: POP3 Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.20.20.20:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-IMAP-payload:
value:
name: IMAP_Test
config:
url: imap://imap.com
port: '222'
timeout: 500
checkType: IMAP
credential:
uniqueId: gFEzdPH6RmMgGWDpwkKwVp23
credentials:
- uniqueId: gFEzdPH6RmMgGWDpwkKwVp23
resourceName: IMAP_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-RTT-payload:
value:
name: RTT_Test
config:
url: smtp://smtp.host.com
port: 34
timeout: 500
checkType: RTT
credential:
uniqueId: yWG7YxYNZrGqRDeKqkaQnyQs
credentials:
- uniqueId: yWG7YxYNZrGqRDeKqkaQnyQs
resourceName: RTT_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
receiverHostPort: 22
receiverHost: imap://imap.host.com
emailReceiverType: IMAP
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.21.20.200:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-SCRIPT-payload:
value:
name: script_Test
config:
resourceName: script_Test
resourceType: SYNTHETIC
credentials: []
checkType: SCRIPT
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
timeout: 500
webBrowserType: Google Chrome
absoluteTime: true
seleniumJsonScript: |-
{
"id": "65d49a98-5f1c-4150-bae7-65d360b30e7d",
"version": "2.0",
"name": "sample UAT",
"url": "https://test.opsramp.net",
"tests": [{
"id": "9d684ee3-261d-4201-8195-f8434f17d35a",
"name": "sample UAT",
"commands": [{
"id": "c07c35b0-40df-4c52-a9f4-a89bbdc17dd6",
"comment": "",
"command": "open",
"target": "/tenancy/web/login?cb=/loginResponse.do",
"targets": [],
"value": ""
}, {
"id": "022c0c5f-bd3a-4381-a5bf-531d12684bb4",
"comment": "",
"command": "setWindowSize",
"target": "1382x744",
"targets": [],
"value": ""
}, {
"id": "4ebba6c2-026e-489b-9c3a-1c36470959cf",
"comment": "",
"command": "click",
"target": "id=login_username",
"targets": [
["id=login_username", "id"],
["name=username", "name"],
["css=#login_username", "css:finder"],
["xpath=//input[@id='login_username']", "xpath:attributes"],
["xpath=//div[@id='username_grp']/input", "xpath:idRelative"],
["xpath=//input", "xpath:position"]
],
"value": ""
}, {
"id": "251d20d4-196d-4105-b9dd-779ccccf5e39",
"comment": "",
"command": "type",
"target": "id=login_username",
"targets": [
["id=login_username", "id"],
["name=username", "name"],
["css=#login_username", "css:finder"],
["xpath=//input[@id='login_username']", "xpath:attributes"],
["xpath=//div[@id='username_grp']/input", "xpath:idRelative"],
["xpath=//input", "xpath:position"]
],
"value": "testn_API1"
}, {
"id": "ce5ef51d-d841-427f-afaf-4feb01ec8a15",
"comment": "",
"command": "click",
"target": "id=leftContentDiv",
"targets": [
["id=leftContentDiv", "id"],
["css=#leftContentDiv", "css:finder"],
["xpath=//div[@id='leftContentDiv']", "xpath:attributes"],
["xpath=//div[2]/div", "xpath:position"]
],
"value": ""
}, {
"id": "72f89614-145b-46a9-8fb4-0d7f48ef3314",
"comment": "",
"command": "click",
"target": "id=login_password",
"targets": [
["id=login_password", "id"],
["name=password", "name"],
["css=#login_password", "css:finder"],
["xpath=//input[@id='login_password']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[2]/input", "xpath:idRelative"],
["xpath=//div[2]/input", "xpath:position"]
],
"value": ""
}, {
"id": "87eef95a-cc26-42d5-8934-79115e64a715",
"comment": "",
"command": "type",
"target": "id=login_password",
"targets": [
["id=login_password", "id"],
["name=password", "name"],
["css=#login_password", "css:finder"],
["xpath=//input[@id='login_password']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[2]/input", "xpath:idRelative"],
["xpath=//div[2]/input", "xpath:position"]
],
"value": "Pass@1234"
}, {
"id": "434f89f7-ddb8-4b08-8b3b-bc17d45e8705",
"comment": "",
"command": "click",
"target": "id=login_btn",
"targets": [
["id=login_btn", "id"],
["css=#login_btn", "css:finder"],
["xpath=//button[@id='login_btn']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[3]/button", "xpath:idRelative"],
["xpath=//div[3]/button", "xpath:position"]
],
"value": ""
}, {
"id": "7520be9f-add6-4a22-b158-3bb23c5fa1e5",
"comment": "",
"command": "mouseOver",
"target": "id=addWidgetImg",
"targets": [
["id=addWidgetImg", "id"],
["css=#addWidgetImg", "css:finder"],
["xpath=//span[@id='addWidgetImg']", "xpath:attributes"],
["xpath=//div[@id='dashboardTools']/span", "xpath:idRelative"],
["xpath=//div[4]/span", "xpath:position"],
["xpath=//span[contains(.,' Add Widget')]", "xpath:innerText"]
],
"value": ""
}, {
"id": "07a7679d-5975-4329-a744-16d4b390cc59",
"comment": "",
"command": "mouseOut",
"target": "css=#setupTab .ops-nav-label",
"targets": [
["css=#setupTab .ops-nav-label", "css:finder"],
["xpath=//div[@id='setupTab']/button/div[2]", "xpath:idRelative"],
["xpath=//div[7]/button/div[2]", "xpath:position"]
],
"value": ""
}, {
"id": "445cc58a-35cc-46a5-886b-8ad93a79acf3",
"comment": "",
"command": "close",
"target": "",
"targets": [],
"value": ""
}]
}],
"suites": [{
"id": "948c156a-7c72-4945-ab4f-cfbd656a6c91",
"name": "Default Suite",
"persistSession": false,
"parallel": false,
"timeout": 300,
"tests": ["9d684ee3-261d-4201-8195-f8434f17d35a"]
}],
"urls": ["https://test.opsramp.net/"],
"plugins": []
}
description: Post the necessary fields on updating the domain profile of the app.
description: Creates app profile.
tags:
- installed-apps
parameters:
- name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: Installed app uuid
get:
summary: Lists all domain profiles of the installed app.
operationId: get-api-v2-tenants-tenantId-apps-installedAppId-configs-configId
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
results:
- {}
totalResults: 1
orderBy: name
pageNo: 1
pageSize: 100
totalPages: 1
nextPage: false
previousPageNo: 0
descendingOrder: true
properties:
id:
type: string
minLength: 1
name:
type: string
minLength: 1
config:
type: object
properties:
url:
type: string
method:
type: string
timeout:
type: integer
checkType:
type: string
httpParams:
type: string
credentials:
type: array
items:
type: object
properties:
uniqueId:
type: string
httpHeaders:
type: string
validateSSL:
type: boolean
resourceName:
type: string
resourceType:
type: string
locationUuids:
type: array
items:
type: string
shouldContain:
type: string
followRedirects:
type: boolean
description: >
Indicates whether HTTP or HTTPS redirects should be followed during the synthetic check.
Allowed values: true or false.
maxRedirects:
type: integer
description: >
Specifies the maximum number of redirects to follow.
- Required when followRedirects is true.
- Must be between 1 and 50 (inclusive) when followRedirects is true.
- Must be 0 or omitted when followRedirects is false.
shouldNotContain:
type: string
expectedResponseCode:
type: string
syntheticProxyCredSet:
type: array
items:
type: object
properties:
uniqueId:
type: string
syntheticProxyServerUrl:
type: string
payloadRegularExpression:
type: string
proxyConfigurationSettings:
type: boolean
syntheticProxyServerAuthType:
type: string
syntheticProxyServerConfigType:
type: string
installedAPPId:
type: string
frequency:
type: integer
state:
type: string
upgrade:
type: boolean
scheduleNone:
type: boolean
discoveryConfigId:
type: integer
resourceId:
type: string
allResources:
type: boolean
thirdPartyCiMappable:
type: boolean
availabilityEnabled:
type: boolean
lastScanTime:
type: integer
required:
- results
examples:
example-config-list:
value:
results:
- id: ADAPTER-MANIFEST-e7586677-b878-483d-baaa-389e3ee3329a
name: test_config
config:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
credentials:
- vFeYjzSVsxsxmpDa5Jr8WdyC
vcenterName: vCenter
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
schedule:
patternType: MINUTES
pattern: '20'
startTime: '20'
frequency: 20
state: ENABLED
totalResults: 1
orderBy: name
pageNo: 1
pageSize: 100
totalPages: 1
nextPage: false
previousPageNo: 0
descendingOrder: true
example-HTTP-config-list:
value:
results:
id: ADAPTER-MANIFEST-641765e6-160f-4938-9497-1215a143b190
name: HTTP_TEST
config:
url: 'http://www.google.com/'
method: GET
timeout: 60
checkType: HTTP
httpParams: '{"Content-Type":"application/json"}'
credentials:
- uniqueId: 8np6Yc3gXVjfr3sNXhwfuXZx
httpHeaders: '{"Accept":"application/json"}'
maxRedirects: 10
resourceName: HTTP_TEST
resourceType: SYNTHETIC
locationUuids:
- 51970699-4a8f-44b7-bdcd-2773803ab84a
shouldContain: Test
followRedirects: true
shouldNotContain: dummy
expectedResponseCode: '200'
syntheticProxyCredSet:
- uniqueId: 8gcp9GtFCpEtyVtQyEVsqYCM
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
payloadRegularExpression: \bAbout\b
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-11ad0daf-d102-48e1-9e49-2a9400017ab3
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: aec3109d-d1b4-4485-8c56-65d97468600e
allResources: false
thirdPartyCiMappable: false
availabilityEnabled: false
lastScanTime: 0
example-HTTPS-config-list:
value:
results:
id: ADAPTER-MANIFEST-93dceac4-928e-4946-82e8-b2527e95f13e
name: HTTPS_TEST
config:
url: 'https://www.google.com/'
method: GET
timeout: 60
checkType: HTTPS
httpParams: '{"Content-Type":"application/json"}'
credentials:
- uniqueId: 8np6Yc3gXVjfr3sNXhwfuXZx
httpHeaders: '{"Accept":"application/json"}'
validateSSL: true
maxRedirects: 10
resourceName: HTTPS_TEST
resourceType: SYNTHETIC
locationUuids:
- 51970699-4a8f-44b7-bdcd-2773803ab84a
shouldContain: Test
followRedirects: true
shouldNotContain: User
expectedResponseCode: '200'
syntheticProxyCredSet:
- uniqueId: 8gcp9GtFCpEtyVtQyEVsqYCM
syntheticProxyServerUrl: 'http://172.25.251.124:3128'
payloadRegularExpression: "\bAbout\b"
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-11ad0daf-d102-48e1-9e49-2a9400017ab3
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 66719a6f-424b-4bd9-abc0-caae534d0ea9
allResources: false
thirdPartyCiMappable: false
availabilityEnabled: false
lastScanTime: 0
description: List all the domain profiles of the app
parameters: []
tags:
- installed-apps
'/api/v3/tenants/{tenantId}/apps/install/{id}/config/{id}':
description: |
Manage an app's domain profiles by retrieving, updating, or deleting domain profiles associated with the installed application.
Note: This API is also used to manage synthetic monitoring configurations.
summary: 'apps/install/{id}/config/{id}'
x-new-path: true
parameters:
- name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: Installed app uuid
- schema:
type: string
format: uuid
name: configId
in: path
required: true
description: App manifest uuid
post:
summary: Manage app's domain profiles.
operationId: post-profiles
description: Update the required profile for the intalled apps
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
name:
type: string
minLength: 1
config:
type: object
properties:
Etcd:
type: boolean
coreDNS:
type: boolean
KubeProxy:
type: boolean
enableLog:
type: boolean
enableEBPF:
type: boolean
kubeEvents:
type: boolean
enableTrace:
type: boolean
KubeletStats:
type: boolean
KubeAPIServer:
type: boolean
KubeScheduler:
type: boolean
ebpfFeatureFlag:
type: boolean
KubeClusterReceiver:
type: boolean
KubeControllerManager:
type: boolean
clientLevelLogPermission:
type: boolean
clientLevelTracePermission:
type: boolean
replicaCount:
type: integer
DistributionType:
type: string
eBPFContainerEngine:
type: string
url:
type: string
method:
type: string
timeout:
type: integer
checkType:
type: string
credentials:
type: array
items:
type: object
properties:
uniqueId:
type: string
syntheticProxyCredSet:
type: array
items:
type: object
properties:
uniqueId:
type: string
httpHeaders:
type: string
httpParams:
type: string
validateSSL:
type: boolean
shouldContain:
type: string
shouldNotContain:
type: string
expectedResponseCode:
type: string
resourceName:
type: string
resourceType:
type: string
syntheticProxyServerUrl:
type: string
payloadRegularExpression:
type: string
proxyConfigurationSettings:
type: boolean
syntheticProxyServerAuthType:
type: string
syntheticProxyServerConfigType:
type: string
locationUuids:
type: array
items:
type: string
port:
type: string
minLength: 1
protocol:
type: string
minLength: 1
ipAddress:
type: string
minLength: 1
vcenterName:
type: string
minLength: 1
nativeTypes:
type: object
properties:
vm:
type: object
properties:
metrics:
type: object
properties:
system_memory_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_network_interface_utilization:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
host:
type: object
properties:
metrics:
type: object
properties:
system_disk_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
system_cpu_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_memory_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
installedAppId:
type: string
minLength: 1
schedule:
type: object
properties:
patternType:
type: string
minLength: 1
pattern:
type: string
minLength: 1
startTime:
type: string
minLength: 1
infoMap:
type: object
properties:
kubernetesProxy:
type: object
properties:
uuid:
type: string
name:
type: string
examples:
example-profile:
value:
id: ADAPTER-MANIFEST-9895c9a6-73fa-4399-956e-08f2b9d32899
name: Update SNMP Monitoring App
config:
options:
cdp: true
credential1:
snmp_version: V1
port: '9445'
community: test
credential2:
snmp_version: V2
port: '8843'
advancedOptions:
scanDiscovered: true
discoveryType: IP Range
ipRange: 192.168.56.102
installedAPPId: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
schedule:
patternType: MINUTES
pattern: '30'
startTime: '30'
frequency: 5
state: ENABLED
example-update-profile:
value:
id: ADAPTER-MANIFEST-e7586677-b878-483d-baaa-389e3ee3329a
name: test_config_1
config:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
credentials:
- SByTpYg7fauQtPfkzM6pDbpf
vcenterName: vCenter
nativeTypes:
vm:
metrics:
system_memory_usage_utilization:
name: system_memory_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory usage Utilization in percentage
displayName: system_memory_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_network_interface_utilization:
name: system_network_interface_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system network interface utilization
displayName: system_network_interface_utilization
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
frequency: '5'
resourceType: Server
host:
metrics:
system_disk_usage_usedspace:
name: system_disk_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system disk usage
displayName: system_disk_usage_usedspace
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
formatAlertValue: true
system_cpu_usage_utilization:
name: system_cpu_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '65'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system cpu usage Utilization in percentage
displayName: system_cpu_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_memory_usage_usedspace:
name: system_memory_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory used sapce
displayName: system_memory_usage_usedspace
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
frequency: '5'
resourceType: Server
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
schedule:
patternType: MINUTES
pattern: '20'
startTime: '20'
frequency: 20
state: ENABLED
example-HTTPS-payload:
value:
id: ADAPTER-MANIFEST-acd42728-2d49-4a75-b844-a3fa816213f9
name: HTTPS_Test
config:
url: 'https://www.google.com'
method: GET
timeout: 500
checkType: HTTPS
credentials:
- uniqueId: tdCcapquZQcF4PETWXcUqkyS
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
httpHeaders: '{"Accept":"application/json"}'
httpParams: '{"Content-Type":"application/json"}'
validateSSL: true
shouldContain: instance
shouldNotContain: unknown
expectedResponseCode: '200'
resourceName: HTTPS_1
resourceType: SYNTHETIC
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
payloadRegularExpression: test
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 0ba70da9-e58a-4518-9b79-b92cc446d6f5
allResources: false
lastScanTime: 0
example-HTTP-payload:
value:
id: ADAPTER-MANIFEST-643526b8-01c7-4de8-a42e-a7f1a948274d
name: HTTP_Testcase
config:
url: 'http://www.google.com'
method: GET
timeout: 500
checkType: HTTP
httpHeaders: '{"Accept":"application/json"}'
httpParams: '{"Content-Type":"application/json"}'
credentials:
- uniqueId: BaBS3kDmP3EgxdJ3gbecy8X9
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
resourceName: HTTP_Test
resourceType: SYNTHETIC
locationUuids:
- 34cef020-adda-4b18-b717-fab7f44fe490
shouldContain: Test
shouldNotContain: user
expectedResponseCode: '200'
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
payloadRegularExpression: test
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 07d96e02-45a8-4e0a-bcc4-d9070d2d10b2
allResources: false
lastScanTime: 0
example-DNS-payload:
value:
id: ADAPTER-MANIFEST-a0d58fbb-2b4e-48d6-ba1e-cdcc2cf47f50
name: DNS_Testcase1
config:
url: www.hpe.com
timeout: 500
checkType: DNS
resourceName: DNS Test
resourceType: SYNTHETIC
expectedIp: 16.193.213.4
nameServer: 8.8.8.8
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 96fa9a0e-be39-4adc-8da6-8187a04758eb
allResources: false
lastScanTime: 0
example-PING-payload:
value:
id: ADAPTER-MANIFEST-61e00abe-4a80-4e5f-8c49-104c9d9d3efa
name: PING_Test
config:
url: www.google.com
timeout: 500
checkType: PING
resourceName: PING_NEW
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 7d6ff2d7-954f-43e4-8413-252f7d48e7af
allResources: false
lastScanTime: 0
example-FTP-payload:
value:
id: ADAPTER-MANIFEST-6263afaa-3320-45ee-8b37-5ebec2b2a6c0
name: ftp_upload
config:
url: ftp://ftp-localserver.com
port: 21
timeout: 500
checkType: FTP
credential:
uniqueId: xGjU8SKCAdbY6NyvPvMfc7KE
credentials:
- uniqueId: xGjU8SKCAdbY6NyvPvMfc7KE
resourceName: ftp_upload
resourceType: SYNTHETIC
uploadStream: RGFzaGJvYXJkIDIuMDoNCkF1dGhlbnRpY2F0aW9uLm1kCQ0KQnVsa19VcGRhdGVfVGlsZXMubWQJ
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
uploadFileName: test.txt
destinationFilePath: 'C:/Users/Desktop'
syntheticProxyCredSet:
- uniqueId: 3EwgVqvPyjV9F93MK7yxEDfN
syntheticProxyServerUrl: 'http://172.26.111.16:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 411201b2-7593-44fb-a923-2aec9bc0c6dd
allResources: false
lastScanTime: 0
example-SSL-payload:
value:
id: ADAPTER-MANIFEST-533a7315-25cf-4224-ac65-39284417a26f
name: SSL_Test
config:
url: www.google.com
timeout: 500
checkType: SSL
resourceName: SSL_new
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: 3EwgVqvPyjV9F93MK7yxEDfN
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 09ae8d4c-1d07-44d5-b1c8-bb7e1074a239
allResources: false
lastScanTime: 0
example-TCP-payload:
value:
id: ADAPTER-MANIFEST-72de2983-86ff-45b6-a37a-8df1ff77173c
name: TCP_Test
config:
url: www.google.com
port: 80
timeout: 500
checkType: TCP
resourceName: TCP
resourceType: SYNTHETIC
messageToSend: Test
shouldContain: test1
shouldNotContain: user
validateSSL: true
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 05248043-882d-4c46-bb42-6bff1db451f5
allResources: false
lastScanTime: 0
example-UDP-payload:
value:
id: ADAPTER-MANIFEST-9ebcccd9-e3bc-443b-b41d-717ba7794c8f
name: UDP_Test
config:
url: www.google.com
port: 67
timeout: 400
checkType: UDP
credentials: []
resourceName: UDP
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
messageToSend: Test1
shouldContain: instance1
shouldNotContain: Test12
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 5eaedd45-6072-4516-b760-542860712dc7
allResources: false
lastScanTime: 0
example-SMTP-payload:
value:
id: ADAPTER-MANIFEST-1292eac6-fb0d-4000-8464-add1fe13ae2c
name: SMTP_Test
config:
resourceName: smtp
resourceType: SYNTHETIC
credentials:
- uniqueId: Jmzz2bAQkwQkkZnNcF9N27WE
checkType: SMTP
syntheticProxyServerConfigType: Custom
url: www.Test.com
timeout: 500
port: 222
messageToSend: Test
recipientList: Test@hpe.com
syntheticProxyServerAuthType: Basic
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
proxyConfigurationSettings: true
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
credential:
uniqueId: Jmzz2bAQkwQkkZnNcF9N27WE
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: a3c36311-c6d6-403f-8a05-03b5d0f9efa8
allResources: false
lastScanTime: 0
example-POP3-payload:
value:
id: ADAPTER-MANIFEST-f85cb983-9cc0-4f43-abab-8d03337b527d
name: POP3_Test
config:
url: pop3://pop3-host.com
port: 22
timeout: 500
checkType: POP3
credential:
uniqueId: R83HrRsxncuZK7XtZ2nueRuJ
credentials:
- uniqueId: R83HrRsxncuZK7XtZ2nueRuJ
resourceName: POP3 Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.20.24.200:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 9b5b7c9d-96c1-4795-af5c-0d8b1598ee11
allResources: false
lastScanTime: 0
example-IMAP-payload:
value:
id: ADAPTER-MANIFEST-e3dfaf31-4ec1-45a2-88e9-a75cdc588057
name: IMAP_Test
config:
url: imap://imap.com
port: '222'
timeout: 500
checkType: IMAP
credential:
uniqueId: gFEzdPH6RmMgGWDpwkKwVp23
credentials:
- uniqueId: gFEzdPH6RmMgGWDpwkKwVp23
resourceName: IMAP_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 3129eb02-bb28-4122-bf49-d7394b660148
allResources: false
lastScanTime: 0
example-RTT-payload:
value:
id: ADAPTER-MANIFEST-5bf18e4b-0f39-4a91-a2d8-7678aaf1bbcd
name: RTT_Test
config:
url: smtp://smtp.host.com
port: 34
timeout: 500
checkType: RTT
credential:
uniqueId: yWG7YxYNZrGqRDeKqkaQnyQs
credentials:
- uniqueId: yWG7YxYNZrGqRDeKqkaQnyQs
resourceName: RTT_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
receiverHostPort: 22
receiverHost: test
emailReceiverType: IMAP
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.20.24.200:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 8e729534-363b-4e92-98cc-a69ee09c831b
allResources: false
lastScanTime: 0
example-SCRIPT-payload:
value:
id: ADAPTER-MANIFEST-28bf03ce-91ad-4063-8a9c-840e8e854b43
name: script_Test
config:
resourceName: script_Test
resourceType: SYNTHETIC
credentials: []
checkType: SCRIPT
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
timeout: 500
webBrowserType: Google Chrome
absoluteTime: true
seleniumJsonScript: |-
{
"id": "65d49a98-5f1c-4150-bae7-65d360b30e7d",
"version": "2.0",
"name": "sample UAT",
"url": "https://test.hpe.com",
"tests": [{
"id": "9d684ee3-261d-4201-8195-f8434f17d35a",
"name": "sample UAT",
"commands": [{
"id": "c07c35b0-40df-4c52-a9f4-a89bbdc17dd6",
"comment": "",
"command": "open",
"target": "/tenancy/web/login?cb=/loginResponse.do",
"targets": [],
"value": ""
}, {
"id": "022c0c5f-bd3a-4381-a5bf-531d12684bb4",
"comment": "",
"command": "setWindowSize",
"target": "1382x744",
"targets": [],
"value": ""
}, {
"id": "4ebba6c2-026e-489b-9c3a-1c36470959cf",
"comment": "",
"command": "click",
"target": "id=login_username",
"targets": [
["id=login_username", "id"],
["name=username", "name"],
["css=#login_username", "css:finder"],
["xpath=//input[@id='login_username']", "xpath:attributes"],
["xpath=//div[@id='username_grp']/input", "xpath:idRelative"],
["xpath=//input", "xpath:position"]
],
"value": ""
}, {
"id": "251d20d4-196d-4105-b9dd-779ccccf5e39",
"comment": "",
"command": "type",
"target": "id=login_username",
"targets": [
["id=login_username", "id"],
["name=username", "name"],
["css=#login_username", "css:finder"],
["xpath=//input[@id='login_username']", "xpath:attributes"],
["xpath=//div[@id='username_grp']/input", "xpath:idRelative"],
["xpath=//input", "xpath:position"]
],
"value": "testn_API1"
}, {
"id": "ce5ef51d-d841-427f-afaf-4feb01ec8a15",
"comment": "",
"command": "click",
"target": "id=leftContentDiv",
"targets": [
["id=leftContentDiv", "id"],
["css=#leftContentDiv", "css:finder"],
["xpath=//div[@id='leftContentDiv']", "xpath:attributes"],
["xpath=//div[2]/div", "xpath:position"]
],
"value": ""
}, {
"id": "72f89614-145b-46a9-8fb4-0d7f48ef3314",
"comment": "",
"command": "click",
"target": "id=login_password",
"targets": [
["id=login_password", "id"],
["name=password", "name"],
["css=#login_password", "css:finder"],
["xpath=//input[@id='login_password']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[2]/input", "xpath:idRelative"],
["xpath=//div[2]/input", "xpath:position"]
],
"value": ""
}, {
"id": "87eef95a-cc26-42d5-8934-79115e64a715",
"comment": "",
"command": "type",
"target": "id=login_password",
"targets": [
["id=login_password", "id"],
["name=password", "name"],
["css=#login_password", "css:finder"],
["xpath=//input[@id='login_password']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[2]/input", "xpath:idRelative"],
["xpath=//div[2]/input", "xpath:position"]
],
"value": "Pass@1234"
}, {
"id": "434f89f7-ddb8-4b08-8b3b-bc17d45e8705",
"comment": "",
"command": "click",
"target": "id=login_btn",
"targets": [
["id=login_btn", "id"],
["css=#login_btn", "css:finder"],
["xpath=//button[@id='login_btn']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[3]/button", "xpath:idRelative"],
["xpath=//div[3]/button", "xpath:position"]
],
"value": ""
}, {
"id": "7520be9f-add6-4a22-b158-3bb23c5fa1e5",
"comment": "",
"command": "mouseOver",
"target": "id=addWidgetImg",
"targets": [
["id=addWidgetImg", "id"],
["css=#addWidgetImg", "css:finder"],
["xpath=//span[@id='addWidgetImg']", "xpath:attributes"],
["xpath=//div[@id='dashboardTools']/span", "xpath:idRelative"],
["xpath=//div[4]/span", "xpath:position"],
["xpath=//span[contains(.,' Add Widget')]", "xpath:innerText"]
],
"value": ""
}, {
"id": "07a7679d-5975-4329-a744-16d4b390cc59",
"comment": "",
"command": "mouseOut",
"target": "css=#setupTab .ops-nav-label",
"targets": [
["css=#setupTab .ops-nav-label", "css:finder"],
["xpath=//div[@id='setupTab']/button/div[2]", "xpath:idRelative"],
["xpath=//div[7]/button/div[2]", "xpath:position"]
],
"value": ""
}, {
"id": "445cc58a-35cc-46a5-886b-8ad93a79acf3",
"comment": "",
"command": "close",
"target": "",
"targets": [],
"value": ""
}]
}],
"suites": [{
"id": "948c156a-7c72-4945-ab4f-cfbd656a6c91",
"name": "Default Suite",
"persistSession": false,
"parallel": false,
"timeout": 300,
"tests": ["9d684ee3-261d-4201-8195-f8434f17d35a"]
}],
"urls": ["https://test.hpe.com/"],
"plugins": []
}
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 402d0954-75fe-4463-8ec1-57b1aaa14acc
allResources: false
lastScanTime: 0
example-kubernetes-2.0-payload:
value:
id: ADAPTER-MANIFEST-d4a332a4-5d05-40c5-9105-41182f089d53
name: test-cluster-api
config:
Etcd: true
coreDNS: true
KubeProxy: true
enableLog: false
enableEBPF: false
kubeEvents: true
enableTrace: false
KubeletStats: true
KubeAPIServer: true
KubeScheduler: true
ebpfFeatureFlag: false
KubeClusterReceiver: true
KubeControllerManager: true
clientLevelLogPermission: true
clientLevelTracePermission: true
replicaCount: 3
DistributionType: K8S
eBPFContainerEngine: cri-o
installedAPPId: INTG-c2ea297f-f2eb-4879-9c00-1f4bdc3eaba6
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
allResources: false
thirdPartyCiMappable: false
availabilityEnabled: false
lastScanTime: 0
example-kubernetes-2.0-with-proxy-payload:
value:
id: ADAPTER-MANIFEST-d04c7656-6b16-4539-8ebd-b9c743d30ce2
name: test-cluster-api-proxy
config:
Etcd: true
coreDNS: true
KubeProxy: true
enableLog: false
enableEBPF: false
kubeEvents: true
enableTrace: false
KubeletStats: true
KubeAPIServer: true
KubeScheduler: true
ebpfFeatureFlag: false
KubeClusterReceiver: true
KubeControllerManager: true
clientLevelLogPermission: true
clientLevelTracePermission: true
replicaCount: 3
DistributionType: K8S
eBPFContainerEngine: cri-o
installedAPPId: INTG-c2ea297f-f2eb-4879-9c00-1f4bdc3eaba6
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
allResources: false
thirdPartyCiMappable: false
availabilityEnabled: false
lastScanTime: 0
infoMap:
kubernetesProxy:
uuid: 28a68058-53df-4820-8750-a8b422a61c44
name: labrat-nextgen-gateway
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
schedule:
type: object
properties:
patternType:
type: string
minLength: 1
pattern:
type: string
minLength: 1
startTime:
type: string
minLength: 1
config:
type: object
properties:
Etcd:
type: boolean
coreDNS:
type: boolean
KubeProxy:
type: boolean
enableLog:
type: boolean
enableEBPF:
type: boolean
kubeEvents:
type: boolean
enableTrace:
type: boolean
KubeletStats:
type: boolean
KubeAPIServer:
type: boolean
KubeScheduler:
type: boolean
ebpfFeatureFlag:
type: boolean
KubeClusterReceiver:
type: boolean
KubeControllerManager:
type: boolean
clientLevelLogPermission:
type: boolean
clientLevelTracePermission:
type: boolean
replicaCount:
type: integer
DistributionType:
type: string
eBPFContainerEngine:
type: string
url:
type: string
method:
type: string
timeout:
type: integer
checkType:
type: string
credentials:
type: array
items:
type: object
properties:
uniqueId:
type: string
syntheticProxyCredSet:
type: array
items:
type: object
properties:
uniqueId:
type: string
httpHeaders:
type: string
httpParams:
type: string
validateSSL:
type: boolean
shouldContain:
type: string
shouldNotContain:
type: string
expectedResponseCode:
type: string
resourceName:
type: string
resourceType:
type: string
syntheticProxyServerUrl:
type: string
payloadRegularExpression:
type: string
proxyConfigurationSettings:
type: boolean
syntheticProxyServerAuthType:
type: string
syntheticProxyServerConfigType:
type: string
locationUuids:
type: array
items:
type: string
discoveryType:
type: string
minLength: 1
enum:
- IP Range
- Iprange
ipRange:
type: string
minLength: 1
options:
type: object
properties:
cdp:
type: boolean
ospf:
type: boolean
bgp:
type: boolean
bridge:
type: boolean
loadBalancer:
type: boolean
revDnsLookUp:
type: boolean
discoverVoipPhones:
type: boolean
credential1:
type: object
properties:
snmp_version:
type: string
minLength: 1
port:
type: string
minLength: 1
community:
type: string
minLength: 1
credential2:
type: object
properties:
snmp_version:
type: string
minLength: 1
port:
type: string
minLength: 1
advancedOptions:
type: object
properties:
scanDiscovered:
type: boolean
snmpEnabledDevice:
type: boolean
nativeTypes:
type: object
properties:
vm:
type: object
properties:
metrics:
type: object
properties:
system_memory_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_network_interface_utilization:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
host:
type: object
properties:
metrics:
type: object
properties:
system_disk_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
system_cpu_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_memory_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
infoMap:
type: object
properties:
kubernetesProxy:
type: object
properties:
uuid:
type: string
name:
type: string
examples:
example-profile:
value:
id: ADAPTER-MANIFEST-e7586677-b878-483d-baaa-389e3ee3329a
name: test_config
config:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
credentials:
- SByTpYg7fauQtPfkzM6pDbpf
vcenterName: vCenter
nativeTypes:
vm:
metrics:
system_memory_usage_utilization:
name: system_memory_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory usage Utilization in percentage
displayName: system_memory_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_network_interface_utilization:
name: system_network_interface_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system network interface utilization
displayName: system_network_interface_utilization
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
frequency: '5'
resourceType: Server
host:
metrics:
system_disk_usage_usedspace:
name: system_disk_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system disk usage
displayName: system_disk_usage_usedspace
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
formatAlertValue: true
system_cpu_usage_utilization:
name: system_cpu_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '65'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system cpu usage Utilization in percentage
displayName: system_cpu_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_memory_usage_usedspace:
name: system_memory_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory used sapce
displayName: system_memory_usage_usedspace
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
frequency: '5'
resourceType: Server
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
schedule:
patternType: MINUTES
pattern: '20'
startTime: '20'
frequency: 20
state: ENABLED
example-update-profile:
value:
name: test_config_1
config:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
credentials:
- SByTpYg7fauQtPfkzM6pDbpf
vcenterName: vCenter
nativeTypes:
vm:
metrics:
system_memory_usage_utilization:
name: system_memory_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory usage Utilization in percentage
displayName: system_memory_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_network_interface_utilization:
name: system_network_interface_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system network interface utilization
displayName: system_network_interface_utilization
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
frequency: '5'
resourceType: Server
host:
metrics:
system_disk_usage_usedspace:
name: system_disk_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system disk usage
displayName: system_disk_usage_usedspace
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
formatAlertValue: true
system_cpu_usage_utilization:
name: system_cpu_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '65'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system cpu usage Utilization in percentage
displayName: system_cpu_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_memory_usage_usedspace:
name: system_memory_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory used sapce
displayName: system_memory_usage_usedspace
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
frequency: '5'
resourceType: Server
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
schedule:
patternType: MINUTES
pattern: '20'
startTime: '20'
frequency: 20
state: ENABLED
example-HTTPS-payload:
value:
name: HTTPS_Test
config:
url: 'https://www.google.com'
method: GET
timeout: 500
checkType: HTTPS
credentials:
- uniqueId: tdCcapquZQcF4PETWXcUqkyS
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
httpHeaders: '{"Accept":"application/json"}'
httpParams: '{"Content-Type":"application/json"}'
validateSSL: true
shouldContain: instance
shouldNotContain: unknown
expectedResponseCode: '200'
resourceName: HTTPS_1
resourceType: SYNTHETIC
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
payloadRegularExpression: test
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
example-HTTP-payload:
value:
name: HTTP_Testcase
config:
url: 'http://www.google.com'
method: GET
timeout: 500
checkType: HTTP
httpHeaders: '{"Accept":"application/json"}'
httpParams: '{"Content-Type":"application/json"}'
credentials:
- uniqueId: BaBS3kDmP3EgxdJ3gbecy8X9
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
resourceName: HTTP_Test
resourceType: SYNTHETIC
locationUuids:
- 34cef020-adda-4b18-b717-fab7f44fe490
shouldContain: Test
shouldNotContain: user
expectedResponseCode: '200'
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
payloadRegularExpression: test
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-DNS-payload:
value:
name: DNS_Testcase1
config:
url: www.opsramp.com
timeout: 500
checkType: DNS
resourceName: DNS Test
resourceType: SYNTHETIC
expectedIp: 16.193.213.4
nameServer: 8.8.8.8
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
example-PING-payload:
value:
name: PING_Test
config:
url: www.google.com
timeout: 500
checkType: PING
resourceName: PING_NEW
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
example-FTP-payload:
value:
name: ftp_upload
config:
url: ftp://ftp-localserver.com
port: 21
timeout: 500
checkType: FTP
credential:
uniqueId: xGjU8SKCAdbY6NyvPvMfc7KE
credentials:
- uniqueId: xGjU8SKCAdbY6NyvPvMfc7KE
resourceName: ftp_upload
resourceType: SYNTHETIC
uploadStream: RGFzaGJvYXJkIDIuMDoNCkF1dGhlbnRpY2F0aW9uLm1kCQ0KQnVsa19VcGRhdGVfVGlsZXMubWQJ
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
uploadFileName: test.txt
destinationFilePath: 'C:/Users/Desktop'
syntheticProxyCredSet:
- uniqueId: 3EwgVqvPyjV9F93MK7yxEDfN
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-SSL-payload:
value:
name: SSL_Test
config:
url: www.google.com
timeout: 500
checkType: SSL
resourceName: SSL_new
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: 3EwgVqvPyjV9F93MK7yxEDfN
syntheticProxyServerUrl: 'http://17.25.25.10:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-TCP-payload:
value:
name: TCP_Test
config:
url: www.google.com
port: 80
timeout: 500
checkType: TCP
resourceName: TCP
resourceType: SYNTHETIC
messageToSend: Test
shouldContain: test1
shouldNotContain: user
validateSSL: true
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
example-UDP-payload:
value:
name: UDP_Test
config:
url: www.google.com
port: 67
timeout: 400
checkType: UDP
credentials: []
resourceName: UDP
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
messageToSend: Test1
shouldContain: instance1
shouldNotContain: Test12
example-SMTP-payload:
value:
name: SMTP_Test
config:
resourceName: smtp
resourceType: SYNTHETIC
credentials:
- uniqueId: Jmzz2bAQkwQkkZnNcF9N27WE
checkType: SMTP
syntheticProxyServerConfigType: Custom
url: www.Test.com
timeout: 500
port: 222
messageToSend: Test
recipientList: Test@opsramp.com
syntheticProxyServerAuthType: Basic
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
proxyConfigurationSettings: true
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
credential:
uniqueId: Jmzz2bAQkwQkkZnNcF9N27WE
example-POP3-payload:
value:
name: POP3_Test
config:
url: pop3://pop3-host.com
port: 22
timeout: 500
checkType: POP3
credential:
uniqueId: R83HrRsxncuZK7XtZ2nueRuJ
credentials:
- uniqueId: R83HrRsxncuZK7XtZ2nueRuJ
resourceName: POP3 Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.20.20.20:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-IMAP-payload:
value:
name: IMAP_Test
config:
url: imap://imap.com
port: '222'
timeout: 500
checkType: IMAP
credential:
uniqueId: gFEzdPH6RmMgGWDpwkKwVp23
credentials:
- uniqueId: gFEzdPH6RmMgGWDpwkKwVp23
resourceName: IMAP_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.25.25.10:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-RTT-payload:
value:
name: RTT_Test
config:
url: smtp://smtp.host.com
port: 34
timeout: 500
checkType: RTT
credential:
uniqueId: yWG7YxYNZrGqRDeKqkaQnyQs
credentials:
- uniqueId: yWG7YxYNZrGqRDeKqkaQnyQs
resourceName: RTT_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
receiverHostPort: 22
receiverHost: imap://imap.host.com
emailReceiverType: IMAP
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.21.20.200:3128'
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
example-SCRIPT-payload:
value:
name: script_Test
config:
resourceName: script_Test
resourceType: SYNTHETIC
credentials: []
checkType: SCRIPT
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
timeout: 500
webBrowserType: Google Chrome
absoluteTime: true
seleniumJsonScript: |-
{
"id": "65d49a98-5f1c-4150-bae7-65d360b30e7d",
"version": "2.0",
"name": "sample UAT",
"url": "https://test.opsramp.net",
"tests": [{
"id": "9d684ee3-261d-4201-8195-f8434f17d35a",
"name": "sample UAT",
"commands": [{
"id": "c07c35b0-40df-4c52-a9f4-a89bbdc17dd6",
"comment": "",
"command": "open",
"target": "/tenancy/web/login?cb=/loginResponse.do",
"targets": [],
"value": ""
}, {
"id": "022c0c5f-bd3a-4381-a5bf-531d12684bb4",
"comment": "",
"command": "setWindowSize",
"target": "1382x744",
"targets": [],
"value": ""
}, {
"id": "4ebba6c2-026e-489b-9c3a-1c36470959cf",
"comment": "",
"command": "click",
"target": "id=login_username",
"targets": [
["id=login_username", "id"],
["name=username", "name"],
["css=#login_username", "css:finder"],
["xpath=//input[@id='login_username']", "xpath:attributes"],
["xpath=//div[@id='username_grp']/input", "xpath:idRelative"],
["xpath=//input", "xpath:position"]
],
"value": ""
}, {
"id": "251d20d4-196d-4105-b9dd-779ccccf5e39",
"comment": "",
"command": "type",
"target": "id=login_username",
"targets": [
["id=login_username", "id"],
["name=username", "name"],
["css=#login_username", "css:finder"],
["xpath=//input[@id='login_username']", "xpath:attributes"],
["xpath=//div[@id='username_grp']/input", "xpath:idRelative"],
["xpath=//input", "xpath:position"]
],
"value": "testn_API1"
}, {
"id": "ce5ef51d-d841-427f-afaf-4feb01ec8a15",
"comment": "",
"command": "click",
"target": "id=leftContentDiv",
"targets": [
["id=leftContentDiv", "id"],
["css=#leftContentDiv", "css:finder"],
["xpath=//div[@id='leftContentDiv']", "xpath:attributes"],
["xpath=//div[2]/div", "xpath:position"]
],
"value": ""
}, {
"id": "72f89614-145b-46a9-8fb4-0d7f48ef3314",
"comment": "",
"command": "click",
"target": "id=login_password",
"targets": [
["id=login_password", "id"],
["name=password", "name"],
["css=#login_password", "css:finder"],
["xpath=//input[@id='login_password']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[2]/input", "xpath:idRelative"],
["xpath=//div[2]/input", "xpath:position"]
],
"value": ""
}, {
"id": "87eef95a-cc26-42d5-8934-79115e64a715",
"comment": "",
"command": "type",
"target": "id=login_password",
"targets": [
["id=login_password", "id"],
["name=password", "name"],
["css=#login_password", "css:finder"],
["xpath=//input[@id='login_password']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[2]/input", "xpath:idRelative"],
["xpath=//div[2]/input", "xpath:position"]
],
"value": "Pass@1234"
}, {
"id": "434f89f7-ddb8-4b08-8b3b-bc17d45e8705",
"comment": "",
"command": "click",
"target": "id=login_btn",
"targets": [
["id=login_btn", "id"],
["css=#login_btn", "css:finder"],
["xpath=//button[@id='login_btn']", "xpath:attributes"],
["xpath=//div[@id='loginBody']/div[3]/button", "xpath:idRelative"],
["xpath=//div[3]/button", "xpath:position"]
],
"value": ""
}, {
"id": "7520be9f-add6-4a22-b158-3bb23c5fa1e5",
"comment": "",
"command": "mouseOver",
"target": "id=addWidgetImg",
"targets": [
["id=addWidgetImg", "id"],
["css=#addWidgetImg", "css:finder"],
["xpath=//span[@id='addWidgetImg']", "xpath:attributes"],
["xpath=//div[@id='dashboardTools']/span", "xpath:idRelative"],
["xpath=//div[4]/span", "xpath:position"],
["xpath=//span[contains(.,' Add Widget')]", "xpath:innerText"]
],
"value": ""
}, {
"id": "07a7679d-5975-4329-a744-16d4b390cc59",
"comment": "",
"command": "mouseOut",
"target": "css=#setupTab .ops-nav-label",
"targets": [
["css=#setupTab .ops-nav-label", "css:finder"],
["xpath=//div[@id='setupTab']/button/div[2]", "xpath:idRelative"],
["xpath=//div[7]/button/div[2]", "xpath:position"]
],
"value": ""
}, {
"id": "445cc58a-35cc-46a5-886b-8ad93a79acf3",
"comment": "",
"command": "close",
"target": "",
"targets": [],
"value": ""
}]
}],
"suites": [{
"id": "948c156a-7c72-4945-ab4f-cfbd656a6c91",
"name": "Default Suite",
"persistSession": false,
"parallel": false,
"timeout": 300,
"tests": ["9d684ee3-261d-4201-8195-f8434f17d35a"]
}],
"urls": ["https://test.opsramp.net/"],
"plugins": []
}
example-kubernetes-2.0-payload:
value:
name: test-cluster-api
config:
Etcd: true
coreDNS: true
KubeProxy: true
enableLog: false
enableEBPF: false
kubeEvents: true
enableTrace: false
KubeletStats: true
KubeAPIServer: true
KubeScheduler: true
ebpfFeatureFlag: false
KubeClusterReceiver: true
KubeControllerManager: true
clientLevelLogPermission: true
clientLevelTracePermission: true
replicaCount: 3
DistributionType: K8S
eBPFContainerEngine: cri-o
allResources: false
scheduleNone: true
example-kubernetes-2.0-with-proxy-payload:
value:
name: test-cluster-api-proxy
config:
Etcd: true
coreDNS: true
KubeProxy: true
enableLog: false
enableEBPF: false
kubeEvents: true
enableTrace: false
KubeletStats: true
KubeAPIServer: true
KubeScheduler: true
ebpfFeatureFlag: false
KubeClusterReceiver: true
KubeControllerManager: true
clientLevelLogPermission: true
clientLevelTracePermission: true
replicaCount: 3
DistributionType: K8S
eBPFContainerEngine: cri-o
allResources: false
scheduleNone: true
infoMap:
kubernetesProxy:
uuid: 28a68058-53df-4820-8750-a8b422a61c44
name: labrat-nextgen-gateway
description: ''
tags:
- installed-apps
get:
summary: Get all the profiles associated with the app.
operationId: get-profiles
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
name:
type: string
minLength: 1
config:
type: object
properties:
url:
type: string
method:
type: string
timeout:
type: integer
checkType:
type: string
credentials:
type: array
items:
type: object
properties:
uniqueId:
type: string
syntheticProxyCredSet:
type: array
items:
type: object
properties:
uniqueId:
type: string
httpHeaders:
type: string
httpParams:
type: string
validateSSL:
type: boolean
shouldContain:
type: string
shouldNotContain:
type: string
expectedResponseCode:
type: string
resourceName:
type: string
resourceType:
type: string
syntheticProxyServerUrl:
type: string
payloadRegularExpression:
type: string
proxyConfigurationSettings:
type: boolean
syntheticProxyServerAuthType:
type: string
syntheticProxyServerConfigType:
type: string
locationUuids:
type: array
items:
type: string
port:
type: string
minLength: 1
protocol:
type: string
minLength: 1
ipAddress:
type: string
minLength: 1
vcenterName:
type: string
minLength: 1
nativeTypes:
type: object
properties:
vm:
type: object
properties:
metrics:
type: object
properties:
system_memory_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_network_interface_utilization:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
host:
type: object
properties:
metrics:
type: object
properties:
system_disk_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
system_cpu_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_memory_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
installedAppId:
type: string
minLength: 1
schedule:
type: object
properties:
patternType:
type: string
minLength: 1
pattern:
type: string
minLength: 1
startTime:
type: string
minLength: 1
examples:
example-app-profiles:
value:
id: ADAPTER-MANIFEST-9895c9a6-73fa-4399-956e-08f2b9d32899
name: test
config:
ipRange: 192.168.56.102
options:
cdp: true
credential1:
port: '9445'
community: test
snmp_version: V1
credential2:
port: '8843'
snmp_version: V2
discoveryType: IP Range
advancedOptions:
scanDiscovered: true
installedAPPId: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
schedule:
patternType: MINUTES
pattern: '30'
startTime: '30'
frequency: 5
state: ENABLED
example-app-profile:
value:
id: ADAPTER-MANIFEST-e7586677-b878-483d-baaa-389e3ee3329a
name: test_config
config:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
credentials:
- SByTpYg7fauQtPfkzM6pDbpf
vcenterName: vCenter
nativeTypes:
vm:
metrics:
system_memory_usage_utilization:
name: system_memory_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory usage Utilization in percentage
displayName: system_memory_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_network_interface_utilization:
name: system_network_interface_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system network interface utilization
displayName: system_network_interface_utilization
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
frequency: '5'
resourceType: Server
host:
metrics:
system_disk_usage_usedspace:
name: system_disk_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system disk usage
displayName: system_disk_usage_usedspace
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
formatAlertValue: true
system_cpu_usage_utilization:
name: system_cpu_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '65'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system cpu usage Utilization in percentage
displayName: system_cpu_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_memory_usage_usedspace:
name: system_memory_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory used sapce
displayName: system_memory_usage_usedspace
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
frequency: '5'
resourceType: Server
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
schedule:
patternType: MINUTES
pattern: '20'
startTime: '20'
frequency: 20
state: ENABLED
example-configuration:
value:
id: ADAPTER-MANIFEST-643526b8-01c7-4de8-a42e-a7f1a948274d
name: HTTP_Testcase
config:
url: 'http://www.google.com'
method: GET
timeout: 500
checkType: HTTP
httpParams: '{"Content-Type":"application/json"}'
credentials:
- uniqueId: BaBS3kDmP3EgxdJ3gbecy8X9
httpHeaders: '{"Accept":"application/json"}'
resourceName: HTTP_Test
resourceType: SYNTHETIC
locationUuids:
- 855ef020-adda-4b18-b717-fab7f44fe405
shouldContain: Test
shouldNotContain: user
expectedResponseCode: '200'
syntheticProxyCredSet:
- uniqueId: uBrRaJgg6Fc7NcE9r6hBTBJ9
syntheticProxyServerUrl: 'http://172.26.11.16:3128'
payloadRegularExpression: test
proxyConfigurationSettings: true
syntheticProxyServerAuthType: Basic
syntheticProxyServerConfigType: Custom
installedAPPId: INTG-01cb3041-7a8b-4adb-aee0-7c14e3b9f2f0
frequency: 0
state: ENABLED
upgrade: false
scheduleNone: false
discoveryConfigId: 0
resourceId: 07d96e02-45a8-4e0a-bcc4-d9070d2d10b2
allResources: false
lastScanTime: 0
description: Listing all the associated profiles across all installed apps
parameters: []
tags:
- installed-apps
delete:
summary: Deletes the app's domain profile
operationId: delete-api-v2-tenants-tenantId-install-installedAppUniqueId-configs-sdkConfigId
responses:
'200':
description: OK
description: Removes the domain profile configuration from the apps.
tags:
- installed-apps
'/api/v3/tenants/{tenantId}/apps/config/{installedIntgId}/{configId}/execute':
description: Execute On-Demand "discovery" or "enable/disable profiles".
summary: 'apps/{id}/config/{configId}/execute'
x-new-path: true
parameters:
- schema:
type: string
name: tenantId
in: path
required: true
- schema:
type: string
name: id
in: path
required: true
- schema:
type: string
name: configId
in: path
required: true
post:
summary: Execute on demand action on configuration
tags:
- installed-apps
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
status:
type: string
minLength: 1
required:
- status
x-examples:
example-1:
status: success
examples:
example-config-actions:
value:
status: success
operationId: get-api-v2-tenants-tenantId-apps-installedAppUniqueId-config-sdkConfigId-actions
requestBody:
content:
application/json:
schema:
type: object
x-examples:
example-1:
action: DISCOVERY
properties:
action:
type: string
minLength: 1
enum:
- discovery
- enable
- disable
default: discovery
example: discovery
required:
- action
examples:
example-discovery-action:
value:
action: discovery
example-enable-action:
value:
action: enable
description: Executes an on demand configuration action
'/api/v3/tenants/{tenantId}/apps/{appName}/versions':
x-new-path: true
x-internal: true
description: List all installed versions of app.
summary: 'apps/{appName}/versions'
parameters:
- name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
- name: appName
in: path
required: true
schema:
type: string
description: Unique App Name
get:
summary: Get list of installed versions of an app by name
tags:
- installed-apps
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
results:
- id: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
displayName: snmp-Gateway18.04
installedBy: opsramp_api_user
installedTime: '2021-09-09T14:39:59+0100'
profile:
id: 10135
name: Gateway18.04
status: DOWN
uuId: 359ed62c-6e4a-4bf4-8305-463ac320e013
delete: false
app: snmp
version: 2.0.0
updateAvailable: false
title: SNMP
state: Installed
totalResults: 1
orderBy: appName
pageNo: 1
pageSize: 20
totalPages: 1
nextPage: false
previousPageNo: 0
descendingOrder: true
properties:
results:
type: array
uniqueItems: true
minItems: 1
items:
type: object
properties:
id:
type: string
minLength: 1
displayName:
type: string
minLength: 1
installedBy:
type: string
minLength: 1
installedTime:
type: string
minLength: 1
profile:
type: object
properties:
id:
type: number
name:
type: string
minLength: 1
status:
type: string
minLength: 1
uuId:
type: string
minLength: 1
delete:
type: boolean
app:
type: string
minLength: 1
version:
type: string
minLength: 1
updateAvailable:
type: boolean
title:
type: string
minLength: 1
state:
type: string
minLength: 1
required:
- version
totalResults:
type: number
orderBy:
type: string
minLength: 1
pageNo:
type: number
pageSize:
type: number
totalPages:
type: number
nextPage:
type: boolean
previousPageNo:
type: number
descendingOrder:
type: boolean
required:
- pageNo
- pageSize
- totalPages
- nextPage
- previousPageNo
examples:
example-versioned-app:
value:
results:
- id: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
displayName: SNMP Monitoring App
installedBy: opsramp_api_user
installedTime: '2021-09-09T14:39:59+0100'
profile:
id: 10135
name: Gateway-Test
status: DOWN
uuId: 359ed62c-6e4a-4bf4-8305-463ac320e013
delete: false
app: snmp
version: 2.0.0
updateAvailable: false
title: SNMP
state: Installed
totalResults: 1
orderBy: appName
pageNo: 1
pageSize: 20
totalPages: 1
nextPage: false
previousPageNo: 0
descendingOrder: true
operationId: get-api-v2-tenants-tenantId-apps-installed
description: Get the list of installed instances of an app
parameters:
- schema:
type: string
in: query
name: pageNo
description: Current page No.
- schema:
type: string
in: query
name: pageSize
description: Max page size
'/api/v3/tenants/{tenantId}/apps/{appName}/versions/{versionId}':
description: Get the details of given installed app version.
summary: 'apps/{appName}/versions/{versionId}'
x-new-path: true
x-internal: true
parameters:
- name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
- schema:
type: string
name: appName
in: path
required: true
- schema:
type: string
name: versionId
in: path
required: true
get:
summary: Get details of the versioned app
tags:
- installed-apps
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
x-examples:
example-1:
results:
- id: string
displayName: string
installedBy: string
installedTime: string
profile:
id: 0
name: string
status: DOWN
uuId: 0757149a-1b5d-4494-b3fb-bbf85aad909a
delete: true
app: string
version: string
updateAvailable: true
title: string
state: string
totalResults: 0
orderBy: string
pageNo: 0
pageSize: 0
totalPages: 0
nextPage: true
previousPageNo: 0
descendingOrder: true
properties:
results:
type: array
uniqueItems: true
minItems: 1
items:
$ref: '#/components/schemas/installedApp'
totalResults:
type: number
orderBy:
type: string
minLength: 1
pageNo:
type: number
pageSize:
type: number
totalPages:
type: number
nextPage:
type: boolean
previousPageNo:
type: number
descendingOrder:
type: boolean
required:
- results
examples:
example-version-app-details:
value:
results:
- id: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
displayName: snmp-Gateway18.04
installedBy: opsramp_api_user
installedTime: '2021-09-09T14:39:59+0100'
profile:
id: 10135
name: Gateway18.04
status: DOWN
uuId: 359ed62c-6e4a-4bf4-8305-463ac320e013
delete: false
app: snmp
version: 2.0.0
updateAvailable: false
state: Installed
totalResults: 1
orderBy: appName
pageNo: 1
pageSize: 20
totalPages: 1
nextPage: false
previousPageNo: 0
descendingOrder: true
operationId: get-api-v2-tenants-teantId-versioned-apps
parameters:
- schema:
type: string
in: query
name: pageNo
description: Current page No.
- schema:
type: string
in: query
name: pageSize
description: Max page size
description: Get versioned app details.
'/api/v3/tenants/{tenantId}/apps/list':
description: Get the list of ordered count of installed apps.
summary: apps/list
x-new-path: true
x-internal: true
parameters:
- name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
get:
summary: Get installed Apps grouped by App
tags:
- installed-apps
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
description: ''
minItems: 1
uniqueItems: true
items:
type: object
required:
- app
- title
- count
properties:
app:
type: string
minLength: 1
title:
type: string
minLength: 1
count:
type: number
x-examples:
example-1:
- app: snmp
title: SNMP
count: 1
examples:
example-groupby-apps:
value:
- app: snmp
title: SNMP
count: 1
operationId: get-api-v2-groupBy-apps
parameters: []
description: Get the instances of the apps installed.
'/api/v3/tenants/{tenantId}/apps/install/config':
x-new-path: true
x-internal: true
summary: apps/install/config
parameters:
- schema:
type: string
name: tenantId
in: path
required: true
get:
summary: apps/install/config
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
config:
type: object
properties:
port:
type: string
protocol:
type: string
ipAddress:
type: string
tagValue:
type: string
tagId:
type: string
tagName:
type: string
credentials:
type: array
items:
type: string
vcenterName:
type: string
installedAPPId:
type: string
installedApp:
type: object
properties:
id:
type: string
displayName:
type: string
version:
type: string
collectorProfile:
type: object
properties:
id:
type: integer
name:
type: string
uuId:
type: string
totalResults:
type: integer
orderBy:
type: string
pageNo:
type: integer
pageSize:
type: integer
totalPages:
type: integer
nextPage:
type: boolean
previousPageNo:
type: integer
descendingOrder:
type: boolean
x-examples:
Example 1:
results:
- id: ADAPTER-MANIFEST-e7586677-b878-483d-baaa-389e3ee3329a
name: test_config
config:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
tagValue: value01
tagId: 8615541d-ab60-4aeb-bdbb-01991fec1d02
tagName: tag-name01
credentials:
- vFeYjzSVsxsxmpDa5Jr8WdyC
vcenterName: vCenter
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
installedApp:
id: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
displayName: Dell Power Max App
version: 1.0.0
collectorProfile:
id: 10135
name: Gateway18.04
uuId: 359ed62c-6e4a-4bf4-8305-463ac320e013
totalResults: 1
orderBy: name
pageNo: 1
pageSize: 100
totalPages: 1
nextPage: false
previousPageNo: 0
descendingOrder: true
examples:
Example 1:
value:
results:
- id: ADAPTER-MANIFEST-e7586677-b878-483d-baaa-389e3ee3329a
name: test_config
config:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
tagValue: value01
tagId: 8615541d-ab60-4aeb-bdbb-01991fec1d02
tagName: tag-name01
credentials:
- vFeYjzSVsxsxmpDa5Jr8WdyC
vcenterName: vCenter
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
installedApp:
id: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
displayName: Dell Power Max App
version: 1.0.0
collectorProfile:
id: 10135
name: Gateway18.04
uuId: 359ed62c-6e4a-4bf4-8305-463ac320e013
totalResults: 1
orderBy: name
pageNo: 1
pageSize: 100
totalPages: 1
nextPage: false
previousPageNo: 0
descendingOrder: true
operationId: get-api-v3-tenants-tenantId-apps-install-config
x-internal: true
description: searches app configurations
parameters:
- schema:
type: string
in: query
name: tagId
description: Tag uuid
- schema:
type: string
in: query
name: tagName
description: Tag name
- schema:
type: string
in: query
name: tagValue
description: Tag value
components:
schemas:
appDetails:
description: ''
type: object
properties:
app:
type: string
minLength: 1
profile:
type: object
properties:
uuId:
type: string
minLength: 1
required:
- uuId
version:
type: string
minLength: 1
required:
- app
- profile
- version
x-examples:
example-1:
app: snmp
profile:
uuId: 359ed62c-6e4a-4bf4-8305-463ac320e013
version: 2.0.0
installedApp:
type: object
x-examples:
example-1:
id: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
displayName: snmp-Gateway18.04
installedBy: opsramp_api_user
installedTime: '2021-09-09T14:39:59+0100'
profile:
id: 10135
name: Gateway18.04
status: DOWN
uuId: 359ed62c-6e4a-4bf4-8305-463ac320e013
delete: false
app: snmp
version: 2.0.0
updateAvailable: false
title: SNMP
state: Installed
properties:
id:
type: string
minLength: 1
displayName:
type: string
minLength: 1
installedBy:
type: string
minLength: 1
installedTime:
type: string
minLength: 1
profile:
type: object
properties:
id:
type: number
name:
type: string
minLength: 1
status:
type: string
minLength: 1
enum:
- DOWN
- UP
uuId:
type: string
minLength: 1
format: uuid
delete:
type: boolean
required:
- id
- delete
app:
type: string
minLength: 1
version:
type: string
minLength: 1
updateAvailable:
type: boolean
state:
type: string
minLength: 1
enum:
- Installed
required:
- id
- app
- version
- updateAvailable
oldappProfile:
description: ''
type: object
x-examples:
example-1:
id: ADAPTER-MANIFEST-9895c9a6-73fa-4399-956e-08f2b9d32899
name: test
config:
ipRange: 192.168.56.102
options:
cdp: true
credential1:
port: '9445'
community: test
snmp_version: V1
credential2:
port: '8843'
snmp_version: V2
discoveryType: IP Range
advancedOptions:
scanDiscovered: true
installedAPPId: INTG-aeeb8d77-982f-4276-b48b-28d2e8a1e21b
schedule:
patternType: MINUTES
pattern: '30'
startTime: '30'
frequency: 5
state: ENABLED
properties:
id:
type: string
minLength: 1
name:
type: string
minLength: 1
config:
type: object
properties:
ipRange:
type: string
minLength: 1
options:
type: object
properties:
cdp:
type: boolean
credential1:
type: object
properties:
port:
type: string
minLength: 1
community:
type: string
minLength: 1
snmp_version:
type: string
minLength: 1
credential2:
type: object
properties:
port:
type: string
minLength: 1
snmp_version:
type: string
minLength: 1
discoveryType:
type: string
minLength: 1
enum:
- IP Range
advancedOptions:
type: object
properties:
scanDiscovered:
type: boolean
installedAPPId:
type: string
minLength: 1
schedule:
type: object
properties:
patternType:
type: string
minLength: 1
pattern:
type: string
minLength: 1
startTime:
type: string
minLength: 1
frequency:
type: number
state:
type: string
minLength: 1
enum:
- ENABLED
- CREATED
required:
- id
- name
appConfig:
type: object
properties:
name:
type: string
minLength: 1
schedule:
type: object
properties:
patternType:
type: string
minLength: 1
enum:
- MINUTES
- HOURLY
pattern:
type: string
minLength: 1
startTime:
type: string
minLength: 1
config:
type: object
properties:
discoveryType:
type: string
minLength: 1
enum:
- IP Range
- Iprange
ipRange:
type: string
minLength: 1
options:
type: object
properties:
cdp:
type: boolean
ospf:
type: boolean
bgp:
type: boolean
bridge:
type: boolean
loadBalancer:
type: boolean
revDnsLookUp:
type: boolean
discoverVoipPhones:
type: boolean
credential1:
type: object
properties:
snmp_version:
type: string
minLength: 1
port:
type: string
minLength: 1
community:
type: string
minLength: 1
credential2:
type: object
properties:
snmp_version:
type: string
minLength: 1
port:
type: string
minLength: 1
advancedOptions:
type: object
properties:
scanDiscovered:
type: boolean
snmpEnabledDevice:
type: boolean
credentials:
type: array
items:
type: string
appProfile:
description: ''
type: object
x-examples:
example-1:
id: ADAPTER-MANIFEST-e7586677-b878-483d-baaa-389e3ee3329a
name: test_config
config:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
credentials: SByTpYg7fauQtPfkzM6pDbpf
vcenterName: vCenter
nativeTypes:
vm:
metrics:
system_memory_usage_utilization:
name: system_memory_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory usage Utilization in percentage
displayName: system_memory_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_network_interface_utilization:
name: system_network_interface_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system network interface utilization
displayName: system_network_interface_utilization
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
frequency: '5'
resourceType: Server
host:
metrics:
system_disk_usage_usedspace:
name: system_disk_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system disk usage
displayName: system_disk_usage_usedspace
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
formatAlertValue: true
system_cpu_usage_utilization:
name: system_cpu_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '65'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system cpu usage Utilization in percentage
displayName: system_cpu_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
system_memory_usage_usedspace:
name: system_memory_usage_usedspace
units: GB
factor: 1
alertOn: NONE
warning:
value: '1'
repeat: 1
operator: GREATER_THAN
critical:
value: '2'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory used sapce
displayName: system_memory_usage_usedspace
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
formatAlertValue: true
monitors:
Performance Monitor:
title: Performance Monitor
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
frequency: '5'
resourceType: Server
installedAPPId: INTG-7825ef58-5ecf-498e-a9ed-2318721dee87
schedule:
patternType: MINUTES
pattern: '20'
startTime: '20'
frequency: 20
state: ENABLED
properties:
id:
type: string
minLength: 1
name:
type: string
minLength: 1
config:
$ref: '#/components/schemas/appConfigs'
nativeTypes:
type: object
properties:
vm:
type: object
properties:
metrics:
type: object
properties:
system_memory_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_network_interface_utilization:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
host:
type: object
properties:
metrics:
type: object
properties:
system_disk_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
system_cpu_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_memory_usage_usedspace:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
resourceType:
type: string
minLength: 1
installedAppId:
type: string
minLength: 1
schedule:
$ref: '#/components/schemas/appSchedules'
frequency:
type: number
state:
type: string
minLength: 1
appConfigs:
type: object
x-examples:
example-1:
port: '45000'
protocol: http
ipAddress: 192.168.56.121
credentials: SByTpYg7fauQtPfkzM6pDbpf
vcenterName: vCenter
properties:
port:
type: string
minLength: 1
protocol:
type: string
minLength: 1
ipAddress:
type: string
minLength: 1
credentials:
type: array
items:
type: string
vcenterName:
type: string
minLength: 1
appMetrics:
description: ''
type: object
x-examples:
example-1:
name: system_memory_usage_utilization
units: '%'
factor: 1
alertOn: NONE
warning:
value: '50'
repeat: 1
operator: GREATER_THAN
critical:
value: '70'
repeat: 2
operator: GREATER_THAN
dataPoint: GUAGE
plotValue: true
description: provides system memory usage Utilization in percentage
displayName: system_memory_usage_utilization
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
availibityMetric: true
formatAlertValue: true
properties:
name:
type: string
minLength: 1
units:
type: string
minLength: 1
factor:
type: number
alertOn:
type: string
minLength: 1
warning:
type: object
properties:
value:
type: string
minLength: 1
repeat:
type: number
operator:
type: string
minLength: 1
critical:
type: object
properties:
value:
type: string
minLength: 1
repeat:
type: number
operator:
type: string
minLength: 1
dataPoint:
type: string
minLength: 1
plotValue:
type: boolean
description:
type: string
minLength: 1
displayName:
type: string
minLength: 1
formatValue:
type: boolean
alertSummary:
type: string
minLength: 1
alertDescription:
type: string
minLength: 1
availibityMetric:
type: boolean
formatAlertValue:
type: boolean
required:
- formatAlertValue
appMonitors:
description: ''
type: object
x-examples: {}
properties:
title:
type: string
minLength: 1
metrics:
type: array
items:
type: string
frequency:
type: string
minLength: 1
appSchedules:
description: ''
type: object
properties:
patternType:
type: string
minLength: 1
pattern:
type: string
minLength: 1
startTime:
type: string
minLength: 1
required:
- patternType
- pattern
- startTime
x-examples:
example-1:
patternType: MINUTES
pattern: '20'
startTime: '20'
publishedApp:
description: ''
type: object
x-examples:
example-1:
name: test-vcenter-sdk2
displayName: test-vcenter-sdk2
appVersion: 2.0.0
description: This is a sample sdk app v2 to learn the flow
category: SDK
appScope: Private
assets:
icon:
type: png
url: 'https://beta.apps.opsramp.com/api/v1/apps/demo-content/icon'
md:
url: null
images: []
version:
apiVersion: api/v2
kind: AppVersion
metadata:
appName: mock-vcenter-sdk2
displayName: mock-vcenter-sdk2
description: mock-vcenter-sdk2 integrates with sample vcenter APIs
version: 2.0.0
categories:
- DISCOVERY AND MONITORING
spec:
assets:
helm:
pullType: image
url: 'us-docker.pkg.dev/gateway-images/gateway-cluster-charts/mock-vcenter-sdk2:2.0.0'
maven:
url: null
digest: null
icon:
type: null
url: null
md:
url: null
images: []
manifest:
data:
port: '45000'
nativeTypes:
host:
resourceType: Server
metrics:
system_cpu_usage_utilization:
alertOn: NONE
formatAlertValue: true
availibityMetric: true
name: system_cpu_usage_utilization
displayName: system_cpu_usage_utilization
description: provides system cpu usage Utilization in percentage
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '65'
repeat: 2
system_disk_usage_usedspace:
alertOn: NONE
formatAlertValue: true
name: system_disk_usage_usedspace
displayName: system_disk_usage_usedspace
description: provides system disk usage
units: GB
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
warning:
operator: GREATER_THAN
value: '1'
repeat: 1
critical:
operator: GREATER_THAN
value: '2'
repeat: 2
system_memory_usage_usedspace:
alertOn: NONE
formatAlertValue: true
name: system_memory_usage_usedspace
displayName: system_memory_usage_usedspace
description: provides system memory used sapce
units: GB
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
warning:
operator: GREATER_THAN
value: '1'
repeat: 1
critical:
operator: GREATER_THAN
value: '2'
repeat: 2
monitors:
Performance Monitor:
title: Performance Monitor
frequency: '5'
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
vm:
resourceType: Server
metrics:
system_memory_usage_utilization:
alertOn: NONE
formatAlertValue: true
availibityMetric: true
name: system_memory_usage_utilization
displayName: system_memory_usage_utilization
description: provides system memory usage Utilization in percentage
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '70'
repeat: 2
system_network_interface_utilization:
alertOn: NONE
formatAlertValue: true
name: system_network_interface_utilization
displayName: system_network_interface_utilization
description: provides system network interface utilization
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '70'
repeat: 2
monitors:
Performance Monitor:
title: Performance Monitor
frequency: '5'
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
schema:
properties:
ipAddress:
type: string
port:
type: string
vcenterName:
type: string
protocol:
type: string
credentials:
type: string
required:
- ipAddress
- vcenterName
- port
- protocol
type: object
uischema:
elements:
- label: IP Address
options:
placeholder: Enter IP Address
scope: '#/properties/ipAddress'
type: Control
- label: Port
options:
placeholder: Enter Port Name
scope: '#/properties/port'
type: Control
- label: VCenter Name
options:
placeholder: Enter VCenter Name
scope: '#/properties/vcenterName'
type: Control
- label: Protocol
scope: '#/properties/protocol'
type: Control
- type: Control
scope: '#/properties/credentials'
label: Credentials
options:
format: credential
placeholder: Select credential
credentialType: APPLICATION
type: VerticalLayout
properties:
name:
type: string
minLength: 1
displayName:
type: string
minLength: 1
appVersion:
type: string
minLength: 1
description:
type: string
minLength: 1
category:
type: string
minLength: 1
appScope:
type: string
minLength: 1
assets:
$ref: '#/components/schemas/appAssets'
version:
$ref: '#/components/schemas/appVersionSpec'
appSpecs:
description: ''
type: object
x-examples:
example-1:
assets:
helm:
pullType: image
url: 'us-docker.pkg.dev/gateway-images/gateway-cluster-charts/mock-vcenter-sdk2:2.0.0'
maven:
url: null
digest: null
icon:
type: null
url: null
md:
url: null
images: []
manifest:
data:
port: '45000'
nativeTypes:
host:
resourceType: Server
metrics:
system_cpu_usage_utilization:
alertOn: NONE
formatAlertValue: true
availibityMetric: true
name: system_cpu_usage_utilization
displayName: system_cpu_usage_utilization
description: provides system cpu usage Utilization in percentage
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '65'
repeat: 2
system_disk_usage_usedspace:
alertOn: NONE
formatAlertValue: true
name: system_disk_usage_usedspace
displayName: system_disk_usage_usedspace
description: provides system disk usage
units: GB
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
warning:
operator: GREATER_THAN
value: '1'
repeat: 1
critical:
operator: GREATER_THAN
value: '2'
repeat: 2
system_memory_usage_usedspace:
alertOn: NONE
formatAlertValue: true
name: system_memory_usage_usedspace
displayName: system_memory_usage_usedspace
description: provides system memory used sapce
units: GB
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
warning:
operator: GREATER_THAN
value: '1'
repeat: 1
critical:
operator: GREATER_THAN
value: '2'
repeat: 2
monitors:
Performance Monitor:
title: Performance Monitor
frequency: '5'
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
vm:
resourceType: Server
metrics:
system_memory_usage_utilization:
alertOn: NONE
formatAlertValue: true
availibityMetric: true
name: system_memory_usage_utilization
displayName: system_memory_usage_utilization
description: provides system memory usage Utilization in percentage
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '70'
repeat: 2
system_network_interface_utilization:
alertOn: NONE
formatAlertValue: true
name: system_network_interface_utilization
displayName: system_network_interface_utilization
description: provides system network interface utilization
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '70'
repeat: 2
monitors:
Performance Monitor:
title: Performance Monitor
frequency: '5'
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
schema:
properties:
ipAddress:
type: string
port:
type: string
vcenterName:
type: string
protocol:
type: string
credentials:
type: string
required:
- ipAddress
- vcenterName
- port
- protocol
type: object
uischema:
elements:
- label: IP Address
options:
placeholder: Enter IP Address
scope: '#/properties/ipAddress'
type: Control
- label: Port
options:
placeholder: Enter Port Name
scope: '#/properties/port'
type: Control
- label: VCenter Name
options:
placeholder: Enter VCenter Name
scope: '#/properties/vcenterName'
type: Control
- label: Protocol
scope: '#/properties/protocol'
type: Control
- type: Control
scope: '#/properties/credentials'
label: Credentials
options:
format: credential
placeholder: Select credential
credentialType: APPLICATION
type: VerticalLayout
properties:
assets:
type: object
properties:
helm:
type: object
properties:
pullType:
type: string
minLength: 1
url:
type: string
minLength: 1
maven:
type: object
properties:
url:
type: string
digest:
type: string
icon:
type: object
properties:
type:
type: string
url:
type: string
md:
type: object
properties:
url:
type: string
images:
type: array
items:
type: object
manifest:
$ref: '#/components/schemas/appManifest'
appAssets:
description: ''
type: object
x-examples:
example-1:
icon:
type: png
url: 'https://beta.apps.opsramp.com/api/v1/apps/demo-content/icon'
md:
url: null
images: []
properties:
icon:
type: object
required:
- type
- url
properties:
type:
type: string
minLength: 1
url:
type: string
minLength: 1
md:
type: object
properties:
url:
type: string
images:
type: array
items:
type: string
required:
- icon
- md
- images
appVersion:
title: appVersion
type: object
properties:
id:
type: string
appMetadata:
description: ''
type: object
x-examples:
example-1:
appName: mock-vcenter-sdk2
displayName: mock-vcenter-sdk2
description: mock-vcenter-sdk2 integrates with sample vcenter APIs
version: 2.0.0
categories:
- DISCOVERY AND MONITORING
properties:
appName:
type: string
minLength: 1
displayName:
type: string
minLength: 1
description:
type: string
minLength: 1
version:
type: string
minLength: 1
categories:
type: array
items:
type: string
required:
- appName
- displayName
- description
- version
- categories
appVersionSpec:
description: ''
type: object
x-examples:
example-1:
apiVersion: api/v2
kind: AppVersion
metadata:
appName: mock-vcenter-sdk2
displayName: mock-vcenter-sdk2
description: mock-vcenter-sdk2 integrates with sample vcenter APIs
version: 2.0.0
categories:
- DISCOVERY AND MONITORING
spec:
assets:
helm:
pullType: image
url: 'us-docker.pkg.dev/gateway-images/gateway-cluster-charts/mock-vcenter-sdk2:2.0.0'
maven:
url: null
digest: null
icon:
type: null
url: null
md:
url: null
images: []
manifest:
data:
port: '45000'
nativeTypes:
host:
resourceType: Server
metrics:
system_cpu_usage_utilization:
alertOn: NONE
formatAlertValue: true
availibityMetric: true
name: system_cpu_usage_utilization
displayName: system_cpu_usage_utilization
description: provides system cpu usage Utilization in percentage
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '65'
repeat: 2
system_disk_usage_usedspace:
alertOn: NONE
formatAlertValue: true
name: system_disk_usage_usedspace
displayName: system_disk_usage_usedspace
description: provides system disk usage
units: GB
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
warning:
operator: GREATER_THAN
value: '1'
repeat: 1
critical:
operator: GREATER_THAN
value: '2'
repeat: 2
system_memory_usage_usedspace:
alertOn: NONE
formatAlertValue: true
name: system_memory_usage_usedspace
displayName: system_memory_usage_usedspace
description: provides system memory used sapce
units: GB
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
warning:
operator: GREATER_THAN
value: '1'
repeat: 1
critical:
operator: GREATER_THAN
value: '2'
repeat: 2
monitors:
Performance Monitor:
title: Performance Monitor
frequency: '5'
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
vm:
resourceType: Server
metrics:
system_memory_usage_utilization:
alertOn: NONE
formatAlertValue: true
availibityMetric: true
name: system_memory_usage_utilization
displayName: system_memory_usage_utilization
description: provides system memory usage Utilization in percentage
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '70'
repeat: 2
system_network_interface_utilization:
alertOn: NONE
formatAlertValue: true
name: system_network_interface_utilization
displayName: system_network_interface_utilization
description: provides system network interface utilization
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '70'
repeat: 2
monitors:
Performance Monitor:
title: Performance Monitor
frequency: '5'
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
schema:
properties:
ipAddress:
type: string
port:
type: string
vcenterName:
type: string
protocol:
type: string
credentials:
type: string
required:
- ipAddress
- vcenterName
- port
- protocol
type: object
uischema:
elements:
- label: IP Address
options:
placeholder: Enter IP Address
scope: '#/properties/ipAddress'
type: Control
- label: Port
options:
placeholder: Enter Port Name
scope: '#/properties/port'
type: Control
- label: VCenter Name
options:
placeholder: Enter VCenter Name
scope: '#/properties/vcenterName'
type: Control
- label: Protocol
scope: '#/properties/protocol'
type: Control
- type: Control
scope: '#/properties/credentials'
label: Credentials
options:
format: credential
placeholder: Select credential
credentialType: APPLICATION
type: VerticalLayout
properties:
apiVersion:
type: string
minLength: 1
kind:
type: string
minLength: 1
metadata:
$ref: '#/components/schemas/appMetadata'
spec:
$ref: '#/components/schemas/appSpecs'
appManifest:
description: ''
type: object
x-examples:
example-1:
data:
port: '45000'
nativeTypes:
host:
resourceType: Server
metrics:
system_cpu_usage_utilization:
alertOn: NONE
formatAlertValue: true
availibityMetric: true
name: system_cpu_usage_utilization
displayName: system_cpu_usage_utilization
description: provides system cpu usage Utilization in percentage
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '65'
repeat: 2
system_disk_usage_usedspace:
alertOn: NONE
formatAlertValue: true
name: system_disk_usage_usedspace
displayName: system_disk_usage_usedspace
description: provides system disk usage
units: GB
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_disk_usage_usedspace
alertDescription: system_disk_usage_usedspace
warning:
operator: GREATER_THAN
value: '1'
repeat: 1
critical:
operator: GREATER_THAN
value: '2'
repeat: 2
system_memory_usage_usedspace:
alertOn: NONE
formatAlertValue: true
name: system_memory_usage_usedspace
displayName: system_memory_usage_usedspace
description: provides system memory used sapce
units: GB
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_usedspace
alertDescription: system_memory_usage_usedspace
warning:
operator: GREATER_THAN
value: '1'
repeat: 1
critical:
operator: GREATER_THAN
value: '2'
repeat: 2
monitors:
Performance Monitor:
title: Performance Monitor
frequency: '5'
metrics:
- system_cpu_usage_utilization
- system_memory_usage_usedspace
- system_disk_usage_usedspace
vm:
resourceType: Server
metrics:
system_memory_usage_utilization:
alertOn: NONE
formatAlertValue: true
availibityMetric: true
name: system_memory_usage_utilization
displayName: system_memory_usage_utilization
description: provides system memory usage Utilization in percentage
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_memory_usage_utilization
alertDescription: system_memory_usage_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '70'
repeat: 2
system_network_interface_utilization:
alertOn: NONE
formatAlertValue: true
name: system_network_interface_utilization
displayName: system_network_interface_utilization
description: provides system network interface utilization
units: '%'
factor: 1
dataPoint: GUAGE
plotValue: true
formatValue: true
alertSummary: system_network_interface_utilization
alertDescription: system_network_interface_utilization
warning:
operator: GREATER_THAN
value: '50'
repeat: 1
critical:
operator: GREATER_THAN
value: '70'
repeat: 2
monitors:
Performance Monitor:
title: Performance Monitor
frequency: '5'
metrics:
- system_memory_usage_utilization
- system_network_interface_utilization
schema:
properties:
ipAddress:
type: string
port:
type: string
vcenterName:
type: string
protocol:
type: string
credentials:
type: string
required:
- ipAddress
- vcenterName
- port
- protocol
type: object
uischema:
elements:
- label: IP Address
options:
placeholder: Enter IP Address
scope: '#/properties/ipAddress'
type: Control
- label: Port
options:
placeholder: Enter Port Name
scope: '#/properties/port'
type: Control
- label: VCenter Name
options:
placeholder: Enter VCenter Name
scope: '#/properties/vcenterName'
type: Control
- label: Protocol
scope: '#/properties/protocol'
type: Control
- type: Control
scope: '#/properties/credentials'
label: Credentials
options:
format: credential
placeholder: Select credential
credentialType: APPLICATION
type: VerticalLayout
properties:
data:
type: object
required:
- port
properties:
port:
type: string
minLength: 1
nativeTypes:
type: object
properties:
host:
type: object
properties:
resourceType:
type: string
minLength: 1
metrics:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
required:
- Performance Monitor
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
vm:
type: object
properties:
resourceType:
type: string
minLength: 1
metrics:
type: object
properties:
system_memory_usage_utilization:
$ref: '#/components/schemas/appMetrics'
system_network_interface_utilization:
$ref: '#/components/schemas/appMetrics'
monitors:
type: object
required:
- Performance Monitor
properties:
Performance Monitor:
$ref: '#/components/schemas/appMonitors'
schema:
$ref: '#/components/schemas/appSchema'
uischema:
$ref: '#/components/schemas/appUIschema'
appSchema:
description: ''
type: object
x-examples:
example-1:
properties:
ipAddress:
type: string
port:
type: string
vcenterName:
type: string
protocol:
type: string
credentials:
type: string
required:
- ipAddress
- vcenterName
- port
- protocol
type: object
properties:
properties:
type: object
properties:
ipAddress:
type: object
properties:
type:
type: string
minLength: 1
port:
type: object
properties:
type:
type: string
minLength: 1
vcenterName:
type: object
properties:
type:
type: string
minLength: 1
protocol:
type: object
properties:
type:
type: string
minLength: 1
credentials:
type: object
properties:
type:
type: string
minLength: 1
required:
type: array
items:
type: object
type:
type: string
minLength: 1
appUIschema:
description: ''
type: object
properties:
elements:
type: array
uniqueItems: true
minItems: 1
items:
required:
- label
- scope
- type
properties:
label:
type: string
minLength: 1
options:
type: object
properties:
placeholder:
type: string
minLength: 1
required:
- placeholder
scope:
type: string
minLength: 1
type:
type: string
minLength: 1
type:
type: string
minLength: 1
required:
- elements
- type
x-examples:
example-1:
elements:
- label: IP Address
options:
placeholder: Enter IP Address
scope: '#/properties/ipAddress'
type: Control
- label: Port
options:
placeholder: Enter Port Name
scope: '#/properties/port'
type: Control
- label: VCenter Name
options:
placeholder: Enter VCenter Name
scope: '#/properties/vcenterName'
type: Control
- label: Protocol
scope: '#/properties/protocol'
type: Control
- type: Control
scope: '#/properties/credentials'
label: Credentials
options:
format: credential
placeholder: Select credential
credentialType: APPLICATION
type: VerticalLayout
publishedAppDetails:
description: ''
type: object
x-examples:
example-1:
id: HELLOWORLD-APP-PYTHON
name: helloworld-app-python
category: SDK APP
assets:
md:
url: null
icon:
url: 'https://beta.apps.opsramp.com/api/v1/apps/helloworld-app-python/icon'
type: png
images: []
publisher: Cluster Demo 1
versions:
- state: Published
tag: 3.0.0
properties:
id:
type: string
minLength: 1
name:
type: string
minLength: 1
category:
type: string
minLength: 1
assets:
$ref: '#/components/schemas/appAssets'
publisher:
type: string
minLength: 1
versions:
type: array
uniqueItems: true
minItems: 1
items:
type: object
properties:
state:
type: string
minLength: 1
tag:
type: string
minLength: 1
parameters:
tenantId:
name: tenantId
in: path
required: true
schema:
type: string
description: Describes the Client uuid
appName:
name: appName
in: path
required: true
schema:
type: string
description: Unique App Name
installedAppUniqueId:
name: installedAppUniqueId
in: path
required: true
schema:
type: string
format: uuid
description: Installed app uuid
securitySchemes:
accessToken:
type: oauth2
flows:
clientCredentials:
tokenUrl: 'https://custom-branded-domain.api.opsramp.com'
scopes: {}