Administration API getVHosts() method

Custom.Adobe.FlashMediaServer.GetVHosts.QuerySuccess.Monitor (UnitMonitor)

Knowledge Base article:

Summary

Calls of an Adobe Flash Media Server API method that is used by the management pack are not possible.

The management pack makes use of this method for discovery, performance collection rules and availability monitors by querying the FMS Administrator web interface. If the call is not possible these processes will not work as expected.

The management pack uses the following methods:

Causes

- FMS Admin Windows Service not running

- No access to Administration API via HTTP

- Method execution not allowed

Resolutions

Make sure the FMS Admin Windows Service is running

Check that it is possible to call methods over HTTP

- Open fms.ini file in the /conf folder

- Make sure that USERS.HTTPCOMMAND_ALLOW is set to true

- Open Users.xml in the /conf folder and check the bold lines in the example below.

<Root>

<UserList>

  <!-- This tag defines an administrator for the server. -->

  <User name="${SERVER.ADMIN_USERNAME}">

  <Password encrypt="false">${SERVER.ADMIN_PASSWORD}</Password>        

<Allow>127.0.0.1</Allow>

  <Deny></Deny>

  <Order>Allow,Deny</Order>

</User>

</UserList>

 <AdminServer>

<HTTPCommands>

<Enable>true</Enable>                         <Allow>ping,getAdaptors,getApps,getAppStats,getServerStats,getVHosts,getVHostStats</Allow>

<Deny></Deny>

<Order>Allow,Deny</Order>

</HTTPCommands>

</AdminServer>

</Root>

- Restart the FMS Admin Service

External

More details can be found in the documentation of Adobe Flash Media Server. The following documents contain information on how to configure and use the API.

Element properties:

TargetCustom.Adobe.FlashMediaServer.x.Role
Parent MonitorSystem.Health.ConfigurationState
CategoryAvailabilityHealth
EnabledTrue
Alert GenerateTrue
Alert SeverityMatchMonitorHealth
Alert PriorityNormal
Alert Auto ResolveTrue
Monitor TypeCustom.Adobe.FlashMediaServer.GetDiscoveryQueries.MonitorType
RemotableFalse
AccessibilityPublic
Alert Message
Flash Server Administration API method getVHosts() failes
The Adobe Flash Server's Administration API method getVHosts() can not be called using the HTTP interface. When execiting the method, the error message was: {0}
RunAsDefault

Source Code:

<UnitMonitor ID="Custom.Adobe.FlashMediaServer.GetVHosts.QuerySuccess.Monitor" Accessibility="Public" Enabled="true" Target="Custom.Adobe.FlashMediaServer.x.Role" ParentMonitorID="Health!System.Health.ConfigurationState" Remotable="false" Priority="Normal" TypeID="Custom.Adobe.FlashMediaServer.GetDiscoveryQueries.MonitorType" ConfirmDelivery="false">
<Category>AvailabilityHealth</Category>
<AlertSettings AlertMessage="Custom.Adobe.FlashMediaServer.GetVHosts.QuerySuccess.Monitor.AlertMessage">
<AlertOnState>Warning</AlertOnState>
<AutoResolve>true</AutoResolve>
<AlertPriority>Normal</AlertPriority>
<AlertSeverity>MatchMonitorHealth</AlertSeverity>
<AlertParameters>
<AlertParameter1>$Data/Context/Property[@Name='getVHosts returncode']$</AlertParameter1>
</AlertParameters>
</AlertSettings>
<OperationalStates>
<OperationalState ID="QuerySucceeded" MonitorTypeStateID="Success" HealthState="Success"/>
<OperationalState ID="QueryFailed" MonitorTypeStateID="Failure" HealthState="Warning"/>
</OperationalStates>
<Configuration>
<IntervalSeconds>3780</IntervalSeconds>
<FMSAdminURL>$Target/Property[Type="Custom.Adobe.FlashMediaServer.x.Role"]/FMSAdminAddress$</FMSAdminURL>
<FMSIniFile>$Target/Property[Type="Custom.Adobe.FlashMediaServer.x.Role"]/FMSIniFile$</FMSIniFile>
<FMSAPIMethod>getVHosts</FMSAPIMethod>
<SuccessString>NetConnection.Call.Success</SuccessString>
<TimeoutSeconds>300</TimeoutSeconds>
</Configuration>
</UnitMonitor>