Update Module Configuration
The Update Module Configuration workflow modifies the specified module configuration, including version, revision, and configuration items.
The following table describes the input elements for the workflow.
Input elements for the workflow
Input element | Input type | Description | Required |
|---|---|---|---|
authentication token | string | Specifies the authentication token generated by running the Login workflow. | Yes |
url | string | Specifies the URL to the TrueSight Orchestration peer in the following format: https://<hostname>:<port>/<name of the peer> For example, https://hostname.domainName.com:38080/baocdp | Conditional; required if not specified in the module configuration |
input | string | Specifies the input in a JSON format for updating module configuration. Valid input type: string, XML, secure context items Example JSON request { "name": "AutoPilot-OA-BAOGridManagement", "version": "20.17.01.00", "revision": "1", "configItems": [ { "path": "ConnectionDetails:AdapterName", "value": "REST" } ] } Example request with XML input { "name": "ModuleName", "version": "6.0", "revision": "1", "configItems": [ { "path": "group1:staticValue", "value": "HappyNewYear - 2019 - 2" }, { "path": "group1:XMLValue", "value": "&lt;root-node&gt;&lt;child1&gt;text1234& lt;/child1&gt;&lt;child2& gt;text1234&lt;/child2&gt;&lt; child3&gt;text1234&lt;/child3&gt;&lt;/root-node&gt;" }, ] } Example request with encrypted data { "name": "ModuleName", "version": "6.0", "revision": "1", "configItems": [ { "path": "group1:staticValue", "value": "HappyNewYear - 2019 - 2" }, { "path": "group1:XMLValue", "value": "&lt;root-node&gt;&lt;child1&gt;text1234& lt;/child1&gt;&lt;child2&gt;text1234&lt;/child2&gt;& lt;child3&gt;text1234&lt;/child3&gt;&lt;/root-node&gt;" }, { "path": "group1:Password", "value": "&lt;EncryptedData Type = \"http://www.w3.org/2001/04/xmlenc#Content\"&gt; Type = \"http://www.w3.org/2001/04/xmlenc#Content\"&lt;CipherData&gt;&lt; CipherValue&gt;g50Pb2Y1+uxOruA3BGrMUA==&lt;/CipherValue&gt;&lt;/ CipherData&gt;&lt;/EncryptedData&gt;" } ] } For the supported body elements, see Update-module-configuration REST API call in TrueSight Orchestration Platform documentation. | Yes |
The following table describes the output elements for the workflow.
Output elements for the workflow
Output element | Description |
|---|---|
remediation message | Contains the resolution if an error occurs |
error number | Contains more information about the error |
status reason | Indicates the reason for success or failure Example: OK |
response in XML doc | Contains the XML response for the request Example <XML> <json> <rest-adapter-response> <header-lines> <Transfer-Encoding>chunked</Transfer-Encoding> <Server>Apache-Coyote/1.1</Server> <Date>Mon, 21 Aug 2017 06:18:03 GMT</Date> <Content-Type>application/json;charset=UTF-8</Content-Type> </header-lines> <metadata> <status>success</status> </metadata> <status-line> <reason>OK</reason> <code>200</code> </status-line> <message-body> <adapterId>null</adapterId> <message>Requested module configuration/s successfully updated.</message> <status>Success</status> </message-body> </rest-adapter-response> </json> </XML> |
error message | Contains the error message if the request fails |
status code | Contains the response code for the request Example: 200 For more information about status codes, see HTTP response codes. |
adapter response | Contains the adapter response in a JSON format Example { "rest-adapter-response": { "metadata": { "status": "success" }, "status-line": { "code": "200", "reason": "OK" }, "header-lines": { "Server": "Apache-Coyote/1.1", "Content-Type": "application/json;charset=UTF-8", "Transfer-Encoding": "chunked", "Date": "Mon, 21 Aug 2017 06:18:03 GMT" }, "message-body": [ { "adapterId": null, "status": "Success", "message": "Requested module configuration/s successfully updated." } ] } } |
response message | Contains the message included in the adapter response Example: Requested module configuration/s successfully updated. |
response status | Indicates whether the adapter response is generated successfully Valid values: Success, Failure |
status | Indicates whether the workflow is run successfully Valid values: success, failure |