EsIndexConfig

Elasticsearch Index configuration

Overview

associatedEsIlmPolicyId string
configStatus enum (FAILED | IN_PROGRESS | SUCCESS) read only   filterable   orderable  
description string read only   filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
ilmStatus enum (FAILED | SUCCESS) read only   filterable   orderable  
indexPattern string required   read only   filterable   orderable  
indexType enum (NUAGE_ACL | NUAGE_ADDRESSMAP | NUAGE_DPI_FLOWSTATS | NUAGE_DPI_PROBESTATS | NUAGE_DPI_SLASTATS | NUAGE_EVENT | NUAGE_FEC | NUAGE_FLOW | NUAGE_GW_SEL_STATS | NUAGE_IKE_PROBE_STATUS | NUAGE_IKE_PROBESTATS | NUAGE_IKE_STATS | NUAGE_LTE | NUAGE_NATT | NUAGE_SYSMON | NUAGE_VLAN | NUAGE_VNF | NUAGE_VPORT | NUAGE_VPORT_QOS | NUAGE_WIFI) required   read only   filterable   orderable  
name string required   read only   filterable   orderable  
numShards integer required   filterable   orderable  
policyName string read only   filterable   orderable  
rolloverAlias string required   read only   filterable   orderable  

API Resource

/esindexconfigs/id
get put

Parents

/esindexconfigs
get put

Children

/esindexconfigs/id/permissions
delete get post put
/esindexconfigs/id/metadatas
get post
/esindexconfigs/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedEsIlmPolicyId string
Discussion

The UUID of the associated EsIlmPolicy object with ES Index Config.

Charateristics

Format: free
Max length: 225
SDK attribute: associatedEsIlmPolicyId

configStatus enum read only   filterable   orderable  
Discussion

Configuration status of ES Config.

Charateristics

Allowed values: FAILED, IN_PROGRESS, SUCCESS
SDK attribute: configStatus

description string read only   filterable   orderable  
Discussion

Description of the ES Index Config.

Charateristics

Format: free
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

ilmStatus enum read only   filterable   orderable  
Discussion

Index Life Management Status.

Charateristics

Allowed values: FAILED, SUCCESS
SDK attribute: ilmStatus

indexPattern string required   read only   filterable   orderable  
Discussion

The wildcard pattern for the specific ES index

Charateristics

Format: free
Max length: 255
SDK attribute: indexPattern

indexType enum required   read only   filterable   orderable  
Discussion

The enum value corresponding to an ES index.

Charateristics

Allowed values: NUAGE_ACL, NUAGE_ADDRESSMAP, NUAGE_DPI_FLOWSTATS, NUAGE_DPI_PROBESTATS, NUAGE_DPI_SLASTATS, NUAGE_EVENT, NUAGE_FEC, NUAGE_FLOW, NUAGE_GW_SEL_STATS, NUAGE_IKE_PROBE_STATUS, NUAGE_IKE_PROBESTATS, NUAGE_IKE_STATS, NUAGE_LTE, NUAGE_NATT, NUAGE_SYSMON, NUAGE_VLAN, NUAGE_VNF, NUAGE_VPORT, NUAGE_VPORT_QOS, NUAGE_WIFI
SDK attribute: indexType

name string required   read only   filterable   orderable  
Discussion

Name of the ES Index Config.

Charateristics

Format: free
Max length: 255
SDK attribute: name

numShards integer required   filterable   orderable  
Discussion

The number of primary shards for this index.

Charateristics

Default value: 3
Min value: 1
Max value: 100
SDK attribute: numShards

policyName string read only   filterable   orderable  
Discussion

The associated EsIlmPolicy name.

Charateristics

Format: free
Min length: 1
Max length: 100
SDK attribute: policyName

rolloverAlias string required   read only   filterable   orderable  
Discussion

The rollover alias for the specific ES index.

Charateristics

Format: free
Max length: 255
SDK attribute: rolloverAlias