StatisticsPolicy

Defines the frequency of statistics collection associated with an object.

Overview

dataCollectionFrequency integer required   filterable   orderable  
description string filterable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  

API Resource

/statisticspolicies/id
delete get put

Parents

/zones/id/statisticspolicies
get post
/patnatpools/id/statisticspolicies
get post
/vports/id/statisticspolicies
get post
/subnets/id/statisticspolicies
get post
/domains/id/statisticspolicies
get post
/addressmaps/id/statisticspolicies
get post
/l2domains/id/statisticspolicies
get post
/aggregateddomains/id/statisticspolicies
get post
/nsports/id/statisticspolicies
get post

Children

/statisticspolicies/id/metadatas
get post
/statisticspolicies/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

dataCollectionFrequency integer required   filterable   orderable  
Discussion

How frequent to collect statistics in seconds

Charateristics

Min value: 1
SDK attribute: dataCollectionFrequency

description string filterable  
Discussion

A description of the statistics policy

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of statistics policy

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name