visibility reporting reporting-db elastic-search¶
Configure Elastic Search
elastic-search Specification¶
Type Configuration Resource Element Name elastic-search Element URI /axapi/v3/visibility/reporting/reporting-db/elastic-search Element Attributes elastic-search_attributes Schema elastic-search schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/visibility/reporting/reporting-db/elastic-search | ||
Get Object | GET | /axapi/v3/visibility/reporting/reporting-db/elastic-search | ||
Modify Object | POST | /axapi/v3/visibility/reporting/reporting-db/elastic-search | ||
Replace Object | PUT | /axapi/v3/visibility/reporting/reporting-db/elastic-search | ||
Delete Object | DELETE | /axapi/v3/visibility/reporting/reporting-db/elastic-search |
elastic-search attributes¶
host-ipv4-address
Description Configure the server IPv4 address (Elastic Search server IPv4 address)
Type: string
Format: ipv4-address
Mutual Exclusion: host-ipv4-addresshost-ipv6-address, host-name and local-host are mutually exclusive
host-ipv6-address
Description Configure the server IPv6 address (Elastic Search IPv6 address)
Type: string
Format: ipv6-address
Mutual Exclusion: host-ipv6-addresshost-ipv4-address, host-name and local-host are mutually exclusive
host-name
Description Elastic Search host name(e.g www.a10networks.com)
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: host-namehost-ipv4-address, host-ipv6-address and local-host are mutually exclusive
http-port
Description Configure the http service port to use for REST API(default 9200) (Elastic Search http port(default 9200))
Type: number
Range: 1-65535
Default: 9200
http-protocol
Description ‘http’: Use http protocol; ‘https’: Use https protocol(default); (Elastic Search http protocol)
Type: string
Supported Values: http, https
Default: https
local-host
Description On-box Elastic Search service
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: local-hosthost-ipv4-address, host-ipv6-address and host-name are mutually exclusive
use-mgmt-port
Description Use management port for notifications
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters