FIRE (3473) Dallas Los Angeles Sydney New York London

Transcription

1 Traditional project life cycles lasting 12+ months are increasingly putting organizations at a disadvantage to more nimble startups that can innovate and change direction at a faster pace. New Agile development methodologies such as Scrum and Kanban, the move to DevOps-aligned operations and cloud-enabled automation are all contributing to a more flexilble and dynamic business, but they introduce a new challenge for the business - When entirely new services can be planned, built and deployed on-demand, how can IT ensure optimal service delivery? FireScope solves this problem in two ways. First, API-integration with VMware, NetApp, Cisco and others enables the solution to identify changes in the environment as they happen, automatically adjusting data collection and event analysis to adapt to new, modified or decommissioned virtual machines, storage volumes and applications. Next, FireScope features a configuration web service. An organization s automation tools can be configured to use this web service as changes are being implemented to automatically add the new assets to FireScope s configuration and apply the appropriate templates for data collection and event analysis. This document will describe the processes and development concepts to leverage FireScope s configuration web service to create, edit and delete Configuration Items, apply templates and assign to service groups.

2 CAPABILITIES AT-A-GLANCE The FireScope configuration web service is designed to facilitate the automatic creation, update and deletion of Configuration Items (CI s), as well as the creation of new Logical Groups and Service Groups. Additionally, templates can be applied to CI s and they can be assigned to Logical Groups and Service Groups. Any modern programming language that can perform an HTTP request can use the configuration web service, maximizing the possibilities for automation. The web service itself is stateless, meaning that credentials must be passed with each request, eliminating the need for session management on the client-side. Later sections of this document will include code examples in a variety of languages to help users get started. USE CASES Service Catalog A user in the marketing department accesses the organization s service catalog and makes a request for a new business intelligence (BI) service. The request follows a prescribed approval workflow and after all approvals have been received, an automation tool deploys a new virtual machine using the BI-application image. As part of this process, it calls the FIreScope configuration web service, creating a Service Group called Marketing BI, creating a Configuration Item matching the name of the new VM, assigns the new CI to the Marketing BI Service Group and then applies the Business Intelligence template. Even before the user has access to this new service, FireScope is already collecting data around CPU utilization, JVM garbage collection and metrics unique to the BI application. All of this new data is analyzed in real-time against the Event Definitions associated with the template, and FireScope dashboard users now have a new collection of visual controls around the new service that can be added to their own dashboards. New Customer Implementation An interactive marketing agency uses a collection of custom-built automation scripts to streamline implementations for new customers, including deploying virtual machines, registering domains and generating landing pages. They recognize that optimal performance of their customers user experiences is essential, and as a result the script includes automatic generation of Configuration Items with appropriate templates for each virtual machine and associated with a Service Group created for that customer. These customers also received their own user accounts to access FireScope Unify dashboards displaying the real-time health and performance of their interactive campaigns, along with key business metrics to better understand the return on investment. Change Management The Change Advisory Board (CAB) approved a Request for Change (RFC) to implement a mass migration of applications from physical hosts to a new virtual environment. Implementing this change had a major risk factor; interruptions in visibility into service health, during which time incidents could occur that impair the business ability to support customer requests. In order to mitigate this risk, as well as reduce manual efforts during this project, FireScope s configuration web service was included in the implementation scripts. As each virtual machine was stood up, they had instant performance insight through FireScope Unify to verify successful startup before decommissioning the physical assets and simultaneously stopping data collection of the old infrastructure in FireScope. In effect, they were able to achieve overlapping visibility of the new and old environment that enabled them to identify and correct issues during the transition that might have been show stoppers for the entire project. REQUIREMENTS Any applicable security or network configuration settings will need to permit traffic between FireScope Unify and any client accessing the web service on ports 8048 (HTTP) or 8049 (secure HTTPS). Designated local account on the FireScope Unify appliance with Administratorlevel permissions. This account cannot be an LDAP or externally authenticated account. If using HTTPS, the web service uses a locally-signed certificate that may need to be downloaded locally to the client accessing the web service. Any programming or scripting language that supports the ability to generate HTTP requests. This may require additional class libraries or dependencies where necessary.

