Agents, Environments and Applications administration

book

Article ID: 144527

calendar_today

Updated On:

Products

CA Release Automation - Release Operations Center (Nolio) CA Release Automation - DataManagement Server (Nolio)

Issue/Introduction

Some important reports and API's to do common administration activity below.

  1. Licensing Report
  2. Environment Overview
  3. Get Environments for an Application
  4. Get Agents/Server mapped to an Environment
  5. Map an agent to an Environment
  6. Remove an agent from an Environment
  7. Remove all agents from an Environment

Environment

Release : 6.4

Component : CA RELEASE AUTOMATION RELEASE OPERATIONS CENTER

Resolution

It is important to understand the layout of an applications with respect to Release Automation (RA) before carrying out an administration activity. It is often misinterpreted that the agents are mapped to an application, this is a correct view from end user perspective but from administration perspective it is not accurate. Each application is made of various environments and each environments will be made up of various server types. It is the server types where actually the agents are mapped.

Example: 



The above administration activity can be done via two interfaces exposed by CA Release Automation (CARA) product. Some interfaces are readily available in dashboard in forms of report and other administration activity can be carried using the exposed OpenAPI service.  Please find details of each below.
  • Licensing Report
The licensing report is a report is readily available and can be added to dashboard. This report once added will provide details around Version of Product Installed Action Packs, Available Resources (counts only), Installed Dashboard Content. The same can be exported as PDF and can act as a back-reference document.
  • Environment Overview
The Environment Overview report is readily available and can be added to dashboard. This report will provide a report about environments in each application, about deployments in environment, servers and server type mapped to an environment.The same can be exported as PDF and can act as a back-reference document.

Note: All the administration type mentioned below will be using SOAP API service of the CARA product. Please refer to ca-release-automation-6-4-guide attached.
  • Get Environments for an Application
Method: getEnvironmentsForApplication
Sample request:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:mod="http://model.api.dataservices.server.platform.nolio.com/">
      <soap:Header/>
          <soap:Body>
              <mod:getEnvironmentsForApplication>
                      <mod:username>username</mod:username>
                      <mod:password>password</mod:password>
                     <mod:appName>Application_Name</mod:appName>
              </mod:getEnvironmentsForApplication>
         </soap:Body>
 </soap:Envelope>

  • Get Agents/Server mapped to an Environment
Method: getEnvironmentServers
Sample request:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:mod="http://model.api.dataservices.server.platform.nolio.com/">
   <soap:Header/>
   <soap:Body>
      <mod:getEnvironmentServers>
         <mod:username>username</mod:username>
         <mod:password>password</mod:password>        
         <mod:appName>Application_Name</mod:appName>        
         <mod:envName>Environment_Name</mod:envName>
      </mod:getEnvironmentServers>
   </soap:Body>
</soap:Envelope>

  • Map an agent to an Environment
Method: mapInstanceToEnvironment
Sample request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:mod="http://model.api.dataservices.server.platform.nolio.com/">
   <soap:Header/>
   <soap:Body>
      <mod:mapInstanceToEnvironment>        
         <mod:userName>username</mod:userName>        
         <mod:password>password</mod:password>        
         <mod:agent>Aget_Node_Id/HostName</mod:agent>        
         <mod:applicationName>Application_Name</mod:applicationName>        
         <mod:environment>Environemnt_Name</mod:environment>        
         <mod:serverTypeName>Server_Type_Name</mod:serverTypeName>
      </mod:mapInstanceToEnvironment>
   </soap:Body>
</soap:Envelope>

  • Remove an agent from an Environment
Method: removeInstanceFromEnvironment
Sample request:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:mod="http://model.api.dataservices.server.platform.nolio.com/">
   <soap:Header/>
   <soap:Body>
      <mod:removeInstanceFromEnvironment>        
         <mod:userName>username</mod:userName>        
         <mod:password>password</mod:password>        
         <mod:agent>Aget_Node_Id/HostName</mod:agent>        
         <mod:applicationName>Application_Name</mod:applicationName>        
         <mod:environment>Environemnt_Name</mod:environment>        
         <mod:serverTypeName>Server_Type_Name</mod:serverTypeName>
      </mod:removeInstanceFromEnvironment>
   </soap:Body>
</soap:Envelope>

  • Remove all agents from an Environment
Method: removeAllAgentsFromEnvironment
Sample request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:mod="http://model.api.dataservices.server.platform.nolio.com/">
   <soap:Header/>
   <soap:Body>
      <mod:removeAllAgentsFromEnvironment>        
         <mod:userName>username</mod:userName>        
         <mod:password>password</mod:password>        
         <mod:applicationName>Application_Name</mod:applicationName>        
         <mod:environment>Environemnt_Name</mod:environment>
      </mod:removeAllAgentsFromEnvironment>
   </soap:Body>
</soap:Envelope>

Attachments

1580971004732__ca-release-automation-6-4[ra_guide].pdf get_app