References > Component Monitor Types > SOAP Component Monitor

SOAP component monitor

SOAP is a communication system that delivers and receives messages and instructions.

The SOAP component monitor supports automatic retries falling back through older cryptographic protocols to try completing a secure connection. The SOAP monitor will retry the connection while declaring support only for TLS1.2, thenTLS1.1, then TLS1.0, and finally SSL. If the target machine refuses a secure connection, the monitor returns an error.

Currently, the SOAP monitor within SAM can only detect the presence of a string and return a status of either Up or Down.

  • SOAP: (Simple Object Access Protocol) is a protocol used for exchanging information in the implementation of web services in computer networks. It relies on XML for its message format, and usually relies on other application layer protocols, most notably Hypertext Transfer Protocol (HTTP).
  • WSDL: (Web Services Description Language). The Web Services Description Language is an XML-based interface description language that is used for describing the functionality offered by a web service.
  • XML: Extensible Markup Language is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.

You can test the SOAP monitor in Edit mode. If the test poll throws a web exception (indicating that there was a problem on the target), the response content is extracted and you are able to view the message to help identify the issue.

Currently, the SOAP monitor within SAM can return a status of either Up or , or return a status of Warning or Critical based on response time thresholds. This monitor also has the ability to search for the presence of a string.

Polling using Orion agent for Linux

This component monitor has the following limitations for Orion agent for Linux polling methods.

Does not support Kerberos authentication. Only basic and digest authentication types are supported when this probe runs using Orion agent for Linux. For Kerebos authentication on a Linux-based computer, select Agentless for the Preferred Polling Method on the monitor.

If the version of Python is before 2.7.6, the Linux implementation does not support checking of Common Name (CN) and Certificate Authority (CA) errors for the SSL connection. If you configure the component monitor to Do Not Ignore CA/CN Errors or and the installed version of Python does not allow checking, polling fails with a message prompting you to disable these checks or switch to agent-less polling.

To resolve, consider one of the following options:

  • Continue using your current Python version and switching the option to Ignore CA/CN Errors. Be advised, these errors will be ignored.

  • Update the Python version to support Orion agent for Linux and these CN and CA checks. For details, see the Python site for downloads and install instructions.
  • Switch to agent-less polling.

Field Descriptions

Description

This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which is automatically saved. The variable to access this field is ${UserDescription}.

Component Type

This describes the type of monitor you are using.

Enable Component

This option determines whether or not the component is enabled. Disabling this component leaves it in the application as deactivated and does not influence application availability or status.

Credential for Monitoring

Select the credentials needed for monitoring this component.

SOAP XML Request

You can either choose to load XML from a WSDL file or manually enter the XML. If you choose to manually enter the SOAP XML request, you must populate the following fields:

Manually entering the SOAP XML request displays the following fields

  • Web Service Server URL: The http(s) address of web server. For example: https://localhost:17778/SolarWinds/InformationService/v3?wsdl
  • SOAP Action: Indicates the intent of the SOAP HTTP request. For example: http://schemas.solarwinds.com/2007/08/InformationService/QueryXml
  • SOAP Version: Select either 1.1 or 1.2 from the drop down list.
  • SOAP XML: This is the XML envelope.

Loading the SOAP XML from a WSDL displays the following fields once the WSDL is successfully loaded:

  • Web Service Server URL:The http(s) address of web server. For example: https://localhost:17778/SolarWinds/InformationService/v3?wsdl
  • Binding: Displays the type of binding detected in the WSDL.
  • Service Name: Displays the service name detected in the WSDL.
  • Method Name: Displays the method name detected in the WSDL.
  • Query: This is a dynamically generated field for Simple and Complex method parameters where you can input values that you can include as part of the SOAP message. May not be present depending upon the type of argument used.
  • Parameters: This is a dynamically generated field for Simple and Complex method parameters where you can input values that you can include as part of the SOAP message. May not be present depending upon the type of argument used.
  • Method Name Space: The unique identifier for the method. This definitional information is extracted from the WSDL file.
  • Schema Name Space: The unique identifier for the schema. This definitional information is extracted from the WSDL file.
  • SOAP Action: The unique name for the method itself. This definitional information is extracted from the WSDL file.
  • SOAP Version: Displays the SOAP version detected in the WSDL. This definitional information is extracted from the WSDL file.
  • SOAP XML: Content for this field is dynamically generated by changing the other SOAP settings. This field serves for reviewing the envelope. Advanced users can edit the content in this field.

For more information, see Configure the SOAP monitor.

Host Header

Enter the address of the host header. For example, www.solarwinds.com.

HTTP User Agent

This identifies the client that is making the request. For example, Google Chrome identifies itself as “Mozilla/5.0 (Windows NT 6.2; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/32.0.1667.0 Safari/537.36” Some web services may behave differently based on the user agent.

HTTP Content Type

Indicates the format of the content of the message. With SOAP, this can either be application/soap+xml or text/xml.

Authenticate Mode

Select an option for the authentication of the HTTPS: Normal, PreAuthenticate, or AlwaysAuthenticate.

Accept Compression

Indicates to the server whether or not the client supports compression of the data.

Certificate Subject

The subject of the certificate to match against.

Ignore CA Errors

Decide whether or not to ignore any errors verifying the Certificate Authority. This can occur if the certificate is self-signed or if the certificate was not installed correctly on the server.

Ignore CN Errors

Ignore Common Name error. This occurs when the Common Name of the certificate does not match the name of the server that is in the URL.

Use Proxy

This option allows you to tell the monitor whether or not it is going through a proxy connection.

Proxy Address

Enter the address for the proxy connection, if enabled.

Search String

Allows you to enter a string to test for its presence.

Fail if Found

Select either Yes or No to determine if this monitor reports a status of Fail if the string is found.

Response Time Threshold

Select and enter appropriate thresholds for Warning and Critical statuses. See setting Application Monitor Thresholds for more information.

User Notes

This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}.