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

# GET WLCMemoryUtilizations

Represents the latest memory utilization collected from a WLAN controller.

Since Product Version: 3.1

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
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/data/WLCMemoryUtilizations

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
collectionTime long | The time on the server when the collection was performed, as milliseconds from the Unix epoch
ipAddress String | WLAN controller IP address
memoryFree long | The total amount of free memory in all controller memory pools
memoryPoolUtilization MemoryUtilization[] | Detailed utilization information per each controller memory pool
Attribute | Description
--- | ---
memoryFree long | Free memory
memoryTotal long | Total memory
memoryUsed long | Used memory
memoryUtilization int | Memory utilization
poolName String | Name of memory pool.
poolType int | The memory pool type. Memory pool can be predefined or dynamic. The following pool types are predefined: 1) processor memory; 2) i/o memory; 3) pci memory; 4) fast memory; 5) multibus memory; Dynamic pools can have pool type value greater than any of predefined type.
memoryTotal long | The total amount of memory in all controller memory pools
memoryUsed long | The total amount of used memory in all controller memory pools
memoryUtilization int | Common memory utilization for all controller memory pools
name String | WLAN controller 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 Payload

https://10.64.88.203/webacs/api/v1/data/WLCMemoryUtilizations/15

    <?xml version="1.0" ?>
    <queryResponse type="WLCMemoryUtilizations" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/WLCMemoryUtilizations/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="wLCMemoryUtilizationsDTO" type="WLCMemoryUtilizations" url="https://10.64.88.203/webacs/api/v1/data/WLCMemoryUtilizations/15">
        <wlcMemoryUtilizationsDTO displayName="String value" id="15" uuid="String value">
          <collectionTime>2</collectionTime>
          <memoryFree>2</memoryFree>
          <memoryPools>
            <memoryPool>
              <memoryFree>2</memoryFree>
              <memoryTotal>2</memoryTotal>
              <memoryUsed>2</memoryUsed>
              <memoryUtilization>1</memoryUtilization>
              <poolName>String value</poolName>
              <poolType>1</poolType>
            </memoryPool>
            <memoryPool>
              <memoryFree>12</memoryFree>
              <memoryTotal>12</memoryTotal>
              <memoryUsed>12</memoryUsed>
              <memoryUtilization>11</memoryUtilization>
              <poolName>Another string value</poolName>
              <poolType>11</poolType>
            </memoryPool>
          </memoryPools>
          <memoryTotal>2</memoryTotal>
          <memoryUsed>2</memoryUsed>
          <memoryUtilization>1</memoryUtilization>
          <name>String value</name>
          <ipAddress>String value</ipAddress>
        </wlcMemoryUtilizationsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/WLCMemoryUtilizations/15.json

    {
      "queryResponse" : {
        "@type" : "WLCMemoryUtilizations",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/WLCMemoryUtilizations/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "wLCMemoryUtilizationsDTO",
          "@type" : "WLCMemoryUtilizations",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/WLCMemoryUtilizations/15",
          "wlcMemoryUtilizationsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "collectionTime" : 2,
            "memoryFree" : 2,
            "memoryPools" : {
              "memoryPool" : [{
                "memoryFree" : 2,
                "memoryTotal" : 2,
                "memoryUsed" : 2,
                "memoryUtilization" : 1,
                "poolName" : "String value",
                "poolType" : 1
              },
              {
                "memoryFree" : 12,
                "memoryTotal" : 12,
                "memoryUsed" : 12,
                "memoryUtilization" : 11,
                "poolName" : "Another string value",
                "poolType" : 11
              }]
            },
            "memoryTotal" : 2,
            "memoryUsed" : 2,
            "memoryUtilization" : 1,
            "name" : "String value",
            "ipAddress" : "String value"
          }
        }
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/WLCMemoryUtilizations

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Unmodified

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

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
collectionTime long | The time on the server when the collection was performed, as milliseconds from the Unix epoch
ipAddress String | WLAN controller IP address
memoryFree long | The total amount of free memory in all controller memory pools
memoryPoolUtilization MemoryUtilization[] | Detailed utilization information per each controller memory pool
Attribute | Description
--- | ---
memoryFree long | Free memory
memoryTotal long | Total memory
memoryUsed long | Used memory
memoryUtilization int | Memory utilization
poolName String | Name of memory pool.
poolType int | The memory pool type. Memory pool can be predefined or dynamic. The following pool types are predefined: 1) processor memory; 2) i/o memory; 3) pci memory; 4) fast memory; 5) multibus memory; Dynamic pools can have pool type value greater than any of predefined type.
memoryTotal long | The total amount of memory in all controller memory pools
memoryUsed long | The total amount of used memory in all controller memory pools
memoryUtilization int | Common memory utilization for all controller memory pools
name String | WLAN controller 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 Payload

