+<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <title>WildFly Full 31 Model Reference</title> <meta name="description" content=""> <link rel="stylesheet" href="../../../../../css/bootstrap.min.css"> <link rel="stylesheet" href="../../../../../css/bootstrap-reboot.min.css"> <link rel="stylesheet" href="../../../../../css/main.css"> </head> <body> <div class="container"> <div class="masthead"> <h3 class="text-muted my-3">WildFly Full 31 Model Reference</h3> </div> <ol class="breadcrumb"> <li class="breadcrumb-item"> <a href="../../../../../index.html">home</a> </li> <li class="breadcrumb-item"> <a href="../../../../../core-service/management/index.html">core-service=management</a> </li> <li class="breadcrumb-item"> <a href="../../../../../core-service/management/access/audit/index.html">access=audit</a> </li> <li class="breadcrumb-item active">file-handler</li> </ol> <div class="alert alert-danger"> <strong>Deprecated</strong> Since 1.7.0 <div>The management audit log configuration is deprecated and may be removed or moved in future versions.</div> </div> <div class="well"> <p>A file handler for use with the management audit logging service.</p> </div> <div class="page-header"> <h4 class="btn btn-secondary" data-toggle="collapse" data-target="#attributes">Attributes (7)</h4> <div class="collapse show" id="attributes"> <div class="panel"> <ul> <li> <a id="attr-disabled-due-to-failure" href="#attr-disabled-due-to-failure" data-toggle="collapse" data-target="#attribute-disabled-due-to-failure" class="">disabled-due-to-failure</a> Whether this handler has been disabled due to logging failures. </li> <div id="attribute-disabled-due-to-failure" class="collapse"> <div class="table-responsive"> <table class="table table-striped table-hover"> <thead> <tr> <th>Attribute</th> <th>Value</th> </tr> </thead> <tr> <td> <b>Type</b> </td> <td> BOOLEAN </td> </tr> <tr> <td> <b>Nillable</b> </td> <td> false </td> </tr> <tr> <td> <b>Expressions Allowed</b> </td> <td> false </td> </tr> <tr> <td> <b>Storage</b> </td> <td> runtime </td> </tr> <tr> <td> <b>Access Type</b> </td> <td> read-only </td> </tr> </table> </div> </div> <li> <a id="attr-failure-count" href="#attr-failure-count" data-toggle="collapse" data-target="#attribute-failure-count" class="">failure-count</a> The number of logging failures since the handler was initialized. </li> <div id="attribute-failure-count" class="collapse"> <div class="table-responsive"> <table class="table table-striped table-hover"> <thead> <tr> <th>Attribute</th> <th>Value</th> </tr> </thead> <tr> <td> <b>Type</b> </td> <td> INT </td> </tr> <tr> <td> <b>Nillable</b> </td> <td> false </td> </tr> <tr> <td> <b>Expressions Allowed</b> </td> <td> false </td> </tr> <tr> <td> <b>Storage</b> </td> <td> runtime </td> </tr> <tr> <td> <b>Access Type</b> </td> <td> read-only </td> </tr> </table> </div> </div> <li> <a id="attr-formatter" href="#attr-formatter" data-toggle="collapse" data-target="#attribute-formatter" class="">formatter</a> The formatter used to format the log messages. </li> <div id="attribute-formatter" class="collapse"> <div class="table-responsive"> <table class="table table-striped table-hover"> <thead> <tr> <th>Attribute</th> <th>Value</th> </tr> </thead> <tr> <td> <b>Type</b> </td> <td> STRING </td> </tr> <tr> <td> <b>Nillable</b> </td> <td> false </td> </tr> <tr> <td> <b>Expressions Allowed</b> </td> <td> false </td> </tr> <tr> <td> <b>Storage</b> </td> <td> configuration </td> </tr> <tr> <td> <b>Access Type</b> </td> <td> read-write </td> </tr> <tr> <td> <b>Restart Required</b> </td> <td> no-services </td> </tr> </table> </div> </div> <li> <a id="attr-max-failure-count" href="#attr-max-failure-count" data-toggle="collapse" data-target="#attribute-max-failure-count" class="">max-failure-count</a> The maximum number of logging failures before disabling this handler. </li> <div id="attribute-max-failure-count" class="collapse"> <div class="table-responsive"> <table class="table table-striped table-hover"> <thead> <tr> <th>Attribute</th> <th>Value</th> </tr> </thead> <tr> <td> <b>Default Value</b> </td> <td> 10 </td> </tr> <tr> <td> <b>Type</b> </td> <td> INT </td> </tr> <tr> <td> <b>Nillable</b> </td> <td> true </td> </tr> <tr> <td> <b>Expressions Allowed</b> </td> <td> true </td> </tr> <tr> <td> <b>Min</b> </td> <td> 0 </td> </tr> <tr> <td> <b>Max</b> </td> <td> 2,147,483,647 </td> </tr> <tr> <td> <b>Storage</b> </td> <td> configuration </td> </tr> <tr> <td> <b>Access Type</b> </td> <td> read-write </td> </tr> <tr> <td> <b>Restart Required</b> </td> <td> no-services </td> </tr> </table> </div> </div> <li> <a id="attr-path" href="#attr-path" data-toggle="collapse" data-target="#attribute-path" class="">path</a> The path of the audit log file. </li> <div id="attribute-path" class="collapse"> <div class="table-responsive"> <table class="table table-striped table-hover"> <thead> <tr> <th>Attribute</th> <th>Value</th> </tr> </thead> <tr> <td> <b>Type</b> </td> <td> STRING </td> </tr> <tr> <td> <b>Nillable</b> </td> <td> false </td> </tr> <tr> <td> <b>Expressions Allowed</b> </td> <td> true </td> </tr> <tr> <td> <b>Storage</b> </td> <td> configuration </td> </tr> <tr> <td> <b>Access Type</b> </td> <td> read-write </td> </tr> <tr> <td> <b>Restart Required</b> </td> <td> no-services </td> </tr> </table> </div> </div> <li> <a id="attr-relative-to" href="#attr-relative-to" data-toggle="collapse" data-target="#attribute-relative-to" class="">relative-to</a> The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. </li> <div id="attribute-relative-to" class="collapse"> <div class="table-responsive"> <table class="table table-striped table-hover"> <thead> <tr> <th>Attribute</th> <th>Value</th> </tr> </thead> <tr> <td> <b>Type</b> </td> <td> STRING </td> </tr> <tr> <td> <b>Nillable</b> </td> <td> true </td> </tr> <tr> <td> <b>Expressions Allowed</b> </td> <td> false </td> </tr> <tr> <td> <b>Storage</b> </td> <td> configuration </td> </tr> <tr> <td> <b>Access Type</b> </td> <td> read-write </td> </tr> <tr> <td> <b>Restart Required</b> </td> <td> no-services </td> </tr> </table> </div> </div> <li> <a id="attr-rotate-at-startup" href="#attr-rotate-at-startup" data-toggle="collapse" data-target="#attribute-rotate-at-startup" class="">rotate-at-startup</a> Whether the old log file should be rotated at server startup. </li> <div id="attribute-rotate-at-startup" class="collapse"> <div class="table-responsive"> <table class="table table-striped table-hover"> <thead> <tr> <th>Attribute</th> <th>Value</th> </tr> </thead> <tr> <td> <b>Default Value</b> </td> <td> true </td> </tr> <tr> <td> <b>Type</b> </td> <td> BOOLEAN </td> </tr> <tr> <td> <b>Nillable</b> </td> <td> true </td> </tr> <tr> <td> <b>Expressions Allowed</b> </td> <td> false </td> </tr> <tr> <td> <b>Storage</b> </td> <td> configuration </td> </tr> <tr> <td> <b>Access Type</b> </td> <td> read-write </td> </tr> <tr> <td> <b>Restart Required</b> </td> <td> no-services </td> </tr> </table> </div> </div> </ul> </div> </div> </div> <div class="page-header"> <h4 class="btn btn-secondary" data-toggle="collapse" data-target="#operations">Operations (3)</h4> <div class="collapse show" id="operations"> <ul> <li> <a id="op-add" href="#op-add" data-toggle="collapse" data-target="#operation-add" class="">add</a> Adds an audit log file handler. <div id="operation-add" class="collapse"> <table class="table table-striped"> <thead> <tr> <th>Request Parameter</th> <th>Type</th> <th>Required</th> <th>Expressions Allowed</th> <th>Default value</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>formatter</td> <td>STRING</td> <td>true</td> <td>false</td> <td></td> <td>The formatter used to format the log messages.</td> </tr> <tr> <td>max-failure-count</td> <td>INT</td> <td>false</td> <td>true</td> <td>10</td> <td>The maximum number of logging failures before disabling this handler.</td> </tr> <tr> <td>path</td> <td>STRING</td> <td>true</td> <td>true</td> <td></td> <td>The path of the audit log file.</td> </tr> <tr> <td>relative-to</td> <td>STRING</td> <td>false</td> <td>false</td> <td></td> <td>The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.</td> </tr> <tr> <td>rotate-at-startup</td> <td>BOOLEAN</td> <td>false</td> <td>false</td> <td>true</td> <td>Whether the old log file should be rotated at server startup.</td> </tr> </tbody> </table> </div> </li> <li> <a id="op-recycle" href="#op-recycle" data-toggle="collapse" data-target="#operation-recycle" class="">recycle</a> Resets the file handler failure count, and backs up the current log file. <div id="operation-recycle" class="collapse"> </div> </li> <li> <a id="op-remove" href="#op-remove" data-toggle="collapse" data-target="#operation-remove" class="">remove</a> Removes an audit log file handler. <div id="operation-remove" class="collapse"> </div> </li> </ul> </div> </div> <hr> <footer> <p>© Red Hat 2024</p> </footer> </div> <script src="../../../../../js/vendor/jquery-3.4.1.slim.min.js"></script> <script>window.jQuery || document.write('<script src="../../../../../js/vendor/jquery-3.4.1.slim.min.js"><\/script>')</script> <script src="../../../../../js/vendor/bootstrap.bundle.min.js"></script> <script src="../../../../../js/main.js"></script> <script src="../../../../../js/vendor/ie10-viewport-bug-workaround.js"></script> </body> </html>
0 commit comments