FAQ:
2) Run the following command: > automation_api_config --set_log_level <logLevelOptions> where <logLevelOptions> is structured as: server:logLevel For server, specify one of the following values: aapi, capi, all For logLevel, specify one of the following values: error, warn, info, debug, trace, default Examples:
Q8. Is it possible to create/update/delete Conditions or Scheduling criteria if the Jobs/Folders are already in the Active Jobs Folder Table in the Control-M Server Database? Q9. How do the versions of the Control-M Automation API relate to the version of the Control-M Enterprise Manager Server?
Q10. What is the default timeout value for AAPI requests
A10. 10000 milliseconds The next command can be used to change this value: ctm env config serverTimeout <milliseconds> Q11. What Application job types are supported Automation API A11. As of release 9.0.20 MFT
SAP AI Informatica Databases Hadoop AWS Azure Note: in the first half of 2022, support for new job types will be introduced step-by-step during monthly delivery of Automation API, so all of them will be available within one or two monthly releases, the job properties will appear as variables. Q12. How to enable trace on the client side
A12. Use -trace option or --trace (v920+) to send the debug output to the console example: ctm conf servers --trace Q13. Is it possible to connect to AAPI through Single SignOn? A13. Currently, as of version 9.0.19, it is necessary to supply both the user and password to obtain a token to be used for subsequent requests. The following RFE CTM-1806 - A better way of authenticating to the AAPI. has been created to address this need. Q14. How do you perform a health check using the Control-M Automation API via the command line interface (CLI)? A14. ctm config servers::get Sample Output: [ { "name": "clm-aus-tk003e", "host": "clm-aus-tk003e", "state": "Up", "message": "Connected" } ] Q15. Is it possible to manage all EM components using AAPI calls? A15. Currently, as of version 9.0.20, through the "config" AAPI service it is possible to partially manage CTM Server and CTM Agent only for all the other components you need to use "em ctl" or "ccmcli" the following RFE CTM-3354 - Ability to manage all EM components through Automation API REST calls has been opened to address this need. Q16. Is it possible to allow the connection to AAPI Server and submission of AAPI calls only to a list of source addresses (IP Whitelist) for security reasons? A16. Currently, as of version 9.0.20, is it not possible to specify the IP addresses from where it is possible to place AAPI calls and block all the others. The following RFE has been opened to address this need: CTM-3543 - Need the possibility to allow access to AAPI server only from a Whitelisted list of source IP Q17. What information regarding Control-M Automation API Scalability is currently available? A17. Please see knowledge article 000368757 Q18. Can I install the latest monthly release of Control-M Automation API even if I'm using a different version of Control-M/Enterprise Manager? A18. Control-M Automation API monthly releases are compatible with a variety of Control-M 9.x versions, starting with Control-M 9 Fix Pack 5 (that is, Control-M 9.0.00.500 and above). Specific features that require a later version of Control-M are indicated in the current documentation, and the minimum version of Control-M that is compatible with each feature is specified. Q19. What is the maximum length of error messages returned by Control-M Automation API calls? A19. The Control-M Automation API calls return results and errors in a JSON structure that has no predefined limits for values length. So error messages have not a predefined maximum length. Q20. Is it possible to manage (set) EM system parameters through Control-M Automation API calls? A20. Currently, as of version 9.0.20.100, the command "config em:param::set" allows the setting of 4 EM System Parameters. The following RFE has been created to extend the functionality to all EM System parameter: CTM-5132 - Ability to manage ALL EM system parameters through AAPI Q21. Does Control-M Automation API support the AS400 job type? A21: Currently, AS/400 job type is not supported. Following RFE has been created to extend the support for this job type. CTM-3691 - Full Automation API support for AS/400 full job type Q22. Can Control-M for z/OS jobs be ordered using Control-M Automation API? A22: This functionality is available with Control-M Automation API 9.0.19.100 Q23. What Authentication method is currently supported on Control-M Automation API? A23: For Control-M AAPI only supports using user/password which allows you to log in and log out of Control-M and receive a token that can be reused in subsequent requests. Note: For Control-M v21 a new authentication method will be included API Token (different from user/password). Q24. Is Control-M Automation API rest server stateless ? A24: Starting with 9.0.20.100 all requests to AAPI are stateless. Prior to this version all request but deploy xml were stateless. Q25. Can Control-M Automation API actions be tracked down to specific users through Audit reports? A25: Currently this is not possible. CTM-6569 - Improve the Audit information from Audit_activities DB table, so AAPI actions can be mapped to AAPI users was created to address this enhancement. Q26. How to deploy a Control-M Integration job type for example Azure Data Factory ? A24: ctm deploy jobtype <path to .ctmai file> <name of the Control-M/Agent> <name of the Control-M/Server> All characters are case sensitive and must be typed as shown in Control-M Configuration Manager. Q27. How to troubleshoot emrestsrv startup script ? A24: When the rest server is launched automatically the output of the script are redirected to Calalina.log file Q28. Why when using Tokens as authentication, when changing any Roles settings of the user associated with the Token these changes are not reflected in the execution of processes via AAPI? And when using User/Password authentication, are changes reflected immediately? A28: Token authorizations are based on user roles that were assigned when the token was created. From this time, user roles are NOT bound to the token itself and don't reflect any changes. That's why changes are immediately reflected if the env is created with user/password, and are not reflected when using Token authentication, having to regenerate the same if any changes are made to the roles. Q29: Is there a version of AAPI CMD client on Mainframe? A29: The AAPI client on the MF is the same AAPI client used on other platforms (i.e. it can be installed on the MF...). Note that it needs nodejs as prerequisite (can be downloaded from here: https://www.ibm.com/products/sdk-nodejs-compiler-zos).
There are no EBCDIC/ASCII concerns as the data is sent in UTF8. Q30: Is it supported to execute "automation_api_config -speval false" on Helix Control-M Automation API?
A: Using Helix Control-M Automation API to update the Helix Control-M server parameters is not supported currently. Q31: Will changing the SERVICE.API GATEWAY PORT PROTOCOL from http to https only affect the specific Control-M server where the changes are being made?
A: This change will only apply to the selected Control-M/Server. Q32: When EM-CTM Request Service and EM-MFT Update Service are restarted, will it cause downtime for all servers connected to Enterprise Manager or just the server for which https was enabled?
A: The Request Service is general for all CTM Servers, so it will affect all of them. EM-CTM request service – the EM will not be able to send new request until the service started. The MFT Updates will remain in the queue until the service started. Q33: After changing the bmc_https_client_server.ignoreCertificateTrustVerify value to false in <EM_Home>/services/config/https_client_server.properties file, will it only affect the CTM Servers where the SERVICE.API_GATEWAY_PORT_PROTOCOL parameter was set to https or will it affect all CTM Servers?
A: Will affect only servers that configured as https, be aware that the certifications must be valid. Q34: What are the steps to check if the https enablement for SERVICE.API_GATEWAY_PORT_PROTOCOL is properly validated, according to the following excerpt from the product documentation? "Verify that you have deployed the keystore that contains the signed certificate on Control-M/EM and Control-M/Server, as described in Configuring SSL in Zone 2 and 3."
A: This sentence simply states that it is necessary to deploy using ctmkeytool a keystore signed by the same root CA on all components in the environment (EM and CTM servers and agents). "Verify that you have deployed the keystore that contains the signed certificate on Control-M/EM and Control-M/Server, as described in Configuring SSL in Zone 2 and 3." Q35. Where can I find the response code for each endpoint of Control-M Automation API?
A: The response code for each endpoint API can be found from the swagger-ui https://<EM Web Server Hostname>:8443/automation-api/swagger-ui.html Q36. After upgrading to Automation API 9.0.22.010 or higher and the python based ctm cli, the .nodejs file still exists. Is this file still used?
A: This file is still used for the Python based ctm cli. If this file is deleted, the ctm cli command will no longer be in the PATH environment variable.
|
Additional information: |