https://10.64.88.203/webacs/api/v2/data/WLCMemoryUtilizations/15

    <?xml version="1.0" ?>
    <queryResponse type="WLCMemoryUtilizations" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/WLCMemoryUtilizations/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="wLCMemoryUtilizationsDTO" type="WLCMemoryUtilizations" url="https://10.64.88.203/webacs/api/v2/data/WLCMemoryUtilizations/15">
        <wlcMemoryUtilizationsDTO displayName="String value" id="15" uuid="String value">
          <collectionTime>2</collectionTime>
          <memoryFree>2</memoryFree>
          <memoryPools>
            <memoryPool>
              <memoryFree>2</memoryFree>
              <memoryTotal>2</memoryTotal>
              <memoryUsed>2</memoryUsed>
              <memoryUtilization>1</memoryUtilization>
              <poolName>String value</poolName>
              <poolType>1</poolType>
            </memoryPool>
            <memoryPool>
              <memoryFree>12</memoryFree>
              <memoryTotal>12</memoryTotal>
              <memoryUsed>12</memoryUsed>
              <memoryUtilization>11</memoryUtilization>
              <poolName>Another string value</poolName>
              <poolType>11</poolType>
            </memoryPool>
          </memoryPools>
          <memoryTotal>2</memoryTotal>
          <memoryUsed>2</memoryUsed>
          <memoryUtilization>1</memoryUtilization>
          <name>String value</name>
          <ipAddress>String value</ipAddress>
        </wlcMemoryUtilizationsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/WLCMemoryUtilizations/15.json

    {
      "queryResponse" : {
        "@type" : "WLCMemoryUtilizations",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/WLCMemoryUtilizations/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "wLCMemoryUtilizationsDTO",
          "@type" : "WLCMemoryUtilizations",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/WLCMemoryUtilizations/15",
          "wlcMemoryUtilizationsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "collectionTime" : 2,
            "ipAddress" : "String value",
            "memoryFree" : 2,
            "memoryPools" : {
              "memoryPool" : [ {
                "memoryFree" : 2,
                "memoryTotal" : 2,
                "memoryUsed" : 2,
                "memoryUtilization" : 1,
                "poolName" : "String value",
                "poolType" : 1
              }, {
                "memoryFree" : 12,
                "memoryTotal" : 12,
                "memoryUsed" : 12,
                "memoryUtilization" : 11,
                "poolName" : "Another string value",
                "poolType" : 11
              } ]
            },
            "memoryTotal" : 2,
            "memoryUsed" : 2,
            "memoryUtilization" : 1,
            "name" : "String value"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/WLCMemoryUtilizations

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Unmodified

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

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
collectionTime long | The time on the server when the collection was performed, as milliseconds from the Unix epoch
ipAddress String | WLAN controller IP address
memoryFree long | The total amount of free memory in all controller memory pools
memoryPoolUtilization MemoryUtilization[] | Detailed utilization information per each controller memory pool
Attribute | Description
--- | ---
memoryFree long | Free memory
memoryTotal long | Total memory
memoryUsed long | Used memory
memoryUtilization int | Memory utilization
poolName String | Name of memory pool.
poolType int | The memory pool type. Memory pool can be predefined or dynamic. The following pool types are predefined: 1) processor memory; 2) i/o memory; 3) pci memory; 4) fast memory; 5) multibus memory; Dynamic pools can have pool type value greater than any of predefined type.
memoryTotal long | The total amount of memory in all controller memory pools
memoryUsed long | The total amount of used memory in all controller memory pools
memoryUtilization int | Common memory utilization for all controller memory pools
name String | WLAN controller 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 Payload

