::nsmcp::Tool ::nsmcp::Tool describe execute name permission validate ::nx::Object ::nx::Object ::nsmcp::Tool->::nx::Object ::nsmcp::ConfigurationTool ::nsmcp::ConfigurationTool credentialParameter execute options sections validate value ::nsmcp::ConfigurationTool->::nsmcp::Tool

Class ::nsmcp::ConfigurationTool

::nsmcp::ConfigurationTool[i] create ... \
           [ -authorizer:required authorizer:required ] \
           [ -description (default "Inspect live NaviServer configuration for configuration reviews, SMTP policy interpretation and scaling advice. scope=server (default) returns process-wide sections plus the authenticated virtual server's sections, excluding other virtual servers. scope=process returns every section across all virtual servers and requires diagnostics.configuration.process.read in addition to diagnostics.runtime.read. Includes driver, database-pool, connection-pool, limit, logging and module settings. Policy scripts are returned as data and are never executed. Named credential values and URI userinfo are redacted; referenced files are not read. Configuration reflects the current configuration table, including defaults published there by modules, not necessarily every compiled default or a historical policy. Use section to select an exact section and its descendants. Follow nextArguments to retrieve remaining sections. Pair with server_topology and server_runtime for actual installed components and utilization.") ] \
           [ -inputSchema (default "{} object {type string object properties object { scope object {type string string enum array {0 string server 1 string process} default string server} section object {type string string description string {Exact section prefix, including descendants; defaults to all authorized sections.}} limit object {type string integer minimum number 1 maximum number 100 default number 50} offset object {type string integer minimum number 0 default number 0} } additionalProperties boolean false}") ] \
           [ -name (default "configuration") ] \
           [ -outputSchema (default "") ] \
           [ -permission (default "diagnostics.runtime.read") ] \
           [ -redactor:required redactor:required ]

Defined in /usr/local/ns/tcl/nsmcp/config-tools.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nsmcp::Tool[i]

Methods (to be applied on instances)

  • execute (scripted, public)

     <instance of nsmcp::ConfigurationTool[i]> execute context arguments
    Parameters:
    context (required)
    arguments (required)

    Testcases:
    No testcase defined.
  • validate (scripted, public)

     <instance of nsmcp::ConfigurationTool[i]> validate arguments
    Parameters:
    arguments (required)

    Testcases:
    No testcase defined.