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

# GET settings/logging/snmpSettings

Retrieves SNMP settings.

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 | GET

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/snmpSettings

## Response Parameters

Attribute | Description
--- | ---
enableTrace boolean | Is traicing enabled.
logFileSettings LogFileSettingsDTO | The log file settings.
Attribute | Description
--- | ---
maxFileSize long | Maximum size of log file in MB
maxFilesCount int | Maximum number of log files.
traceAllIps boolean | Are all ip addresses traced.
traceDisplayValues boolean | Is tracing display values.
tracedIPs String[] | The traced IP addresses.

## 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://10.64.88.203/webacs/api/v1/op/settings/logging/snmpSettings

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <snmpSettingsDTO>
        <enableTrace>true</enableTrace>
        <logFileSettings>
          <maxFileSize>2</maxFileSize>
          <maxFilesCount>1</maxFilesCount>
        </logFileSettings>
        <traceAllIps>true</traceAllIps>
        <traceDisplayValues>true</traceDisplayValues>
        <tracedIPs>
          <tracedIP>String value</tracedIP>
          <tracedIP>Another string value</tracedIP>
        </tracedIPs>
      </snmpSettingsDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v1/op/settings/logging/snmpSettings.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/settings/logging/snmpSettings",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "snmpSettingsDTO" : {
          "enableTrace" : true,
          "logFileSettings" : {
            "maxFileSize" : 2,
            "maxFilesCount" : 1
          },
          "traceAllIps" : true,
          "traceDisplayValues" : true,
          "tracedIPs" : {
            "tracedIP" : ["String value",
            "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 | GET

## Resource URL

/webacs/api/v2/op/settings/logging/snmpSettings

Unmodified

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

## Response Parameters

Attribute | Description
--- | ---
enableTrace boolean | Is traicing enabled.
logFileSettings LogFileSettingsDTO | The log file settings.
Attribute | Description
--- | ---
maxFileSize long | Maximum size of log file in MB
maxFilesCount int | Maximum number of log files.
traceAllIps boolean | Are all ip addresses traced.
traceDisplayValues boolean | Is tracing display values.
tracedIPs String[] | The traced IP addresses.

## 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://10.64.88.203/webacs/api/v2/op/settings/logging/snmpSettings

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <snmpSettingsDTO>
        <enableTrace>true</enableTrace>
        <logFileSettings>
          <maxFileSize>2</maxFileSize>
          <maxFilesCount>1</maxFilesCount>
        </logFileSettings>
        <traceAllIps>true</traceAllIps>
        <traceDisplayValues>true</traceDisplayValues>
        <tracedIPs>
          <tracedIP>String value</tracedIP>
          <tracedIP>Another string value</tracedIP>
        </tracedIPs>
      </snmpSettingsDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/settings/logging/snmpSettings.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "snmpSettingsDTO" : [ {
          "enableTrace" : true,
          "logFileSettings" : {
            "maxFileSize" : 2,
            "maxFilesCount" : 1
          },
          "traceAllIps" : true,
          "traceDisplayValues" : true,
          "tracedIPs" : {
            "tracedIP" : [ "String value", "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 | GET

## Resource URL

/webacs/api/v3/op/settings/logging/snmpSettings

Unmodified

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

## Response Parameters

Attribute | Description
--- | ---
enableTrace boolean | Is traicing enabled.
logFileSettings LogFileSettingsDTO | The log file settings.
Attribute | Description
--- | ---
maxFileSize long | Maximum size of log file in MB
maxFilesCount int | Maximum number of log files.
traceAllIps boolean | Are all ip addresses traced.
traceDisplayValues boolean | Is tracing display values.
tracedIPs String[] | The traced IP addresses.

## 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://10.64.88.203/webacs/api/v3/op/settings/logging/snmpSettings

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
      <snmpSettingsDTO>
        <enableTrace>true</enableTrace>
        <logFileSettings>
          <maxFileSize>2</maxFileSize>
          <maxFilesCount>1</maxFilesCount>
        </logFileSettings>
        <traceAllIps>true</traceAllIps>
        <traceDisplayValues>true</traceDisplayValues>
        <tracedIPs>
          <tracedIP>String value</tracedIP>
          <tracedIP>Another string value</tracedIP>
        </tracedIPs>
      </snmpSettingsDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/settings/logging/snmpSettings.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
        "snmpSettingsDTO" : [ {
          "enableTrace" : true,
          "logFileSettings" : {
            "maxFileSize" : 2,
            "maxFilesCount" : 1
          },
          "traceAllIps" : true,
          "traceDisplayValues" : true,
          "tracedIPs" : {
            "tracedIP" : [ "String value", "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 | GET

## Resource URL

/webacs/api/v4/op/settings/logging/snmpSettings

Unmodified

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

## Response Parameters

Attribute | Description
--- | ---
enableTrace boolean | Is traicing enabled.
logFileSettings LogFileSettingsDTO | The log file settings.
Attribute | Description
--- | ---
maxFileSize long | Maximum size of log file in MB
maxFilesCount int | Maximum number of log files.
traceAllIps boolean | Are all ip addresses traced.
traceDisplayValues boolean | Is tracing display values.
tracedIPs String[] | The traced IP addresses.

## 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://10.64.88.203/webacs/api/v4/op/settings/logging/snmpSettings

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <snmpSettingsDTO>
        <enableTrace>true</enableTrace>
        <logFileSettings>
          <maxFileSize>2</maxFileSize>
          <maxFilesCount>1</maxFilesCount>
        </logFileSettings>
        <traceAllIps>true</traceAllIps>
        <traceDisplayValues>true</traceDisplayValues>
        <tracedIPs>
          <tracedIP>String value</tracedIP>
          <tracedIP>Another string value</tracedIP>
        </tracedIPs>
      </snmpSettingsDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v4/op/settings/logging/snmpSettings.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "snmpSettingsDTO" : [ {
          "enableTrace" : true,
          "logFileSettings" : {
            "maxFileSize" : 2,
            "maxFilesCount" : 1
          },
          "traceAllIps" : true,
          "traceDisplayValues" : true,
          "tracedIPs" : {
            "tracedIP" : [ "String value", "Another string value" ]
          }
        } ]
      }
    }