Network Insight API Reference Data Structures
{
"field": "string",
"aggregation_type": "string",
"order": "string"
}
field
aggregation_type
order
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "string"
}
field
aggregation_type
{
"entity_type": "Flow",
"filter": "destination_ip.ip_address = '1.1.1.1'",
"aggregations": [
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "SUM"
}
],
"time_range": {
"start_time": 1534410000,
"end_time": 1534410559
}
}
query filter
{
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
],
"total_count": "integer",
"start_time": "integer",
"end_time": "integer"
}
total_count
start_time
end_time
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
field
aggregation_type
value
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
code
message
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"create_time": "integer",
"created_by": "string",
"last_modified_time": "integer",
"last_modified_by": "string"
}
{
"service_endpoint_count": "integer",
"groups": [
{
"group_id": "string",
"entity_id": "string",
"entity_type": "string",
"flow_summary": {
"ingress_bytes": "integer",
"egress_bytes": "integer"
}
}
],
"start_time": "integer",
"end_time": "integer"
}
service_endpoint_count
start_time
end_time
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
entity_id
entity_type
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
],
"cursor": "string"
}
cursor
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"created_by": "string",
"creation_time": "integer",
"last_modified_by": "string",
"last_modified_time": "integer",
"source": "string",
"tiers": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
]
}
]
}
entity_id
entity_type
name
created_by
creation_time
last_modified_by
last_modified_time
source
{
"name": "string"
}
name
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"created_by": "string",
"creation_time": "integer",
"last_modified_by": "string",
"last_modified_time": "integer",
"source": "string",
"tiers": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
]
}
]
}
],
"cursor": "string",
"total_count": "integer"
}
cursor
total_count
{
"referred_entity": {
"entity_id": "1000:104:12213212",
"entity_type": "string"
},
"name": "string",
"value": "string",
"vendor_type": "string"
}
name
value
vendor_type
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"results": [
{
"ip_address": "string",
"user_name": "string",
"entity_type": "string",
"entity_id": "string",
"operation": "string",
"response": "string",
"value": "string",
"timestamp": "integer"
}
],
"cursor": "ML12eu02==",
"start_time": 1504739809,
"end_time": 1504739809
}
cursor
start_time
end_time
{
"username": "admin@local",
"operation": "LOGIN",
"time_range": {
"start_time": 1534410000,
"end_time": 1534410559
},
"size": 10,
"cursor": "string"
}
user_name
ip_address
entity_type
entity_id
operation
response
size
cursor
{
"ip_address": "string",
"user_name": "string",
"entity_type": "string",
"entity_id": "string",
"operation": "string",
"response": "string",
"value": "string",
"timestamp": "integer"
}
ip_address
user_name
entity_type
entity_id
operation
response
value
timestamp
{
"azure_client": "string",
"azure_key": "string",
"azure_tenant": "string",
"azure_subscription": "string"
}
azure_client
azure_key
azure_tenant
azure_subscription
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"azure_client": "string",
"azure_key": "string",
"azure_tenant": "string",
"azure_subscription": "string"
},
"flows_enabled": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"azure_client": "string",
"azure_key": "string",
"azure_tenant": "string",
"azure_subscription": "string"
},
"flows_enabled": "boolean"
}
{
"config_filter": {
"applications": "boolean",
"snmp": "boolean",
"smtp": "boolean",
"data_sources": "boolean",
"analytics_thresholds": "boolean",
"analytics_outliers": "boolean",
"events": "boolean",
"syslog": "boolean",
"pinboards": "boolean",
"ldap": "boolean",
"vidm": "boolean",
"user_data": "boolean",
"user_preferences": "boolean",
"physical_subnet_vlan": "boolean",
"saved_searches": "boolean",
"physical_ip_dns_mapping": "boolean",
"east_west_ip": "boolean",
"north_south_ip": "boolean"
},
"backup_schedule": {
"enable": "boolean",
"schedule_period": "DAILY",
"minute": 30,
"hour": 12,
"day_of_week": 1
},
"backup_file_server_type": "SSH",
"local_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"ssh_file_server": {
"server_address": "10.234.12.134",
"port": 22,
"username": "testuser",
"password": "password",
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"ftp_file_server": {
"server_address": "10.234.12.134",
"port": 21,
"username": "testuser",
"password": "password",
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"schedule_now": "boolean"
}
True, to run backup now (on demand)
{
"status": "IN_PROGRESS",
"backup_file_name": "vrni_backup-10000-2020-12-15-13-00-40.tar",
"status_updated_timestamp": 1589908165162
}
Status of currently executing or last backup-restore job
File name of backup tar file
TimeStamp of the last status update
{
"enable": "boolean",
"schedule_period": "DAILY",
"minute": 30,
"hour": 12,
"day_of_week": 1
}
True, to enable scheduled backup
The minute at which backup needs to run (permitted values 0 - 59)
The hour at which backup needs to run (permitted values 0 - 23)
The day of the week when backup to be scheduled (permitted values 1 - 7)
Backup Schedule period.
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}
entity_id
ip
fqdn
proxy vm which should register this vcenter
nickname
enabled
notes
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}
ip
fqdn
proxy vm which should register this vcenter
nickname
enabled
notes
{
"entity_id": "string",
"name": "string",
"entity_type": "string"
}
entity_id
name
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"exclusions": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
},
"version": "string",
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"exclusions": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
],
"direction": "string"
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"ip_ranges": [
{
"start_ip": "string",
"end_ip": "string"
}
],
"ip_numeric_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"parent_security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"direct_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"direct_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"indirect_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"indirect_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"vendor_id": "string",
"vendor": "string"
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"network_addresses": [
"string"
],
"gateways": [
"string"
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string"
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string"
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"direct_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"direct_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"indirect_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"indirect_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"parents": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"direct_members": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"vendor_id": "string",
"excluded_members": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"protocol": "string",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"default_gateway": "string",
"vnics": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"source_firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"destination_firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"ip_sets": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"layer2_network": {
"entity_id": "string",
"entity_type": "string"
},
"vlan": {
"begin": "integer",
"end": "integer"
},
"vm": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"field": "string",
"value": "string"
}
field
value
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"entity": {
"entity_id": "string",
"name": "string",
"entity_type": "string"
},
"time": "integer"
}
]
}
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer",
"time": "integer"
}
]
}
{
"value": "integer",
"is_approx": "boolean"
}
value
is_approx
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"switch_type": "string"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"switch_type": "string"
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"total_cpus": "integer",
"total_memory": "integer",
"num_cpu_cores": "integer",
"vendor_id": "string",
"num_hosts": "integer",
"num_datastores": "integer",
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
},
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"applications": "boolean",
"snmp": "boolean",
"smtp": "boolean",
"data_sources": "boolean",
"analytics_thresholds": "boolean",
"analytics_outliers": "boolean",
"events": "boolean",
"syslog": "boolean",
"pinboards": "boolean",
"ldap": "boolean",
"vidm": "boolean",
"user_data": "boolean",
"user_preferences": "boolean",
"physical_subnet_vlan": "boolean",
"saved_searches": "boolean",
"physical_ip_dns_mapping": "boolean",
"east_west_ip": "boolean",
"north_south_ip": "boolean"
}
applications
snmp
smtp
data_sources
analytics_thresholds
analytics_outliers
events
syslog
pinboards
ldap
vidm
user_data
user_preferences
physical_subnet_vlan
saved_searches
physical_ip_dns_mapping
east_west_ip
north_south_ip
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"manager_id": "192.168.10.1",
"credentials": {
"kubeconfig": "string"
}
}
cursor from previous response
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
Entity Identifier
{
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
],
"total_count": 1
}
total_count
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"switch_type": "string"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"switch_type": "string"
}
{
"entity_id": "string",
"entity_type": "string",
"entity_name": "string",
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string",
"entity_name": "string",
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
]
}
}
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"entity_name": "string",
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string",
"entity_name": "string",
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
]
}
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
},
"distributed_virtual_switch": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
},
"hosts": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"domain_type": "LDAP",
"value": "example.com"
}
domain_type
domain value, not required for LOCAL domain
end time for query in epoch seconds
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
Entity Identifier
{
"entity_id": "string",
"entity_type": "string",
"time": "integer"
}
Entity Identifier
time
{
"results": [
{
"metric": "string",
"display_name": "string",
"intervals": [
"integer"
],
"description": "string",
"unit": "string"
}
]
}
{
"entity_id": "string",
"entity_type": "string",
"time": "integer",
"name": "string"
}
{
"entity_id": "string",
"entity_type": "string",
"entity": {
"entity_id": "string",
"name": "string",
"entity_type": "string"
},
"time": "integer"
}
Entity Identifier
time
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
code
message
target
{
"entity_type": "string",
"name": "string",
"help_text": "string",
"severity": "string",
"tags": [
"string"
],
"supported_entity_types": [
"string"
],
"supported_manager_types": [
"string"
],
"impact": "string",
"recommendations": [
"string"
]
}
entity_type
name
help_text
severity
tags
supported_entity_types
supported_manager_types
impact
recommendations
{
"results": [
{
"entity_type": "string",
"name": "string",
"help_text": "string",
"severity": "string",
"tags": [
"string"
],
"supported_entity_types": [
"string"
],
"supported_manager_types": [
"string"
],
"impact": "string",
"recommendations": [
"string"
]
}
]
}
status of event open or closed
event tags
type of event, e.g UserDefinedProblemEvent
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_ids": [
{
"entity_id": "string",
"entity_type": "string",
"time": "integer"
}
]
}
entity_ids
File Server type.
{
"firewall_entity_id": {
"entity_id": "string",
"entity_type": "string"
},
"vendor_info": {
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
},
"manager": {
"entity_id": "string",
"entity_type": "string"
},
"rules": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
]
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"source_vm": {
"entity_id": "string",
"entity_type": "string"
},
"destination_vm": {
"entity_id": "string",
"entity_type": "string"
},
"source_vnic": {
"entity_id": "string",
"entity_type": "string"
},
"destination_vnic": {
"entity_id": "string",
"entity_type": "string"
},
"source_vpc": {
"entity_id": "string",
"entity_type": "string"
},
"destination_vpc": {
"entity_id": "string",
"entity_type": "string"
},
"source_cloud_network": {
"entity_id": "string",
"entity_type": "string"
},
"destination_cloud_network": {
"entity_id": "string",
"entity_type": "string"
},
"source_azure_nsg": {
"entity_id": "string",
"entity_type": "string"
},
"destination_azure_nsg": {
"entity_id": "string",
"entity_type": "string"
},
"source_datacenter": {
"entity_id": "string",
"entity_type": "string"
},
"destination_datacenter": {
"entity_id": "string",
"entity_type": "string"
},
"source_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"destination_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"source_l2_network": {
"entity_id": "string",
"entity_type": "string"
},
"destination_l2_network": {
"entity_id": "string",
"entity_type": "string"
},
"port": {
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
},
"source_folders": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destination_folders": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"source_resource_pool": {
"entity_id": "string",
"entity_type": "string"
},
"destination_resource_pool": {
"entity_id": "string",
"entity_type": "string"
},
"source_cluster": {
"entity_id": "string",
"entity_type": "string"
},
"destination_cluster": {
"entity_id": "string",
"entity_type": "string"
},
"protocol": "string",
"source_ip_sets": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destination_ip_sets": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"source_security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destination_security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"traffic_type": "string",
"source_security_tags": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destination_security_tags": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"source_host": {
"entity_id": "string",
"entity_type": "string"
},
"destination_host": {
"entity_id": "string",
"entity_type": "string"
},
"source_vm_tags": [
"string"
],
"destination_vm_tags": [
"string"
],
"within_host": "boolean",
"firewall_action": "string",
"firewall_rule_id": "string",
"flow_tag": [
"string"
]
}
{
"ingress_bytes": "integer",
"egress_bytes": "integer"
}
ingress_bytes
egress_bytes
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"server_address": "10.234.12.134",
"port": 21,
"username": "testuser",
"password": "password",
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
}
IP address or hostname of destination FTP file server
File transfer port
username to login FTP server
password for the user to login FTP server
directory on file server to store/fetch backups
filename of the backup to be restored (used during restore only)
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"group_id": "string",
"entity_id": "string",
"entity_type": "string",
"flow_summary": {
"ingress_bytes": "integer",
"egress_bytes": "integer"
}
}
group_id
entity_id
entity_type
EntityType currently restricted to VirtualMachine
{
"membership_type": "string",
"ip_address_membership_criteria": {
"ip_addresses": [
"string"
]
},
"search_membership_criteria": {
"entity_type": "string",
"filter": "string"
}
}
membership_type
{
"bucket": [
{
"field": "string",
"value": "string"
}
],
"count": "integer",
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
]
}
count of entity in group
{
"entity_ids": [
"10000:561:123456789",
"10000:561:987654321"
],
"cursor": "CKWP=="
}
entity_ids
cursor
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vmknics": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"cluster": {
"entity_id": "string",
"entity_type": "string"
},
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
},
"vm_count": "integer",
"datastores": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"service_tag": "string",
"vendor_id": "string",
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
},
"maintenance_mode": "string",
"connection_state": "string"
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
entity id
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
create_time
created_by
last_modified_time
last_modified_by
create_time
created_by
last_modified_time
last_modified_by
create_time
created_by
last_modified_time
last_modified_by
flows_enabled
flows_enabled
flows_enabled
flows_enabled
flows_enabled
flows_enabled
flows_enabled
message
event_tags
admin_state
archived
event_time_epoch_ms
event_type
recommendations
version
version
rule_id
section_id
section_name
sequence_number
source_any
destination_any
service_any
disabled
source_inversion
destination_inversion
rule_id
section_id
section_name
sequence_number
source_any
destination_any
service_any
disabled
source_inversion
destination_inversion
rule_id
section_id
section_name
sequence_number
source_any
destination_any
service_any
disabled
source_inversion
destination_inversion
vendor_id
vendor
vendor_id
vendor
network_addresses
gateways
network_addresses
gateways
vendor_id
vendor_id
protocol
protocol
default_gateway
default_gateway
total_cpus
total_memory
num_cpu_cores
vendor_id
num_hosts
num_datastores
total_cpus
total_memory
num_cpu_cores
vendor_id
num_hosts
num_datastores
Associated nsxt data source entity Id
name
name
source_vm_tags
destination_vm_tags
within_host
firewall_rule_id
source_vm_tags
destination_vm_tags
within_host
firewall_rule_id
vm_count
service_tag
vendor_id
maintenance_mode
connection_state
vm_count
service_tag
vendor_id
maintenance_mode
connection_state
Associated nsxt data source entity Id
Associated nsxt data source entity Id
Associated nsxt data source entity Id
vendor_id
annotations
labels
creation_timestamp
type
selectors
vendor_id
annotations
labels
creation_timestamp
type
selectors
logging_enabled
ipfix_enabled
latency_enabled
ipfix_enabled
latency_enabled
ipfix_enabled
latency_enabled
ipfix_enabled
latency_enabled
ipfix_enabled
latency_enabled
ipfix_enabled
latency_enabled
ipfix_enabled
latency_enabled
Associated vcenter data source entity Id
ipfix_enabled
central_cli_enabled
latency_enabled
Associated vcenter data source entity Id
ipfix_enabled
central_cli_enabled
latency_enabled
Associated vcenter data source entity Id
ipfix_enabled
central_cli_enabled
latency_enabled
Associated vcenter data source entity Id
ipfix_enabled
central_cli_enabled
latency_enabled
Associated vcenter data source entity Id
ipfix_enabled
central_cli_enabled
latency_enabled
Associated vcenter data source entity Id
ipfix_enabled
central_cli_enabled
latency_enabled
Associated vcenter data source entity Id
ipfix_enabled
central_cli_enabled
latency_enabled
Associated nsx-t manager entity Id
Associated nsx-t manager entity Id
Associated nsx-t manager entity Id
Associated nsx-t manager entity Id
Associated nsx-t manager entity Id
Associated nsxt data source entity Id
Associated nsxt data source entity Id
csp_refresh_token
Associated vcenter data source entity Id
ipfix_enabled
csp_refresh_token
Associated vcenter data source entity Id
ipfix_enabled
csp_refresh_token
Associated vcenter data source entity Id
ipfix_enabled
csp_refresh_token
Associated vcenter data source entity Id
ipfix_enabled
csp_refresh_token
Associated vcenter data source entity Id
ipfix_enabled
csp_refresh_token
Associated vcenter data source entity Id
ipfix_enabled
csp_refresh_token
Associated vcenter data source entity Id
ipfix_enabled
severity
event_close_time_epoch_ms
severity
event_close_time_epoch_ms
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Associated service now instance
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Associated service now instance
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
cidr
vlan_id
cidr
vlan_id
cidr
vlan_id
total_count
refs_added_count
refs_deleted_count
vendor_id
vendor_id
is_vmc
is_vmc
is_vmc
is_vmc
is_vmc
is_vmc
is_vmc
fqdn
vc_uuid
fqdn
vc_uuid
{
"id": "string",
"name": "string",
"type": "string"
}
id
name
type
Ip Address membership definition
{
"ip_addresses": [
"string"
]
}
ip_addresses
{
"start_ip": "string",
"end_ip": "string"
}
start_ip
end_ip
{
"start": "integer",
"end": "integer"
}
start
end
{
"tag_id": "string",
"subnets": [
"string"
],
"ip_address_ranges": [
{
"start_ip": "string",
"end_ip": "string"
}
]
}
tag_id
subnets
{
"tag_ids": [
"string"
]
}
tag_ids
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
ip_address
netmask
network_address
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"kubeconfig": "string"
}
kubeconfig
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"manager_id": "192.168.10.1",
"credentials": {
"kubeconfig": "string"
}
}
{
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"kubeconfig": "string"
},
"manager_id": "192.168.10.1"
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"kubernetes_cluster": {
"entity_id": "string",
"entity_type": "string"
},
"manager": {
"entity_id": "string",
"entity_type": "string"
},
"annotations": [
"string"
],
"labels": [
"string"
],
"creation_timestamp": "string",
"namespace": {
"entity_id": "string",
"entity_type": "string"
},
"cluster_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"loadbalancer_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"type": "string",
"external_ips": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"selectors": [
"string"
]
}
{
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}
proxy vm which should register this vcenter
nickname
enabled
notes
{
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
}
Directory on file server to store/fetch backups
filename of the backup to be restored (used during restore only)
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"metric": "string",
"display_name": "string",
"interval": "integer",
"unit": "string",
"pointlist": [
[
{}
]
],
"start": "integer",
"end": "integer"
}
metric
display_name
interval
unit
pointlist
start
end
{
"metric": "string",
"display_name": "string",
"intervals": [
"integer"
],
"description": "string",
"unit": "string"
}
metric
display_name
intervals
description
unit
{
"entity": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"enabled": "boolean",
"controller_password": "string"
}
enabled
controller_password
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
],
"logging_enabled": "boolean",
"direction": "string",
"scope": "string",
"nsx_managers": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"ipfix_enabled": "boolean",
"latency_enabled": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"ipfix_enabled": "boolean",
"latency_enabled": "boolean"
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"vcenter_id": "string",
"ipfix_enabled": "boolean",
"central_cli_enabled": "boolean",
"latency_enabled": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"vcenter_id": "string",
"ipfix_enabled": "boolean",
"central_cli_enabled": "boolean",
"latency_enabled": "boolean"
}
{
"entity_id": "string",
"time": "integer"
}
entity_id
time
{
"entities": [
{
"entity_id": "string",
"time": "integer"
}
]
}
{
"entities": [
{
"entity_id": "string",
"entity_type": "string",
"time": "integer",
"name": "string"
}
]
}
{
"id": "string",
"entity_type": "string",
"node_type": "string",
"node_id": "string",
"ip_address": "string",
"name": "string"
}
id
node_type
node_id
ip_address
name
{
"id": "1000:104:12213212",
"entity_type": "string"
}
Entity Identifier
{
"results": [
{
"id": "1000:104:12213212",
"entity_type": "string"
}
],
"total_count": 1
}
total_count
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"manager_id": "string"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"manager_id": "string"
}
{
"results": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"create_time": "integer",
"created_by": "string",
"last_modified_time": "integer",
"last_modified_by": "string"
}
],
"cursor": "string",
"total_count": "integer"
}
cursor
total_count
{
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
],
"cursor": "string",
"total_count": "integer",
"start_time": "integer",
"end_time": "integer"
}
cursor
total_count
start_time
end_time
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"time": "integer"
}
],
"cursor": "ML12eu02==",
"total_count": 100,
"start_time": 1504739809,
"end_time": 1504739809
}
cursor
total_count
start_time
end_time
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"username": "string",
"password": "string"
}
username
password
{
"firewalls": [
{
"firewall_entity_id": {
"entity_id": "string",
"entity_type": "string"
},
"vendor_info": {
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
},
"manager": {
"entity_id": "string",
"entity_type": "string"
},
"rules": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
]
}
]
}
{
"source_ip_address": "string",
"destination_ip_address": "string",
"port": "integer",
"protocol": "string",
"time": "integer"
}
source_ip_address
destination_ip_address
port
protocol
time
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"csp_refresh_token": "string",
"vcenter_id": "string",
"ipfix_enabled": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"csp_refresh_token": "string",
"vcenter_id": "string",
"ipfix_enabled": "boolean"
}
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
start
end
display
iana_name
iana_port_display
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer"
}
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer",
"time": "integer"
}
Entity Identifier
time
{
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"protocols": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"action": "string"
}
protocols
action
{
"results": [
{
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"protocols": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"action": "string"
}
],
"time_range": {
"start_time": "integer",
"end_time": "integer"
}
}
{
"group_1": {
"entity": {
"entity_type": "Tier",
"entity_id": "10000:562:1904698621"
}
},
"group_2": {
"entity": {
"entity_type": "Tier",
"entity_id": "10000:562:1780351215"
}
}
}
When True, includes ungrouped endpoints outside defined scope
{
"entity_id": "string",
"entity_type": "string"
}
entity_id
Role assigned the user/group.
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
{
"community_string": "string"
}
community_string
{
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
username
context_name
authentication_type
authentication_password
privacy_type
privacy_password
{
"snmp_enabled": "boolean",
"snmp_version": "string",
"config_snmp_2c": {
"community_string": "string"
},
"config_snmp_3": {
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
}
snmp_enabled
snmp_version
{
"entity_type": "Flow",
"filter": "destination_ip.ip_address = '1.1.1.1'",
"aggregations": [
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "SUM"
}
],
"time_range": {
"start_time": 1534410000,
"end_time": 1534410559
},
"group_by": [
"source_ip",
"destination_ip"
],
"size": 2,
"sort_by": [
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "SUM",
"order": "DESC"
}
]
}
query filter
group_by
size
cursor
{
"results": [
{
"bucket": [
{
"field": "string",
"value": "string"
}
],
"count": "integer",
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
]
}
],
"size": "integer",
"total_bucket": {
"value": "integer",
"is_approx": "boolean"
},
"total_count": "integer",
"time_range": {
"start_time": "integer",
"end_time": "integer"
},
"cursor": "string"
}
size
total count of entity
cursor
{
"entity_type": "string",
"filter": "string"
}
As defined in search end point
{
"entity_type": "string",
"filter": "string",
"sort_by": {
"field": "string",
"order": "string"
},
"size": "integer",
"cursor": "string",
"time_range": {
"start_time": "integer",
"end_time": "integer"
}
}
query filter
size
cursor
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"description": "string",
"direct_security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"vendor_id": "string",
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"instance_id": "dev36113.service-now.com",
"graph_configuration": "string",
"is_graph_config_customized": "boolean"
}
{
"proxy_id": "1000:104:12313412",
"nickname": "snow1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"instance_id": "dev36113.service-now.com",
"graph_configuration": "string",
"is_graph_config_customized": "boolean"
}
{
"proxy_id": "1000:104:12313412",
"nickname": "snow1",
"enabled": "boolean",
"notes": "string"
}
proxy vm which should register this vcenter
nickname
enabled
notes
{
"start": "integer",
"end": "integer"
}
start
end
page size of results
{
"snmp_profiles": [
"string"
]
}
snmp_profiles
{
"results": [
{
"entity_id": "snmp-er67ght8kn67",
"nick_name": "Aws collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "string"
},
"snmp_v3": {
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
}
],
"total_count": "integer"
}
total_count
{
"nick_name": "Aws collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "string"
},
"snmp_v3": {
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
}
Descriptor or identifier for particular snmp profile.
IP address of SNMP target destination
Receiving port number of SNMP target destination
snmp_version
{
"entity_id": "snmp-er67ght8kn67",
"nick_name": "Aws collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "string"
},
"snmp_v3": {
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
}
Entity Identifier for snmp profile.
User defined descriptor or identifier for particular snmp profile.
IP address of SNMP target destination
Receiving port number of SNMP target destination
snmp_version
{
"field": "string",
"order": "string"
}
field
order
{
"server_address": "10.234.12.134",
"port": 22,
"username": "testuser",
"password": "password",
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
}
IP address or hostname of destination SSH file server
File transfer port
username to login ssh server
password for the user to login ssh server
directory on file server to store/fetch backups
filename of the backup to be restored (used during restore only)
start time for query in epoch seconds
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"cidr": "string",
"vlan_id": "integer"
}
{
"results": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"cidr": "string",
"vlan_id": "integer"
}
]
}
{
"cidr": "string",
"vlan_id": "integer"
}
cidr
vlan_id
{
"results": [
{
"entity_id": "string",
"active": "boolean",
"event_name": "string",
"is_problem": "boolean",
"severity": "string",
"search_criteria": "string",
"generate_event_criteria": "string",
"email_frequency": "string",
"daily_at_utc": "string",
"email_ids": [
"string"
],
"snmp_trap_entity_ids": [
"string"
]
}
],
"total_count": "integer"
}
total_count
{
"event_name": "string",
"is_problem": "boolean",
"severity": "string",
"search_criteria": "string",
"generate_event_criteria": "string",
"email_frequency": "string",
"daily_at_utc": "string",
"email_ids": [
"string"
],
"snmp_trap_entity_ids": [
"string"
]
}
event_name
is_problem
severity
search_criteria
daily_at_utc
email_ids
snmp_trap_entity_ids
{
"entity_id": "string",
"active": "boolean",
"event_name": "string",
"is_problem": "boolean",
"severity": "string",
"search_criteria": "string",
"generate_event_criteria": "string",
"email_frequency": "string",
"daily_at_utc": "string",
"email_ids": [
"string"
],
"snmp_trap_entity_ids": [
"string"
]
}
entity_id
active
event_name
is_problem
search_criteria
daily_at_utc
email_ids
snmp_trap_entity_ids
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"status": true,
"message": "Failed sending SNMP trap"
}
Test trap sent successfully or not
Test snmp trap status message
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"group_membership_criteria": [
{
"membership_type": "string",
"ip_address_membership_criteria": {
"ip_addresses": [
"string"
]
},
"search_membership_criteria": {
"entity_type": "string",
"filter": "string"
}
}
],
"application": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"results": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"group_membership_criteria": [
{
"membership_type": "string",
"ip_address_membership_criteria": {
"ip_addresses": [
"string"
]
},
"search_membership_criteria": {
"entity_type": "string",
"filter": "string"
}
}
],
"application": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
]
}
entity_id
entity_type
name
{
"name": "tier-1",
"group_membership_criteria": [
{
"membership_type": "SearchMembershipCriteria",
"search_membership_criteria": {
"entity_type": "VirtualMachine",
"filter": "security_groups.entity_id = '18230:82:604573173'"
}
}
]
}
name
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
]
}
],
"cursor": "string",
"total_count": "integer"
}
cursor
total_count
time in epoch seconds
{
"start_time": "integer",
"end_time": "integer"
}
start_time
end_time
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Events that were created or updated or closed between this time and update_time_to, in seconds
Events that were created or updated or closed between update_time_from and this time, in seconds
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer",
"total_count": "integer",
"refs_added_count": "integer",
"refs_deleted_count": "integer",
"subscriptions": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer",
"total_count": "integer",
"refs_added_count": "integer",
"refs_deleted_count": "integer",
"subscriptions": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"time": "integer"
}
Entity Identifier
time
{
"id": "[email protected]",
"group_type": "VIDM",
"group_name": "testgroup",
"domain": "vidmlabs.com",
"role": "ADMIN"
}
Unique identifier assigned to user-group.
Group-name of the user-group.
Domain name to which user-group belongs to.
The type of user-group.
{
"id": "[email protected]",
"user_type": "VIDM",
"username": "alleymartin123",
"domain": "vidmlabs.com",
"display_name": "alley martin",
"role": "ADMIN"
}
The type of user.
{
"username": "admin@local",
"new_password": "password"
}
username
new_password
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"is_vmc": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"is_vmc": "boolean"
}
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"fqdn": "string",
"vm": {
"entity_id": "string",
"entity_type": "string"
},
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
},
"vc_uuid": "string"
}
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
{
"id_type": "string",
"id_value": "string"
}
id_type
id_value
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"entity_id": "string",
"entity_type": "string",
"entity_name": "string",
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
]
}
entity_id
entity_type
entity_name
{
"api_version": "string"
}
api_version
{
"begin": "integer",
"end": "integer"
}
begin
end
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"vlan": {
"begin": "integer",
"end": "integer"
},
"host": {
"entity_id": "string",
"entity_type": "string"
},
"layer2_network": {
"entity_id": "string",
"entity_type": "string"
}
}
{
"site": "Washington DC",
"region": "US East",
"interfaces": [
{
"id": "string",
"name": "string",
"type": "string"
}
]
}
site
region