Monitoring
Global Operations
Resource path:
/global-config/services/monitoring
Resource version: 1.0
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action Monitoring --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action Monitoring --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action Monitoring --global --actionName nextdescendents
update
Usage
am> update Monitoring --global --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "authfilePath" : { "title" : "Monitoring HTTP interface authentication file path", "description" : "Path to the monitoring system authentication file<br><br>The <code>openam_mon_auth</code> file contains the username and password of the account used to protect the monitoring interfaces. The default username is <code>demo</code> with a password of <code>changeit</code>. Use the <code>ampassword</code> command to encrypt a new password.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" }, "snmpEnabled" : { "title" : "Monitoring SNMP interface status", "description" : "Enable / Disable the SNMP access to the monitoring system", "propertyOrder" : 800, "required" : true, "type" : "boolean", "exampleValue" : "" }, "sessionHistoryWindowSize" : { "title" : "Session monitoring history size", "description" : "Size of the window of most recent session operations to record to expose via monitoring system. Valid range is 100 - 1000000.", "propertyOrder" : 1000, "required" : true, "type" : "integer", "exampleValue" : "" }, "enabled" : { "title" : "Monitoring Status", "description" : "Enable / Disable the monitoring system", "propertyOrder" : 100, "required" : true, "type" : "boolean", "exampleValue" : "" }, "rmiPort" : { "title" : "Monitoring RMI Port", "description" : "Port number for the JMX monitoring interface", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" }, "policyHistoryWindowSize" : { "title" : "Policy evaluation monitoring history size", "description" : "Size of the window of most recent policy evaluations to record to expose via monitoring system. Valid range is 100 - 1000000.", "propertyOrder" : 900, "required" : true, "type" : "integer", "exampleValue" : "" }, "httpEnabled" : { "title" : "Monitoring HTTP interface status", "description" : "Enable / Disable the HTTP access to the monitoring system ", "propertyOrder" : 300, "required" : true, "type" : "boolean", "exampleValue" : "" }, "snmpPort" : { "title" : "Monitoring SNMP Port", "description" : "Port number for the SNMP monitoring interface", "propertyOrder" : 700, "required" : true, "type" : "integer", "exampleValue" : "" }, "httpPort" : { "title" : "Monitoring HTTP Port", "description" : "Port number for the HTTP monitoring interface", "propertyOrder" : 200, "required" : true, "type" : "integer", "exampleValue" : "" }, "rmiEnabled" : { "title" : "Monitoring RMI interface status", "description" : "Enable / Disable the JMX access to the monitoring system", "propertyOrder" : 600, "required" : true, "type" : "boolean", "exampleValue" : "" } } }