
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# PUT settings/logging/generalLoggingOptions

Updates general logging options for passed arguments.

Since Product Version: 3.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/op/settings/logging/generalLoggingOptions

## Request Payload Parameters

Attribute | Description
--- | ---
logFileSettings LogFileSettingsDTO | Log files setting: maximum number of files, and maximun file size.
Attribute | Description
--- | ---
maxFileSize long | Maximum size of log file in MB
maxFilesCount int | Maximum number of log files.
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".
Attribute | Description
--- | ---
enabled boolean | Is log for this module enabled.
moduleName String | Log module name.

## 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 Request Payload

https://172.20.127.108/webacs/api/v1/op/settings/logging/generalLoggingOptions

    <?xml version="1.0" ?>
    <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>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v1/op/settings/logging/generalLoggingOptions.json

    {
      "generalLoggingOptionsDTO" : {
        "logFileSettings" : {
          "maxFileSize" : 2,
          "maxFilesCount" : 1
        },
        "logMessageLevel" : "INFO",
        "logModules" : {
          "logModules" : [{
            "enabled" : true,
            "moduleName" : "String value"
          },
          {
            "enabled" : false,
            "moduleName" : "Another string value"
          }]
        }
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

## Resource URL

/webacs/api/v2/op/settings/logging/generalLoggingOptions

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
logFileSettings LogFileSettingsDTO | Log files setting: maximum number of files, and maximun file size.
Attribute | Description
--- | ---
maxFileSize long | Maximum size of log file in MB
maxFilesCount int | Maximum number of log files.
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".
Attribute | Description
--- | ---
enabled boolean | Is log for this module enabled.
moduleName String | Log module name.

## 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 Request Payload

https://172.20.127.108/webacs/api/v2/op/settings/logging/generalLoggingOptions

    <?xml version="1.0" ?>
    <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>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v2/op/settings/logging/generalLoggingOptions.json

    {
      "generalLoggingOptionsDTO" : {
        "logFileSettings" : {
          "maxFileSize" : 2,
          "maxFilesCount" : 1
        },
        "logMessageLevel" : "INFO",
        "logModules" : {
          "logModules" : [ {
            "enabled" : true,
            "moduleName" : "String value"
          }, {
            "enabled" : false,
            "moduleName" : "Another string value"
          } ]
        }
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

## Resource URL

/webacs/api/v3/op/settings/logging/generalLoggingOptions

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
logFileSettings LogFileSettingsDTO | Log files setting: maximum number of files, and maximun file size.
Attribute | Description
--- | ---
maxFileSize long | Maximum size of log file in MB
maxFilesCount int | Maximum number of log files.
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".
Attribute | Description
--- | ---
enabled boolean | Is log for this module enabled.
moduleName String | Log module name.

## 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 Request Payload

https://172.20.127.108/webacs/api/v3/op/settings/logging/generalLoggingOptions

    <?xml version="1.0" ?>
    <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>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v3/op/settings/logging/generalLoggingOptions.json

    {
      "generalLoggingOptionsDTO" : {
        "logFileSettings" : {
          "maxFileSize" : 2,
          "maxFilesCount" : 1
        },
        "logMessageLevel" : "INFO",
        "logModules" : {
          "logModules" : [ {
            "enabled" : true,
            "moduleName" : "String value"
          }, {
            "enabled" : false,
            "moduleName" : "Another string value"
          } ]
        }
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

## Resource URL

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

Unmodified

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

## Request Payload Parameters

Attribute | Description
--- | ---
logFileSettings LogFileSettingsDTO | Log files setting: maximum number of files, and maximun file size.
Attribute | Description
--- | ---
maxFileSize long | Maximum size of log file in MB
maxFilesCount int | Maximum number of log files.
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".
Attribute | Description
--- | ---
enabled boolean | Is log for this module enabled.
moduleName String | Log module name.

## 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 Request Payload

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

    <?xml version="1.0" ?>
    <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>

### Sample JSON Request Payload

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

    {
      "generalLoggingOptionsDTO" : {
        "logFileSettings" : {
          "maxFileSize" : 2,
          "maxFilesCount" : 1
        },
        "logMessageLevel" : "INFO",
        "logModules" : {
          "logModules" : [ {
            "enabled" : true,
            "moduleName" : "String value"
          }, {
            "enabled" : false,
            "moduleName" : "Another string value"
          } ]
        }
      }
    }