3 CALLING THE WEB SERVICE FireScope s configuration web service follows Simple Object Access Protocol (SOAP) and is listening on ports 8048 (clear-text HTTP) and 8049 (secure HTTPS). Best practice advice is to use the secure port whenever possible. The Web Service Description Language (WSDL) can be accessed through the primary FireScope Unify interface by going to the Administration menu and selecting Web Service. The web service can be accessed directly through the following URI. All calls to the web service will require authenticating using WS-Security headers and using a local FireScope user account with FireScope Administrative privileges. FireScope Unify Appliance>>:8048/services/FireScopeConfigurationWebService/v1 WEB SERVICE OPERATIONS createconfigurationitem This operation will create a new Configuration Item and apply basic settings and profile information. Please note that this operation only creates the CI, no data collection or event analysis will be carried out using this operation in isolation. After creating the CI, you will want to use the linktemplate operation to apply the appropriate set of attributes and event definitions to this CI, as well as the linklogicalgroup or linkservicegroup operations to properly place this CI in your service model. Parameters Parameter Required Type Description name Required String The name of the Configuration Item is what will be displayed in the FireScope web interface in any references to this CI. It is important that this name is unique, as all web service calls for update and deletion use the CI s name for lookup. status Required String (MONITORED, NOT_MONITORED, TEMPLATE) Denotes whether FireScope will actively be collecting data (MONITORED) from this CI, if it will be created in a disabled state (NOT_MONITORED) or if it is a template for other CI s (TEMPLATE). useip Required Boolean Will FireScope be using this CI s IP Address or DNS name for network lookups? If True, the IP Address will be used. dns Optional String The DNS name for this Configuration Item. If useip is set to false, this parameter must have a value. ip Optional String The IP Address for this Configuration Item. If useip is set to true, this parameter must have a value. port Optional Integer If using a FireScope Agent on this CI, and if the agent is listening on a non-standard port, this must be specified. proxyhost Optional String If a proxy CI is being used to connect to this CI, the proxy CI name must be supplied. vmname Optional String If you are using VMware API integration to collect data regarding this CI, this parameter should include the unique name used in your VMware configuration to locate this virtual center host or guest. profilename Optional String Optional name used in the profile section of the CI configuration. contact Optional String If a specific person is responsible for this CI, this field is useful for pointing this out. hardware Optional String Optional field to include information pertaining to the physical hardware this CI is running from. Useful for including manufacturer identification tags, model numbers, etc. location Optional String Optional field to describe the physical location of this CI. macaddress Optional String Optional field to include the CI s network MAC address. notes Optional String Any additional notes that may be useful for other users. os Optional String Optional field to describe the Operating System installed on this CI.

4 Parameter Required Type Description primarystacklayer Optional int If you are using the Service Stack lens for dashboarding, this designates which layer this CI will be assigned to. Options are: 1 User Experience 2 Application 3 Database 4 OS 5 Virtualization 6 Hardware 7 Network 8 Storage 9 Environmental secondarystacklayer Optional int If you are using the Service Stack lens and this CI applies to more than one category, a secondary designation can be identified here. serialno Optional String Optional field for including any relevant serial numbers for this CI. software Optional String Optional field for listing any software installed on this CI. tag Optional String Optional tags useful in describing this CI. type Optional String Optional classification of this CI, such as Server, MS SQL Server or application. url Optional String Optional web address for a knowledge base related to this CI. connections Optional If API s will be used to collect data from this CI, such as those from VMware, NetApp or Cisco, connectioninfo objects will need to be passed. Note that the connections themselves must be first configured in FireScope Unify. connection Optional connectioninfo type Required deviceconnectiontype Must be one of CISCO_UCS, LDAP, NETAPP, NETAPP_DFM or VM name Required String Name of the connection as used in FireScope Unify. createlogicalgroup (name: string) This operation will create a Logical Group. The only parameter is name. After using this operation, the linklogicalgroup operation can be called to associate CI s to the newly created Logical Group. createservicegroup (name: string, type: servicegrouptype) This operation will create a new Service Group and requires 2 parameters; name and type. The name parameter denotes the name for this service group. type will be one of the following: BUSINESS, FLEXPOD, INFRASTRUCTURE or OPERATIONAL. After using this operation, the linkservicegroup can be called to associate CI s or Logical Groups to this newly created Service Group. deleteconfigurationitem (name: string) This operation will mark a CI as being deleted and requires only a name parameter, which will be the name used in the creation of the CI. The CI will not be actually removed from the system, but all data collection and event analysis will be stopped and any associated event definitions will be removed from associated Aggregate Event Definitions and Policies. linklogicalgroup (logicalgroup: string, cis: ci) Calling this operation will link one or more CI s to a Logical Group. The first parameter, logicalgroup, is the unique name of the targeted Logical Group. The second parameter, cis, will list the CI names to be associated with this Logical Group. linkservicegroup (servicegroup: string, cis: ci, logicalgroups: logicalgroup) To link CI s or Logical Groups to a Service Group, use this operation. The first parameter will be the unique name for this Service Group. Next, you can optionally include a list of CI s that will be associated with the Service Group, followed by an optional list of Logical Groups.