https://10.64.88.203/webacs/api/v3/data/WLCMemoryUtilizations/15

    <?xml version="1.0" ?>
    <queryResponse type="WLCMemoryUtilizations" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/WLCMemoryUtilizations/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="wLCMemoryUtilizationsDTO" type="WLCMemoryUtilizations" url="https://10.64.88.203/webacs/api/v3/data/WLCMemoryUtilizations/15">
        <wlcMemoryUtilizationsDTO displayName="String value" id="15" uuid="String value">
          <collectionTime>2</collectionTime>
          <memoryFree>2</memoryFree>
          <memoryPools>
            <memoryPool>
              <memoryFree>2</memoryFree>
              <memoryTotal>2</memoryTotal>
              <memoryUsed>2</memoryUsed>
              <memoryUtilization>1</memoryUtilization>
              <poolName>String value</poolName>
              <poolType>1</poolType>
            </memoryPool>
            <memoryPool>
              <memoryFree>12</memoryFree>
              <memoryTotal>12</memoryTotal>
              <memoryUsed>12</memoryUsed>
              <memoryUtilization>11</memoryUtilization>
              <poolName>Another string value</poolName>
              <poolType>11</poolType>
            </memoryPool>
          </memoryPools>
          <memoryTotal>2</memoryTotal>
          <memoryUsed>2</memoryUsed>
          <memoryUtilization>1</memoryUtilization>
          <name>String value</name>
          <ipAddress>String value</ipAddress>
        </wlcMemoryUtilizationsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/WLCMemoryUtilizations/15.json

    {
      "queryResponse" : {
        "@type" : "WLCMemoryUtilizations",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/WLCMemoryUtilizations/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "wLCMemoryUtilizationsDTO",
          "@type" : "WLCMemoryUtilizations",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/WLCMemoryUtilizations/15",
          "wlcMemoryUtilizationsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "collectionTime" : 2,
            "ipAddress" : "String value",
            "memoryFree" : 2,
            "memoryPools" : {
              "memoryPool" : [ {
                "memoryFree" : 2,
                "memoryTotal" : 2,
                "memoryUsed" : 2,
                "memoryUtilization" : 1,
                "poolName" : "String value",
                "poolType" : 1
              }, {
                "memoryFree" : 12,
                "memoryTotal" : 12,
                "memoryUsed" : 12,
                "memoryUtilization" : 11,
                "poolName" : "Another string value",
                "poolType" : 11
              } ]
            },
            "memoryTotal" : 2,
            "memoryUsed" : 2,
            "memoryUtilization" : 1,
            "name" : "String value"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/WLCMemoryUtilizations

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Updated

Since version 4 type of ipAddress attribute is InetAddress.

## Response Parameters

Attribute | Description
--- | ---
collectionTime long | The time on the server when the collection was performed, as milliseconds from the Unix epoch
ipAddress InetAddress | WLAN controller IP address
memoryFree long | The total amount of free memory in all controller memory pools
memoryPoolUtilization MemoryUtilization[] | Detailed utilization information per each controller memory pool
Attribute | Description
--- | ---
memoryFree long | Free memory
memoryTotal long | Total memory
memoryUsed long | Used memory
memoryUtilization int | Memory utilization
poolName String | Name of memory pool.
poolType int | The memory pool type. Memory pool can be predefined or dynamic. The following pool types are predefined: 1) processor memory; 2) i/o memory; 3) pci memory; 4) fast memory; 5) multibus memory; Dynamic pools can have pool type value greater than any of predefined type.
memoryTotal long | The total amount of memory in all controller memory pools
memoryUsed long | The total amount of used memory in all controller memory pools
memoryUtilization int | Common memory utilization for all controller memory pools
name String | WLAN controller 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 Payload

https://10.64.88.203/webacs/api/v4/data/WLCMemoryUtilizations/15

    <?xml version="1.0" ?>
    <queryResponse type="WLCMemoryUtilizations" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/WLCMemoryUtilizations/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="wLCMemoryUtilizationsDTO" type="WLCMemoryUtilizations" url="https://10.64.88.203/webacs/api/v4/data/WLCMemoryUtilizations/15">
        <wlcMemoryUtilizationsDTO displayName="String value" id="15" uuid="String value">
          <collectionTime>2</collectionTime>
          <memoryFree>2</memoryFree>
          <memoryPools>
            <memoryPool>
              <memoryFree>2</memoryFree>
              <memoryTotal>2</memoryTotal>
              <memoryUsed>2</memoryUsed>
              <memoryUtilization>1</memoryUtilization>
              <poolName>String value</poolName>
              <poolType>1</poolType>
            </memoryPool>
            <memoryPool>
              <memoryFree>12</memoryFree>
              <memoryTotal>12</memoryTotal>
              <memoryUsed>12</memoryUsed>
              <memoryUtilization>11</memoryUtilization>
              <poolName>Another string value</poolName>
              <poolType>11</poolType>
            </memoryPool>
          </memoryPools>
          <memoryTotal>2</memoryTotal>
          <memoryUsed>2</memoryUsed>
          <memoryUtilization>1</memoryUtilization>
          <name>String value</name>
          <ipAddress>
            <address>192.168.115.243</address>
          </ipAddress>
        </wlcMemoryUtilizationsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/WLCMemoryUtilizations/15.json

    {
      "queryResponse" : {
        "@type" : "WLCMemoryUtilizations",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/WLCMemoryUtilizations/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "wLCMemoryUtilizationsDTO",
          "@type" : "WLCMemoryUtilizations",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/WLCMemoryUtilizations/15",
          "wlcMemoryUtilizationsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "collectionTime" : 2,
            "ipAddress" : {
              "address" : "192.168.115.243"
            },
            "memoryFree" : 2,
            "memoryPools" : {
              "memoryPool" : [ {
                "memoryFree" : 2,
                "memoryTotal" : 2,
                "memoryUsed" : 2,
                "memoryUtilization" : 1,
                "poolName" : "String value",
                "poolType" : 1
              }, {
                "memoryFree" : 12,
                "memoryTotal" : 12,
                "memoryUsed" : 12,
                "memoryUtilization" : 11,
                "poolName" : "Another string value",
                "poolType" : 11
              } ]
            },
            "memoryTotal" : 2,
            "memoryUsed" : 2,
            "memoryUtilization" : 1,
            "name" : "String value"
          }
        } ]
      }
    }