VMware Aria Operations for Networks API Reference Data Structures
{
"username": "readonly",
"password": "VMware1!",
"name": "API_Credential_1",
"entityId": "1:3100:3",
"account_type": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"manager_id": "string"
}
{
"access_key": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}
AWS Access Key to authenticate with
AWS Secret Key to authenticate with
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"credentials": {
"access_key": "AKIAIOSFODNN7EXAMPLE",
"secret_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"flows_enabled": "boolean",
"add_linked_accounts": "boolean",
"role_arn_suffix": "string",
"linked_role_arn": "string",
"data_source_hierarchy": "string",
"enable_aws_geo_restrictions": "boolean",
"selected_regions": [
"string"
],
"child_datasource_count": "integer",
"child_datasources": [
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
],
"web_proxy_id": "string"
}
Type of credential account. LOCAL or DIRECTORY
{
"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"
}
],
"series_values": [
{
"field": "string",
"aggregation_type": "string",
"resolution_in_secs": "integer",
"series": [
[
{}
]
]
}
],
"total_count": 100,
"start_time": 1597247025,
"end_time": 1597247999
}
Total count of objects returned
Start timestamp of the window of the objects returned
End timestamp of the window of the objects returned
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
field
aggregation_type
value
{
"name": "mtuCheck",
"alertType": "Intent",
"intentTypeId": "MtuMismatch",
"filterRules": {
"isValid": "string",
"filterType": "string",
"rules": [
{
"membership": {
"membershipType": "string",
"objectType": "integer",
"entities": [
{
"modelKey": "string",
"name": "string"
}
],
"query": "string"
}
}
]
},
"paramValues": [
{
"id": "min-violation-duration",
"values": "VIOLATION_DURATION_FIVE_MINUTES",
"valueType": "FIXED_MULTI_CHOICE_SINGLE_VALUE"
}
],
"selected_scope": "All Applications",
"description": "Monitor traffic rate and total bandwidth for applications",
"enabled": true,
"severity": "Info",
"notes": "Mtu check",
"tags": [
" [\"Device Health\", \"MTU\", \"dummy\"]"
],
"notificationSettings": [
{
"type": "string",
"frequency": "string",
"enabled": true,
"receivers": [
[
"[email protected]"
]
],
"schedule": [
{
"type": "string",
"periodInMS": "integer",
"startTimestamp": "integer"
}
]
}
]
}
Intent name
Intent type
Intent type
filterRules
Intent scope
Intent description
enabled
Intent severity
Intent notes
Intent tags
The type of alert. It can take a value PROBLEM or CHANGE.
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
code
message
{
"name": "fbad_app1",
"entity_id": "18230:561:264351372",
"source_group_entity_id": [
"18230:565:264351372"
],
"enable_intent": true,
"tiers": [
{
"name": "fbad-tier-1",
"entity_id": "18230:562:264351372",
"source_group_entity_id": [
"18230:566:264351372"
],
"group_membership_criteria": [
{
"membership_type": "SearchMembershipCriteria",
"search_membership_criteria": {
"entity_type": "VirtualMachine",
"filter": "security_groups.entity_id = '18230:82:604573173'"
}
},
{
"membership_type": "IPAddressMembershipCriteria",
"ip_address_membership_criteria": {
"ip_addresses": [
"10.0.0.1",
"10.0.0.1/24",
"10.0.0.1-10.0.0.200"
]
}
}
],
"member_list": {
"vms": [
{
"key": {
"entity_id": "18230:1:1158969162",
"entity_type": "VIRTUALMACHINE"
},
"name": "VM1"
},
{
"key": {
"entity_id": "18230:601:863301375",
"entity_type": "EC2INSTANCE"
},
"name": "EC2-VM1"
},
{
"key": {
"entity_id": "18230:1702:264351372",
"entity_type": "AZUREVM"
},
"name": "Azure-VM1"
}
]
},
"physical_ips": [
{
"key": {
"entity_id": "18230:541:365252372",
"entity_type": "IPENDPOINT"
},
"name": "52.35.41.245"
}
],
"kubernetes_services": [
{
"key": {
"entity_id": "18230:1504:263252172",
"entity_type": "KUBERNETESSERVICE"
},
"name": "KS"
}
]
}
]
}
name
entity_id
Entity ID of corresponding discovered application. It's recommended to not merge tiers and use only one source group.
Enabling intent will enable 2 intents which will creates a dynamic threshold configuration that analyses "Application flow health" and "Application flow utilization" for all VMs belonging to the application at tier level and generates alerts if violation is detected for any of them based on their historic behavior.
Type of HCX Appliance, e.g HCXNEAPPLIANCE
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"create_time": 159724400600,
"created_by": "admin@local",
"last_modified_time": 159724400600,
"last_modified_by": "[email protected]",
"last_modified_by_service": "Ensemble",
"tier_count": 25,
"member_count": 500,
"update_status": "string",
"confidence": "Medium"
}
{
"application_id": "18230:3:187309184",
"flow_data": [
{
"name": "string",
"value": "number"
}
]
}
The entity ID of the application this flow is attached
{
"service_endpoint_count": "integer",
"groups": [
{
"group_id": "string",
"entity_id": "string",
"entity_type": "string",
"flow_summary": {
"ingress_bytes": "integer",
"egress_bytes": "integer"
}
}
],
"start_time": 1597247025,
"end_time": 1597247999
}
service_endpoint_count
Start timestamp of the window of the objects returned
End timestamp of the window of the objects returned
{
"id": "string",
"type": "string",
"specversion": "string",
"source": "string",
"message_group": "string",
"status": "string",
"total": "integer",
"start": "integer",
"end": "integer",
"timestamp": "integer",
"data": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"created_by": "string",
"creation_time": "integer",
"last_modified_by": "string",
"last_modified_by_service": "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": "VirtualMachine",
"entity_name": "string"
}
}
]
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
}
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
},
"curated_groups": [
"string"
],
"confidence": "string"
}
]
}
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "VirtualMachine",
"entity_name": "string"
}
}
]
}
],
"cursor": "string"
}
cursor
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"created_by": "string",
"creation_time": "integer",
"last_modified_by": "string",
"last_modified_by_service": "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": "VirtualMachine",
"entity_name": "string"
}
}
]
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
}
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
},
"curated_groups": [
"string"
],
"confidence": "string"
}
entity_id
entity_type
name
created_by
creation_time
last_modified_by
last_modified_by_service
last_modified_time
curated_groups
confidence
Application change information over databus.
{
"id": "string",
"type": "string",
"specversion": "string",
"source": "string",
"message_group": "string",
"status": "string",
"deleted_at": "integer",
"data": {
"entity_id": "string",
"entity_type": "string",
"name": "string",
"created_by": "string",
"creation_time": "integer",
"last_modified_by": "string",
"last_modified_by_service": "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": "VirtualMachine",
"entity_name": "string"
}
}
]
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
}
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
},
"curated_groups": [
"string"
],
"confidence": "string"
}
}
{
"name": "My-3Tier-App"
}
The name of the application
{
"application_id": "18230:3:187309184",
"top_talker_member": [
{
"sort_criteria": "string",
"sorted_list": {
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "VirtualMachine",
"entity_name": "VM-1"
}
],
"cursor": "MTA=",
"total_count": 1102,
"start_time": 1597247025,
"end_time": 1597247999
}
}
]
}
The entity ID of the application this flow is attached
{
"application_id": "18230:3:187309184",
"top_talker_member": [
{
"sort_criteria": "string",
"sorted_list": {
"results": [
{
"src_entity_id": "1000:104:12213212",
"src_entity_type": "VirtualMachine",
"dst_entity_id": "1000:104:56789",
"dst_entity_type": "VirtualMachine"
}
],
"cursor": "MTA=",
"total_count": 1102,
"start_time": 1597247025,
"end_time": 1597247999
}
}
]
}
The entity ID of the application this flow is attached
{
"basic_update_info": {
"name": "string",
"entity_id": "string",
"update_status": "string"
},
"tiers": [
{
"basic_update_info": {
"name": "string",
"entity_id": "string",
"update_status": "string"
},
"vms": [
{
"name": "string",
"entity_id": "string",
"update_status": "string"
}
],
"physical_ips": [
{
"name": "string",
"entity_id": "string",
"update_status": "string"
}
],
"kubernetes_services": [
{
"name": "string",
"entity_id": "string",
"update_status": "string"
}
]
}
]
}
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"created_by": "string",
"creation_time": "integer",
"last_modified_by": "string",
"last_modified_by_service": "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": "VirtualMachine",
"entity_name": "string"
}
}
]
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
}
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
},
"curated_groups": [
"string"
],
"confidence": "string"
}
],
"cursor": "string",
"total_count": "integer"
}
cursor
total_count
{
"referred_entity": {
"entity_id": "1000:104:12213212",
"entity_type": "VirtualMachine",
"entity_name": "VM-1"
},
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"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 for the next page of logs
Start timestamp of the window of the objects returned
End timestamp of the window of the objects returned
{
"username": "admin@local",
"operation": "LOGIN",
"time_range": {
"start_time": 1534410000,
"end_time": 1534410559
},
"size": 10,
"cursor": "string"
}
Username making the change
Client IP that is making the change
Entity Type of object being changed
Entity ID of object being changed
Operation on object being changed
Response from Operations for Networks, whether it's successfull or not
size
Cursor for the next page of logs
{
"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
The Authentication Provider
{
"azure_client": "53ba6f2b-6d52-4f5c-8ae0-7adc20808854",
"azure_key": "NMubGVcDqkwwGnCs6fa01tqlkTisfUd4pBBYgcxxx=",
"azure_tenant": "b98531cb-75cc-4b4a-1ba6-fe87q98662f0",
"azure_subscription": "b98531cb-75cc-4b4a-1ba6-fe87q98662f0"
}
Azure Application Client ID to authenticate with
Azure Application Secret Key to authenticate with
Azure Application Tenant ID to authenticate against
Azure Application Subscription ID to authenticate against
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"credentials": {
"azure_client": "53ba6f2b-6d52-4f5c-8ae0-7adc20808854",
"azure_key": "NMubGVcDqkwwGnCs6fa01tqlkTisfUd4pBBYgcxxx=",
"azure_tenant": "b98531cb-75cc-4b4a-1ba6-fe87q98662f0",
"azure_subscription": "b98531cb-75cc-4b4a-1ba6-fe87q98662f0"
},
"flows_enabled": "boolean",
"web_proxy_id": "string"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"azure_client": "53ba6f2b-6d52-4f5c-8ae0-7adc20808854",
"azure_key": "NMubGVcDqkwwGnCs6fa01tqlkTisfUd4pBBYgcxxx=",
"azure_tenant": "b98531cb-75cc-4b4a-1ba6-fe87q98662f0",
"azure_subscription": "b98531cb-75cc-4b4a-1ba6-fe87q98662f0"
},
"flows_enabled": "boolean",
"web_proxy_id": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"secondary_id": "string",
"manager_id": "string"
}
{
"key": "Data Source Type",
"value": "VCENTER"
}
Name of the attribute
Value of the attribute
{
"componentName": "DATA_SOURCES",
"totalCount": "integer",
"successCount": "integer",
"failedEntities": [
{
"nickName": "SiteT_24_Openshift-VC",
"errorCode": -8,
"errorDescription": "Unknown host",
"entityAttributes": [
{
"key": "Data Source Type",
"value": "VCENTER"
}
]
}
]
}
Name of the component
Number of entities present in this component
Number of entities present in this component which are successfully backed up or restored
List of the entities for which backup/restore failed
{
"data_filter": {
"snmp": true,
"smtp": true,
"web_proxy": true,
"data_sources": true,
"events": true,
"syslog": true,
"ldap": true,
"vidm": true,
"user_data": true,
"physical_subnet_vlan": true,
"physical_ip_dns_mapping": true,
"system_configuration": true,
"east_west_ip": true,
"north_south_ip": true,
"data_management": true,
"online_update_status": true,
"ceip_status": true,
"audit_logs_pii_status": true,
"applications": true,
"analytics_outliers": true,
"analytics_thresholds": true,
"custom_dashboards": true
},
"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"
},
"s3_file_server": {
"orgId": "string",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"schedule_now": true,
"is_ondemand": true,
"collector_mapping": {
"default_collector": "10.78.89.125",
"mappings": [
{
"source": "10.78.89.125",
"destination": "10.78.89.126"
}
]
},
"user_mapping": {
"mappings": [
{
"source": "10.78.89.125",
"destination": "10.78.89.126"
}
]
},
"syslog_collector_mapping": {
"mappings": [
{
"server": "10.78.89.125",
"collector": "10.78.89.126"
}
]
},
"snmp_destination_collector_mapping": {
"mappings": [
{
"server": "10.78.89.125",
"collector": "10.78.89.126"
}
]
}
}
True, to run backup now (on demand)
Internal, to be used by VMware services.
snmp_destination_collector_mapping
{
"status": "IN_PROGRESS",
"backup_file_name": "vrni_backup-10000-2020-12-15-13-00-40.tar",
"status_updated_timestamp": "vrni_backup-10000-2020-12-15-13-00-40.tar",
"failed_components": [
"string"
]
}
Status of currently executing or last backup-restore job
File name of backup tar file
TimeStamp of the last status update
List of components failed to backup or restore
{
"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{Sunday} - 7{Saturday})
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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18"
}
Internal ID of data source, to be used in subsequent API calls
IP address of data source (use either IP or FQDN, not both)
Hostname of data source (use either IP or FQDN, not both)
ID of Collector VM which should register this vcenter
A friendly nickname for the data source
Whether or not data collection is enabled
Room for notes or comments about the data source
Certificate of data source
SHA thumbprint of data source
New certificate of data source
New SHA thumbprint of data source
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1"
}
IP address of data source (use either IP or FQDN, not both)
Hostname of data source (use either IP or FQDN, not both)
ID of Collector VM which should register this vcenter
A friendly nickname for the data source
Whether or not data collection is enabled
Room for notes or comments about the data source
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412"
}
IP address of data source (use either IP or FQDN, not both)
Hostname of data source (use either IP or FQDN, not both)
ID of Collector VM which should register this vcenter
{
"code": "integer",
"message": "string"
}
code
message
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine"
}
Entity ID that can be references in detail API calls
Name of the object
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "UserDefinedEvent",
"recommendations": [
"string"
],
"notes": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"exclusions": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"nsx_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"version": "string",
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"anySrcInterface": "boolean",
"anyDstInterface": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"section_id": "string",
"precedence": "integer",
"firewall_rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"exclusions": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"anySrcInterface": "boolean",
"anyDstInterface": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"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",
"ip_range_start": "string",
"ip_range_end": "string"
}
],
"parent_security_groups": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"direct_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"direct_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"indirect_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"indirect_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"vendor_id": "string",
"vendor": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"network_addresses": [
"string"
],
"gateways": [
"string"
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"members": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"direct_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"direct_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"indirect_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"indirect_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"parents": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"direct_members": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"vendor_id": "string",
"excluded_members": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"protocol": "string",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"members": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"default_gateway": "string",
"default_gateways": [
"string"
],
"vnics": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"security_groups": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"source_firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"destination_firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
],
"ip_sets": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"tag_keys": [
"string"
],
"tag_key_values": [
"string"
],
"tag_values": [
"string"
],
"vm_UUID": "string",
"manager_uuid": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"layer2_network": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vlan": {
"begin": "integer",
"end": "integer"
},
"vm": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"name": "string",
"entity_id": "string",
"update_status": "string"
}
name
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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"field": "string",
"value": "string"
}
field
value
{
"message": "string",
"validation_errors": [
{
"row_no": "string",
"ip_or_fqdn": "string",
"column_name": "string",
"error_message": "string"
}
]
}
validation message
{
"row_no": "string",
"ip_or_fqdn": "string",
"column_name": "string",
"error_message": "string"
}
row_no
ip_or_fqdn
column_name
error_message
{
"entity_id": "string",
"fields": [
{
"key": "string",
"value": "string",
"action_on_field": "string"
}
]
}
entity_id
fields
{
"action_type": "string",
"data_sources": [
{
"entity_id": "string",
"fields": [
{
"key": "string",
"value": "string",
"action_on_field": "string"
}
]
}
]
}
Type of Bulk Action to perform
{
"results": [
{
"entity_id": "18230:3:187309184",
"entity_type": "VirtualMachine",
"entity": {
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine"
},
"time": "integer"
}
]
}
{
"total_count": "integer",
"success_count": "integer",
"failed_count": "integer",
"successful_data_sources": [
"string"
],
"failed_data_sources": [
{
"entity_id": "string",
"reason": "string"
}
]
}
Total Count of Data Sources
Total Count of Successful data sources
Total Count of Failed data sources
successful_data_sources
{
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "VirtualMachine",
"name": "My Name",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "UserDefinedEvent",
"recommendations": [
"string"
],
"notes": "string",
"severity": "string",
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean",
"switch_type": "NEXUS_6K"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean",
"switch_type": "NEXUS_6K"
}
The Cisco switch model type
{
"id": "string",
"type": "string",
"specversion": "string",
"source": "string",
"message_group": "string",
"status": "string"
}
id
type
specversion
source
message_group
status
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"total_cpus": 32,
"total_memory": 102400,
"num_cpu_cores": 320,
"vendor_id": "c-13",
"num_hosts": 4,
"num_datastores": 4,
"nsx_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"datacenter": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"manager_uuid": "string"
}
Mappings for source collector (backup setup) to destination collector (restore setup)
{
"default_collector": "10.78.89.125",
"mappings": [
{
"source": "10.78.89.125",
"destination": "10.78.89.126"
}
]
}
Default collector_VM ip-address for mapping data sources, if no other collector mapping provided explicitly
{
"snmp": true,
"smtp": true,
"web_proxy": true,
"data_sources": true,
"events": true,
"syslog": true,
"ldap": true,
"vidm": true,
"user_data": true,
"physical_subnet_vlan": true,
"physical_ip_dns_mapping": true,
"system_configuration": true,
"east_west_ip": true,
"north_south_ip": true,
"data_management": true,
"online_update_status": true,
"ceip_status": true,
"audit_logs_pii_status": true,
"applications": true,
"analytics_outliers": true,
"analytics_thresholds": true,
"custom_dashboards": true
}
snmp
smtp
web_proxy
data_sources
events
syslog
ldap
vidm
user_data
physical_subnet_vlan
physical_ip_dns_mapping
system_configuration
east_west_ip
north_south_ip
data_management
online_update_status
ceip_status
audit_logs_pii_status
applications
analytics_outliers
analytics_thresholds
custom_dashboards
{
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM"
}
Config polling interval to be provided in minutes. Preset values are [10 min, 15 min, 30 min, 1 hour, 12 hours, 1 day, 3 days, 5 days, 7 days]. For any other polling interval, CUSTOM polling interval type should be used. Minimum- 10 minutes, Maximum- 7 days
Scheduled time (UTC) to be provided. This is only applicable when config_polling_interval_type is SCHEDULED
Scheduled config polling days. Supported values are weekdays. Multiple days separated with comma can be supplied. This is only applicable when config_polling_interval_type is SCHEDULED
Config Polling interval type. Supported values are PRESET, CUSTOM, SCHEDULED
Type of connection device supports.
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"manager_id": "192.168.10.1",
"credentials": {
"kubeconfig": {
"apiVersion": "v1",
"clusters": {
"cluster": {
"api-version": "v1",
"server": "http://cow.org:8080",
"name": "cow-cluster"
}
}
}
}
}
{
"start_entity_id": "string",
"name": "string",
"start_time": "integer",
"end_time": "integer"
}
start_entity_id
name
start_time
end_time
{
"entity_id": "10000:3100:3441876721632546588",
"name": "sshprofile",
"connection_type": "SSH",
"account_type": "string",
"credential": {
"username": "readonly",
"password": "VMware1!"
},
"snmp_credential": {
"snmp_enabled": true,
"snmp_version": "v2c",
"config_snmp_2c": {
"community_string": "public"
},
"config_snmp_3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
}
}
entity ID of credential profile
name of credential profile
{
"entity_id": "10000:3100:3441876721632546588",
"name": "sshprofile",
"connection_type": "SSH",
"account_type": "string",
"credential": {
"username": "readonly",
"password": "VMware1!"
},
"snmp_credential": {
"snmp_enabled": true,
"snmp_version": "v2c",
"config_snmp_2c": {
"community_string": "public"
},
"config_snmp_3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
},
"createdBy": "admin",
"modifiedBy": "support",
"creationTime": "3441876721632546588",
"modifiedTime": "3441876721632546588"
}
This object returns licenses which will be removed and retained.
{
"toRemove": [
"VRNILicense Object"
],
"toRetain": [
"VRNILicense Object"
]
}
List of licenses that will be removed. This list will have Socket based licenses when Core based license is added.
Cursor from previous response
{
"preference": [
"mk1",
"mk2",
"GET_STARTED"
]
}
Custom dashboard model keys/OOTB dashboard ids in order of preference upto a maximum of 5. GET_STARTED is the only OOTB dashboard supported.
{
"name": "Custom Dashboard Name",
"description": "This is a Custom Dashboard"
}
Name of the custom dashboard
Description of the custom dashboard
{
"id": "18799:10002:211561153588",
"name": "Custom Dashboard Name",
"description": "This is the Custom Dashboard description",
"create_timestamp": 156789876,
"last_updated_timestamp": 156789876,
"owner": "admin@local",
"users_read_access": [
"[email protected]",
"[email protected]"
],
"users_write_access": [
"[email protected]",
"[email protected]"
],
"pins": [
{
"pin_model_key": "1000:10001:78690089",
"pin_name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
],
"groups_write_access": [
"CN=HR,CN=Users"
],
"groups_read_access": [
"cn=administrators"
]
}
Entity Identifier for a custom dashboard
Descriptor or identifier for particular custom dashboard.
Description of the custom dashboard
Create timestamp for custom dashboard
Last update timestamp for custom dashboard
User email of the custom dashboard owner
List of users with read privilege for the custom dashboard
List of users with read and write privilege for the custom dashboard
LDAP/VIDM groups with read and write privilege of the custom dashboard
LDAP/VIDM groups with read privilege of the custom dashboard
{
"pin_model_key": "1000:10001:78690089",
"pin_name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
Pin model key
Name of the pin
Search query behind the pin
{
"pin_name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
Name of the pin
Search query behind the pin
{
"pin_model_key": "1000:10001:78690089",
"pin_name": "Pin Name",
"custom_dashboard_id": "1000:2504:7869098089",
"query": "Alert where Severity = 'Critical'",
"created_timestamp": 1679088763,
"last_updated_timestamp": 16790887689,
"pinned_timestamp": 1679088763,
"owner": "admin@local"
}
Pin model key
Name of the pin
Model key of the custom dashboard of which the pin is part of
Search query behind the pin
Create timestamp of the pin
Last update timestamp of the pin
Timestamp when the pin was pinned
Owner of the pin
{
"awsVMCount": "integer",
"azureVMCount": "integer",
"vcVMCount": "integer",
"activeFlowsCount": "integer",
"devicesCount": "integer",
"totalFlowsCount": "integer",
"networkRulesCount": "integer",
"fbadVMCount": "integer"
}
Count of AWS VMs
Count of Azure VMs
Count of vCenter VMs
Count of Active Flows
Count of Devices
Count of Total Flows
Count of Network Rules
Count of fbad VMs
{
"entity_id": "string",
"reason": "string"
}
entity_id
reason
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
Entity Identifier
{
"results": [
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"health": {
"health_status": "HEALTH",
"health_details": [
{
"message": "Invalid credentials",
"code": "string"
}
]
},
"last_modified_timestamp": "integer",
"last_activity_timestamp": "integer",
"last_config_activity_timestamp": "integer"
}
],
"total_count": 1
}
total_count
{
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
],
"total_count": 1
}
total_count
{
"filterKey": "appName",
"filterValue": [
"app1",
"app2"
]
}
filterKey
List of filter value tags
{
"id": "9c488c91-692e-4992-a83f-ee33a0f9a6c6",
"message_group": "problems",
"url": "https://data-pipeline.vmware.com/vrni/events",
"filter_tags": [
{
"filterKey": "appName",
"filterValue": [
"app1",
"app2"
]
}
]
}
unique id assigned for the receiver by Operations for Networks. This is not required while creating the subscription
Message-group name for receiving the data from. Message group of a subscription cannot be changed after creation. Supported message groups - application, flows, problems, metrics, vms, hosts, nics, switchports, vms-metrics, hosts-metrics, flows-metrics, nics-metrics, switchports-metrics
URL where the data will be posted to. All the messages from the message group will be posted to this url. If multiple receivers are present behind a load balancer, this can be the url of the load balancer. The url of the subscription can be changed after the creation of the subscription.
{
"results": [
{
"id": "9c488c91-692e-4992-a83f-ee33a0f9a6c6",
"message_group": "problems",
"url": "https://data-pipeline.vmware.com/vrni/events",
"filter_tags": [
{
"filterKey": "appName",
"filterValue": [
"app1",
"app2"
]
}
]
}
],
"total_count": 1
}
total_count
Datasource Health state in detail
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"health": {
"health_status": "HEALTH",
"health_details": [
{
"message": "Invalid credentials",
"code": "string"
}
]
},
"last_modified_timestamp": "integer",
"last_activity_timestamp": "integer",
"last_config_activity_timestamp": "integer"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean",
"switch_type": "S4048"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean",
"switch_type": "S4048"
}
The Dell switch model type
{
"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": "10000:3200:34334343",
"name": "discoveryvrniIT",
"network_ranges": [
"10.10.5.1/24",
"10.10.6.1/24",
"10.10.7.100 - 10.10.7.110"
],
"seeds": [
"10.10.12.1",
"10.10.13.1"
],
"ignored_list": [
"10.10.5.100 - 10.10.5.110",
"10.10.6.100 - 10.10.6.110"
],
"credential_profiles": [
"10000:3100:3434343453454535",
"10000:3101:3434343453454535",
"10000:3102:3434343453454535"
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"local_asn": "integer",
"tunnel_id": "string",
"dx_connection_id": "string",
"mtu": "integer",
"local_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"remote_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"remote_asn": "integer",
"state": "string",
"bgp_status": "string",
"type": "string",
"sddc": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"dx_connection": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"source_entity_id": "string"
}
ID of discovered application which was requested to be saved.
{
"discovered_apps": [
{
"source_entity_id": "18203:565:2854896465419091802"
},
{
"source_entity_id": "18203:565:3896568950496372144"
}
],
"discovery_type": "FLOW_BASED_DISCOVERY",
"enable_intent": true
}
Indicates source of discovery. Only one source of discovery is accepted in one request.
Enabling intent will enable 2 intents which will creates a dynamic threshold configuration that analyses "Application flow health" and "Application flow utilization" for all VMs belonging to the application at tier level and generates alerts if violation is detected for any of them based on their historic behavior.
{
"ip_or_fqdn": "10.10.10.1",
"supported_data_source": "CISCON5K",
"ds_subtype": "HUAWEI",
"os": "nx-os",
"version": "5.1(3)N2(1)",
"model": "2ES",
"collector": "10.10.10.101",
"username": "readonly",
"password": "VMware1!",
"name": "SNMP_Credential_1",
"entityId": "1:3102:3",
"account_type": "string",
"snmp_enabled": true,
"snmp_version": "v2c",
"config_snmp_2c": {
"community_string": "public"
},
"config_snmp_3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
}
device ip or fqdn
data source type
data source subtype
Device OS type
Device OS version
Device Model
Collector IP
{
"job_name": "DiscoveryVrniIT",
"entity_id": "13337:3160:3218530872257772016",
"discovered_devices": [
{
"ip_or_fqdn": "10.10.10.1",
"supported_data_source": "CISCON5K",
"ds_subtype": "HUAWEI",
"os": "nx-os",
"version": "5.1(3)N2(1)",
"model": "2ES",
"collector": "10.10.10.101",
"username": "readonly",
"password": "VMware1!",
"name": "SNMP_Credential_1",
"entityId": "1:3102:3",
"account_type": "string",
"snmp_enabled": true,
"snmp_version": "v2c",
"config_snmp_2c": {
"community_string": "public"
},
"config_snmp_3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
}
],
"total_count": 50
}
Discovery job name
Discovery Job Model Key
total_count
{
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
}
{
"job_name": "DiscoveryVrniIT",
"entity_id": "13337:3160:3218530872257772016",
"job_subtype": "Discovery",
"run_status": "COMPLETED",
"run_status_message": "string",
"created_by": "admin",
"started_by": "admin",
"start_time": "3441876721632546588",
"end_time": "3441876721632546588",
"job_log": "Job completed successfully"
}
Discovery job name
Discovery Job status Model Key
Discovery job sub type
Discovery job status
Discovery job status message
Discovery job created by
Discovery job started by
Discovery job start time
Discovery job end time
Discovery job log
{
"type": "string",
"value": "string"
}
value
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
entity_id
manager_entity_id
The discovery type of the application. Allowed values are SERVICE_NOW and FLOW_BASED_DISCOVERY.
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"distributed_virtual_switch": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"hosts": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"domain_type": "LDAP",
"value": "example.com"
}
domain type, should be in uppercase
domain value, not required for LOCAL domain
{
"name": "Custom Dashboard Name",
"description": "This is a Custom Dashboard",
"retain_access_permissions": "boolean"
}
Name of the custom dashboard
Description of the custom dashboard
Should custom dashboard permissions be copied while duplicating the custom dashboard.
{
"name": "Pinboard Name",
"description": "This is a Pinboard",
"retain_access_permissions": "boolean"
}
Name of the pinboard
Description of the pinboard
Should pinboard permissions be copied while duplicating the pinboard.
End time for query in epoch seconds
{
"results": [
{
"src_entity_id": "string",
"src_entity_type": "string",
"dst_entity_id": "string",
"dst_entity_type": "string",
"flow_properties": [
{
"property_type": "string",
"count": "integer",
"query": "string"
}
],
"network_properties": [
{
"property_type": "string",
"ingress": "number",
"egress": "number",
"total": "number"
}
]
}
],
"total_count": "integer"
}
total_count
{
"scope": {
"scope_type": "TIER",
"entity_ids": [
"10000:562:1904698621",
"10000:562:1780351215"
]
},
"group_by": "10000:1:0"
}
group_by
{
"src_entity_id": "string",
"src_entity_type": "string",
"dst_entity_id": "string",
"dst_entity_type": "string",
"flow_properties": [
{
"property_type": "string",
"count": "integer",
"query": "string"
}
],
"network_properties": [
{
"property_type": "string",
"ingress": "number",
"egress": "number",
"total": "number"
}
]
}
src_entity_id
src_entity_type
dst_entity_id
dst_entity_type
{
"entity_id": "1000:104:12213212",
"entity_type": "VirtualMachine",
"entity_name": "VM-1"
}
Entity Identifier
The name of the Entity
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"time": "integer"
}
Entity Identifier
time
{
"id": "string",
"type": "string",
"specversion": "string",
"source": "string",
"message_group": "string",
"status": "string",
"total": "integer",
"start": "integer",
"end": "integer",
"timestamp": "integer",
"data": [
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "UserDefinedEvent",
"recommendations": [
"string"
],
"notes": "string",
"severity": "string",
"absolute_limit": "integer",
"upper_threshold": "integer",
"lower_threshold": "integer",
"is_percentage": "boolean",
"sub_type": "string",
"alert_entity_type": "VirtualMachine",
"entity_count": "integer"
}
Entity change information over databus. example - ProblemEvent
{
"id": "string",
"type": "string",
"specversion": "string",
"source": "string",
"message_group": "string",
"status": "string",
"deleted_at": "integer",
"data": {
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine"
}
}
{
"entity_id": "string",
"value": "number"
}
entity_id
value
{
"results": [
{
"metric": "string",
"display_name": "string",
"intervals": [
"integer"
],
"description": "string",
"unit": "string"
}
]
}
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"time": "integer",
"name": "string"
}
{
"src_entity_id": "1000:104:12213212",
"src_entity_type": "VirtualMachine",
"dst_entity_id": "1000:104:56789",
"dst_entity_type": "VirtualMachine"
}
Source Entity Identifier
Destination Entity Identifier
{
"scope_type": "string",
"entity_ids": [
"string"
]
}
entity_ids
The entity type of an object. This is how Operations for Networks identifies different objects like VMs, Hosts, Switches, etc.
{
"results": [
{
"entity_id": "10000:1:15332641552",
"entity_type": "DataSource",
"name": "vcenter",
"identifier": "10.98.101.59"
}
]
}
{
"entity_id": "10000:1:15332641552",
"entity_type": "DataSource",
"name": "vcenter",
"identifier": "10.98.101.59"
}
Entity ID for a connected client
Type of Entity
Name of connected client
Identifier/AccessKey/IP Adress of connected client
{
"entity_id": "18230:3:187309184",
"entity_type": "VirtualMachine",
"entity": {
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine"
},
"time": "integer"
}
Entity Identifier
The timestamp of this object
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
code
message
target
The entity ID of the manager of entity on which event is raised
{
"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"
]
}
]
}
{
"threshold_upper_bound": "integer",
"threshold_lower_bound": "integer",
"violation_value": "integer",
"metric": "string",
"violation_time_stamp": "integer"
}
Threshold Upper Bound
Threshold Lower Bound
Violation Value
Metric Name
Violation Time Stamp in milliseconds
Event severity filter
Status of event open or closed
Event tags
Type of event, e.g UserDefinedProblemEvent
{
"results": [
{
"id": "string",
"entity_type": "string",
"node_type": "string",
"node_id": "string",
"ip_address": "string",
"ipv6_address": "string",
"name": "string",
"is_physical_flow_collector": "boolean",
"sddc_details": {
"sddc_id": "string",
"org_id": "string",
"aap_id": "string"
},
"version": "string",
"health": {
"health_status": "HEALTH",
"health_details": [
{
"message": "Invalid credentials",
"code": "string"
}
]
},
"registered_timestamp": "integer",
"last_updated_timestamp": "integer"
}
],
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"totalRecords": 3
}
Total number of errors. To view errors in detail, check /groups/discovered-applications/custom-config/fbad/fileErrors/csv
{
"filepath": "RkJBRF9URU1QX0ZJTEU6OklZTU9zQzd1NnQ5S0lEY0xybXRYRVEuY3N2"
}
Encoded file path
{
"results": [
"16710:969:5155421418804951043",
"16710:969:5155421418804951044"
]
}
results
{
"scope_object_type": 66,
"scope_entities": [
"Cluster-3",
"Haas-cluster-adhoc",
"HaaS-Cluster-6",
"HaaS-Regression-Cluster-7",
"HaaS-Cluster-2"
],
"full_fetch_flow_interval_in_sec": 604800,
"pause_discovery": false,
"application_naming_preferences": [
{
"type": "LB_VIRTUAL_SERVERS"
},
{
"type": "NSX_SECURITY_GROUPS"
},
{
"type": "SECURITY_TAGS"
},
{
"type": "VCENTER_TAGS",
"values": [
"AppSystem",
"App Sys",
"App_ownership"
]
},
{
"type": "VM_NAMES",
"values": [
".*?_([^-_@. ]*)-([^-_@. ]*)-.*"
]
}
],
"tier_naming_preferences": [
{
"type": "LB_VIRTUAL_SERVERS"
},
{
"type": "NSX_SECURITY_GROUPS"
},
{
"type": "SECURITY_TAGS"
},
{
"type": "VCENTER_TAGS",
"values": [
"TestDB",
"TestDB2",
"Space"
]
},
{
"type": "VM_NAMES",
"values": [
".*?_([^-_@. ]*)-.*"
]
}
],
"discovery_options": [
{
"type": "CSV",
"value": "RkJBRF9URU1QX0ZJTEU6OklZTU9zQzd1NnQ5S0lEY0xybXRYRVEuY3N2"
},
{
"type": "LB"
}
]
}
The type of objects in the scope entities
The list of name of the entities to be considered in discovery scope
Full fetch flow interval in seconds. Range of allowed values is number of seconds in one week to number of seconds in one month, both values included.
True means pause the application and tier discovery and false means resume flow based application and tier discovery
List of application naming preferences. The order should be the same as tier naming preferences. VM Names preference will be added to the end of the naming preferences if not present already.
List of tier naming preferences. The order should be the same as application naming preferences. VM Names preference will be added to the end of the naming preferences if not present already.
The ordered list of preferences to be used for discovery of applications and tiers to improve flow based application discovery. Add CSV enrichment preference to use the uploaded CSV in improving discovery. LB enrichment preference will be added at the end of the list if not present already.
{
"id": "16710:969:5155421418804951043",
"scope_object_type": 66,
"scope_entities": [
"Cluster-3",
"Haas-cluster-adhoc",
"HaaS-Cluster-6",
"HaaS-Regression-Cluster-7",
"HaaS-Cluster-2"
],
"full_fetch_flow_interval_in_sec": 604800,
"pause_discovery": false,
"application_naming_preferences": [
{
"type": "LB_VIRTUAL_SERVERS"
},
{
"type": "NSX_SECURITY_GROUPS"
},
{
"type": "SECURITY_TAGS"
},
{
"type": "VCENTER_TAGS",
"values": [
"AppSystem",
"App Sys",
"App_ownership"
]
},
{
"type": "VM_NAMES",
"values": [
".*?_([^-_@. ]*)-([^-_@. ]*)-.*"
]
}
],
"tier_naming_preferences": [
{
"type": "LB_VIRTUAL_SERVERS"
},
{
"type": "NSX_SECURITY_GROUPS"
},
{
"type": "SECURITY_TAGS"
},
{
"type": "VCENTER_TAGS",
"values": [
"TestDB",
"TestDB2",
"Space"
]
},
{
"type": "VM_NAMES",
"values": [
".*?_([^-_@. ]*)-.*"
]
}
],
"discovery_options": [
{
"type": "CSV",
"value": "RkJBRF9QRVJNOjpuYW1pbmdfcHJlZmVyZW5jZXNfMTAwMDBfOTY5Xzg3NzE5NDEyMzYyNTk3MTY3NDBfMTY4NjY1OTY0ODQxNC5jc3Y="
},
{
"type": "LB"
}
]
}
{
"last_success": 1677038709211,
"progress": 100,
"error_code": "",
"error_message": ""
}
The timestamp of when flow based application discovery was last successful
The current progress percentage of flow based application discovery task. It will be set to 100 if no flow based discovery task is currently running
Error code of the error that occurs during flow based application discovery
Detailed description of the error that occurs during flow based application discovery
{
"nickName": "SiteT_24_Openshift-VC",
"errorCode": -8,
"errorDescription": "Unknown host",
"entityAttributes": [
{
"key": "Data Source Type",
"value": "VCENTER"
}
]
}
Nick name of the entity for which restore failed
Error code of the reason behind restore failure of the entity
Reason behind the restore failure of the entity
List of attributes related to an entity
{
"entity_ids": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"time": "integer"
}
]
}
entity_ids
File Server type.
A filter expression is a predicate expression (similar to SQL where clause) used to define the search criteria
{
"membership": {
"membershipType": "string",
"objectType": "integer",
"entities": [
{
"modelKey": "string",
"name": "string"
}
],
"query": "string"
}
}
{
"modelKey": "string",
"name": "string"
}
Entity model key
Entity name
{
"membershipType": "string",
"objectType": "integer",
"entities": [
{
"modelKey": "string",
"name": "string"
}
],
"query": "string"
}
Intent type
filter rule entity type
filter rule query
{
"firewall_entity_id": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vendor_info": {
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
},
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rules": [
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"anySrcInterface": "boolean",
"anyDstInterface": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"source_vm": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_vm": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_vnic": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_vnic": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_vpc": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_vpc": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_cloud_network": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_cloud_network": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_azure_nsg": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_azure_nsg": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_datacenter": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_datacenter": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "VirtualMachine",
"entity_name": "string"
},
"destination_l2_network": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"port": {
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
},
"source_folders": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destination_folders": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"source_resource_pool": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_resource_pool": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_cluster": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_cluster": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"protocol": "string",
"source_ip_sets": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destination_ip_sets": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"source_security_groups": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destination_security_groups": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"traffic_type": "string",
"source_security_tags": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destination_security_tags": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"source_host": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_host": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_vm_tags": [
"string"
],
"destination_vm_tags": [
"string"
],
"within_host": "boolean",
"firewall_action": "string",
"firewall_rule_id": "string",
"flow_tag": [
"string"
]
}
{
"name": "string",
"value": "number"
}
name
value
{
"property_type": "string",
"count": "integer",
"query": "string"
}
property_type
count
query
{
"ingress_bytes": "integer",
"egress_bytes": "integer"
}
Incoming traffic in bytes
Outgoing traffic in bytes
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
The basis of raising of alerts. It can take a value SEARCH_RESULT_CHANGE or ZERO_SEARCH_RESULTS
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"nsx_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"sddc_id": "string",
"org_id": "string",
"org_name": "string",
"vc_private_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"vc_public_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"vc_fqdn": "string",
"nsx_private_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"nsx_public_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"nsx_fqdn": "string",
"cloud_provider_type": "string"
}
{
"isEnabled": "boolean",
"fromTimeStamp": "integer",
"toTimeStamp": "integer"
}
isEnabled
fromTimeStamp
toTimeStamp
The granularity of the discovered applications. Only applies to flow based discovery. Allowed values are FINE, MEDIUM and COARSE.
{
"srcId": "string",
"dstId": "string"
}
srcId
dstId
{
"id": "string",
"name": "string",
"entityId": "string"
}
id
name
entityId
{
"nodes": [
{
"id": "string",
"name": "string",
"entityId": "string"
}
],
"edges": [
{
"srcId": "string",
"dstId": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"members": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": 100,
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
],
"series_values": [
{
"field": "string",
"aggregation_type": "string",
"resolution_in_secs": "integer",
"series": [
[
{}
]
]
}
]
}
count of entity in group
{
"entity_ids": [
"10000:561:123456789",
"10000:562:987654321"
],
"cursor": "CKWP=="
}
entity_ids
cursor
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"appliance_type": "string",
"service_mesh": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"site": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"compute_profile": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"peer_appliances": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"tunnels": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"compute_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"state": "string",
"appliance_version": "string",
"appliance_status": {
"overall_status": "string",
"overall_transport_status": "string",
"service_pipeline_status": "string",
"overall_encryption_status": "string",
"wan_opt_status": "string",
"system_state": "string"
},
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"device": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"overall_status": "string",
"overall_transport_status": "string",
"service_pipeline_status": "string",
"overall_encryption_status": "string",
"wan_opt_status": "string",
"system_state": "string"
}
overall_status
overall_transport_status
service_pipeline_status
overall_encryption_status
wan_opt_status
system_state
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"state": "string",
"network_profiles": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"compute": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"switches": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"storage": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"gateway": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"prefix_length": "integer",
"primary_DNS": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"secondary_DNS": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"dns_suffix": "string",
"ip_address_ranges": [
{
"start_ip": "string",
"end_ip": "string"
}
]
}
prefix_length
dns_suffix
{
"mon": "boolean"
}
Is HCX Mobility Optimized Network Enabled
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"source_site": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_site": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_compute": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_compute": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_l2_network": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"destination_l2_network": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"gateway": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"netmask": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"layer3_domain": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"source_appliance": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"remote_appliance": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"proximity_routing": "boolean",
"mon": "boolean",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"tunnels": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"local_site": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"sddc_type": "string",
"cloud_provider_type": "string",
"endpoint_id": "string",
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"compute_managers": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"sddc": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"version": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"state": "string",
"mtu": "integer",
"ip_scopes": [
{
"gateway": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"prefix_length": "integer",
"primary_DNS": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"secondary_DNS": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"dns_suffix": "string",
"ip_address_ranges": [
{
"start_ip": "string",
"end_ip": "string"
}
]
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"service_mesh": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"service_type": "string",
"status": "string",
"hcx_manager_pair": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"running_state": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"state": "string",
"services": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"compute_profiles": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"hcx_manager_pair": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"endpoint_id": "string",
"endpoint_type": "string",
"sddc_type": "string",
"cloud_type": "string",
"cloud_provider_type": "string",
"compute_managers": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"remote_sites": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"local_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"remote_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"local_port": "integer",
"remote_port": "integer",
"source_appliance": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"remote_appliance": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"tunnel_type": "string",
"tunnel_state": "string",
"local_site": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"remote_site": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"l2_extensions": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"credentials": {
"username": "readonly",
"password": "VMware1!"
}
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
}
}
{
"health_status": "HEALTH",
"health_details": [
{
"message": "Invalid credentials",
"code": "string"
}
]
}
Is the data source/collector healthy and data is being collected?
{
"message": "Invalid credentials",
"code": "string"
}
Message for when the data source/collector is not healthy
code
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vmknics": [
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"vlan": {
"begin": "integer",
"end": "integer"
},
"host": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"layer2_network": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
],
"cluster": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vm_count": 100,
"datastores": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"service_tag": "CT1342",
"vendor_id": "host-12",
"nsx_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"maintenance_mode": "false",
"connection_state": "DISCONNECTED",
"cpu_count": 4,
"memory": 1024,
"manager_uuid": "string",
"tag_keys": [
"string"
],
"tag_key_values": [
"string"
],
"tag_values": [
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine"
}
The Entity ID of object requestion information on
{
"results": [
{
"src_entity": "string",
"src_entity_id": "string",
"src_entity_type": "string",
"dst_Port": "string",
"firewall_rule": "string",
"firewall_rule_id": "string",
"incomplete_tcp_session_count": "integer"
}
],
"start_time": "integer",
"end_time": "integer",
"total_count": "integer"
}
start_time
end_time
total_count
{
"src_entity": "string",
"src_entity_id": "string",
"src_entity_type": "string",
"dst_Port": "string",
"firewall_rule": "string",
"firewall_rule_id": "string",
"incomplete_tcp_session_count": "integer"
}
src_entity
src_entity_id
src_entity_type
dst_Port
firewall_rule
firewall_rule_id
incomplete_tcp_session_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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
}
}
Unique Name
entityId
vendor_id
manager_id
vendor_id
manager_id
Whether or not to collect flows from the VPC Flow Logs
Automatically add linked accounts
role_arn_suffix
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Limit collection to only regions specified in selected_regions
selected_regions
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Whether or not to collect flows from the VPC Flow Logs
Automatically add linked accounts
role_arn_suffix
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Limit collection to only regions specified in selected_regions
selected_regions
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Whether or not to collect flows from the VPC Flow Logs
Automatically add linked accounts
role_arn_suffix
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Limit collection to only regions specified in selected_regions
selected_regions
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Whether or not to collect flows from the VPC Flow Logs
Automatically add linked accounts
role_arn_suffix
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Limit collection to only regions specified in selected_regions
selected_regions
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Whether or not to collect flows from the VPC Flow Logs
Automatically add linked accounts
role_arn_suffix
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Limit collection to only regions specified in selected_regions
selected_regions
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Whether or not to collect flows from the VPC Flow Logs
Automatically add linked accounts
role_arn_suffix
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Limit collection to only regions specified in selected_regions
selected_regions
Should not be populated. Will be ignored if populated.
Should not be populated. Will be ignored if populated.
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Timestamp of when the object was created
The username of who created the object
Timestamp of when the object was last modified
The username of who last modified the object
The service which last modified the application.
The count of all the tiers of the application.
The count of all the members of the application.
The confidence of discovery of this application, if applicable.
Timestamp of when the object was created
The username of who created the object
Timestamp of when the object was last modified
The username of who last modified the object
The service which last modified the application.
The count of all the tiers of the application.
The count of all the members of the application.
The confidence of discovery of this application, if applicable.
Timestamp of when the object was created
The username of who created the object
Timestamp of when the object was last modified
The username of who last modified the object
The service which last modified the application.
The count of all the tiers of the application.
The count of all the members of the application.
The confidence of discovery of this application, if applicable.
Timestamp of when the object was created
The username of who created the object
Timestamp of when the object was last modified
The username of who last modified the object
The service which last modified the application.
The count of all the tiers of the application.
The count of all the members of the application.
The confidence of discovery of this application, if applicable.
total
start
end
timestamp
deleted_at
Whether or not to collect flow data from the VNET Flow Logs
Identifier of web proxy to be used for connection. If not given or empty, will clear any web proxy used earlier
Whether or not to collect flow data from the VNET Flow Logs
Identifier of web proxy to be used for connection. If not given or empty, will clear any web proxy used earlier
Whether or not to collect flow data from the VNET Flow Logs
Identifier of web proxy to be used for connection. If not given or empty, will clear any web proxy used earlier
Whether or not to collect flow data from the VNET Flow Logs
Identifier of web proxy to be used for connection. If not given or empty, will clear any web proxy used earlier
Whether or not to collect flow data from the VNET Flow Logs
Identifier of web proxy to be used for connection. If not given or empty, will clear any web proxy used earlier
Whether or not to collect flow data from the VNET Flow Logs
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Whether or not to collect flow data from the VNET Flow Logs
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
vendor_id
secondary_id
manager_id
vendor_id
secondary_id
manager_id
Event message
Event tags
Administrative state of the event
Whether of not the event is archived
Epoc timestamp of when the event was triggered
The type of event
A list of recommended remedies
User added custom notes
rule_id
section_id
section_name
sequence_number
source_any
destination_any
service_any
anySrcInterface
anyDstInterface
disabled
source_inversion
destination_inversion
rule_id
section_id
section_name
sequence_number
source_any
destination_any
service_any
anySrcInterface
anyDstInterface
disabled
source_inversion
destination_inversion
rule_id
section_id
section_name
sequence_number
source_any
destination_any
service_any
anySrcInterface
anyDstInterface
disabled
source_inversion
destination_inversion
section_id
precedence
vendor_id
vendor
vendor_id
vendor
network_addresses
gateways
network_addresses
gateways
vendor_id
vendor_id
protocol
protocol
This field is deprecated and only contains IPv4 default gateway of the VM, please use default_gateways.
Default gateways of the VM
tag_keys
tag_key_values
tag_values
UUID of the VM
UUID of the Manager
This field is deprecated and only contains IPv4 default gateway of the VM, please use default_gateways.
Default gateways of the VM
tag_keys
tag_key_values
tag_values
UUID of the VM
UUID of the Manager
Total CPUs inside the cluster
Total memory inside the cluster
Total CPU Cores inside the cluster
Internal vCenter ID of the cluster
Number of ESXi hosts in the cluster
Number of datastores in the cluster
UUID of the Manager
Total CPUs inside the cluster
Total memory inside the cluster
Total CPU Cores inside the cluster
Internal vCenter ID of the cluster
Number of ESXi hosts in the cluster
Number of datastores in the cluster
UUID of the Manager
Associated NSX-T data source entity ID
User who created the credential profile
User who modified the credential profile
creation time of credential profile
modified time of credential profile
last_modified_timestamp
last_activity_timestamp
last_config_activity_timestamp
Discovery Job Id
Discovery Job Name
list of network or CIDR range for network discovery
list of seed device for network discovery
depth of seed discovery
list of ip/fqdn which needs to be ignored during discovery
list of credential profile entity ids to be used during discovery
modelKey of proxy node
modelKey of discovery profile
local_asn
tunnel_id
dx_connection_id
mtu
remote_asn
state
bgp_status
type
local_asn
tunnel_id
dx_connection_id
mtu
remote_asn
state
bgp_status
type
total
start
end
timestamp
The configured absolute limit.
The configured upper threshold value at which the alert is raised.
The configured lower threshold value at which the alert is raised.
Indicates whether the threshold value is in percentage of the absolute limt or not.
Event sub-type.
The count of entities at which the alert is raised.
deleted_at
name
name
The id of discovery config
The id of discovery config
The id of discovery config
The id of discovery config
source_vm_tags
destination_vm_tags
within_host
firewall_rule_id
source_vm_tags
destination_vm_tags
within_host
firewall_rule_id
enable_ds_associated_tags
enable_ds_associated_tags
enable_ds_associated_tags
enable_ds_associated_tags
enable_ds_associated_tags
enable_ds_associated_tags
enable_ds_associated_tags
sddc_id
org_id
org_name
vc_fqdn
nsx_fqdn
sddc_id
org_id
org_name
vc_fqdn
nsx_fqdn
vendor_id
appliance_type
state
appliance_version
vendor_id
appliance_type
state
appliance_version
vendor_id
proximity_routing
mon
vendor_id
proximity_routing
mon
vendor_id
sddc_type
cloud_provider_type
endpoint_id
version
vendor_id
sddc_type
cloud_provider_type
endpoint_id
version
vendor_id
state
mtu
vendor_id
state
mtu
vendor_id
endpoint_id
endpoint_type
sddc_type
cloud_type
cloud_provider_type
vendor_id
endpoint_id
endpoint_type
sddc_type
cloud_type
cloud_provider_type
vendor_id
local_port
remote_port
tunnel_type
tunnel_state
vendor_id
local_port
remote_port
tunnel_type
tunnel_state
Number of VMs running on the host
Hardware service tag of the host
Internal vCenter ID of the host
Is the host in maintenance mode?
Connection state of the host
Number of vCPUs this Host has
Amount of memory this Host has in MB.
UUID of the Manager
tag_keys
tag_key_values
tag_values
Number of VMs running on the host
Hardware service tag of the host
Internal vCenter ID of the host
Is the host in maintenance mode?
Connection state of the host
Number of vCPUs this Host has
Amount of memory this Host has in MB.
UUID of the Manager
tag_keys
tag_key_values
tag_values
Associated NSX-T data source entity Id
Associated NSX-T data source entity Id
Associated NSX-T data source entity Id
status
vendor_id
labels
creation_timestamp
annotations
status
vendor_id
labels
creation_timestamp
annotations
roles
labels
creation_timestamp
annotations
ready_status
os_image
kubelet_version
kube_proxy_version
vendor_id
roles
labels
creation_timestamp
annotations
ready_status
os_image
kubelet_version
kube_proxy_version
vendor_id
labels
vendor_id
creation_timestamp
annotations
ready_status
labels
vendor_id
creation_timestamp
annotations
ready_status
vendor_id
annotations
labels
creation_timestamp
type
selectors
vendor_id
annotations
labels
creation_timestamp
type
selectors
sub_types
next_hop_gateways
ospf
scope_type
status
nat_enabled
edge_state
vni
operation_mode
Enforcement Point Unique ID of Logical Router
sub_types
next_hop_gateways
ospf
scope_type
status
nat_enabled
edge_state
vni
operation_mode
Enforcement Point Unique ID of Logical Router
pointlist
pointlist
pointlist
pointlist
logging_enabled
version
control_cluster_status
management_connection_status
vendor_id
version
control_cluster_status
management_connection_status
vendor_id
version
management_cluster_status
vendor_id
tag_keys
tag_key_values
version
management_cluster_status
vendor_id
tag_keys
tag_key_values
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Whether or not to configure NSX-T to send virtual infrastructure latency metrics to Operations for Networks
Whether or not to configure NSX Intelligence to send additional traffic information to Operations for Networks
Public Certificate to connect to NSX-T
Private Key to connect to NSX-T
Data source sub type
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Whether or not to configure NSX-T to send virtual infrastructure latency metrics to Operations for Networks
Whether or not to configure NSX Intelligence to send additional traffic information to Operations for Networks
Public Certificate to connect to NSX-T
Private Key to connect to NSX-T
Data source sub type
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Whether or not to configure NSX-T to send virtual infrastructure latency metrics to Operations for Networks
Whether or not to configure NSX Intelligence to send additional traffic information to Operations for Networks
Public Certificate to connect to NSX-T
Private Key to connect to NSX-T
Data source sub type
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Whether or not to configure NSX-T to send virtual infrastructure latency metrics to Operations for Networks
Whether or not to configure NSX Intelligence to send additional traffic information to Operations for Networks
Public Certificate to connect to NSX-T
Private Key to connect to NSX-T
Data source sub type
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Whether or not to configure NSX-T to send virtual infrastructure latency metrics to Operations for Networks
Whether or not to configure NSX Intelligence to send additional traffic information to Operations for Networks
Public Certificate to connect to NSX-T
Private Key to connect to NSX-T
Data source sub type
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Whether or not to configure NSX-T to send virtual infrastructure latency metrics to Operations for Networks
Whether or not to configure NSX Intelligence to send additional traffic information to Operations for Networks
Public Certificate to connect to NSX-T
Private Key to connect to NSX-T
Data source sub type
enable_ds_associated_tags
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Whether or not to configure NSX-T to send virtual infrastructure latency metrics to Operations for Networks
Whether or not to configure NSX Intelligence to send additional traffic information to Operations for Networks
Public Certificate to connect to NSX-T
Private Key to connect to NSX-T
Data source sub type
enable_ds_associated_tags
node_type
maintenance_mode
vendor_id
roll_up_status
management_status
control_status
pnic_status
tunnel_status
deployment_type
deployment_status
ecmp
tag_keys
tag_key_values
node_type
maintenance_mode
vendor_id
roll_up_status
management_status
control_status
pnic_status
tunnel_status
deployment_type
deployment_status
ecmp
tag_keys
tag_key_values
Associated vCenter data source entity ID
Whether or not to configure NSX-v to send IPFIX to Operations for Networks
Whether or not collection via the Central CLI for ESG data is enabled
Whether or not to configure NSX-v to send virtual infrastructure latency metrics to Operations for Networks
Associated vCenter data source entity ID
Whether or not to configure NSX-v to send IPFIX to Operations for Networks
Whether or not collection via the Central CLI for ESG data is enabled
Whether or not to configure NSX-v to send virtual infrastructure latency metrics to Operations for Networks
Associated vCenter data source entity ID
Whether or not to configure NSX-v to send IPFIX to Operations for Networks
Whether or not collection via the Central CLI for ESG data is enabled
Whether or not to configure NSX-v to send virtual infrastructure latency metrics to Operations for Networks
Associated vCenter data source entity ID
Whether or not to configure NSX-v to send IPFIX to Operations for Networks
Whether or not collection via the Central CLI for ESG data is enabled
Whether or not to configure NSX-v to send virtual infrastructure latency metrics to Operations for Networks
Associated vCenter data source entity ID
Whether or not to configure NSX-v to send IPFIX to Operations for Networks
Whether or not collection via the Central CLI for ESG data is enabled
Whether or not to configure NSX-v to send virtual infrastructure latency metrics to Operations for Networks
Associated vcenter data source entity ID
Whether or not to configure NSX-v to send IPFIX to Operations for Networks
Whether or not collection via the Central CLI for ESG data is enabled
Whether or not to configure NSX-v to send virtual infrastructure latency metrics to Operations for Networks
Associated vcenter data source entity ID
Whether or not to configure NSX-v to send IPFIX to Operations for Networks
Whether or not collection via the Central CLI for ESG data is enabled
Whether or not to configure NSX-v to send virtual infrastructure latency metrics to Operations for Networks
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 NSX-T Manager data source entity ID
Associated NSX-T Manager data source entity ID
Cloud Services Portal API Refresh Token. You can generate this via the CSP UI under My Account and API Tokens.
Associated vcenter data source entity ID
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Identifier of web proxy to be used for connection
Data source sub type
Cloud Services Portal API Refresh Token. You can generate this via the CSP UI under My Account and API Tokens.
Associated vcenter data source entity ID
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Identifier of web proxy to be used for connection
Data source sub type
Cloud Services Portal API Refresh Token. You can generate this via the CSP UI under My Account and API Tokens.
Associated vcenter data source entity ID
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Identifier of web proxy to be used for connection
Data source sub type
Cloud Services Portal API Refresh Token. You can generate this via the CSP UI under My Account and API Tokens.
Associated vcenter data source entity ID
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Identifier of web proxy to be used for connection
Data source sub type
Cloud Services Portal API Refresh Token. You can generate this via the CSP UI under My Account and API Tokens.
Associated vcenter data source entity ID
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Identifier of web proxy to be used for connection
Data source sub type
Cloud Services Portal API Refresh Token. You can generate this via the CSP UI under My Account and API Tokens.
Associated vcenter data source entity ID
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Data source sub type
Cloud Services Portal API Refresh Token. You can generate this via the CSP UI under My Account and API Tokens.
Associated vcenter data source entity ID
Whether or not to configure NSX-T to send IPFIX to Operations for Networks
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Data source sub type
severity
severity
Operational status
Administrative status
duplex
connected
physicalAddress
Boolean flag to indicate Sub Interface.
Router Port Type
uRPFMode
Operational status
Administrative status
duplex
connected
physicalAddress
Boolean flag to indicate Sub Interface.
Router Port Type
uRPFMode
Unique Name
entityId
Unique Name
entityId
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Identifier of web proxy to be used for connection
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Identifier of web proxy to be used for connection
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Identifier of web proxy to be used for connection
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Identifier of web proxy to be used for connection
Associated nsxt data source entity Id
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Identifier of web proxy to be used for connection
Associated ServiceNow instance
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
Associated ServiceNow instance
CMDB configuration for CIs, relationships and graph traversal rules
Has graph configuration been modified from the default configuration
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
cidr
vlan_id
cidr
vlan_id
cidr
vlan_id
enable_ds_associated_tags
enable_ds_associated_tags
total_count
refs_added_count
refs_deleted_count
vendor_id
UUID of the Manager
vendor_id
UUID of the Manager
Whether vCenter is a VMware Cloud operated vCenter (true or false).
Optional field for Vmware Cloud operated vCenter (VMCVCENTER)
enable_ds_associated_tags
Whether vCenter is a VMware Cloud operated vCenter (true or false).
Optional field for Vmware Cloud operated vCenter (VMCVCENTER)
enable_ds_associated_tags
Whether vCenter is a VMware Cloud operated vCenter (true or false).
Optional field for Vmware Cloud operated vCenter (VMCVCENTER)
enable_ds_associated_tags
Whether vCenter is a VMware Cloud operated vCenter (true or false).
Optional field for Vmware Cloud operated vCenter (VMCVCENTER)
enable_ds_associated_tags
Whether vCenter is a VMware Cloud operated vCenter (true or false).
Optional field for Vmware Cloud operated vCenter (VMCVCENTER)
enable_ds_associated_tags
Whether vCenter is a VMware Cloud operated vCenter (true or false).
Optional field for Vmware Cloud (VMCVCENTER)
enable_ds_associated_tags
Whether vCenter is a VMware Cloud operated vCenter (true or false).
Optional field for Vmware Cloud (VMCVCENTER)
enable_ds_associated_tags
Whether or not to configure vCenter to send IPFIX to Operations for Networks
Whether or not to configure vCenter to send IPFIX to Operations for Networks
group_id
org_id
org_name
provider_type
deployment_type
state
group_id
org_id
org_name
provider_type
deployment_type
state
vendor_id
asn
state
arn
org_id
region
vendor_id
asn
state
arn
org_id
region
Validation status of a connected entity with the updated web proxy details
Error code in case validation failed
Error message in case validation failed
Identifier of web proxy to be used for connection
URL of data source (use either IP or FQDN, not both)
Identifier of web proxy to be used for connection
URL of data source (use either IP or FQDN, not both)
Identifier of web proxy to be used for connection
URL of data source (use either IP or FQDN, not both)
Identifier of web proxy to be used for connection
URL of data source (use either IP or FQDN, not both)
Identifier of web proxy to be used for connection
URL of data source (use either IP or FQDN, not both)
capacity
disk_format
thin_provisioned
filename
capacity
disk_format
thin_provisioned
filename
local_asn
local_asn
{
"type": "string",
"frequency": "string",
"enabled": true,
"receivers": [
[
"[email protected]"
]
],
"schedule": [
{
"type": "string",
"periodInMS": "integer",
"startTimestamp": "integer"
}
]
}
Intent type
Intent freq
enabled
Intent receivers
{
"type": "string",
"periodInMS": "integer",
"startTimestamp": "integer"
}
Intent type
Intent period
Intent time stamp
{
"id": "min-violation-duration",
"values": "VIOLATION_DURATION_FIVE_MINUTES",
"valueType": "FIXED_MULTI_CHOICE_SINGLE_VALUE"
}
Intent param id
Intent param value
Intent param valueType
{
"id": "string",
"name": "string",
"type": "string"
}
id
name
type
Interval type. Supported values are DAY, WEEK, MONTH applicable only for CUSTOM RecurrenceType
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
ip_address
netmask
network_address
Ip Address membership definition
{
"ip_addresses": [
"string"
]
}
ip_addresses
{
"start_ip": "string",
"end_ip": "string"
}
start_ip
end_ip
The Ip Address of object
{
"start": "integer",
"end": "integer",
"ip_range_start": "string",
"ip_range_end": "string"
}
Long value of IPv4 range start address (set to 0 for IPv6 ranges)
Long value of IPv4 range end address (set to 0 for IPv6 ranges)
Start address of IPv6 range (set only for IPv6 ranges)
End address of IPv6 range (set only for IPv6 ranges)
{
"subnet": "string",
"ip_address_range": {
"start_ip": "string",
"end_ip": "string"
}
}
subnet
{
"tag_id": "string",
"subnets": [
"string"
],
"ip_address_ranges": [
{
"start_ip": "string",
"end_ip": "string"
}
]
}
tag_id
subnets
{
"tag_id": "string",
"entries": [
{
"parent": {
"subnet": "string",
"ip_address_range": {
"start_ip": "string",
"end_ip": "string"
}
},
"exclusions": [
{
"subnet": "string",
"ip_address_range": {
"start_ip": "string",
"end_ip": "string"
}
}
]
}
]
}
tag_id
{
"parent": {
"subnet": "string",
"ip_address_range": {
"start_ip": "string",
"end_ip": "string"
}
},
"exclusions": [
{
"subnet": "string",
"ip_address_range": {
"start_ip": "string",
"end_ip": "string"
}
}
]
}
{
"tag_ids": [
"string"
]
}
tag_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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"kubeconfig": {
"apiVersion": "v1",
"clusters": {
"cluster": {
"api-version": "v1",
"server": "http://cow.org:8080",
"name": "cow-cluster"
}
}
}
}
Configuration used to connect to Kubernetes. Can be found in ~/.kube/config
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vendor_id": "string",
"running_as": "string",
"api_server": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"master_nodes": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"manager_id": "192.168.10.1",
"credentials": {
"kubeconfig": {
"apiVersion": "v1",
"clusters": {
"cluster": {
"api-version": "v1",
"server": "http://cow.org:8080",
"name": "cow-cluster"
}
}
}
}
}
{
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"kubeconfig": {
"apiVersion": "v1",
"clusters": {
"cluster": {
"api-version": "v1",
"server": "http://cow.org:8080",
"name": "cow-cluster"
}
}
}
},
"manager_id": "18230:3:187309184"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"kubernetes_cluster": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"status": "string",
"l2_networks": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"vendor_id": "string",
"labels": [
"string"
],
"creation_timestamp": "string",
"annotations": [
"string"
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"kubernetes_cluster": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"roles": [
"string"
],
"logical_port": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"labels": [
"string"
],
"vm": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"host": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"creation_timestamp": "string",
"annotations": [
"string"
],
"ready_status": "string",
"os_image": "string",
"kubelet_version": "string",
"kube_proxy_version": "string",
"vendor_id": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"kubernetes_cluster": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"kubernetes_namespace": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"kubernetes_service": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"kubernetes_node": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"vm": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"host": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"logical_port": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"labels": [
"string"
],
"vendor_id": "string",
"creation_timestamp": "string",
"annotations": [
"string"
],
"ready_status": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"kubernetes_cluster": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"annotations": [
"string"
],
"labels": [
"string"
],
"creation_timestamp": "string",
"namespace": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"cluster_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"load_balancer_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"type": "string",
"external_ips": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"service_ports": [
{
"name": "string",
"node_port": "string",
"port": "integer",
"protocol": "string",
"target_port": "string"
}
],
"selectors": [
"string"
]
}
{
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1"
}
ID of Collector VM which should register this vcenter
A friendly nickname for the data source
Whether or not data collection is enabled
Room for notes or comments about the data source
License entitlement types
Types for License Editions
Entitlement supported by the license
{
"capacityType": "string",
"count": "integer"
}
capacity count for entitlement
[
{
"type": "string",
"unit": "string",
"count": 132,
"socketsUsed": 132,
"coresUsed": 1584,
"edgesUsed": "integer",
"devicesUsed": "integer",
"query": "Hosts where manager.SDDC Type = 'ONPREM' and model != 'VMware Mobility Platform' and Witness = False group by manager order by sum(CPU Sockets)"
}
]
Capacity types for license usage
License usage objects
{
"result": {
"productName": "Operations for Networks",
"evaluation": "boolean",
"licenseKey": "AAAAA-BBBBB-CCCCC-DDDDD-EEEE",
"numberOfSockets": 25,
"expirationDate": 1661143082,
"serviceTag": "CPN0EgdEOFVWNzM0",
"expired": "boolean",
"deploymentType": "onprem",
"capacityType": "string",
"edition": "string",
"suspended": "boolean",
"deleted": "boolean",
"invalid": "boolean",
"managedByVrni": "boolean",
"entitlements": [
{
"capacityType": "string",
"count": "integer"
}
],
"currentLicenses": "CurrentLicenses Object"
}
}
license request object
{
"licenseKey": "string"
}
licenseKey
{
"result": {
"licenses": [
{
"productName": "Operations for Networks",
"evaluation": "boolean",
"licenseKey": "AAAAA-BBBBB-CCCCC-DDDDD-EEEE",
"numberOfSockets": 25,
"expirationDate": 1661143082,
"serviceTag": "CPN0EgdEOFVWNzM0",
"expired": "boolean",
"deploymentType": "onprem",
"capacityType": "string",
"edition": "string",
"suspended": "boolean",
"deleted": "boolean",
"invalid": "boolean",
"managedByVrni": "boolean",
"entitlements": [
{
"capacityType": "string",
"count": "integer"
}
],
"currentLicenses": "CurrentLicenses Object"
}
],
"licenseUsage": [
[
{
"type": "string",
"unit": "string",
"count": 132,
"socketsUsed": 132,
"coresUsed": 1584,
"edgesUsed": "integer",
"devicesUsed": "integer",
"query": "Hosts where manager.SDDC Type = 'ONPREM' and model != 'VMware Mobility Platform' and Witness = False group by manager order by sum(CPU Sockets)"
}
]
],
"customerId": 10000,
"cpuCapacity": 10,
"ccuCapacity": 10,
"vmCapacity": 10,
"coreCapacity": 10,
"edgeCapacity": 10,
"serviceTag": "CJBOEgdEQVMzWTFI",
"expireDate": 10,
"enterprise": "boolean",
"evaluation": "boolean",
"numOfEnterpriseLicense": 10,
"numOfValidLicense": 1,
"numOfValidEnterpriseLicense": 10,
"numOfValidSDWANLicense": 5,
"numOfValidNAVLicense": 2,
"numOfValidAdvancedLicense": 5,
"numOfValidROBOLicense": 1,
"numOfActiveLicense": 1,
"numOfActiveEnterpriseLicense": 2,
"numOfActiveSDWANLicense": 1,
"numOfActiveNAVLicense": 7,
"numOfActiveAdvancedLicense": 5,
"numOfActiveROBOLicense": 10,
"usedSockets": 64,
"usedCores": 768,
"usedEdges": 10,
"usedDevices": 10,
"coreLicensePresent": "boolean"
}
}
result
{
"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)
{
"tag_key": true,
"tag_value": true
}
Name of the local tag
Value of the local tag
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"authentication_provider": "Local"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"authentication_provider": "Local"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"sub_types": [
"integer"
],
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"neighbor_vrfs": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"default_gateway_vrfs": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"default_next_hop_router_interfaces": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"next_hop_gateways": [
"string"
],
"ospf": "string",
"scope_type": "string",
"nsx": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"status": "string",
"layer3_domain": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"nat_enabled": "boolean",
"edge_state": "string",
"child_vrfs": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"parent_vrf": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"nat_domain": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vni": "integer",
"operation_mode": "string",
"directly_connected_network": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"directly_connected_gateway": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"enforcement_point_uuid": "string"
}
{
"is_enabled": true,
"login_message_banner": "Please read these terms of Use (the \"Terms\") carefully before using the websites of VMware, Inc. and its subsidiaries (collectively \"VMware\").",
"user_consent_title": "US Gov Term of Use",
"user_consent_description": "By accessing, browing or using these websites, you acknowledge that you have read, understood and agree to be bound by these Terms and to comply with all applicable laws and regulations, including United States export and re-export control laws and regulations, diversion contrary to United States export laws is prohibited. If you do not agree to these Terms, you are not authorized to use these websites."
}
Boolean flag to indicate login banner is enabled/disabled.
A summary of this message along with a link to view it in its entirety will be displayed on the login page. It could be maximum 2,000 characters long with a mix of special characters, alphabets, and numbers.
User consent form title
User consent form description. Users will have to accept the consent form before proceeding to login. The contents of user consent description will be displayed on the login page. It could be maximum 2,000 characters long with a mix of special characters, alphabets, and numbers.
{
"managedByProduct": "string",
"hostname": "string"
}
managedByProduct
hostname
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
Member of a member list
{
"key": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"name": "string"
}
name
Member list
{
"vms": [
{
"key": {
"entity_id": "18230:1:1158969162",
"entity_type": "VIRTUALMACHINE"
},
"name": "VM1"
},
{
"key": {
"entity_id": "18230:601:863301375",
"entity_type": "EC2INSTANCE"
},
"name": "EC2-VM1"
},
{
"key": {
"entity_id": "18230:1702:264351372",
"entity_type": "AZUREVM"
},
"name": "Azure-VM1"
}
],
"physical_ips": [
{
"key": {
"entity_id": "18230:541:365252372",
"entity_type": "IPENDPOINT"
},
"name": "52.35.41.245"
}
],
"kubernetes_services": [
{
"key": {
"entity_id": "18230:1504:263252172",
"entity_type": "KUBERNETESSERVICE"
},
"name": "KS"
}
]
}
{
"metric": "string",
"interval": "integer",
"timestamp": "integer",
"unit": "string",
"entity_type": "VirtualMachine",
"points": [
{
"entity_id": "string",
"value": "number"
}
]
}
Name of the metric
interval
timestamp
unit
[
{}
]
[
{}
]
{
"metric": "string",
"display_name": "string",
"interval": "integer",
"unit": "string",
"start": "integer",
"end": "integer",
"pointlist": [
[
{}
]
]
}
{
"metric": "string",
"display_name": "string",
"interval": "integer",
"unit": "string",
"start": "integer",
"end": "integer"
}
metric
display_name
interval
unit
start
end
{
"pointlist": [
[
{}
]
],
"entity_id": "string"
}
entity_id
{
"timestamps": [
"integer"
],
"values": [
"number"
],
"entity_id": "string"
}
timestamps
values
entity_id
{
"metric": "string",
"display_name": "string",
"interval": "integer",
"unit": "string",
"start": "integer",
"end": "integer",
"pointlist": [
{
"timestamps": [
"integer"
],
"values": [
"number"
]
}
]
}
{
"metric": "string",
"display_name": "string",
"intervals": [
"integer"
],
"description": "string",
"unit": "string"
}
metric
display_name
intervals
description
unit
{
"entity_ids": [
"string"
],
"start_time": "integer",
"end_time": "integer",
"interval": "integer",
"metric": "string"
}
Entity Identifiers
start_time
end_time
Metric resolution
Metric to fetch
{
"metric": "string",
"interval": "integer",
"start": "integer",
"end": "integer",
"display_name": "string",
"unit": "string",
"results": [
{
"pointlist": [
[
{}
]
],
"entity_id": "string"
}
]
}
{
"metric": "string",
"interval": "integer",
"start": "integer",
"end": "integer",
"display_name": "string",
"unit": "string"
}
metric
interval
start
end
display_name
unit
{
"metric": "string",
"interval": "integer",
"start": "integer",
"end": "integer",
"display_name": "string",
"unit": "string",
"results": [
{
"timestamps": [
"integer"
],
"values": [
"number"
],
"entity_id": "string"
}
]
}
{
"entity": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"waveGroups": [
{
"entity_id": "string",
"entity_name": "string",
"mw_name": "string",
"mw_id": "string",
"group_entity_id": "string",
"group_entity_name": "string"
}
],
"groupType": "string",
"timestamp": "number"
}
groupType
timestamp
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"enabled": "boolean",
"controller_password": "string"
}
Whether or not to collect data from the NSX-v Controller Cluster
Controller Password
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"anySrcInterface": "boolean",
"anyDstInterface": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"name": "string",
"status": "string"
}
name
status
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"version": "string",
"control_cluster_status": "string",
"management_connection_status": "string",
"vendor_id": "string",
"device": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"mp_node": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"deployment_type": "string",
"member_node_type": "string",
"members": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"vendor_id": "string",
"ecmp": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"version": "string",
"management_cluster_status": "string",
"node_status_property": {
"cpu_cores": "integer",
"total_ram": "integer",
"total_swap": "integer"
},
"controller_node": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"services_info": [
{
"name": "string",
"status": "string"
}
],
"device": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vendor_id": "string",
"tag_keys": [
"string"
],
"tag_key_values": [
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean",
"ipfix_enabled": "boolean",
"latency_enabled": "boolean",
"nsxi_enabled": "boolean",
"cloud_provider_type": "string",
"cred_type": "string",
"client_certificate": "string",
"client_private_key": "string",
"ds_sub_type": "string"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"ipfix_enabled": true,
"latency_enabled": true,
"nsxi_enabled": true,
"cloud_provider_type": "string",
"cred_type": "string",
"client_certificate": "string",
"client_private_key": "string",
"ds_sub_type": "string",
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"transport_zones": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"fabric_node": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"node_type": "string",
"vsphere_distributed_switches": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"rteps": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"maintenance_mode": "string",
"nsxt_edge_cluster": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"vendor_id": "string",
"roll_up_status": "string",
"management_status": "string",
"control_status": "string",
"pnic_status": "string",
"tunnel_status": "string",
"deployment_type": "string",
"node_status_property": {
"cpu_cores": "integer",
"total_ram": "integer",
"total_swap": "integer"
},
"device": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"deployment_status": "string",
"ecmp": "string",
"tag_keys": [
"string"
],
"tag_key_values": [
"string"
]
}
{
"entity_id": "1000:104:12213212",
"name": "string",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"transport_node": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"cpu_core_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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"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": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"vcenter_id": "18230:3:187309184",
"ipfix_enabled": true,
"central_cli_enabled": true,
"latency_enabled": true
}
{
"entity_id": "string",
"time": "integer"
}
entity_id
time
{
"entities": [
{
"entity_id": "string",
"time": "integer"
}
]
}
{
"entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"time": "integer",
"name": "string"
}
]
}
{
"type": "string",
"values": [
"string"
]
}
values
{
"property_type": "string",
"ingress": "number",
"egress": "number",
"total": "number"
}
property_type
ingress
egress
total
{
"id": "string",
"entity_type": "string",
"node_type": "string",
"node_id": "string",
"ip_address": "string",
"ipv6_address": "string",
"name": "string",
"is_physical_flow_collector": "boolean",
"sddc_details": {
"sddc_id": "string",
"org_id": "string",
"aap_id": "string"
},
"version": "string",
"health": {
"health_status": "HEALTH",
"health_details": [
{
"message": "Invalid credentials",
"code": "string"
}
]
},
"registered_timestamp": "integer",
"last_updated_timestamp": "integer"
}
id
node_type
node_id
ip_address
ipv6_address
name
is_physical_flow_collector
version
registered_timestamp
last_updated_timestamp
{
"id": "1000:104:12213212",
"entity_type": "string"
}
Entity Identifier
{
"results": [
{
"id": "1000:104:12213212",
"entity_type": "string"
}
],
"total_count": 1
}
total_count
{
"cpu_cores": "integer",
"total_ram": "integer",
"total_swap": "integer"
}
cpu_cores
total_ram
total_swap
The frequency of notification. It can take a value IMMEDIATE or DAILY.
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
The custom time of notification. This field needs to be set ONLY in case of Daily Digest Emails.
List of notification receivers.
Set this field to true to enable push notification for current user. This field will be ignored for other notification settings.
The type of notification. It can take a value EMAIL or SNMP.
{
"source": "10.78.89.125",
"destination": "10.78.89.126"
}
Source object value
Destination mapped value
order by
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"manager_id": "string"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"manager_id": "18230:3:187309184"
}
{
"results": [
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"create_time": 159724400600,
"created_by": "admin@local",
"last_modified_time": 159724400600,
"last_modified_by": "[email protected]",
"last_modified_by_service": "Ensemble",
"tier_count": 25,
"member_count": 500,
"update_status": "string",
"confidence": "Medium"
}
],
"cursor": "MTA=",
"total_count": 1102
}
Cursor for the next page
Total number of objects in the system, despite the page limit
{
"results": [
{
"id": "18799:10002:211561153588",
"name": "Custom Dashboard Name",
"description": "This is the Custom Dashboard description",
"create_timestamp": 156789876,
"last_updated_timestamp": 156789876,
"owner": "admin@local",
"users_read_access": [
"[email protected]",
"[email protected]"
],
"users_write_access": [
"[email protected]",
"[email protected]"
],
"pins": [
{
"pin_model_key": "1000:10001:78690089",
"pin_name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
],
"groups_write_access": [
"CN=HR,CN=Users"
],
"groups_read_access": [
"cn=administrators"
]
}
],
"cursor": "integer",
"total_records": "integer"
}
cursor
total_records
{
"results": [
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18"
}
],
"cursor": "MTA=",
"total_count": 1102
}
Cursor for the next page
Total number of objects in the system, despite the page limit
{
"results": [
{
"src_entity_id": "1000:104:12213212",
"src_entity_type": "VirtualMachine",
"dst_entity_id": "1000:104:56789",
"dst_entity_type": "VirtualMachine"
}
],
"cursor": "MTA=",
"total_count": 1102,
"start_time": 1597247025,
"end_time": 1597247999
}
Cursor for the next page
Total number of objects in the system, despite the page limit
Start timestamp of the window of the objects returned
End timestamp of the window of the objects returned
{
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "VirtualMachine",
"entity_name": "VM-1"
}
],
"cursor": "MTA=",
"total_count": 1102,
"start_time": 1597247025,
"end_time": 1597247999
}
Cursor for the next page
Total number of objects
Start timestamp of the window of the objects returned
End timestamp of the window of the objects returned
{
"results": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"time": "integer"
}
],
"cursor": "ML12eu02==",
"total_count": 100,
"start_time": 1504739809,
"end_time": 1504739809
}
Cursor for the next page
Total number of objects returned
Start timestamp of the window of the objects returned
End timestamp of the window of the objects returned
{
"results": [
{
"id": "18799:10002:211561153588",
"name": "Pinboard Name",
"description": "This is the pinboard description",
"create_timestamp": 156789876,
"last_updated_timestamp": 156789876,
"owner": "admin@local",
"users_read_access": [
"[email protected]",
"[email protected]"
],
"users_write_access": [
"[email protected]",
"[email protected]"
],
"pins": [
{
"id": "1000:10001:78690089",
"name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
],
"groups_write_access": [
"CN=HR,CN=Users"
],
"groups_read_access": [
"cn=administrators"
]
}
],
"cursor": "integer",
"total_records": "integer"
}
cursor
total_records
{
"results": [
{
"entity_id": "string",
"start_entity_id": "string",
"name": "string",
"status": "string"
}
],
"total_count": "integer",
"cursor": "MTA="
}
total_count
Cursor for the next page
{
"results": [
{
"id": "[email protected]",
"group_type": "VIDM",
"group_name": "testgroup",
"domain": "vidmlabs.com",
"role": "ADMIN"
}
],
"cursor": "MTA=",
"total_count": 1000
}
cursor
total_count
{
"results": [
{
"id": "[email protected]",
"user_type": "VIDM",
"username": "alleymartin123",
"domain": "vidmlabs.com",
"display_name": "alley martin",
"role": "ADMIN"
}
],
"cursor": "MTA=",
"total_count": 101
}
cursor
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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"username": "readonly",
"password": "VMware1!"
}
Username to authenticate with
Password to authenticate with
{
"firewalls": [
{
"firewall_entity_id": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vendor_info": {
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
},
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rules": [
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"anySrcInterface": "boolean",
"anyDstInterface": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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": "2.2.2.2",
"destination_ip_address": "1.1.1.1",
"port": 80,
"protocol": "TCP",
"time": "integer"
}
Source IP configured in firewall rule
Destination IP configured in firewall rule
Port number configured in firewall rule
Protocol configured in firewall rule
Timestamp of object
{
"id": "1000:10001:78690089",
"name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
Pin model key
Name of the pin
Search query behind the pin
The ID of pin requesting information on
{
"name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
Name of the pin
Search query for the pin
{
"id": "1000:10001:7869000989",
"custom_dashboard_id": "1000:2504:7869098089",
"name": "Pin Name",
"created_timestamp": 1679088763,
"last_updated_timestamp": 16790887689,
"query": "Alert where Severity = 'Critical'",
"pinned_timestamp": 1679088763,
"owner": "admin@local"
}
Model key for the pin
Model key of the custom dashboard of which the pin is part of
Name of the pin
Create timestamp of the pin
Last update timestamop of the pin
Query behind the pin
Timestamp when the pin was pinned
Owner of the pin
{
"name": "Pinboard Name",
"description": "This is a pinboard"
}
Name of the pinboard
Description of the pinboard
{
"id": "18799:10002:211561153588",
"name": "Pinboard Name",
"description": "This is the pinboard description",
"create_timestamp": 156789876,
"last_updated_timestamp": 156789876,
"owner": "admin@local",
"users_read_access": [
"[email protected]",
"[email protected]"
],
"users_write_access": [
"[email protected]",
"[email protected]"
],
"pins": [
{
"id": "1000:10001:78690089",
"name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
],
"groups_write_access": [
"CN=HR,CN=Users"
],
"groups_read_access": [
"cn=administrators"
]
}
Entity Identifier for a pinboard
Descriptor or identifier for particular pinboard.
Description of the pinboard
Create timestamp for pinboard
Last update timestamp for pinboard
User email of the pinboard owner
List of users with read privilege for the pinboard
List of users with read and write privilege for the pinboard
LDAP/VIDM groups with read and write privilege of the pinboard
LDAP/VIDM groups with read privilege of the pinboard
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"csp_refresh_token": "string",
"vcenter_id": "string",
"ipfix_enabled": "boolean",
"web_proxy_id": "string",
"cloud_provider_type": "string",
"ds_sub_type": "string"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"csp_refresh_token": "e9fb6352-03cb-4d98-8f03-b82226c17507",
"vcenter_id": "18230:3:187309184",
"ipfix_enabled": "boolean",
"web_proxy_id": "string",
"cloud_provider_type": "string",
"ds_sub_type": "string"
}
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
start
end
display
iana_name
iana_port_display
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "UserDefinedEvent",
"recommendations": [
"string"
],
"notes": "string",
"severity": "string"
}
{
"entity_id": "1000:104:12213212",
"entity_type": "VirtualMachine",
"name": "My Name",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "UserDefinedEvent",
"recommendations": [
"string"
],
"notes": "string",
"severity": "string",
"time": "integer"
}
Entity Identifier
time
{
"customerId": "integer",
"lifetime": "string",
"remainingValidity": "string",
"lastUpdatedAt": "integer",
"lastUpdatedBy": "string"
}
Customer id
Lifetime (in days) of certificate set by the customer
Remaining number of days for which the certificate is valid
Time (in milli seconds) when the certificate was last updated
Username of the entity which triggered the last update of certificate
{
"customerId": "integer",
"status": "string",
"failedCollectorIds": [
"string"
]
}
Customer id
status
List of collector ids for which proxy key rotation failed
{
"results": [
{
"proxy_id": "web-proxy-er67ght8kn67",
"nick_name": "AWS web Proxy",
"target_ip": "10.11.11.102",
"target_port": 161,
"connected_entities": 3,
"proxy_type": "HTTPS/HTTP",
"auth_type": "Basic/NTLM",
"use_credentials": "true/false",
"user_name": "admin",
"is_modifiable": "true/false"
}
]
}
{
"proxy_id": "web-proxy-er67ght8kn67"
}
Entity Identifier created for the newly configured web proxy server
{
"proxy_id": "web-proxy-er67ght8kn67",
"nick_name": "AWS web Proxy",
"target_ip": "10.11.11.102",
"target_port": 161,
"connected_entities": 3,
"proxy_type": "HTTPS/HTTP",
"auth_type": "Basic/NTLM",
"use_credentials": "true/false",
"user_name": "admin",
"is_modifiable": "true/false"
}
Entity Identifier for a web proxy server
Descriptor or identifier for particular web proxy.
IP address of web Proxy server
Port number of web Proxy server
Number of connected entities to a web proxy
Type of web proxy
Type of authentication
Whether credentials were used earlier when web proxy was configured
Username of the authenticated web proxy
Can the web proxy be edited or deleted from the UI
{
"secret": "sharedSecret",
"validityEpoch": 1605201960327,
"uuid": "87a82a63-d8ed-47bb-a688-49dc1ee06162"
}
Shared secret which will be needed to import the Operations for Networks collector virtual appliance.
Validity of shared secret in epoch time (millis).
Unique ID associated with generated shared secret
{
"sources": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"protocols": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"action": "string"
}
protocols
action
{
"results": [
{
"sources": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"protocols": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"action": "string"
}
],
"time_range": {
"start_time": 1597247025,
"end_time": 1597247999
}
}
{
"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
Recurrence type. Supported values are DAILY, WEEKLY, MONTHLY, CUSTOM
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
entity_id
entity_name
Role assigned the user/group.
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"operationalStatus": "string",
"administrativeStatus": "string",
"internalVrf": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"duplex": "string",
"connected": "boolean",
"physicalAddress": "string",
"vrf": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"l2n": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"subInterface": "boolean",
"routerPortType": "string",
"uRPFMode": "string",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"rules": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"rule_set_type": "string"
}
{
"orgId": "string",
"backup_file_name": "vrni-backup-12-4-5.tar"
}
Organization ID (Only in case of VRNI-Cloud)
filename of the backup to be restored (used during restore only)
{
"community_string": "public"
}
SNMPv2 Community string
{
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
SNMPv3 Username
SNMPv3 Context name
SNMPv3 Authentication type
SNMPv3 Authentication password
SNMPv3 Privacy password type
SNMPv3 Pricacy password
{
"snmp_enabled": true,
"snmp_version": "v2c",
"config_snmp_2c": {
"community_string": "public"
},
"config_snmp_3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
}
Enable SNMP stats collection?
SNMP version to use
{
"snmp_enabled": true,
"snmp_version": "v2c",
"config_snmp_2c": {
"community_string": "public"
},
"config_snmp_3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
},
"name": "SNMP_Credential_1",
"entityId": "1:3102:3",
"account_type": "string"
}
{
"engine_id": "80001adc04417269614F704E6574776F726B73"
}
SNMP Engine ID as a hexadecimal string
{
"username": "readonly",
"password": "VMware1!",
"name": "SSH_Credential_1",
"entityId": "1:3101:3",
"account_type": "string"
}
{
"entity_id": "string",
"name": "string",
"response_code": "string",
"error_message": "string"
}
ID of discovered application which was requested to be saved.
Name of discovered application which was requested to be saved.
Indicates save operation response. eg. SUCCESS
Indicates why application could not be saved.
{
"request_id": "TASK_PROGRESS_application.APP_BULK_SAVE.1641321499579.0.04202820074723557",
"task_name": "APP_BULK_SAVE",
"status": "FINISHED",
"progress": 100,
"start_time": 1641321499579,
"app_save_response": [
{
"entityId": "18203:565:2854896465419091802",
"name": "support-app-web",
"responseCode": "ALREADY_SAVED_APPLICATION",
"errorMessage": "Application email-app is already saved."
}
]
}
RequestId of bulk application save request.
task_name
Status of bulk application save task (eg. FINISHED).
Percent progress of bulk application save task. Task is complete when progress is 100.
start_time
Every application's save operation response.
{
"request_id": "TASK_PROGRESS_application.APP_BULK_SAVE.1641321499579.0.04202820074723557",
"callback_API": "api/ni/groups/task/progress/TASK_PROGRESS_application.APP_BULK_SAVE.1641321499579.0.04202820074723557/"
}
RequestId of bulk application save request.
Path of API which should be called to check status of bulk application save request.
{
"type": "RUN_ONCE",
"value": {
"recurrenceType": "DAILY",
"time": "2:10",
"dayOfWeek": "5",
"dayOfMonth": "3",
"month": "2",
"year": "2022",
"interval": 4,
"intervalType": "DAY"
}
}
Schedule type. Supported values are RUN_ONCE, RECURRENT
{
"recurrenceType": "DAILY",
"time": "2:10",
"dayOfWeek": "5",
"dayOfMonth": "3",
"month": "2",
"year": "2022",
"interval": 4,
"intervalType": "DAY"
}
Scheduled time (UTC) to be provided in the format Hours:Minutes (0-23:0-59)
DAY of the Week to be provided in the format 1-7 -> SUNDAY-SATURDAY
Day of Month to be provided in the format 1-31
Month to be provided in the format 1-12
Year to be provided in the format 2022
Interval at which CUSTOM RecurrenceType job to be run
{
"sddc_id": "string",
"org_id": "string",
"aap_id": "string"
}
sddc_id
org_id
aap_id
{
"results": [
{
"entity_id": "string",
"alert_name": "string",
"enabled": "boolean",
"search_criteria": "string",
"generate_alert_criteria": "string",
"alert_type": "string",
"severity": "string",
"notification_settings": [
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
]
}
],
"total_count": "integer"
}
total_count
{
"alert_name": "string",
"search_criteria": "string",
"generate_alert_criteria": "string",
"alert_type": "string",
"severity": "string",
"notification_settings": [
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
]
}
Name of the Search based Alert Configuration.
The search query for the search-based alert configuration.
Notifications configured for alerts corresponding to this alert configuration.
{
"entity_id": "string",
"alert_name": "string",
"enabled": "boolean",
"search_criteria": "string",
"generate_alert_criteria": "string",
"alert_type": "string",
"severity": "string",
"notification_settings": [
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
]
}
entity_id
Name of the Search based Alert Configuration.
Boolean value to depict if the Search based alert configuration is enabled.
The search query for the search-based alert configuration.
Notifications configured for alerts corresponding to this alert configuration.
{
"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": 100,
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
],
"series_values": [
{
"field": "string",
"aggregation_type": "string",
"resolution_in_secs": "integer",
"series": [
[
{}
]
]
}
]
}
],
"size": "integer",
"total_bucket": {
"value": "integer",
"is_approx": "boolean"
},
"total_count": 1000,
"time_range": {
"start_time": 1597247025,
"end_time": 1597247999
},
"cursor": "MTA="
}
size
Total count of objects returned
Cursor for the next page
{
"entity_type": "string",
"filter": "string"
}
As defined in search end point
{
"query": "VM where CPU Cores > 2",
"size": 10,
"time_range": {
"start_time": 1534410000,
"end_time": 1534410559
}
}
Query
Page size of results
cursor
{
"search_response_total_hits": 100
}
Total number of results
entity_list_response
aggregation_response
groupby_response
{
"entity_type": "string",
"filter": "string",
"sort_by": {
"field": "string",
"order": "string"
},
"size": "integer",
"cursor": "string",
"time_range": {
"start_time": 1597247025,
"end_time": 1597247999
}
}
query filter
size
cursor
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"description": "string",
"direct_security_groups": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"security_groups": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"vendor_id": "string",
"nsx_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"field": "string",
"aggregation_type": "string",
"resolution_in_secs": "integer",
"series": [
[
{}
]
]
}
field
aggregation_type
resolution_in_secs
{
"server": "10.78.89.125",
"collector": "10.78.89.126"
}
Server IP
Collector 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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean",
"instance_id": "string",
"graph_configuration": "string",
"is_graph_config_customized": "boolean",
"web_proxy_id": "string"
}
{
"proxy_id": "1000:104:12313412",
"nickname": "snow1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"instance_id": "dev36113.service-now.com",
"graph_configuration": "string",
"is_graph_config_customized": "boolean",
"web_proxy_id": "string"
}
{
"proxy_id": "1000:104:12313412",
"nickname": "snow1",
"enabled": "boolean",
"notes": "Located in DC1"
}
ID of Collector VM which should register this vcenter
A friendly nickname for the data source
Whether or not data collection is enabled
Room for notes or comments about the data source
{
"name": "string",
"node_port": "string",
"port": "integer",
"protocol": "string",
"target_port": "string"
}
name
node_port
port
protocol
target_port
{
"users_read_access": [
"[email protected]",
"[email protected]"
],
"users_write_access": [
"[email protected]",
"[email protected]"
],
"groups_read_access": [
"CN=Dev,CN=Users,DC=vrni,DC=com"
],
"groups_write_access": [
"CN=HR,CN=Users,DC=vrni,DC=com"
]
}
List of users with read privilege for the custom dashboard
List of users with all privileges for the custom dashboard
List of groups with read privilege for the custom dashboard
List of groups with read and write privilege for the custom dashboard
{
"users_read_access": [
"[email protected]",
"[email protected]"
],
"users_write_access": [
"[email protected]",
"[email protected]"
],
"groups_read_access": [
"CN=Dev,CN=Users,DC=vrni,DC=com"
],
"groups_write_access": [
"CN=HR,CN=Users,DC=vrni,DC=com"
]
}
List of users with read privilege for the pinboard
List of users with all privileges for the pinboard
List of groups with read privilege for the pinboard
List of groups with read and write privilege for the pinboard
show certificates and thumbprint
{
"start": "integer",
"end": "integer"
}
start
end
Page size of results
Mappings for SNMP destination IP to the collector VM IP through which the traps will be routed
{
"mappings": [
{
"server": "10.78.89.125",
"collector": "10.78.89.126"
}
]
}
{
"snmp_profiles": [
"string"
]
}
snmp_profiles
{
"results": [
{
"entity_id": "snmp-er67ght8kn67",
"nick_name": "AWS SNMP collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "public"
},
"snmp_v3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
}
],
"total_count": 5
}
total_count
{
"nick_name": "AWS SNMP collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "public"
},
"snmp_v3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
}
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 SNMP collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "public"
},
"snmp_v3": {
"username": "readonly",
"context_name": "default",
"authentication_type": "MD5",
"authentication_password": "VMware1!",
"privacy_type": "AES256",
"privacy_password": "VMware1!"
}
}
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 Entity ID
Start time for query in epoch seconds
{
"status": true,
"message": "Failed updating Object"
}
The operation is successful.
Response message
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"cidr": "string",
"vlan_id": "integer"
}
{
"results": [
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"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"
],
"notification_settings": [
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
]
}
],
"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"
],
"notification_settings": [
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
]
}
event_name
is_problem
severity
search_criteria
daily_at_utc
email_ids
snmp_trap_entity_ids
Notifications configured for alerts corresponding to this alert configuration.
{
"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"
],
"notification_settings": [
{
"type": "string",
"frequency": "string",
"notification_time": "string",
"receivers": [
"string"
],
"enabled": "boolean"
}
]
}
entity_id
active
event_name
is_problem
search_criteria
daily_at_utc
email_ids
snmp_trap_entity_ids
Notifications configured for alerts corresponding to this alert configuration.
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"operationalStatus": "string",
"administrativeStatus": "string",
"subType": [
"integer"
],
"device": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
Mappings for Syslog server IP to the collector VM IP through which the logs will be routed
{
"mappings": [
{
"server": "10.78.89.125",
"collector": "10.78.89.126"
}
]
}
[
{
"syslog_source": "string",
"collector_id": "string",
"syslog_ip": "string"
}
]
{
"data": [
{
"syslog_source": "string",
"collector_id": "string",
"syslog_ip": "string"
}
]
}
data
{
"enabled": true,
"change_time": 1673245212358,
"message": "string"
}
Whether Syslog functionality is enabled or disabled
Change time of the syslog status
Success in sending enable/disable log
{
"ip_or_fqdn": "string",
"port": "integer",
"protocol": "string",
"nick_name": "string",
"collector_id": "string"
}
ip_or_fqdn
port
Use only UDP protocol
Nickname of the syslog server
id of the collector node. Applicable only in case of cloud offering
{
"data": [
{
"ip_or_fqdn": "string",
"port": "integer",
"protocol": "string",
"nick_name": "string",
"collector_id": "string"
}
]
}
{
"status": true,
"message": "Failed sending SNMP trap"
}
Test trap sent successfully or not
Test SNMP trap status message
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"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": "VirtualMachine",
"entity_name": "string"
},
"member_list": {
"vms": [
{
"key": {
"entity_id": "18230:1:1158969162",
"entity_type": "VIRTUALMACHINE"
},
"name": "VM1"
},
{
"key": {
"entity_id": "18230:601:863301375",
"entity_type": "EC2INSTANCE"
},
"name": "EC2-VM1"
},
{
"key": {
"entity_id": "18230:1702:264351372",
"entity_type": "AZUREVM"
},
"name": "Azure-VM1"
}
],
"physical_ips": [
{
"key": {
"entity_id": "18230:541:365252372",
"entity_type": "IPENDPOINT"
},
"name": "52.35.41.245"
}
],
"kubernetes_services": [
{
"key": {
"entity_id": "18230:1504:263252172",
"entity_type": "KUBERNETESSERVICE"
},
"name": "KS"
}
]
}
}
{
"results": [
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"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": "VirtualMachine",
"entity_name": "string"
},
"member_list": {
"vms": [
{
"key": {
"entity_id": "18230:1:1158969162",
"entity_type": "VIRTUALMACHINE"
},
"name": "VM1"
},
{
"key": {
"entity_id": "18230:601:863301375",
"entity_type": "EC2INSTANCE"
},
"name": "EC2-VM1"
},
{
"key": {
"entity_id": "18230:1702:264351372",
"entity_type": "AZUREVM"
},
"name": "Azure-VM1"
}
],
"physical_ips": [
{
"key": {
"entity_id": "18230:541:365252372",
"entity_type": "IPENDPOINT"
},
"name": "52.35.41.245"
}
],
"kubernetes_services": [
{
"key": {
"entity_id": "18230:1504:263252172",
"entity_type": "KUBERNETESSERVICE"
},
"name": "KS"
}
]
}
}
]
}
{
"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": "VirtualMachine",
"entity_name": "string"
}
}
]
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
}
}
entity_id
entity_type
name
{
"name": "tier-1",
"source_group_entity_id": [
"18230:566:264351372"
],
"group_membership_criteria": [
{
"membership_type": "SearchMembershipCriteria",
"search_membership_criteria": {
"entity_type": "VirtualMachine",
"filter": "security_groups.entity_id = '18230:82:604573173'"
}
},
{
"membership_type": "IPAddressMembershipCriteria",
"ip_address_membership_criteria": {
"ip_addresses": [
"10.0.0.1",
"10.0.0.1/24",
"10.0.0.1-10.0.0.200"
]
}
}
],
"member_list": {
"vms": [
{
"key": {
"entity_id": "18230:1:1158969162",
"entity_type": "VIRTUALMACHINE"
},
"name": "VM1"
},
{
"key": {
"entity_id": "18230:601:863301375",
"entity_type": "EC2INSTANCE"
},
"name": "EC2-VM1"
},
{
"key": {
"entity_id": "18230:1702:264351372",
"entity_type": "AZUREVM"
},
"name": "Azure-VM1"
}
],
"physical_ips": [
{
"key": {
"entity_id": "18230:541:365252372",
"entity_type": "IPENDPOINT"
},
"name": "52.35.41.245"
}
],
"kubernetes_services": [
{
"key": {
"entity_id": "18230:1504:263252172",
"entity_type": "KUBERNETESSERVICE"
},
"name": "KS"
}
]
}
}
name
entity_id
Entity ID of corresponding tier application.
{
"basic_update_info": {
"name": "string",
"entity_id": "string",
"update_status": "string"
},
"vms": [
{
"name": "string",
"entity_id": "string",
"update_status": "string"
}
],
"physical_ips": [
{
"name": "string",
"entity_id": "string",
"update_status": "string"
}
],
"kubernetes_services": [
{
"name": "string",
"entity_id": "string",
"update_status": "string"
}
]
}
{
"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": "VirtualMachine",
"entity_name": "string"
}
}
]
}
],
"discovery_info": {
"sources": [
{
"source_type": "string",
"entity_id": "string",
"manager_entity_id": "string"
}
]
}
}
],
"cursor": "string",
"total_count": "integer"
}
cursor
total_count
Time in epoch seconds
{
"start_time": 1597247025,
"end_time": 1597247999
}
Start timestamp of the window of the objects returned
End timestamp of the window of the objects returned
{
"token": "Mgs2YX0ZSY+gHW6RYypeeA==",
"expiry": 1605201960327
}
token
expiry epoch time in secs.
{
"sort_criteria": "string",
"sorted_list": {
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "VirtualMachine",
"entity_name": "VM-1"
}
],
"cursor": "MTA=",
"total_count": 1102,
"start_time": 1597247025,
"end_time": 1597247999
}
}
{
"sort_criteria": "string",
"sorted_list": {
"results": [
{
"src_entity_id": "1000:104:12213212",
"src_entity_type": "VirtualMachine",
"dst_entity_id": "1000:104:56789",
"dst_entity_type": "VirtualMachine"
}
],
"cursor": "MTA=",
"total_count": 1102,
"start_time": 1597247025,
"end_time": 1597247999
}
}
{
"entity_id": "string",
"start_entity_id": "string",
"name": "string",
"status": "string"
}
entity_id
start_entity_id
name
status
{
"entity_id": "string",
"start_entity_id": "string",
"name": "string",
"status": "string",
"created_time": "integer",
"start_time": "integer",
"end_time": "integer",
"last_modified_time": "integer",
"created_by": "string",
"last_modified_by": "string"
}
entity_id
start_entity_id
name
status
created_time
start_time
end_time
last_modified_time
created_by
last_modified_by
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"config_polling_interval_in_min": "10",
"scheduled_config_polling_time": "2:00",
"scheduled_config_polling_days": "MONDAY,TUESDAY",
"config_polling_interval_type": "CUSTOM",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"pin_name": "Pin Name"
}
Name of the pin
(Optional) Events that were created or updated or closed between this time and update_time_to, in seconds
(Optional) Events that were created or updated or closed between update_time_from and this time, in seconds
{
"name": "string",
"start_time": "integer",
"end_time": "integer",
"status": "string"
}
name
start_time
end_time
status
{
"username": "[email protected]",
"password": "password",
"domain": {
"domain_type": "LDAP",
"value": "example.com"
}
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "UserDefinedEvent",
"recommendations": [
"string"
],
"notes": "string",
"severity": "string",
"total_count": "integer",
"refs_added_count": "integer",
"refs_deleted_count": "integer",
"subscriptions": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"entity_type": "VirtualMachine",
"name": "My Name",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "UserDefinedEvent",
"recommendations": [
"string"
],
"notes": "string",
"severity": "string",
"total_count": "integer",
"refs_added_count": "integer",
"refs_deleted_count": "integer",
"subscriptions": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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.
The type of user-group.
Mappings for users on source (backup setup) to users on destination (restore setup)
{
"mappings": [
{
"source": "10.78.89.125",
"destination": "10.78.89.126"
}
]
}
{
"id": "[email protected]",
"user_type": "VIDM",
"username": "alleymartin123",
"domain": "vidmlabs.com",
"display_name": "alley martin",
"role": "ADMIN"
}
The type of user.
The type of user.
{
"username": "admin@local",
"new_password": "password"
}
username
new_password
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"manager_uuid": "string"
}
{
"deployedby": "VMware Cloud Foundation",
"version": "vcf-4.0",
"managedby": "<fqdn>",
"instanceid": "<UUID>",
"logtoken": "VCF"
}
Deployment owner for Operations for Networks.
Version of VMware Cloud Foundation(VCF).
VMware Cloud Foundation (VCF) manager identifier to determine which instance manages the VRNI.
VMware Cloud Foundation (VCF) instance id.
Logtoken for VMware Cloud Foundation (VCF).
{
"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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"ipfix_request": {
"enable_all": "boolean",
"disable_all": "boolean",
"enable_for_dvs": "vds-1,vds-2,vds-3",
"disable_for_dvs": "vds-1,vds-2,vds-3"
},
"ipfix_response": {
"ipfix_enabled_for": "string",
"ipfix_disabled_for": "string",
"ipfix_disabling_failed": "string",
"ipfix_enabling_failed": "string"
},
"is_vmc": "boolean",
"ds_sub_type": "string",
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"ipfix_request": {
"enable_all": "boolean",
"disable_all": "boolean",
"enable_for_dvs": "vds-1,vds-2,vds-3",
"disable_for_dvs": "vds-1,vds-2,vds-3"
},
"is_vmc": "boolean",
"ds_sub_type": "string",
"tags": [
{
"tag_key": true,
"tag_value": true
}
],
"enable_ds_associated_tags": "boolean"
}
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"ipfix_enabled": "boolean"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"fqdn": "string",
"vm": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"nsx_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vc_uuid": "string"
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"nsx_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vcenter_manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"sddc_id": "string",
"org_id": "string",
"org_name": "string",
"vc_private_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"vc_public_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"vc_fqdn": "string",
"nsx_private_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"nsx_public_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"nsx_fqdn": "string",
"cloud_provider_type": "string",
"region": "string",
"sddc_group": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"group_id": "string",
"org_id": "string",
"org_name": "string",
"provider_type": "string",
"deployment_type": "string",
"state": "string",
"l3_connectors": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"sddcs": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"vpcs": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"direct_connect_gateways": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"vendor_id": "string",
"asn": "integer",
"state": "string",
"arn": "string",
"route_tables": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"gateway_associations": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
],
"org_id": "string",
"sddc_group": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"region": "string",
"attachment": [
{
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
]
}
{
"productName": "Operations for Networks",
"evaluation": "boolean",
"licenseKey": "AAAAA-BBBBB-CCCCC-DDDDD-EEEE",
"numberOfSockets": 25,
"expirationDate": 1661143082,
"serviceTag": "CPN0EgdEOFVWNzM0",
"expired": "boolean",
"deploymentType": "onprem",
"capacityType": "string",
"edition": "string",
"suspended": "boolean",
"deleted": "boolean",
"invalid": "boolean",
"managedByVrni": "boolean",
"entitlements": [
{
"capacityType": "string",
"count": "integer"
}
],
"currentLicenses": "CurrentLicenses Object"
}
productName
true if license is evaluation license
license serial key
sockets entitlement for this license
unix epoch time
service tag
true if license is expired
environment deployment type
true if customer state is suspended
true if customer state is deleted
true for license keys from last version, which are active only for grace period
true for license edition managed by vrni
{
"entity_id": "10000:1:15332641552",
"entity_type": "DataSource",
"name": "vcenter",
"identifier": "10.98.101.59",
"status": "PASS",
"error_code": -1,
"message": "string"
}
{
"results": [
{
"entity_id": "10000:1:15332641552",
"entity_type": "DataSource",
"name": "vcenter",
"identifier": "10.98.101.59",
"status": "PASS",
"error_code": -1,
"message": "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": "Located in DC1",
"certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"sha_thumbprint": "15:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"new_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"new_sha_thumbprint": "13:37:46:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:18",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"web_proxy_id": "string",
"url": "https://192.168.10.1 or https://your.domain.com"
}
{
"url": "https://192.168.10.1 or https://your.domain.com",
"proxy_id": "1000:901:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "Located in DC1",
"credentials": {
"username": "readonly",
"password": "VMware1!"
},
"web_proxy_id": "string"
}
URL of data source
ID of Collector VM which should register this vcenter
A friendly nickname for the data source
Whether or not data collection is enabled
Room for notes or comments about the data source
Identifier of web proxy to be used for connection. If not given or empty, any web proxy used earlier will be cleared
{
"id_type": "string",
"id_value": "string"
}
id_type
id_value
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "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
{
"vidm_root_certificate": "-----BEGIN CERTIFICATE----- ..etc.."
}
Root certificate of the VIDM server
{
"vidm_appliance": "identity.domain.com",
"client_id": "Operations for Networks Client-ID",
"enable": true,
"certificate_validation_enabled": "boolean"
}
Fully quallified domain name of VMware Identity Manager
Client-id of the configured OAuth client
True, if VMware Identity Manager integration is enabled
True, if SSL certificate check is enabled.
{
"vidm_appliance": "identity.domain.com",
"rootCA_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
"client_id": "Operations for Networks Client-ID",
"client_secret": "T2zRetc2f242KhelfoO6Qzw9",
"sha_thumbprint": "15:37:48:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:19",
"enable": true
}
Provide fully quallified domain name of VMware Identity Manager
Provide rootCA certificate to trust. Can be generated using /vidm/licence
Register Operations for Networks as an OAuth client to VMware Identity Manager and provide client-id
Provide the registered OAuth client secret
Optionally, provide SHA thumbprint to validate VMware Identity Manager appliance that is being configured
True, to enable the VMware Identity Manager integration in Operations for Networks
{
"vidm_appliance": "identity.domain.com",
"client_id": "Operations for Networks Client-ID"
}
Fully quallified domain name of VMware Identity Manager configured in Operations for Networks
Client-id of the password grant OAuth client
{
"vidm_token": "string"
}
User access token provided by VMware Identity Manager.
{
"group_name": "testgroup",
"domain": "vidmlabs.com",
"role": "ADMIN"
}
Specify group name (domain should not be part of group name).
Provide domain name to which user-group belongs to.
{
"username": "alleymartin123",
"domain": "vidmlabs.com",
"display_name": "alley martin",
"role": "ADMIN"
}
Provide username (domain should not be part of username).
Provide domain name to which user belongs to.
Provide user's display name (could be "givenName familyName")
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"manager": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"capacity": "integer",
"virtual_machine": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"disk_format": "string",
"thin_provisioned": "boolean",
"datastore": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"filename": "string"
}
{
"begin": "integer",
"end": "integer"
}
begin
end
{
"entity_id": "string",
"entity_name": "string",
"mw_name": "string",
"mw_id": "string",
"group_entity_id": "string",
"group_entity_name": "string"
}
entity_id
entity_name
mw_name
mw_id
group_entity_id
group_entity_name
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"local_asn": "integer",
"learnt_subnets": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"advertised_subnets_success": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"advertised_subnets_failed": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"dx_tunnels": [
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"local_asn": "integer",
"tunnel_id": "string",
"dx_connection_id": "string",
"mtu": "integer",
"local_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"remote_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"remote_asn": "integer",
"state": "string",
"bgp_status": "string",
"type": "string",
"sddc": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"dx_connection": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
],
"sddc": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"entity_id": "1000:104:12213212",
"name": "My Name",
"entity_type": "VirtualMachine",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"vlan": {
"begin": "integer",
"end": "integer"
},
"host": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
},
"layer2_network": {
"entity_id": "string",
"entity_type": "VirtualMachine",
"entity_name": "string"
}
}
{
"site": "Washington DC",
"region": "US East",
"interfaces": [
{
"id": "string",
"name": "string",
"type": "string"
}
]
}
Site name of the WAN router
Region name of the WAN router
Interface mappings for MPLS, INTERNET, or OTHER connections
{
"node_id": "IGHYRTROOHNAMA123",
"web_proxy_id": "web-proxy-er67ght8kn67",
"web_nick_name": "AWS web Proxy"
}
Operations for Networks Node Identifier (Collector or Platform)
Entity Identifier for a web proxy server
Descriptor or identifier for particular web proxy.
{
"results": [
{
"node_id": "IGHYRTROOHNAMA123",
"web_proxy_id": "web-proxy-er67ght8kn67",
"web_nick_name": "AWS web Proxy"
}
]
}
{
"source_webproxy_id": "web-proxy-er67ght8kn67",
"target_webproxy_id": "web-proxy-er67ght8kn68"
}
Identifier of web proxy which needs migration
Identifier of web proxy to which entities connected to source_webproxy_id will be migrated
{
"nick_name": "AWS web Proxy",
"target_ip": "10.11.11.102",
"target_port": 161,
"proxy_type": "HTTP",
"auth_type": "Basic/NTLM",
"use_credentials": true,
"user_name": "admin",
"password": "admin"
}
Descriptor or identifier for particular web proxy. It should be unique
IP address of web Proxy server
Port number of web Proxy server
Type of web Proxy being configured. [Permitted Values - HTTP/HTTPS]
Type of authentication. [Permitted Values - Basic/NTLM]
Credentials required for this web proxy
Username for web proxy authentication
Password for web proxy authentication
{
"enable_all": "boolean",
"disable_all": "boolean",
"enable_for_dvs": "vds-1,vds-2,vds-3",
"disable_for_dvs": "vds-1,vds-2,vds-3"
}
Enable flow collection for All DVS.
Disable flow collection for All DVS.
Comma separated values of all the dvs objects for which ipfix should be enabled.
Comma separated values of all the dvs objects for wihch ipfix should be disabled.
{
"ipfix_enabled_for": "string",
"ipfix_disabled_for": "string",
"ipfix_disabling_failed": "string",
"ipfix_enabling_failed": "string"
}
ipfix_enabled_for
ipfix_disabled_for
ipfix_disabling_failed
ipfix_enabling_failed