Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET settings/logging/generalLoggingOptions

Retrieves current general logging options with log modules names in alphabet case insensitive order.

Since Product Version: 3.2

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v4/op/settings/logging/generalLoggingOptions

Unmodified

This resource has not been modified since the previous API version.

Response Parameters

Attribute Description

logFileSettings LogFileSettingsDTO

Log files setting: maximum number of files, and maximun file size.

logMessageLevel LogMessageLevelEnum

Log message level: "INFO", "ERROR" or "TRACE".

Allowed values:

  • INFO
  • ERROR
  • TRACE

logModules LogModuleDTO[]

An ordered list of log module names with attribute "enabled".

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Response Payload

https://localhost/webacs/api/v4/op/settings/logging/generalLoggingOptions

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/settings/logging/generalLoggingOptions" rootUrl="https://localhost/webacs/api/v4/op">
  <generalLoggingOptionsDTO>
    <logFileSettings>
      <maxFileSize>2</maxFileSize>
      <maxFilesCount>1</maxFilesCount>
    </logFileSettings>
    <logMessageLevel>INFO</logMessageLevel>
    <logModules>
      <logModules>
        <enabled>true</enabled>
        <moduleName>String value</moduleName>
      </logModules>
      <logModules>
        <enabled>false</enabled>
        <moduleName>Another string value</moduleName>
      </logModules>
    </logModules>
  </generalLoggingOptionsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v4/op/settings/logging/generalLoggingOptions.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v4/op/settings/logging/generalLoggingOptions",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v4/op",
    "generalLoggingOptionsDTO" : [ {
      "logFileSettings" : {
        "maxFileSize" : 2,
        "maxFilesCount" : 1
      },
      "logMessageLevel" : "INFO",
      "logModules" : {
        "logModules" : [ {
          "enabled" : true,
          "moduleName" : "String value"
        }, {
          "enabled" : false,
          "moduleName" : "Another string value"
        } ]
      }
    } ]
  }
}