5 linktemplate (template: string, ci: string, operation: templateoperation) This operation will apply a pre-defined set of Attributes, Event Definitions and Visual Controls to a CI or remove this set depending on the value specified for operation. The first parameter, template, denotes the name of the template being applied. Next, the ci parameter denotes the ci name that we are applying this template (or unlinking this template) to. Finally, the operation field will be one of CREATE_OR_UPDATE, UNLINK_AND_CLEAR or UNLINK to tell the web service to either apply the template to the CI or remove any association. updateconfigurationitem (currentname: string, newname: string, ip: string; dns: string, status: CIStatus) This operation is designed for quick, commonly used changes to specific CI s. Only the first parameter, currentname, is required, and is used to target the CI being updated. If the name of the CI needs to be changed, specify a new value using the newname parameter. If the IP address or DNS name of the CI is being changed, use the ip or dns parameter as appropriate. Finally, if the status of the CI needs to be updated, use one of MONITERED, NOT_MONITORED or TEMPLATE in the status parameter. REFERENCE CODE The following are sample code fragments in various languages, intended to help you get started using the FireScope configuration web service. PYTHON import suds from suds.wsse import * url = token = UsernameToken( user, password ) security = Security() security.tokens.append(token) client = suds.client.client(url) client.set_options(wsse = security) try: response = client.service.createlogicalgroup( Linux ) print response except WebFault, e: print e JAVA In the following example, loads a local XML file containing the web service operation payload. The source for the xml is on the right. package com.firescope.ws.client; import static org.apache.http.conn.ssl.sslsocketfactory.*; import java.io.bufferedinputstream; import java.io.bytearrayoutputstream; import java.io.file; import java.io.fileinputstream; import java.io.inputstream; import java.security.keystore; import org.apache.http.httpentity; import org.apache.http.httpresponse; import org.apache.http.client.httpclient; import org.apache.http.client.methods.httppost; import org.apache.http.conn.scheme.plainsocketfactory; import org.apache.http.conn.scheme.scheme; import org.apache.http.conn.scheme.schemeregistry; import org.apache.http.conn.ssl.sslsocketfactory; import org.apache.http.entity.fileentity; import org.apache.http.entity.stringentity; import org.apache.http.impl.client.defaulthttpclient; <?xml version= 1.0 encoding= UTF-8?> <soap:envelope xmlns= xmlns:soap= schemas.xmlsoap.org/soap/envelope/ xmlns:wsse= wss/2004/01/oasis wss-wssecurity-secext-1.0.xsd xmlns:wsu= > <soap:header> <wsse:security> <wsse:usernametoken wsu:id= UsernameToken > <wsse:username>admin</wsse:username> <wsse:password>password</wsse:password> </wsse:usernametoken> </wsse:security> </soap:header> <soap:body> <linklogicalgroup> <logicalgroup>ws Test LogicalGroup</logicalGroup> <cis> <ci>servername</ci> </cis> </linklogicalgroup> </soap:body> </soap:envelope> public class WebServiceClient { private static final Integer HTTP_PORT = 8048; private static final Integer HTTPS_PORT = 8049; private static final String SERVER = localhost ; private static final String KEYSTORE_TYPE = JKS ; private static final String TRUSTSTORE_PATH = C:/truststore.jks ; private static final String TRUSTSTORE_PASSWORD = password ; private static final String URL_PATTERN = %s://%s:%d/services/ FireScopeConfigurationWebService/v1 ; private final HttpClient httpclient; private String url;

6 public WebServiceClient(boolean secure) throws Exception { httpclient = createhttpclient(); url = createurl(secure); public String geturl() { return url; public void seturl(string url) { this.url = url; public String invoke(file file) throws Exception { HttpEntity entity = new FileEntity(file, text/xml ); return invoke(entity); public String invoke(string request) throws Exception { HttpEntity entity = new StringEntity(request); return invoke(entity); private String invoke(httpentity entity) throws Exception { HttpPost httppost = new HttpPost(url); httppost.setentity(entity); HttpResponse httpresponse = httpclient.execute(httppost); ByteArrayOutputStream outputstream = new ByteArrayOutputStream(); httpresponse.getentity().writeto(outputstream); String response = outputstream.tostring(); return response; private HttpClient createhttpclient() throws Exception { System.setProperty( javax.net.debug, ssl ); KeyStore truststore = getkeystore(truststore_path, TRUSTSTORE_PASSWORD); SSLSocketFactory sslsocketfactory = new SSLSocketFactory(null, null, null, truststore, null, null); sslsocketfactory.sethostnameverifier(allow_all_hostname_verifier); HttpClient httpclient = new DefaultHttpClient(); SchemeRegistry schemeregistry = httpclient.getconnectionmanager().getschemeregistry(); schemeregistry.register(new Scheme( http, PlainSocketFactory.getSocketFactory(), HTTP_PORT)); schemeregistry.register(new Scheme( https, sslsocketfactory, HTTPS_PORT)); return httpclient; private static KeyStore getkeystore(string path, String password) throws Exception { InputStream inputstream = null; KeyStore keystore = null; try { finally { inputstream = new BufferedInputStream(new FileInputStream(new File(path))); keystore = KeyStore.getInstance(KEYSTORE_TYPE); keystore.load(inputstream, password!= null? password.tochararray() : null); if (inputstream!= null) { inputstream.close(); return keystore; private String createurl(boolean secure) { int port = secure? HTTPS_PORT : HTTP_PORT; String protocol = secure? https : http ; String url = String.format(URL_PATTERN, protocol, SERVER, port); return url; public static void main(string[] args) { try { WebServiceClient webserviceclient = new WebServiceClient(false); String response = webserviceclient.invoke(new File( C:/request.xml )); System.out.println(response); catch (Exception e) { e.printstacktrace();