Get all modules or Get all activated modules on grid
Returns information about all modules in the repository or all modules on the grid. The grid only contains activated modules.
This topic includes the following sections:
For a video demonstration of how to use this call, see Module-management-API.
Request
HTTP method: GET
Request URL for CDP: https://<hostname>:<port>/baocdp/rest/module
Request URL for AP (only available for get all activated modules on the grid, when repo = false): https://<hostname>:<port>/baoap/rest/module
Header: See HTTP-request-and-response-headers for header information, such as required authentication token.
Request parameters
Parameter | Type | Required | Description | Values | Default value |
|---|---|---|---|---|---|
repo | String | No | Specifies whether to get modules from the repo or the grid The grid only contains activated modules. To get a list of all activated modules on the grid, specify repo=false or do not include this parameter in the URL. | true = get module list from the repository false = get module list from the grid | false |
pattern | String | No | Pattern of modules to get Patterns must be expressed as Java Regular Expressions. PCRE patterns are not supported. Do not specify a pattern to get the list of all modules. | User-provided value | NA |
Request body properties
This call does not require a request body.
Response for Get all modules
If successful, this method returns information about all modules in the repository.
Response body properties
Property | Description |
|---|---|
name | Module name |
version | TrueSight Orchestration content version |
revision | Module revision |
Example response JSON for Get all modules
{
"name": "AO-AD-Solaris_Zones",
"version": "20.16.02.00",
"revision": "1"
},
{
"name": "AutoPilot-OA-Common_Utilities",
"version": "20.16.02.00",
"revision": "1"
}
]
Response for Get all activated modules on the grid
If successful, this method returns information about activated modules on the grid.
Response body properties
Property | Description |
|---|---|
name | Module name |
version | TrueSight Orchestration content version |
revision | Module revision |
processes | List of processes in the module |
name | Name of process in the module |
description | Description of process in the module |
peerLocation | Peer on which the process is configured to be executed |
inputParameters | List of input parameters accepted by the process |
outputParameters | List of output parameters returned by the process |
Example response JSON for Get all activated modules
0: {
name: "AutoPilot-OA-Common_Utilities"
version: "20.16.02.00"
revision: "1"
processes: [17]
0: {
name: ":AutoPilot-OA-Common_Utilities:Tokenize String"
description: "Tokenize String Segments a string on a specified delimiter. "
peerLocation: "ANY"
inputParameters: [2]
0: {
name: "string"
required: true
description: "The string to be parsed on a specified character."
}
1: {
name: "delimiter"
required: true
description: "The character on which the specified string will be parsed."
}
outputParameters: [1]
0: {
name: "tokens"
required: true
description: "An XML document with a root element of <tokens> and child element(s) of <token>, containing the resulting string segments."
}
}
.
.
.
}
}
1: {
name: "AutoPilot-OA-File_Utilities"
version: "20.16.02.00"
revision: "1"
processes: [40]
0: {
name: ":AutoPilot-OA-File_Utilities:RSS:Perform RSS Manage Volume"
description: "Perform RSS Manage Volume Manage an RSS volume."
peerLocation: "ANY"
inputParameters: [8]
0: {
name: "connection details"
required: true
description: "XML document conforming to the ConnectionDetails Concept that contains the information required to execute a command via command line"
}
1: {
name: "volume name"
required: true
description: "Specified volume name."
}
2: {
name: "desired free space"
required: false
description: "Enter the desired free space setting for the volume to the specified percentage (for example"
}
3: {
name: "lower limit size"
required: false
description: "Enter the minimum size in kilobytes (KB) for files to be managed. Only files larger than the specified size will be managed."
}
4: {
name: "days not accessed"
required: false
description: "Enter the number of days"
}
5: {
name: "include rule"
required: false
description: "Specifies an inclusion rule to be added to the volume"
}
6: {
name: "exclude rule"
required: false
description: "Specifies an exclusion rule to be added to the volume"
}
7: {
name: "recursive"
required: false
description: "This option should be used only with "include rule" or "exclude rule". Valid value: true"
}
outputParameters: [2]
0: {
name: "output"
required: true
description: "XML document consisting of one or more <line> elements that contain the command response. Each <line> element contains an index attribute indicating the order in which the information was returned by the command."
}
1: {
name: "success"
required: true
description: "Did the operation succeed? Valid values: true"
}
}
.
.
.
}
.
.
}
Status codes and messages
For more details about HTTP response codes, see HTTP response codes.
HTTP code | Message | Description |
|---|---|---|
200 | OK | Request succeeded |
401 | Unauthorized | |
405 | Method not allowed |
Related topics