Agent data API endpoints
Use the Agent data API endpoints to manage Agent and Gateway Server tasks. Before you run an endpoint, make sure that you authenticate the API request.
openapi: 3.0.2
components:
schemas:
AboutInfo:
title: About info
description: Basic information about the running service
type: object
properties:
api_versions:
type: array
items:
type: string
example:
- 1
version:
type: string
example: 1
component:
type: string
example: analysis-service
product:
type: string
example: TrueSight Helix Capacity Optimization
GWSCompletionRequest:
title: GWS Soap request
description: GWS Soap request
type: object
required:
- gws_id
- gws_api
properties:
gws_id:
description: The gws id
type: string
example: 'gws1.company.com:port'
item_key:
description: The hash key for item
type: string
example: 1234556
error_code:
description: The error code from GWS
type: integer
example: 56
error_msg:
description: The error message from GWS
type: string
example: Failed to complete request
request_type:
description: SOAP or JSON
type: string
default: SOAP
enum:
- SOAP
- JSON
json_response:
description: JSON response
type: string
example: {}
soap_xml_response:
description: SOAP response
type: string
example: >-
20.02.00
operation_name:
description: The name of the requested API operation
type: string
example: CREATE_SPEC
ApiError:
title: ApiError
description: An error message returned by the server
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
transient:
type: boolean
GWSSoapRequest:
title: GWS Soap request
description: GWS Soap request
type: object
required:
- gws_id
- gws_api
- soap_xml_request
properties:
gws_id:
description: The gws id
type: string
example: 'gws1.company.com:port'
gws_api:
description: The SOAP API
type: string
example: getConsoleVersion
soap_xml_request:
description: The SOAP XML Request
type: string
example: ''
wait_secs:
description: Wait time (seconds)
type: integer
example: 60
GWSSoapResponse:
title: GWS Soap response
description: GWS Soap response
type: object
properties:
soap_xml_response:
description: Response SOAP XML
type: string
example: >-
20.02.00
soap_xml_failure:
description: Failure SOAP XML
type: string
example: failure
GWSPendingRequest:
title: GWS pending request
description: GWS pending request
type: object
properties:
item_key:
description: The hash key for item
type: string
example: 1234556
gws_api:
description: The SOAP API
type: string
example: getConsoleVersion
request_type:
description: SOAP or JSON
type: string
default: SOAP
enum:
- SOAP
- JSON
soap_xml_request:
description: The SOAP XML Request
type: string
example: ''
json_request:
description: JSON Request
type: string
example: {}
json_api:
description: The JSON API
type: string
default: SOAP
enum:
- CREATE_SPEC
- UPDATE_SPEC
- RUN_ANALYZE
- GET_SPEC
- GET_USERS_PROCESSES
- LIST_AGENTLISTS
- CREATE_AGENTLIST
- UPDATE_AGENTLIST
- GET_AGENTLIST
- DEL_AGENTLIST
- PING_AGENTS
example: CREATE_SPEC
GWSPendingRequests:
title: List of pending GWS requests
description: List of pending GWS requests
type: object
properties:
requests:
type: array
items:
type: object
$ref: '#/components/schemas/GWSPendingRequest'
GatewayServersResponse:
title: Gateway Servers response
description: Gateway Servers response
type: object
properties:
servers:
type: array
items:
type: object
properties:
gateway_server:
type: string
description: Url of the gateway server.
example: 'http://gws-server.bmc.com:10129'
gateway_server_name:
type: string
description: Name of the gateway server.
example: gws-server.bmc.com
gws_id:
type: string
description: Full URL of the gateway server in base64 encoding.
example: DaHR0cDovL2NvbnRhaW5lcml6ZWRyZWU6MTAxMjk
status:
type: string
enum:
- OK
- INACTIVE
- NO RESPONSE
- UNKNOWN
ServersRequest:
title: Gateway Servers request
description: Gateway Servers request
type: object
required:
- gateway_server
properties:
gateway_server:
type: string
options:
type: object
additionalProperties:
type: string
filters:
type: array
items:
type: object
properties:
name:
type: string
condition:
type: string
value:
type: string
Server:
title: Server
description: Server
type: object
properties:
server_id:
type: number
example: 78945
co_server_name:
type: string
example: vm1.bmc.com
agent_server_name:
type: string
example: vm1.bmc.com
os_type:
type: string
example: Linux
repository:
type: string
example: /usr/adm/repos1
Pagination:
title: Pagination
description: Pagination
type: object
properties:
has_more_data:
type: boolean
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
total_records:
type: integer
format: int32
ServersResponse:
title: Gateway Servers response
description: Gateway Servers response
type: object
properties:
servers:
type: array
items:
$ref: '#/components/schemas/Server'
pagination:
$ref: '#/components/schemas/Pagination'
Interval:
title: Interval
description: Interval
type: object
properties:
start:
description: 'Starting timestamp as string, compliant ISO 8601'
type: string
format: date-time
example:
- 2019-10-10T04:00:00.000Z
end:
description: 'Ending timestamp as string, compliant ISO 8601'
type: string
format: date-time
example:
- 2019-10-10T05:00:00.000Z
UserClasses:
title: User class
description: User class
type: object
properties:
name:
type: string
description: Name of user class
example: admins
description:
type: string
description: Description of user class
example: Admin users
unames:
type: array
description: list of user names
items:
type: string
example: 'root, deamon'
WkldClasses:
title: Workload class
description: Workload class
type: object
properties:
name:
type: string
description: Name of workload class
example: vm1.bmc.com
description:
type: string
description: Description of workload class
example: vm1.bmc.com
precedence:
type: number
description: The ascending order in which to process workloads
example: 1
uclass_list:
type: array
description: List of user classes
items:
type: string
example: 'root, deamon'
tclass_list:
type: array
description: List of transaction classes
items:
type: string
example: 'PD-Ora-Other,PD-Ora-Bkgrnd'
servers:
type: array
description: List of servers
items:
type: string
example: 'server1, server2'
TranClasses:
title: Transaction class
description: Transaction class
type: object
properties:
name:
type: string
description: Name of transaction class
example: PD-Ora-Arc
description:
type: string
description: Description of transaction class
example: Predefined transaction for Oracle
independent:
type: string
description: Is an independent transaction
enum:
- 'YES'
- 'NO'
example: 'YES'
reference_cpu:
type: object
properties:
model:
type: string
description: cpu model
example: T350F2_E5_2650@2000
num_processors:
type: string
description: number of processors
example: 4
vendor:
type: string
description: Vendor name
example: ACER
os_type:
type: string
description: OS Type
example: UNIX
processes:
type: array
items:
type: object
properties:
cmd:
type: string
description: Command
example: oracle
full_cmd:
type: string
description: Full command
example: ora_lgwr.*
include_rule:
type: string
description: inclusion rule
example: INCLUDE_IF_SAME_UID
count_by:
type: object
properties:
counter:
type: string
description: Counter type
example: CPU_TIME
val:
description: Counter value
type: string
example: 0.1
SpecDefinition:
title: WLC Spec update request
description: WLC Spec update request
type: object
required:
- gateway_server
- spec
- name
- interval
- servers
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
spec:
description: Workload spec id
type: string
example: Workload_001_01
name:
description: Workload spec name
type: string
example: Workload 001
description:
description: Workload description
type: string
example: Workload characterization file description
interval:
$ref: '#/components/schemas/Interval'
servers:
type: array
items:
$ref: '#/components/schemas/Server'
user_classes:
type: array
items:
$ref: '#/components/schemas/UserClasses'
workload_classes:
type: array
items:
$ref: '#/components/schemas/WkldClasses'
transaction_classes:
type: array
items:
$ref: '#/components/schemas/TranClasses'
SpecIdentification:
title: WLC Spec creation request
description: WLC Spec creatio request
type: object
required:
- gateway_server
- spec
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
spec:
description: Workload spec id
type: string
example: Workload_001_01
SpecCreateRequest:
title: WLC Spec creation request
description: WLC Spec creation request
type: object
required:
- gateway_server
- name
- interval
- servers
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
name:
description: Workload spec name
type: string
example: Workload 001
description:
description: Workload description
type: string
example: Workload characterization file description
interval:
$ref: '#/components/schemas/Interval'
servers:
type: array
items:
$ref: '#/components/schemas/Server'
user_classes:
type: array
items:
$ref: '#/components/schemas/UserClasses'
workload_classes:
type: array
items:
$ref: '#/components/schemas/WkldClasses'
transaction_classes:
type: array
items:
$ref: '#/components/schemas/TranClasses'
SpecDetails:
title: Spec details
description: Details of a single wlc spec file
type: object
properties:
name:
type: string
example: Workload 001
spec:
type: string
example: Workload_001_01
description:
type: string
example: Description of Workload 001
creation_date:
type: string
format: date-time
example:
- 2022-07-10T05:00:00.000Z
modified_date:
type: string
format: date-time
example:
- 2022-07-18T05:00:00.000Z
user:
type: string
example: user_name
gateway_server:
type: string
example: gws-server.bmc.com
AllSpecsResponse:
title: All wlc specs response
description: >-
Contains a list of all wlc spec files available across all gateway
servers
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/SpecDetails'
AnalyzeRequest:
title: Run Analyze request
description: Run Analyze request
type: object
required:
- gateway_server
- spec
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
spec:
description: Workload spec name
type: string
example: WLC1
AnalyzeStatusResponse:
title: Get Analyze Run status response
description: Get Analyze Run status response
type: object
properties:
spec:
description: Workload spec name
type: string
example: WLC1
status:
type: string
enum:
- RUNNING
- ERROR
- COMPLETE
example: COMPLETE
code:
type: string
example: OPT_AGENTDATA_2
message:
type: string
example: Analyze failed to run WLC1
AnalyzeRunInfoResponse:
title: Analyze run info response
description: Analyze run info response
type: object
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
spec:
description: Workload spec name
type: string
example: WLC1
run_time:
description: The date and time when the product was run.
type: string
format: date-time
example:
- 2019-11-10T12:00:00.000Z
interval:
$ref: '#/components/schemas/Interval'
ReportType:
title: Report type
description: Report type
type: string
enum:
- SERVER_SUMMARY
- RUN_SUMMARY
- WORKLOAD_COMPOSITION
- PROCESS_DETAILS
example: COMPUTER_SUMMARY
AnalyzeReportMetadataRequest:
title: Run Analyze request
description: Run Analyze request
type: object
required:
- gateway_server
- spec
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
spec:
description: Workload spec name
type: string
example: WLC1
report_type:
$ref: '#/components/schemas/ReportType'
MetadataField:
title: Report metadata field
description: Report metadata field
type: object
properties:
name:
type: string
example: CpuUtil
label:
type: string
example: 'CPU Utilization [%]'
datatype:
type: string
example: NUMBER
unit:
type: string
example: PCT
AnalyzeReportMetadataResponse:
title: Run Analyze reponse
description: Run Analyze response
type: object
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
spec:
description: Workload spec name
type: string
example: WLC1
report_type:
$ref: '#/components/schemas/ReportType'
run_time:
description: The date and time when the product was run.
type: string
format: date-time
example:
- 2019-11-10T12:00:00.000Z
interval:
$ref: '#/components/schemas/Interval'
datafields:
type: array
items:
$ref: '#/components/schemas/MetadataField'
AnalyzeReportDataRequest:
title: Run Analyze request
description: Run Analyze request
type: object
required:
- gateway_server
- spec
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
spec:
description: Workload spec name
type: string
example: WLC1
report_type:
$ref: '#/components/schemas/ReportType'
options:
description: Options
type: object
properties:
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
sortdatafield:
type: string
example: MaxDiskUtil
sortorder:
type: string
example: asc
search:
type: string
description: >-
Defines a search filter that will be applied in like on text
fields of the results; supports * as a wildcard.
example: win*
AnalyzeReportDataResponse:
title: Run Analyze reponse
description: Run Analyze response
type: object
properties:
gateway_server:
description: Gateway server
type: string
example: gws-server.bmc.com
spec:
description: Workload spec name
type: string
example: WLC1
report_type:
$ref: '#/components/schemas/ReportType'
data:
type: array
items:
type: object
additionalProperties:
type: string
pagination:
$ref: '#/components/schemas/Pagination'
ServerKpisData:
title: Server and KPIs data
description: Server and KPIs data
type: object
required:
- server_id
- server_name
- start
- end
properties:
server_id:
type: number
example: 78945
agent_server_name:
type: string
example: vm1.bmc.com
start:
type: string
format: date-time
example:
- 2022-07-10T05:00:00.000Z
end:
type: string
format: date-time
example:
- 2022-07-10T10:00:00.000Z
interval:
type: integer
example: 1
cpu_util:
type: number
example: 25
mem_util:
type: number
example: 66
cpu_run_queue:
type: number
example: 8
disk_io_rate:
type: number
example: 10.39
mem_page_in_rate:
type: number
example: 25.3
mem_page_out_rate:
type: number
example: 25.3
net_bit_rate:
type: number
example: 12.24
cpu_num:
type: number
example: 2
duration:
type: string
example: '2:30:00'
ServerKpisResponse:
title: Read KPIs response
description: Read KPIs response
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/ServerKpisData'
KpisRequest:
title: Read KPIs request
description: Read KPIs request
type: object
required:
- server_ids
properties:
server_ids:
type: array
items:
type: number
example: 78945
options:
type: object
additionalProperties:
type: string
KpisResponse:
title: Read KPIs response
description: Read KPIs response
type: object
required:
- data
- pagination
properties:
data:
type: array
items:
$ref: '#/components/schemas/ServerKpisData'
UsersRequest:
title: Read users request
description: Read users request
type: object
required:
- gateway_server
- start_time
- end_time
- server_ids
properties:
gateway_server:
type: string
example: gws-server.bmc.com
start_time:
type: string
format: date-time
example:
- 2022-07-10T05:00:00.000Z
end_time:
type: string
format: date-time
example:
- 2022-07-18T05:00:00.000Z
server_ids:
type: array
items:
type: number
example: 78945
options:
description: Options
type: object
properties:
search:
type: string
example: user1*
UsersResponse:
title: Read users response
description: Read users response
type: object
required:
- users
properties:
users:
type: array
items:
type: string
example: user1
ProcessesRequest:
title: Read processes request
description: Read processes request
type: object
required:
- gateway_server
- start_time
- end_time
- server_ids
properties:
gateway_server:
type: string
example: gws-server.bmc.com
start_time:
type: string
format: date-time
example:
- 2022-07-10T05:00:00.000Z
end_time:
type: string
format: date-time
example:
- 2022-07-18T05:00:00.000Z
server_ids:
type: array
items:
type: number
example: 78945
options:
description: Options
type: object
properties:
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
sortdatafield:
type: string
example: MaxDiskUtil
sortorder:
type: string
example: asc
search:
type: string
example: cmd*
ProcessInfo:
title: Single process information
description: Single process information
type: object
properties:
cmd:
type: string
example: java
full_cmd:
type: string
example: java -o
ProcessesResponse:
title: Read processes response
description: Read processes response
type: object
properties:
processes:
type: array
items:
$ref: '#/components/schemas/ProcessInfo'
pagination:
$ref: '#/components/schemas/Pagination'
AgentList:
title: Agent List
description: Agent List
type: object
properties:
agent_list:
type: string
example: AgentListOne
last_upload:
type: string
format: date-time
example: 2022-07-10T05:00:00.000Z
remote_list_path:
type: string
example: /usr/adm/best1_workspace/automation/AgentListOne
servers_per_domain:
type: integer
example: 25
servers_per_manager_run:
type: integer
example: 100
manager_run:
type: string
example: /usr/adm/best1_workspace/automation/AgentListOne.vcmds
udr_repository:
type: string
example: /usr/adm/best1_workspace/repository
GatewayServerLists:
title: Gateway server agent lists
description: Agent lists of a gateway server
type: object
properties:
gateway_server:
type: string
example: gws-server.bmc.com
agent_lists:
type: array
items:
$ref: '#/components/schemas/AgentList'
AgentListConfiguration:
title: Agent List Configuration
description: Agent List configuration
type: object
properties:
udr_repository:
type: string
example: /usr/adm/best1_workspace/repository
servers_per_domain:
type: integer
example: 25
servers_per_manager_run:
type: integer
example: 100
workload_characterization_file:
type: string
example: /usr/adm/best1_workspace/automation/wlctest.an
gws_data_processing_time_zone:
type: string
example: America/New_York
collect_server_data_based_on_time_zone:
type: boolean
example: false
compress_data_enabled:
type: boolean
example: true
compress_data_older_than_days:
type: integer
example: 3
delete_data_enabled:
type: boolean
example: true
delete_data_older_than_days:
type: integer
example: 7
processing_summarization_interval_mins:
type: integer
example: 60
agent_summarization_interval_mins:
type: integer
example: 15
run_start_time:
type: string
format: time
run_end_time:
type: string
format: time
AgentListServer:
title: Agent List Server
description: Agent List Server
type: object
required:
- agent_server
properties:
agent_server:
type: string
example: machine1.server.com
alias:
type: string
example: machine1
AgentListRequest:
title: Agent List request
description: Create Agent List request
type: object
required:
- agent_list
- servers
properties:
agent_list:
type: string
example: AgentListTest
configuration:
type: object
$ref: '#/components/schemas/AgentListConfiguration'
servers:
type: array
items:
$ref: '#/components/schemas/AgentListServer'
AgentListDefinition:
title: Agent list definition
description: Definition of a specific agent list
type: object
properties:
gateway_server:
type: string
example: gws-server.bmc.com
agent_list:
type: string
example: AgentListOne
last_upload:
type: string
format: date-time
example: 2022-07-10T05:00:00.000Z
remote_list_path:
type: string
example: /usr/adm/best1_workspace/automation/AgentListOne
servers_per_domain:
type: integer
example: 25
servers_per_manager_run:
type: integer
example: 100
manager_run:
type: string
example: /usr/adm/best1_workspace/automation/AgentListOne.vcmds
udr_repository:
type: string
example: /usr/adm/best1_workspace/repository
servers:
type: array
items:
$ref: '#/components/schemas/AgentListServer'
AgentListUpdateRequest:
title: Agent List request
description: Create Agent List request
type: object
required:
- servers
properties:
servers:
type: array
items:
$ref: '#/components/schemas/AgentListServer'
PingRequest:
title: Ping request
description: Contains the list of servers to ping
type: object
required:
- servers
properties:
servers:
type: array
items:
type: string
example:
- vm2.bmc.com
PingResponse:
title: Ping response
description: Contains any unresponsive server after the ping request
type: object
properties:
failed_servers:
type: array
items:
type: string
example:
- vm2.bmc.com
responses:
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
NotFound:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
InternalServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- name: About
description: The status of the service
- name: GWSRequest
description: Executes operation on remote GWS
- name: GWS
description: Info about GWS and agents
- name: Processes
description: retrieve processes for analyze
- name: Report
description: get analyze report data
- name: Analyze
description: run analyze process and get status
- name: AgentLists
description: manage agents lists
paths:
/opt/api/agentdata/about:
get:
summary: About info
description: About info
operationId: about
security: []
tags:
- About
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AboutInfo'
/opt/api/v1/agentdata/gwsrequest:
post:
summary: Dispatch GWS Request
description: Dispatch GWS Request
operationId: dispatchGwsRequest
tags:
- GWSRequest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GWSSoapRequest'
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GWSSoapResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
put:
summary: Notify GWS operation completion
description: Notify GWS operation completion
operationId: gwsOperationCompleted
tags:
- GWSRequest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GWSCompletionRequest'
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/agentdata/gwsrequest/{gws_id}':
get:
summary: Get pending GWS requests
description: Get pending GWS requests
operationId: getPendingGWSRequest
tags:
- GWSRequest
parameters:
- name: gws_id
description: The gws id
in: path
required: true
schema:
type: string
example: 'https:%2F%2Fgws1.company.com:port'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GWSPendingRequests'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/gws:
get:
summary: Gateway servers
description: Return a list of gateway servers
operationId: gws
tags:
- GWS
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayServersResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/servers:
post:
summary: Servers
description: Return a list of servers managed by the selected gws
operationId: servers
tags:
- Servers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServersRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ServersResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/specs:
post:
summary: Create spec file
description: Creates a new wlc spec file on gateway server
operationId: createSpec
x-permissions:
- admin.general_manager_edit
tags:
- Specs
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpecCreateRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/SpecIdentification'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
put:
summary: Update wlc spec
description: Update the contents of a wlc spec on gateway server
operationId: updateSpec
x-permissions:
- admin.general_manager_edit
tags:
- Specs
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpecDefinition'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/SpecIdentification'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
summary: Delete wlc spec
description: Delete the contents of a wlc spec on GWS
operationId: deleteSpec
x-permissions:
- admin.general_manager_edit
tags:
- Specs
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpecIdentification'
responses:
'200':
description: Ok
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/specs/all:
get:
summary: Get definition of all spec files
description: Get definition of all wlc spec files
operationId: getAllSpec
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Specs
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AllSpecsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/specs/definition:
post:
summary: SpecDefinition
description: Reads a wlc spec file definition on gateway server
operationId: getSpecDefinition
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Specs
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpecIdentification'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/SpecDefinition'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/analyze:
post:
summary: Run analyze for spec
description: Run Analyze on GWS for spec
operationId: analyze
x-permissions:
- admin.general_manager_edit
tags:
- Analyze
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeRequest'
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/analyze/runstatus:
post:
summary: Get analyze run status for spec
description: Get analyze run status for spec
operationId: runStatus
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Analyze
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeStatusResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/analyze/runinfo:
post:
summary: Get analyze execution info for spec
description: Get analyze execution info for spec
operationId: runInfo
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Analyze
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeRunInfoResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/reports/metadata:
post:
summary: Get analyze report data metadata for run id
description: Get analyze report data metadata for run id
operationId: getMetadata
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Report
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeReportMetadataRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeReportMetadataResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/reports/data:
post:
summary: Get analyze report data for run id
description: Get analyze report data for run id
operationId: getData
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Report
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeReportDataRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeReportDataResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/agentdata/wlc/server/{server_id}/kpis':
get:
summary: read server KPIs
description: Returns a list of KPIs for a specific server
operationId: readServerKpis
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Kpis
parameters:
- name: server_id
description: The server id
in: path
required: true
schema:
type: number
example: 728372837
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ServerKpisResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/kpis:
post:
summary: read KPIs
description: Returns a list of KPIs for a set of servers
operationId: readKpis
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Kpis
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/KpisRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/KpisResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/users:
post:
summary: Read Users
description: Returns a list of users for the specified servers
operationId: readUsers
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UsersRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/UsersResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/agentdata/wlc/processes:
post:
summary: Read Processes
description: Returns a list of processes for the specified servers
operationId: readProcesses
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- Processes
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessesRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessesResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/agentdata/gws/{gws_name}/agentlists':
get:
summary: Get Agent Lists
description: Get all existing agent lists of a gateway server
operationId: getAllAgents
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- AgentLists
parameters:
- name: gws_name
description: Name of the Gateway server
in: path
required: true
schema:
type: string
example: gws-server.bmc.com
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayServerLists'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
post:
summary: Create Agent List
description: Create Agent list
operationId: postAgentListDefinition
x-permissions:
- admin.general_manager_edit
tags:
- AgentLists
parameters:
- name: gws_name
description: Name of the Gateway server
in: path
required: true
schema:
type: string
example: gws-server.bmc.com
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AgentListRequest'
responses:
'200':
description: Ok
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/agentdata/gws/{gws_name}/agentlists/{agent_list_name}':
get:
summary: Get Agent List definition
description: 'Get an agent list definition, including servers'
operationId: getAgentListDefinition
x-permissions:
- admin.general_manager_read
- admin.general_manager_edit
tags:
- AgentLists
parameters:
- name: gws_name
description: Name of the Gateway server
in: path
required: true
schema:
type: string
example: gws-server.bmc.com
- name: agent_list_name
description: Name of the agent list
in: path
required: true
schema:
type: string
example: AgentListTest
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AgentListDefinition'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
put:
summary: Update Agent List
description: Update Agent list
operationId: updateAgentListDefinition
x-permissions:
- admin.general_manager_edit
tags:
- AgentLists
parameters:
- name: gws_name
description: Name of the Gateway server
in: path
required: true
schema:
type: string
example: gws-server.bmc.com
- name: agent_list_name
description: Name of the agent list
in: path
required: true
schema:
type: string
example: AgentListTest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AgentListUpdateRequest'
responses:
'200':
description: Ok
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
summary: Delete Agent List
description: Delete Agent list
operationId: deleteAgentListDefinition
x-permissions:
- admin.general_manager_edit
tags:
- AgentLists
parameters:
- name: gws_name
description: Name of the Gateway server
in: path
required: true
schema:
type: string
example: gws-server.bmc.com
- name: agent_list_name
description: Name of the agent list
in: path
required: true
schema:
type: string
example: AgentListTest
responses:
'200':
description: Ok
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/agentdata/gws/{gws_name}/ping':
post:
summary: Ping servers
description: Checks the status of a series of servers
operationId: ping
x-permissions:
- admin.general_manager_edit
tags:
- AgentLists
parameters:
- name: gws_name
description: Name of the Gateway server
in: path
required: true
schema:
type: string
example: gws-server.bmc.com
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PingRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/PingResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'