Network Insight API Reference Data Structures
AggregateOrderByClause
JSON Example
{
"field": "string",
"aggregation_type": "string",
"order": "string"
}string
field
Optional
field
string
aggregation_type
Optional
aggregation_type
string
order
Optional
order
Aggregation
JSON Example
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "string"
}string
field
Optional
field
string
aggregation_type
Optional
aggregation_type
AggregationRequest
JSON Example
{
"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
}
}string
filter
Optional
query filter
AggregationResponse
JSON Example
{
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
],
"total_count": "integer",
"start_time": "integer",
"end_time": "integer"
}integer As int32 As int32
total_count
Optional
total_count
integer As int64 As int64
start_time
Optional
start_time
integer As int64 As int64
end_time
Optional
end_time
AggregationWithValue
JSON Example
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}string
field
Optional
field
string
aggregation_type
Optional
aggregation_type
number As double As double
value
Optional
value
AllEntityType
This data structure has no properties.
Enumeration: Group, BaseSecurityGroup, BaseEvent, BaseVirtualMachine, BaseFirewallRule, BaseIPSet, BaseL2Network, BaseFirewall, BaseService, BaseServiceGroup, BaseVnic, VirtualMachine, EC2Instance, Host, Vnic, Vmknic, VxlanLayer2Network, VlanL2Network, Cluster, SecurityTag, ResourcePool, NSXIPSet, NSXTIPSet, EC2IPSet, NSXSecurityGroup, NSGroup, NSXPolicyGroup, EC2SecurityGroup, Flow, ProblemEvent, Application, Tier, IPEndpoint, NSXFirewallRule, EC2SGFirewallRule, NSXRedirectRule, VCenterManager, NSXVManager, NSXTManager, NSXPolicyManager, CheckpointManager, CheckpointMDSManager, BaseManager, BaseFirewallManager, BaseNSXManager, NSXService, EC2Service, NSService, VPC, CloudNetwork, AzureVM, AzureNSG, AzureASG, AzureNSGRule, NSXDistributedFirewall, EC2Firewall, NSXServiceGroup, NSServiceGroup, DistributedVirtualSwitch, DistributedVirtualPortgroup, VCDatacenter, Datastore, Folder, NSXTFirewallRule, NSXTFirewall, PolicyManagerFirewallRule, PolicyManagerFirewall, BaseGenericFirewall, BaseGenericFirewallRule, CheckpointFirewall, CheckpointFirewallRule, UserDefinedSubnet, KubernetesService, UserDefinedProblemEvent, FirewallRuleMaskEvent, EdgeDevice, RouterDevice, NSXController, LogicalRouter, NSXTManagementNode, NSXTController, NSXTTransportNode, NSXTTransportZone, NSXTLoadBalancer, NSXTVirtualServer, NSXTServerPool, NSXTLogicalSwitch, NSXTRouterDevice, NSXTEdgeCluster, NSXControllerCluster,
ApiError
JSON Example
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
Returned By
Application
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"create_time": "integer",
"created_by": "string",
"last_modified_time": "integer",
"last_modified_by": "string"
}
ApplicationFlowSummary
JSON Example
{
"service_endpoint_count": "integer",
"groups": [
{
"group_id": "string",
"entity_id": "string",
"entity_type": "string",
"flow_summary": {
"ingress_bytes": "integer",
"egress_bytes": "integer"
}
}
],
"start_time": "integer",
"end_time": "integer"
}integer
service_endpoint_count
Optional
service_endpoint_count
integer As int64 As int64
start_time
Optional
start_time
integer As int64 As int64
end_time
Optional
end_time
ApplicationMember
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}string
entity_id
Optional
entity_id
string
entity_type
Optional
entity_type
ApplicationMembers
JSON Example
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
],
"cursor": "string"
}string
cursor
Optional
cursor
ApplicationMembersResponse
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"created_by": "string",
"creation_time": "integer",
"last_modified_by": "string",
"last_modified_time": "integer",
"source": "string",
"tiers": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
]
}
]
}string
entity_id
Optional
entity_id
string
entity_type
Optional
entity_type
string
name
Optional
name
string
created_by
Optional
created_by
integer As int64 As int64
creation_time
Optional
creation_time
string
last_modified_by
Optional
last_modified_by
integer As int64 As int64
last_modified_time
Optional
last_modified_time
string
source
Optional
source
ApplicationRequest
JSON Example
{
"name": "string"
}string
name
Optional
name
ApplicationsMembersResponse
JSON Example
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"created_by": "string",
"creation_time": "integer",
"last_modified_by": "string",
"last_modified_time": "integer",
"source": "string",
"tiers": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
]
}
]
}
],
"cursor": "string",
"total_count": "integer"
}string
cursor
Optional
cursor
integer As int32 As int32
total_count
Optional
total_count
AppliedTo
JSON Example
{
"referred_entity": {
"entity_id": "1000:104:12213212",
"entity_type": "string"
},
"name": "string",
"value": "string",
"vendor_type": "string"
}string
name
Optional
name
string
value
Optional
value
string
vendor_type
Optional
vendor_type
AristaSwitchDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
AristaSwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
AuditListResponse
JSON Example
{
"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
}string
cursor
Optional
cursor
integer As int64 As int64
start_time
Optional
start_time
integer As int64 As int64
end_time
Optional
end_time
AuditRequest
JSON Example
{
"username": "admin@local",
"operation": "LOGIN",
"time_range": {
"start_time": 1534410000,
"end_time": 1534410559
},
"size": 10,
"cursor": "string"
}string
user_name
Optional
user_name
string
ip_address
Optional
ip_address
string
entity_type
Optional
entity_type
string
entity_id
Optional
entity_id
string
operation
Optional
operation
string
response
Optional
response
integer As int32 As int32
size
Optional
size
string
cursor
Optional
cursor
AuditResponse
JSON Example
{
"ip_address": "string",
"user_name": "string",
"entity_type": "string",
"entity_id": "string",
"operation": "string",
"response": "string",
"value": "string",
"timestamp": "integer"
}string
ip_address
Optional
ip_address
string
user_name
Optional
user_name
string
entity_type
Optional
entity_type
string
entity_id
Optional
entity_id
string
operation
Optional
operation
string
response
Optional
response
string
value
Optional
value
integer As int64 As int64
timestamp
Optional
timestamp
AzureCredentials
JSON Example
{
"azure_client": "string",
"azure_key": "string",
"azure_tenant": "string",
"azure_subscription": "string"
}string
azure_client
Required
azure_client
string
azure_key
Required
azure_key
string
azure_tenant
Required
azure_tenant
string
azure_subscription
Required
azure_subscription
AzureDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"azure_client": "string",
"azure_key": "string",
"azure_tenant": "string",
"azure_subscription": "string"
},
"flows_enabled": "boolean"
}
Parameter To
AzureDataSourceRequest
AllOf
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"azure_client": "string",
"azure_key": "string",
"azure_tenant": "string",
"azure_subscription": "string"
},
"flows_enabled": "boolean"
}
BackupRestoreRequest
JSON Example
{
"config_filter": {
"applications": "boolean",
"snmp": "boolean",
"smtp": "boolean",
"data_sources": "boolean",
"analytics_thresholds": "boolean",
"analytics_outliers": "boolean",
"events": "boolean",
"syslog": "boolean",
"pinboards": "boolean",
"ldap": "boolean",
"vidm": "boolean",
"user_data": "boolean",
"user_preferences": "boolean",
"physical_subnet_vlan": "boolean",
"saved_searches": "boolean",
"physical_ip_dns_mapping": "boolean",
"east_west_ip": "boolean",
"north_south_ip": "boolean"
},
"backup_schedule": {
"enable": "boolean",
"schedule_period": "DAILY",
"minute": 30,
"hour": 12,
"day_of_week": 1
},
"backup_file_server_type": "SSH",
"local_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"ssh_file_server": {
"server_address": "10.234.12.134",
"port": 22,
"username": "testuser",
"password": "password",
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"ftp_file_server": {
"server_address": "10.234.12.134",
"port": 21,
"username": "testuser",
"password": "password",
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"schedule_now": "boolean"
}boolean
schedule_now
Optional
True, to run backup now (on demand)
BackupRestoreStatusResponse
JSON Example
{
"status": "IN_PROGRESS",
"backup_file_name": "vrni_backup-10000-2020-12-15-13-00-40.tar",
"status_updated_timestamp": 1589908165162
}string
status
Optional
Status of currently executing or last backup-restore job
string
backup_file_name
Optional
File name of backup tar file
string
status_updated_timestamp
Optional
TimeStamp of the last status update
BackupSchedule
JSON Example
{
"enable": "boolean",
"schedule_period": "DAILY",
"minute": 30,
"hour": 12,
"day_of_week": 1
}boolean
enable
Optional
True, to enable scheduled backup
integer
minute
Optional
The minute at which backup needs to run (permitted values 0 - 59)
integer
hour
Optional
The hour at which backup needs to run (permitted values 0 - 23)
integer
day_of_week
Optional
The day of the week when backup to be scheduled (permitted values 1 - 7)
BackupSchedulePeriod
Backup Schedule period.
This data structure has no properties.
Enumeration: DAILY, WEEKLY,
BaseDataSource
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}string
entity_id
Optional
entity_id
string
ip
Optional
ip
string
fqdn
Optional
fqdn
string
proxy_id
Optional
proxy vm which should register this vcenter
string
nickname
Optional
nickname
boolean
enabled
Optional
enabled
string
notes
Optional
notes
BaseDataSourceRequest
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}string
ip
Optional
ip
string
fqdn
Optional
fqdn
string
proxy_id
Required
proxy vm which should register this vcenter
string
nickname
Required
nickname
boolean
enabled
Optional
enabled
string
notes
Optional
notes
BaseEntity
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string"
}string
entity_id
Optional
entity_id
string
name
Optional
name
BaseEvent
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
]
}
BaseFirewall
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"exclusions": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
BaseFirewallManager
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
},
"version": "string",
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
}
BaseFirewallRule
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
BaseGenericFirewall
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"exclusions": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
BaseGenericFirewallRule
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
],
"direction": "string"
}
BaseIPSet
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"ip_ranges": [
{
"start_ip": "string",
"end_ip": "string"
}
],
"ip_numeric_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"parent_security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"direct_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"direct_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"indirect_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"indirect_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"vendor_id": "string",
"vendor": "string"
}
BaseL2Network
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"network_addresses": [
"string"
],
"gateways": [
"string"
]
}
BaseManager
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string"
}
BaseNSXManager
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string"
}
BaseSecurityGroup
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"direct_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"direct_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"indirect_source_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"indirect_destination_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"parents": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"direct_members": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"vendor_id": "string",
"excluded_members": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
BaseService
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"protocol": "string",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
BaseServiceGroup
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
BaseVirtualMachine
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"default_gateway": "string",
"vnics": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"source_firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"destination_firewall_rules": [
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
],
"ip_sets": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
BaseVnic
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"layer2_network": {
"entity_id": "string",
"entity_type": "string"
},
"vlan": {
"begin": "integer",
"end": "integer"
},
"vm": {
"entity_id": "string",
"entity_type": "string"
}
}
BrocadeSwitchDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
BrocadeSwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
BucketValue
JSON Example
{
"field": "string",
"value": "string"
}string
field
Optional
field
string
value
Optional
value
BulkFetchResponse
JSON Example
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"entity": {
"entity_id": "string",
"name": "string",
"entity_type": "string"
},
"time": "integer"
}
]
}
BulkProblemFetchResponse
JSON Example
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer",
"time": "integer"
}
]
}
Cardinality
JSON Example
{
"value": "integer",
"is_approx": "boolean"
}integer As int64 As int64
value
Optional
value
boolean
is_approx
Optional
is_approx
CheckpointFirewallDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
CheckpointFirewallDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
CiscoACIDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
CiscoACIDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
CiscoSwitchDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"switch_type": "string"
}
CiscoSwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"switch_type": "string"
}
CiscoSwitchType
This data structure has no properties.
Enumeration: CATALYST_3000, CATALYST_4500, CATALYST_6500, NEXUS_5K, NEXUS_7K, NEXUS_9K, CISCOASRISR,
Cluster
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"total_cpus": "integer",
"total_memory": "integer",
"num_cpu_cores": "integer",
"vendor_id": "string",
"num_hosts": "integer",
"num_datastores": "integer",
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
},
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
ConfigDataFilter
JSON Example
{
"applications": "boolean",
"snmp": "boolean",
"smtp": "boolean",
"data_sources": "boolean",
"analytics_thresholds": "boolean",
"analytics_outliers": "boolean",
"events": "boolean",
"syslog": "boolean",
"pinboards": "boolean",
"ldap": "boolean",
"vidm": "boolean",
"user_data": "boolean",
"user_preferences": "boolean",
"physical_subnet_vlan": "boolean",
"saved_searches": "boolean",
"physical_ip_dns_mapping": "boolean",
"east_west_ip": "boolean",
"north_south_ip": "boolean"
}boolean
applications
Optional
applications
boolean
snmp
Optional
snmp
boolean
smtp
Optional
smtp
boolean
data_sources
Optional
data_sources
boolean
analytics_thresholds
Optional
analytics_thresholds
boolean
analytics_outliers
Optional
analytics_outliers
boolean
events
Optional
events
boolean
syslog
Optional
syslog
boolean
pinboards
Optional
pinboards
boolean
ldap
Optional
ldap
boolean
vidm
Optional
vidm
boolean
user_data
Optional
user_data
boolean
user_preferences
Optional
user_preferences
boolean
physical_subnet_vlan
Optional
physical_subnet_vlan
boolean
saved_searches
Optional
saved_searches
boolean
physical_ip_dns_mapping
Optional
physical_ip_dns_mapping
boolean
east_west_ip
Optional
east_west_ip
boolean
north_south_ip
Optional
north_south_ip
ContainerBaseDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"manager_id": "192.168.10.1",
"credentials": {
"kubeconfig": "string"
}
}
Cursor
cursor from previous response
This data structure has no properties.
DataSourceEntityId
JSON Example
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}string
entity_id
Optional
Entity Identifier
DataSourceListResponse
JSON Example
{
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
],
"total_count": 1
}integer
total_count
Optional
total_count
Returned By
DataSourceType
This data structure has no properties.
Enumeration: CiscoSwitchDataSource, DellSwitchDataSource, AristaSwitchDataSource, BrocadeSwitchDataSource, JuniperSwitchDataSource, GDDataSource, F5BIGIPDataSource, HuaweiSwitchDataSource, MellanoxSwitchDataSource, HPESwitchDataSource, UANIDataSource, VCenterDataSource, NSXVManagerDataSource, UCSManagerDataSource, HPVCManagerDataSource, HPOneViewDataSource, PanFirewallDataSource, CheckpointFirewallDataSource, FortinetFirewallDataSource, NSXTManagerDataSource, KubernetesDataSource, PKSDataSource, InfobloxManagerDataSource, CiscoACIDataSource, ServiceNowDataSource, PolicyManagerDataSource, AzureDataSource, VeloCloudDataSource,
Datastore
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
DellOs10SwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
DellSwitchDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"switch_type": "string"
}
DellSwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"switch_type": "string"
}
DellSwitchType
This data structure has no properties.
Enumeration: FORCE_10_MXL_10, POWERCONNECT_8024, S4048, Z9100, S6000,
DetailedVendorInfo
AllOf
JSON Example
{
"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"
}
]
}
}
DetailedVendorInfoResponse
JSON Example
{
"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"
}
]
}
}
]
}
DistributedVirtualPortgroup
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
},
"distributed_virtual_switch": {
"entity_id": "string",
"entity_type": "string"
}
}
DistributedVirtualSwitch
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
},
"hosts": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
Domain
JSON Example
{
"domain_type": "LDAP",
"value": "example.com"
}string
domain_type
Optional
domain_type
string
value
Optional
domain value, not required for LOCAL domain
EC2FirewallDirection
This data structure has no properties.
Enumeration: INBOUND, OUTBOUND,
EmailFrequency
This data structure has no properties.
Enumeration: IMMEDIATELY, DAILY_DIGEST,
EndTime
end time for query in epoch seconds
This data structure has no properties.
EntityId
JSON Example
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}string
entity_id
Optional
Entity Identifier
EntityIdWithTime
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"time": "integer"
}string
entity_id
Optional
Entity Identifier
integer As int64 As int64
time
Optional
time
EntityMetricsSchema
JSON Example
{
"results": [
{
"metric": "string",
"display_name": "string",
"intervals": [
"integer"
],
"description": "string",
"unit": "string"
}
]
}
EntityName
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"time": "integer",
"name": "string"
}
EntityType
This data structure has no properties.
Enumeration: VirtualMachine, EC2Instance, Host, Vnic, Vmknic, VxlanLayer2Network, VlanL2Network, Cluster, SecurityTag, ResourcePool, NSXIPSet, NSXTIPSet, EC2IPSet, NSXSecurityGroup, NSGroup, NSXPolicyGroup, EC2SecurityGroup, Flow, ProblemEvent, Application, Tier, IPEndpoint, NSXFirewallRule, EC2SGFirewallRule, NSXRedirectRule, VCenterManager, NSXVManager, NSXTManager, NSXPolicyManager, CheckpointManager, CheckpointMDSManager, NSXService, EC2Service, NSService, VPC, CloudNetwork, AzureVM, AzureNSG, AzureASG, AzureNSGRule, NSXDistributedFirewall, EC2Firewall, NSXServiceGroup, NSServiceGroup, DistributedVirtualSwitch, DistributedVirtualPortgroup, VCDatacenter, Datastore, Folder, NSXTFirewallRule, NSXTFirewall, PolicyManagerFirewallRule, PolicyManagerFirewall, KubernetesService, CheckpointFirewall, CheckpointFirewallRule, UserDefinedSubnet, UserDefinedProblemEvent, FirewallRuleMaskEvent, EdgeDevice, RouterDevice, NSXController, LogicalRouter, NSXTManagementNode, NSXTController, NSXTTransportNode, NSXTTransportZone, NSXTLoadBalancer, NSXTVirtualServer, NSXTServerPool, NSXTLogicalSwitch, NSXTRouterDevice, NSXTEdgeCluster, NSXControllerCluster,
EntityWithTime
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"entity": {
"entity_id": "string",
"name": "string",
"entity_type": "string"
},
"time": "integer"
}string
entity_id
Optional
Entity Identifier
integer As int64 As int64
time
Optional
time
ErrorDetail
JSON Example
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
array of string
target
Optional
target
EventMetaInfo
JSON Example
{
"entity_type": "string",
"name": "string",
"help_text": "string",
"severity": "string",
"tags": [
"string"
],
"supported_entity_types": [
"string"
],
"supported_manager_types": [
"string"
],
"impact": "string",
"recommendations": [
"string"
]
}string
entity_type
Optional
entity_type
string
name
Optional
name
string
help_text
Optional
help_text
string
severity
Optional
severity
array of string
tags
Optional
tags
array of string
supported_entity_types
Optional
supported_entity_types
array of string
supported_manager_types
Optional
supported_manager_types
string
impact
Optional
impact
array of string
recommendations
Optional
recommendations
EventMetaInfoResponse
JSON Example
{
"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"
]
}
]
}
EventStatus
status of event open or closed
This data structure has no properties.
EventTags
event tags
This data structure has no properties.
EventType
type of event, e.g UserDefinedProblemEvent
This data structure has no properties.
F5BIGIPDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
F5BIGIPDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
FetchRequest
JSON Example
{
"entity_ids": [
{
"entity_id": "string",
"entity_type": "string",
"time": "integer"
}
]
}array of object
entity_ids
Optional
entity_ids
FileServerType
File Server type.
This data structure has no properties.
Enumeration: LOCAL, SSH, FTP,
FirewallAction
This data structure has no properties.
Enumeration: ALLOW, ACCEPT, DENY, DROP, REJECT, REDIRECT, DO_NOT_REDIRECT,
FirewallDirection
This data structure has no properties.
Enumeration: IN, OUT, INOUT,
FirewallRuleSet
JSON Example
{
"firewall_entity_id": {
"entity_id": "string",
"entity_type": "string"
},
"vendor_info": {
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
},
"manager": {
"entity_id": "string",
"entity_type": "string"
},
"rules": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
]
}
Flow
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"source_vm": {
"entity_id": "string",
"entity_type": "string"
},
"destination_vm": {
"entity_id": "string",
"entity_type": "string"
},
"source_vnic": {
"entity_id": "string",
"entity_type": "string"
},
"destination_vnic": {
"entity_id": "string",
"entity_type": "string"
},
"source_vpc": {
"entity_id": "string",
"entity_type": "string"
},
"destination_vpc": {
"entity_id": "string",
"entity_type": "string"
},
"source_cloud_network": {
"entity_id": "string",
"entity_type": "string"
},
"destination_cloud_network": {
"entity_id": "string",
"entity_type": "string"
},
"source_azure_nsg": {
"entity_id": "string",
"entity_type": "string"
},
"destination_azure_nsg": {
"entity_id": "string",
"entity_type": "string"
},
"source_datacenter": {
"entity_id": "string",
"entity_type": "string"
},
"destination_datacenter": {
"entity_id": "string",
"entity_type": "string"
},
"source_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"destination_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"source_l2_network": {
"entity_id": "string",
"entity_type": "string"
},
"destination_l2_network": {
"entity_id": "string",
"entity_type": "string"
},
"port": {
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
},
"source_folders": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destination_folders": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"source_resource_pool": {
"entity_id": "string",
"entity_type": "string"
},
"destination_resource_pool": {
"entity_id": "string",
"entity_type": "string"
},
"source_cluster": {
"entity_id": "string",
"entity_type": "string"
},
"destination_cluster": {
"entity_id": "string",
"entity_type": "string"
},
"protocol": "string",
"source_ip_sets": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destination_ip_sets": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"source_security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destination_security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"traffic_type": "string",
"source_security_tags": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destination_security_tags": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"source_host": {
"entity_id": "string",
"entity_type": "string"
},
"destination_host": {
"entity_id": "string",
"entity_type": "string"
},
"source_vm_tags": [
"string"
],
"destination_vm_tags": [
"string"
],
"within_host": "boolean",
"firewall_action": "string",
"firewall_rule_id": "string",
"flow_tag": [
"string"
]
}
FlowSummary
JSON Example
{
"ingress_bytes": "integer",
"egress_bytes": "integer"
}integer As int64 As int64
ingress_bytes
Optional
ingress_bytes
integer As int64 As int64
egress_bytes
Optional
egress_bytes
FlowTag
This data structure has no properties.
Enumeration: TAG_TRAFFIC_TYPE_UNKNOWN, TAG_INTERNET_TRAFFIC, TAG_EAST_WEST_TRAFFIC, TAG_VM_VM_TRAFFIC, TAG_VM_PHY_TRAFFIC, TAG_PHY_PHY_TRAFFIC, TAG_SRC_IP_VMKNIC, TAG_DST_IP_VMKNIC, TAG_SRC_IP_VM, TAG_DST_IP_VM, TAG_SRC_IP_INTERNET, TAG_DST_IP_INTERNET, TAG_SRC_IP_PHYSICAL, TAG_DST_IP_PHYSICAL, TAG_SAME_HOST, TAG_DIFF_HOST, TAG_SHARED_SERVICE, TAG_NOT_SHARED_SERVICE, TAG_NETWORK_SWITCHED, TAG_NETWORK_ROUTED, TAG_NETWORK_UNKNOWN, TAG_SRC_IP_VTEP, TAG_DST_IP_VTEP, TAG_UNICAST, TAG_BROADCAST, TAG_MULTICAST, TAG_SRC_IP_LINK_LOCAL, TAG_DST_IP_LINK_LOCAL, TAG_SRC_IP_CLASS_E, TAG_DST_IP_CLASS_E, TAG_SRC_IP_CLASS_A_RESERVED, TAG_DST_IP_CLASS_A_RESERVED, TAG_INVALID_IP_PACKETS, TAG_NOT_ANALYZED, TAG_GENERIC_INTERNET_SRC_IP, TAG_SNAT_DNAT_FLOW, TAG_MULTINICS, TAG_SRC_VC, TAG_DST_VC, TAG_SRC_AWS, TAG_DST_AWS, TAG_WITHIN_DC, TAG_DIFF_DC, TAG_WITHIN_VPC, TAG_DIFF_VPC, TAG_WITHIN_VNET, TAG_DIFF_VNET, TAG_SRC_AZURE, TAG_DST_AZURE,
FlowTrafficType
This data structure has no properties.
Enumeration: INTERNET_TRAFFIC, EAST_WEST_TRAFFIC,
Folder
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
FortinetFirewallDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
FortinetFirewallDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
FtpFileServer
JSON Example
{
"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"
}string
server_address
Optional
IP address or hostname of destination FTP file server
integer
port
Optional
File transfer port
string
username
Optional
username to login FTP server
string
password
Optional
password for the user to login FTP server
string
backup_directory
Optional
directory on file server to store/fetch backups
string
backup_file_name
Optional
filename of the backup to be restored (used during restore only)
GDDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
GDDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
GenerateEventCritera
This data structure has no properties.
Enumeration: SEARCH_RESULT_CHANGE, ZERO_SEARCH_RESULTS,
GenericSwitchDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}
Parameter To
GenericSwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}
Group
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
GroupEntry
JSON Example
{
"group_id": "string",
"entity_id": "string",
"entity_type": "string",
"flow_summary": {
"ingress_bytes": "integer",
"egress_bytes": "integer"
}
}string
group_id
Optional
group_id
string
entity_id
Optional
entity_id
string
entity_type
Optional
entity_type
GroupMembershipCriteria
EntityType currently restricted to VirtualMachine
JSON Example
{
"membership_type": "string",
"ip_address_membership_criteria": {
"ip_addresses": [
"string"
]
},
"search_membership_criteria": {
"entity_type": "string",
"filter": "string"
}
}string
membership_type
Optional
membership_type
GroupWithValue
JSON Example
{
"bucket": [
{
"field": "string",
"value": "string"
}
],
"count": "integer",
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
]
}integer As int64 As int64
count
Optional
count of entity in group
GroupsMembersRequest
JSON Example
{
"entity_ids": [
"10000:561:123456789",
"10000:561:987654321"
],
"cursor": "CKWP=="
}array of string
entity_ids
Optional
entity_ids
string
cursor
Optional
cursor
HPESwitchDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
HPESwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
HPOneViewManagerDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
HPOneViewManagerDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
HPVCManagerDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
HPVCManagerDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Host
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vmknics": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"cluster": {
"entity_id": "string",
"entity_type": "string"
},
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
},
"vm_count": "integer",
"datastores": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"service_tag": "string",
"vendor_id": "string",
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
},
"maintenance_mode": "string",
"connection_state": "string"
}
HuaweiSwitchDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
HuaweiSwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Identifier
entity id
This data structure has no properties.
InfobloxManagerDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
InfobloxManagerDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
InlineApplication1
This data structure has no properties.
integer As int64 As int64
create_time
Optional
create_time
string
created_by
Optional
created_by
integer As int64 As int64
last_modified_time
Optional
last_modified_time
string
last_modified_by
Optional
last_modified_by
InlineApplication1
This data structure has no properties.
integer As int64 As int64
create_time
Optional
create_time
string
created_by
Optional
created_by
integer As int64 As int64
last_modified_time
Optional
last_modified_time
string
last_modified_by
Optional
last_modified_by
InlineApplication1
This data structure has no properties.
integer As int64 As int64
create_time
Optional
create_time
string
created_by
Optional
created_by
integer As int64 As int64
last_modified_time
Optional
last_modified_time
string
last_modified_by
Optional
last_modified_by
InlineAzureDataSource1
This data structure has no properties.
boolean
flows_enabled
Optional
flows_enabled
InlineAzureDataSource1
This data structure has no properties.
boolean
flows_enabled
Optional
flows_enabled
InlineAzureDataSource1
This data structure has no properties.
boolean
flows_enabled
Optional
flows_enabled
InlineAzureDataSource1
This data structure has no properties.
boolean
flows_enabled
Optional
flows_enabled
InlineAzureDataSource1
This data structure has no properties.
boolean
flows_enabled
Optional
flows_enabled
InlineAzureDataSourceRequest1
This data structure has no properties.
boolean
flows_enabled
Optional
flows_enabled
InlineAzureDataSourceRequest1
This data structure has no properties.
boolean
flows_enabled
Optional
flows_enabled
InlineBaseEvent1
This data structure has no properties.
string
message
Optional
message
array of string
event_tags
Optional
event_tags
string
admin_state
Optional
admin_state
boolean
archived
Optional
archived
integer As int64 As int64
event_time_epoch_ms
Optional
event_time_epoch_ms
string
event_type
Optional
event_type
array of string
recommendations
Optional
recommendations
InlineBaseFirewall1
This data structure has no properties.
InlineBaseFirewallManager1
This data structure has no properties.
string
version
Optional
version
InlineBaseFirewallManager1
This data structure has no properties.
string
version
Optional
version
InlineBaseFirewallRule1
This data structure has no properties.
string
rule_id
Optional
rule_id
string
section_id
Optional
section_id
string
section_name
Optional
section_name
integer
sequence_number
Optional
sequence_number
boolean
source_any
Optional
source_any
boolean
destination_any
Optional
destination_any
boolean
service_any
Optional
service_any
boolean
disabled
Optional
disabled
boolean
source_inversion
Optional
source_inversion
boolean
destination_inversion
Optional
destination_inversion
InlineBaseFirewallRule1
This data structure has no properties.
string
rule_id
Optional
rule_id
string
section_id
Optional
section_id
string
section_name
Optional
section_name
integer
sequence_number
Optional
sequence_number
boolean
source_any
Optional
source_any
boolean
destination_any
Optional
destination_any
boolean
service_any
Optional
service_any
boolean
disabled
Optional
disabled
boolean
source_inversion
Optional
source_inversion
boolean
destination_inversion
Optional
destination_inversion
InlineBaseFirewallRule1
This data structure has no properties.
string
rule_id
Optional
rule_id
string
section_id
Optional
section_id
string
section_name
Optional
section_name
integer
sequence_number
Optional
sequence_number
boolean
source_any
Optional
source_any
boolean
destination_any
Optional
destination_any
boolean
service_any
Optional
service_any
boolean
disabled
Optional
disabled
boolean
source_inversion
Optional
source_inversion
boolean
destination_inversion
Optional
destination_inversion
InlineBaseGenericFirewallRule1
This data structure has no properties.
InlineBaseIPSet1
This data structure has no properties.
string
vendor_id
Optional
vendor_id
string
vendor
Optional
vendor
InlineBaseIPSet1
This data structure has no properties.
string
vendor_id
Optional
vendor_id
string
vendor
Optional
vendor
InlineBaseL2Network1
This data structure has no properties.
array of string
network_addresses
Optional
network_addresses
array of string
gateways
Optional
gateways
InlineBaseL2Network1
This data structure has no properties.
array of string
network_addresses
Optional
network_addresses
array of string
gateways
Optional
gateways
InlineBaseSecurityGroup1
This data structure has no properties.
string
vendor_id
Optional
vendor_id
InlineBaseSecurityGroup1
This data structure has no properties.
string
vendor_id
Optional
vendor_id
InlineBaseService1
This data structure has no properties.
string
protocol
Optional
protocol
InlineBaseService1
This data structure has no properties.
string
protocol
Optional
protocol
InlineBaseVirtualMachine1
This data structure has no properties.
string
default_gateway
Optional
default_gateway
InlineBaseVirtualMachine1
This data structure has no properties.
string
default_gateway
Optional
default_gateway
InlineBaseVnic1
This data structure has no properties.
InlineBaseVnic1
This data structure has no properties.
InlineCiscoSwitchDataSource1
This data structure has no properties.
InlineCiscoSwitchDataSource1
This data structure has no properties.
InlineCiscoSwitchDataSource1
This data structure has no properties.
InlineCiscoSwitchDataSource1
This data structure has no properties.
InlineCiscoSwitchDataSource1
This data structure has no properties.
InlineCiscoSwitchDataSourceRequest1
This data structure has no properties.
InlineCiscoSwitchDataSourceRequest1
This data structure has no properties.
InlineCluster1
This data structure has no properties.
integer As int32 As int32
total_cpus
Optional
total_cpus
integer As int64 As int64
total_memory
Optional
total_memory
integer As int32 As int32
num_cpu_cores
Optional
num_cpu_cores
string
vendor_id
Optional
vendor_id
integer As int32 As int32
num_hosts
Optional
num_hosts
integer As int32 As int32
num_datastores
Optional
num_datastores
InlineCluster1
This data structure has no properties.
integer As int32 As int32
total_cpus
Optional
total_cpus
integer As int64 As int64
total_memory
Optional
total_memory
integer As int32 As int32
num_cpu_cores
Optional
num_cpu_cores
string
vendor_id
Optional
vendor_id
integer As int32 As int32
num_hosts
Optional
num_hosts
integer As int32 As int32
num_datastores
Optional
num_datastores
InlineContainerBaseDataSource1
This data structure has no properties.
string
manager_id
Optional
Associated nsxt data source entity Id
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSource1
This data structure has no properties.
InlineDellSwitchDataSourceRequest1
This data structure has no properties.
InlineDellSwitchDataSourceRequest1
This data structure has no properties.
InlineDetailedVendorInfo1
This data structure has no properties.
InlineDistributedVirtualPortgroup1
This data structure has no properties.
InlineDistributedVirtualPortgroup1
This data structure has no properties.
InlineDistributedVirtualSwitch1
This data structure has no properties.
InlineDistributedVirtualSwitch1
This data structure has no properties.
InlineEntityName1
This data structure has no properties.
string
name
Optional
name
InlineEntityName1
This data structure has no properties.
string
name
Optional
name
InlineFlow1
This data structure has no properties.
array of string
source_vm_tags
Optional
source_vm_tags
array of string
destination_vm_tags
Optional
destination_vm_tags
boolean
within_host
Optional
within_host
string
firewall_rule_id
Optional
firewall_rule_id
InlineFlow1
This data structure has no properties.
array of string
source_vm_tags
Optional
source_vm_tags
array of string
destination_vm_tags
Optional
destination_vm_tags
boolean
within_host
Optional
within_host
string
firewall_rule_id
Optional
firewall_rule_id
InlineHost1
This data structure has no properties.
integer As int32 As int32
vm_count
Optional
vm_count
string
service_tag
Optional
service_tag
string
vendor_id
Optional
vendor_id
string
maintenance_mode
Optional
maintenance_mode
string
connection_state
Optional
connection_state
InlineHost1
This data structure has no properties.
integer As int32 As int32
vm_count
Optional
vm_count
string
service_tag
Optional
service_tag
string
vendor_id
Optional
vendor_id
string
maintenance_mode
Optional
maintenance_mode
string
connection_state
Optional
connection_state
InlineInfobloxManagerDataSourceRequest1
This data structure has no properties.
InlineInfobloxManagerDataSourceRequest1
This data structure has no properties.
InlineKubernetesDataSourceRequest1
This data structure has no properties.
string
manager_id
Required
Associated nsxt data source entity Id
InlineKubernetesDataSourceRequest1
This data structure has no properties.
string
manager_id
Required
Associated nsxt data source entity Id
InlineKubernetesDataSourceRequest1
This data structure has no properties.
string
manager_id
Required
Associated nsxt data source entity Id
InlineKubernetesService1
This data structure has no properties.
string
vendor_id
Optional
vendor_id
array of string
annotations
Optional
annotations
array of string
labels
Optional
labels
string
creation_timestamp
Optional
creation_timestamp
string
type
Optional
type
array of string
selectors
Optional
selectors
InlineKubernetesService1
This data structure has no properties.
string
vendor_id
Optional
vendor_id
array of string
annotations
Optional
annotations
array of string
labels
Optional
labels
string
creation_timestamp
Optional
creation_timestamp
string
type
Optional
type
array of string
selectors
Optional
selectors
InlineNSXFirewallRule1
This data structure has no properties.
boolean
logging_enabled
Optional
logging_enabled
InlineNSXTManagerDataSource1
This data structure has no properties.
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXTManagerDataSource1
This data structure has no properties.
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXTManagerDataSource1
This data structure has no properties.
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXTManagerDataSource1
This data structure has no properties.
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXTManagerDataSource1
This data structure has no properties.
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXTManagerDataSourceRequest1
This data structure has no properties.
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXTManagerDataSourceRequest1
This data structure has no properties.
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXVManagerDataSource1
This data structure has no properties.
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
central_cli_enabled
Optional
central_cli_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXVManagerDataSource1
This data structure has no properties.
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
central_cli_enabled
Optional
central_cli_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXVManagerDataSource1
This data structure has no properties.
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
central_cli_enabled
Optional
central_cli_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXVManagerDataSource1
This data structure has no properties.
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
central_cli_enabled
Optional
central_cli_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXVManagerDataSource1
This data structure has no properties.
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
central_cli_enabled
Optional
central_cli_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXVManagerDataSourceRequest1
This data structure has no properties.
string
vcenter_id
Required
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
central_cli_enabled
Optional
central_cli_enabled
boolean
latency_enabled
Optional
latency_enabled
InlineNSXVManagerDataSourceRequest1
This data structure has no properties.
string
vcenter_id
Required
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
boolean
central_cli_enabled
Optional
central_cli_enabled
boolean
latency_enabled
Optional
latency_enabled
InlinePKSDataSource1
This data structure has no properties.
string
manager_id
Optional
Associated nsx-t manager entity Id
InlinePKSDataSource1
This data structure has no properties.
string
manager_id
Optional
Associated nsx-t manager entity Id
InlinePKSDataSource1
This data structure has no properties.
string
manager_id
Optional
Associated nsx-t manager entity Id
InlinePKSDataSource1
This data structure has no properties.
string
manager_id
Optional
Associated nsx-t manager entity Id
InlinePKSDataSource1
This data structure has no properties.
string
manager_id
Optional
Associated nsx-t manager entity Id
InlinePKSDataSourceRequest1
This data structure has no properties.
string
manager_id
Required
Associated nsxt data source entity Id
InlinePKSDataSourceRequest1
This data structure has no properties.
string
manager_id
Required
Associated nsxt data source entity Id
InlinePolicyManagerDataSource1
This data structure has no properties.
string
csp_refresh_token
Optional
csp_refresh_token
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
InlinePolicyManagerDataSource1
This data structure has no properties.
string
csp_refresh_token
Optional
csp_refresh_token
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
InlinePolicyManagerDataSource1
This data structure has no properties.
string
csp_refresh_token
Optional
csp_refresh_token
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
InlinePolicyManagerDataSource1
This data structure has no properties.
string
csp_refresh_token
Optional
csp_refresh_token
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
InlinePolicyManagerDataSource1
This data structure has no properties.
string
csp_refresh_token
Optional
csp_refresh_token
string
vcenter_id
Optional
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
InlinePolicyManagerDataSourceRequest1
This data structure has no properties.
string
csp_refresh_token
Optional
csp_refresh_token
string
vcenter_id
Required
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
InlinePolicyManagerDataSourceRequest1
This data structure has no properties.
string
csp_refresh_token
Optional
csp_refresh_token
string
vcenter_id
Required
Associated vcenter data source entity Id
boolean
ipfix_enabled
Optional
ipfix_enabled
InlineProblemEvent1
This data structure has no properties.
string
severity
Optional
severity
integer As int64 As int64
event_close_time_epoch_ms
Optional
event_close_time_epoch_ms
InlineProblemEvent1
This data structure has no properties.
string
severity
Optional
severity
integer As int64 As int64
event_close_time_epoch_ms
Optional
event_close_time_epoch_ms
InlineSecurityTag1
This data structure has no properties.
InlineSecurityTag1
This data structure has no properties.
InlineServiceNowDataSource1
This data structure has no properties.
string
instance_id
Optional
Associated nsxt data source entity Id
string
graph_configuration
Optional
CMDB configuration for CIs, relationships and graph traversal rules
boolean
is_graph_config_customized
Optional
Has graph configuration been modified from the default configuration
InlineServiceNowDataSource1
This data structure has no properties.
string
instance_id
Optional
Associated nsxt data source entity Id
string
graph_configuration
Optional
CMDB configuration for CIs, relationships and graph traversal rules
boolean
is_graph_config_customized
Optional
Has graph configuration been modified from the default configuration
InlineServiceNowDataSource1
This data structure has no properties.
string
instance_id
Optional
Associated nsxt data source entity Id
string
graph_configuration
Optional
CMDB configuration for CIs, relationships and graph traversal rules
boolean
is_graph_config_customized
Optional
Has graph configuration been modified from the default configuration
InlineServiceNowDataSource1
This data structure has no properties.
string
instance_id
Optional
Associated nsxt data source entity Id
string
graph_configuration
Optional
CMDB configuration for CIs, relationships and graph traversal rules
boolean
is_graph_config_customized
Optional
Has graph configuration been modified from the default configuration
InlineServiceNowDataSource1
This data structure has no properties.
string
instance_id
Optional
Associated nsxt data source entity Id
string
graph_configuration
Optional
CMDB configuration for CIs, relationships and graph traversal rules
boolean
is_graph_config_customized
Optional
Has graph configuration been modified from the default configuration
InlineServiceNowDataSourceRequest1
This data structure has no properties.
string
instance_id
Required
Associated service now instance
string
graph_configuration
Optional
CMDB configuration for CIs, relationships and graph traversal rules
boolean
is_graph_config_customized
Required
Has graph configuration been modified from the default configuration
InlineServiceNowDataSourceRequest1
This data structure has no properties.
string
instance_id
Required
Associated service now instance
string
graph_configuration
Optional
CMDB configuration for CIs, relationships and graph traversal rules
boolean
is_graph_config_customized
Required
Has graph configuration been modified from the default configuration
InlineSubnetMapping1
This data structure has no properties.
string
cidr
Optional
cidr
integer As int32 As int32
vlan_id
Optional
vlan_id
InlineSubnetMapping1
This data structure has no properties.
string
cidr
Optional
cidr
integer As int32 As int32
vlan_id
Optional
vlan_id
InlineSubnetMapping1
This data structure has no properties.
string
cidr
Optional
cidr
integer As int32 As int32
vlan_id
Optional
vlan_id
InlineSwitchDataSource1
This data structure has no properties.
InlineSwitchDataSourceRequest1
This data structure has no properties.
InlineTier1
This data structure has no properties.
InlineTier1
This data structure has no properties.
InlineTier1
This data structure has no properties.
InlineTier1
This data structure has no properties.
InlineTier1
This data structure has no properties.
InlineUserDefinedProblemEvent1
This data structure has no properties.
integer As int64 As int64
total_count
Optional
total_count
integer As int64 As int64
refs_added_count
Optional
refs_added_count
integer As int64 As int64
refs_deleted_count
Optional
refs_deleted_count
InlineVCDatacenter1
This data structure has no properties.
string
vendor_id
Optional
vendor_id
InlineVCDatacenter1
This data structure has no properties.
string
vendor_id
Optional
vendor_id
InlineVCenterDataSource1
This data structure has no properties.
boolean
is_vmc
Optional
is_vmc
InlineVCenterDataSource1
This data structure has no properties.
boolean
is_vmc
Optional
is_vmc
InlineVCenterDataSource1
This data structure has no properties.
boolean
is_vmc
Optional
is_vmc
InlineVCenterDataSource1
This data structure has no properties.
boolean
is_vmc
Optional
is_vmc
InlineVCenterDataSource1
This data structure has no properties.
boolean
is_vmc
Optional
is_vmc
InlineVCenterDataSourceRequest1
This data structure has no properties.
boolean
is_vmc
Optional
is_vmc
InlineVCenterDataSourceRequest1
This data structure has no properties.
boolean
is_vmc
Optional
is_vmc
InlineVCenterManager1
This data structure has no properties.
string
fqdn
Optional
fqdn
string
vc_uuid
Optional
vc_uuid
InlineVCenterManager1
This data structure has no properties.
string
fqdn
Optional
fqdn
string
vc_uuid
Optional
vc_uuid
InlineVeloCloudDataSource1
This data structure has no properties.
InlineVeloCloudDataSource1
This data structure has no properties.
InlineVeloCloudDataSource1
This data structure has no properties.
InlineVeloCloudDataSource1
This data structure has no properties.
InlineVeloCloudDataSource1
This data structure has no properties.
InlineVeloCloudDataSourceRequest1
This data structure has no properties.
InlineVeloCloudDataSourceRequest1
This data structure has no properties.
InlineVmknic1
This data structure has no properties.
InlineVmknic1
This data structure has no properties.
InterfaceWANConfig
JSON Example
{
"id": "string",
"name": "string",
"type": "string"
}string
id
Optional
id
string
name
Optional
name
string
type
Optional
type
IpAddressMembershipCriteria
Ip Address membership definition
JSON Example
{
"ip_addresses": [
"string"
]
}array of string
ip_addresses
Optional
ip_addresses
IpAddressRange
JSON Example
{
"start_ip": "string",
"end_ip": "string"
}string
start_ip
Optional
start_ip
string
end_ip
Optional
end_ip
IpNumericRange
JSON Example
{
"start": "integer",
"end": "integer"
}integer As int64 As int64
start
Optional
start
integer As int64 As int64
end
Optional
end
IpTag
JSON Example
{
"tag_id": "string",
"subnets": [
"string"
],
"ip_address_ranges": [
{
"start_ip": "string",
"end_ip": "string"
}
]
}string
tag_id
Optional
tag_id
array of string
subnets
Optional
subnets
IpTagIdList
JSON Example
{
"tag_ids": [
"string"
]
}array of string
tag_ids
Optional
tag_ids
IpV4Address
JSON Example
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}string
ip_address
Optional
ip_address
string
netmask
Optional
netmask
string
network_address
Optional
network_address
JuniperSwitchDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
JuniperSwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
K8SCredentials
JSON Example
{
"kubeconfig": "string"
}string
kubeconfig
Required
kubeconfig
KubernetesDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"manager_id": "192.168.10.1",
"credentials": {
"kubeconfig": "string"
}
}
KubernetesDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"kubeconfig": "string"
},
"manager_id": "192.168.10.1"
}
KubernetesService
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"kubernetes_cluster": {
"entity_id": "string",
"entity_type": "string"
},
"manager": {
"entity_id": "string",
"entity_type": "string"
},
"annotations": [
"string"
],
"labels": [
"string"
],
"creation_timestamp": "string",
"namespace": {
"entity_id": "string",
"entity_type": "string"
},
"cluster_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"loadbalancer_ip": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"type": "string",
"external_ips": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"selectors": [
"string"
]
}
KubernetesSourceRequest
JSON Example
{
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string"
}string
proxy_id
Required
proxy vm which should register this vcenter
string
nickname
Required
nickname
boolean
enabled
Optional
enabled
string
notes
Optional
notes
LocalFileServer
JSON Example
{
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
}string
backup_directory
Optional
Directory on file server to store/fetch backups
string
backup_file_name
Optional
filename of the backup to be restored (used during restore only)
MellanoxSwitchDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
MellanoxSwitchDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
MetricResponse
JSON Example
{
"metric": "string",
"display_name": "string",
"interval": "integer",
"unit": "string",
"pointlist": [
[
{}
]
],
"start": "integer",
"end": "integer"
}string
metric
Optional
metric
string
display_name
Optional
display_name
integer
interval
Optional
interval
string
unit
Optional
unit
array
pointlist
Optional
pointlist
integer As int64 As int64
start
Optional
start
integer As int64 As int64
end
Optional
end
MetricSchema
JSON Example
{
"metric": "string",
"display_name": "string",
"intervals": [
"integer"
],
"description": "string",
"unit": "string"
}string
metric
Optional
metric
string
display_name
Optional
display_name
array of integer
intervals
Optional
intervals
string
description
Optional
description
string
unit
Optional
unit
MicroSecGroup
JSON Example
{
"entity": {
"entity_id": "string",
"entity_type": "string"
}
}
NSXControllerDataCollection
JSON Example
{
"enabled": "boolean",
"controller_password": "string"
}boolean
enabled
Optional
enabled
string
controller_password
Optional
controller_password
Parameter To
NSXFirewallRule
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
],
"logging_enabled": "boolean",
"direction": "string",
"scope": "string",
"nsx_managers": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
NSXTManagerDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"ipfix_enabled": "boolean",
"latency_enabled": "boolean"
}
Parameter To
NSXTManagerDataSourceRequest
AllOf
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"ipfix_enabled": "boolean",
"latency_enabled": "boolean"
}
NSXVManagerDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"vcenter_id": "string",
"ipfix_enabled": "boolean",
"central_cli_enabled": "boolean",
"latency_enabled": "boolean"
}
Parameter To
NSXVManagerDataSourceRequest
AllOf
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"vcenter_id": "string",
"ipfix_enabled": "boolean",
"central_cli_enabled": "boolean",
"latency_enabled": "boolean"
}
NameRequestParam
JSON Example
{
"entity_id": "string",
"time": "integer"
}string
entity_id
Optional
entity_id
integer As int64 As int64
time
Optional
time
NamesRequest
JSON Example
{
"entities": [
{
"entity_id": "string",
"time": "integer"
}
]
}
NamesResponse
JSON Example
{
"entities": [
{
"entity_id": "string",
"entity_type": "string",
"time": "integer",
"name": "string"
}
]
}
Node
JSON Example
{
"id": "string",
"entity_type": "string",
"node_type": "string",
"node_id": "string",
"ip_address": "string",
"name": "string"
}string
id
Optional
id
string
node_type
Optional
node_type
string
node_id
Optional
node_id
string
ip_address
Optional
ip_address
string
name
Optional
name
NodeId
JSON Example
{
"id": "1000:104:12213212",
"entity_type": "string"
}string
id
Optional
Entity Identifier
NodeListResult
JSON Example
{
"results": [
{
"id": "1000:104:12213212",
"entity_type": "string"
}
],
"total_count": 1
}integer
total_count
Optional
total_count
PKSDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"manager_id": "string"
}
PKSDataSourceRequest
AllOf
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"manager_id": "string"
}
PagedApplicationListResponse
JSON Example
{
"results": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"create_time": "integer",
"created_by": "string",
"last_modified_time": "integer",
"last_modified_by": "string"
}
],
"cursor": "string",
"total_count": "integer"
}string
cursor
Optional
cursor
integer
total_count
Optional
total_count
PagedListResponse
JSON Example
{
"results": [
{
"entity_id": "1000:104:12213212",
"entity_type": "string"
}
],
"cursor": "string",
"total_count": "integer",
"start_time": "integer",
"end_time": "integer"
}string
cursor
Optional
cursor
integer
total_count
Optional
total_count
integer As int64 As int64
start_time
Optional
start_time
integer As int64 As int64
end_time
Optional
end_time
PagedListResponseWithTime
JSON Example
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"time": "integer"
}
],
"cursor": "ML12eu02==",
"total_count": 100,
"start_time": 1504739809,
"end_time": 1504739809
}string
cursor
Optional
cursor
integer
total_count
Optional
total_count
integer As int64 As int64
start_time
Optional
start_time
integer As int64 As int64
end_time
Optional
end_time
Returned By
PanFirewallDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
PanFirewallDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
PasswordCredentials
JSON Example
{
"username": "string",
"password": "string"
}string
username
Required
username
string
password
Optional
password
PathFirewallRules
JSON Example
{
"firewalls": [
{
"firewall_entity_id": {
"entity_id": "string",
"entity_type": "string"
},
"vendor_info": {
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
},
"manager": {
"entity_id": "string",
"entity_type": "string"
},
"rules": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"rule_id": "string",
"section_id": "string",
"section_name": "string",
"sequence_number": "integer",
"source_any": "boolean",
"destination_any": "boolean",
"service_any": "boolean",
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"services": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"action": "string",
"disabled": "boolean",
"source_inversion": "boolean",
"destination_inversion": "boolean",
"port_ranges": [
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}
]
}
]
}
]
}
PathFirewallRulesRequest
JSON Example
{
"source_ip_address": "string",
"destination_ip_address": "string",
"port": "integer",
"protocol": "string",
"time": "integer"
}string
source_ip_address
Optional
source_ip_address
string
destination_ip_address
Optional
destination_ip_address
integer As int32 As int32
port
Optional
port
string
protocol
Optional
protocol
integer As int64 As int64
time
Optional
time
PolicyManagerDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"csp_refresh_token": "string",
"vcenter_id": "string",
"ipfix_enabled": "boolean"
}
Parameter To
PolicyManagerDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"csp_refresh_token": "string",
"vcenter_id": "string",
"ipfix_enabled": "boolean"
}
PortRange
JSON Example
{
"start": "integer",
"end": "integer",
"display": "string",
"iana_name": "string",
"iana_port_display": "string"
}integer As int32 As int32
start
Optional
start
integer As int32 As int32
end
Optional
end
string
display
Optional
display
string
iana_name
Optional
iana_name
string
iana_port_display
Optional
iana_port_display
ProblemEvent
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer"
}
ProblemWithTime
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer",
"time": "integer"
}string
entity_id
Optional
Entity Identifier
integer As int64 As int64
time
Optional
time
Protocol
This data structure has no properties.
Enumeration: TCP, UDP, OTHER,
RecommendedRule
JSON Example
{
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"protocols": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"action": "string"
}array of string
protocols
Optional
protocols
string
action
Optional
action
RecommendedRules
JSON Example
{
"results": [
{
"sources": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"destinations": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"protocols": [
"string"
],
"port_ranges": [
{
"start": "integer",
"end": "integer"
}
],
"action": "string"
}
],
"time_range": {
"start_time": "integer",
"end_time": "integer"
}
}
RecommendedRulesRequest
JSON Example
{
"group_1": {
"entity": {
"entity_type": "Tier",
"entity_id": "10000:562:1904698621"
}
},
"group_2": {
"entity": {
"entity_type": "Tier",
"entity_id": "10000:562:1780351215"
}
}
}boolean
include_external
Optional
When True, includes ungrouped endpoints outside defined scope
Reference
JSON Example
{
"entity_id": "string",
"entity_type": "string"
}string
entity_id
Optional
entity_id
Role
Role assigned the user/group.
This data structure has no properties.
Enumeration: MEMBER, ADMIN, AUDITOR,
RuleSet
JSON Example
{
"rules": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"firewall": {
"entity_id": "string",
"entity_type": "string"
},
"rule_set_type": "string"
}
SNMP2cConfig
JSON Example
{
"community_string": "string"
}string
community_string
Optional
community_string
SNMP3Config
JSON Example
{
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}string
username
Optional
username
string
context_name
Optional
context_name
string
authentication_type
Optional
authentication_type
string
authentication_password
Optional
authentication_password
string
privacy_type
Optional
privacy_type
string
privacy_password
Optional
privacy_password
SNMPConfig
JSON Example
{
"snmp_enabled": "boolean",
"snmp_version": "string",
"config_snmp_2c": {
"community_string": "string"
},
"config_snmp_3": {
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
}boolean
snmp_enabled
Optional
snmp_enabled
string
snmp_version
Optional
snmp_version
Parameter To
Returned By
ScopeEnum
This data structure has no properties.
Enumeration: UNIVERSAL, GLOBAL,
SddcType
This data structure has no properties.
Enumeration: ONPREM, VMC,
SearchGroupByRequest
JSON Example
{
"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"
}
]
}string
filter
Optional
query filter
array of string
group_by
Optional
group_by
integer As int32 As int32
size
Optional
size
string
cursor
Optional
cursor
SearchGroupByResponse
JSON Example
{
"results": [
{
"bucket": [
{
"field": "string",
"value": "string"
}
],
"count": "integer",
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
]
}
],
"size": "integer",
"total_bucket": {
"value": "integer",
"is_approx": "boolean"
},
"total_count": "integer",
"time_range": {
"start_time": "integer",
"end_time": "integer"
},
"cursor": "string"
}integer As int32 As int32
size
Optional
size
integer As int32 As int32
total_count
Optional
total count of entity
string
cursor
Optional
cursor
SearchMembershipCriteria
JSON Example
{
"entity_type": "string",
"filter": "string"
}string
filter
Optional
As defined in search end point
SearchRequest
JSON Example
{
"entity_type": "string",
"filter": "string",
"sort_by": {
"field": "string",
"order": "string"
},
"size": "integer",
"cursor": "string",
"time_range": {
"start_time": "integer",
"end_time": "integer"
}
}string
filter
Optional
query filter
integer As int32 As int32
size
Optional
size
string
cursor
Optional
cursor
SecurityTag
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"description": "string",
"direct_security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"security_groups": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"vendor_id": "string",
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
ServiceNowDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"instance_id": "dev36113.service-now.com",
"graph_configuration": "string",
"is_graph_config_customized": "boolean"
}
Parameter To
ServiceNowDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"proxy_id": "1000:104:12313412",
"nickname": "snow1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"instance_id": "dev36113.service-now.com",
"graph_configuration": "string",
"is_graph_config_customized": "boolean"
}
ServiceNowSourceRequest
JSON Example
{
"proxy_id": "1000:104:12313412",
"nickname": "snow1",
"enabled": "boolean",
"notes": "string"
}string
proxy_id
Required
proxy vm which should register this vcenter
string
nickname
Required
nickname
boolean
enabled
Optional
enabled
string
notes
Optional
notes
Severity
This data structure has no properties.
Enumeration: Critical, Moderate, Warning, Info,
SimplePortRange
JSON Example
{
"start": "integer",
"end": "integer"
}integer As int32 As int32
start
Optional
start
integer As int32 As int32
end
Optional
end
Size
page size of results
This data structure has no properties.
SnmpProfileIds
JSON Example
{
"snmp_profiles": [
"string"
]
}array of string
snmp_profiles
Optional
snmp_profiles
SnmpProfileListResponse
JSON Example
{
"results": [
{
"entity_id": "snmp-er67ght8kn67",
"nick_name": "Aws collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "string"
},
"snmp_v3": {
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
}
],
"total_count": "integer"
}integer
total_count
Optional
total_count
SnmpProfileRequest
JSON Example
{
"nick_name": "Aws collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "string"
},
"snmp_v3": {
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
}string
nick_name
Optional
Descriptor or identifier for particular snmp profile.
string
target_ip
Optional
IP address of SNMP target destination
integer
target_port
Optional
Receiving port number of SNMP target destination
string
snmp_version
Optional
snmp_version
SnmpProfileResponse
JSON Example
{
"entity_id": "snmp-er67ght8kn67",
"nick_name": "Aws collector profile",
"target_ip": "10.11.11.102",
"target_port": 161,
"snmp_version": "string",
"snmp_v2c": {
"community_string": "string"
},
"snmp_v3": {
"username": "string",
"context_name": "string",
"authentication_type": "string",
"authentication_password": "string",
"privacy_type": "string",
"privacy_password": "string"
}
}string
entity_id
Optional
Entity Identifier for snmp profile.
string
nick_name
Optional
User defined descriptor or identifier for particular snmp profile.
string
target_ip
Optional
IP address of SNMP target destination
integer
target_port
Optional
Receiving port number of SNMP target destination
string
snmp_version
Optional
snmp_version
SortByClause
JSON Example
{
"field": "string",
"order": "string"
}string
field
Optional
field
string
order
Optional
order
SshFileServer
JSON Example
{
"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"
}string
server_address
Optional
IP address or hostname of destination SSH file server
integer
port
Optional
File transfer port
string
username
Optional
username to login ssh server
string
password
Optional
password for the user to login ssh server
string
backup_directory
Optional
directory on file server to store/fetch backups
string
backup_file_name
Optional
filename of the backup to be restored (used during restore only)
StartTime
start time for query in epoch seconds
This data structure has no properties.
SubnetMapping
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"cidr": "string",
"vlan_id": "integer"
}
SubnetMappingList
JSON Example
{
"results": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"cidr": "string",
"vlan_id": "integer"
}
]
}
SubnetMappingRequest
JSON Example
{
"cidr": "string",
"vlan_id": "integer"
}string
cidr
Optional
cidr
integer As int32 As int32
vlan_id
Optional
vlan_id
SubscriptionListResponse
JSON Example
{
"results": [
{
"entity_id": "string",
"active": "boolean",
"event_name": "string",
"is_problem": "boolean",
"severity": "string",
"search_criteria": "string",
"generate_event_criteria": "string",
"email_frequency": "string",
"daily_at_utc": "string",
"email_ids": [
"string"
],
"snmp_trap_entity_ids": [
"string"
]
}
],
"total_count": "integer"
}integer
total_count
Optional
total_count
SubscriptionRequest
JSON Example
{
"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"
]
}string
event_name
Optional
event_name
boolean
is_problem
Optional
is_problem
string
severity
Optional
severity
string
search_criteria
Optional
search_criteria
string
daily_at_utc
Optional
daily_at_utc
array of string
email_ids
Optional
email_ids
array of string
snmp_trap_entity_ids
Optional
snmp_trap_entity_ids
SubscriptionResponse
JSON Example
{
"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"
]
}string
entity_id
Optional
entity_id
boolean
active
Optional
active
string
event_name
Optional
event_name
boolean
is_problem
Optional
is_problem
string
search_criteria
Optional
search_criteria
string
daily_at_utc
Optional
daily_at_utc
array of string
email_ids
Optional
email_ids
array of string
snmp_trap_entity_ids
Optional
snmp_trap_entity_ids
SwitchDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
SwitchDataSourceRequest
AllOf
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
TestSnmpProfileResponse
JSON Example
{
"status": true,
"message": "Failed sending SNMP trap"
}boolean
status
Optional
Test trap sent successfully or not
string
message
Optional
Test snmp trap status message
Tier
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"group_membership_criteria": [
{
"membership_type": "string",
"ip_address_membership_criteria": {
"ip_addresses": [
"string"
]
},
"search_membership_criteria": {
"entity_type": "string",
"filter": "string"
}
}
],
"application": {
"entity_id": "string",
"entity_type": "string"
}
}
Property Of
TierListResponse
JSON Example
{
"results": [
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"group_membership_criteria": [
{
"membership_type": "string",
"ip_address_membership_criteria": {
"ip_addresses": [
"string"
]
},
"search_membership_criteria": {
"entity_type": "string",
"filter": "string"
}
}
],
"application": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
TierMembersResponse
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
]
}string
entity_id
Optional
entity_id
string
entity_type
Optional
entity_type
string
name
Optional
name
TierRequest
JSON Example
{
"name": "tier-1",
"group_membership_criteria": [
{
"membership_type": "SearchMembershipCriteria",
"search_membership_criteria": {
"entity_type": "VirtualMachine",
"filter": "security_groups.entity_id = '18230:82:604573173'"
}
}
]
}string
name
Optional
name
TiersMembersResponse
JSON Example
{
"results": [
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"members": [
{
"entity_id": "string",
"entity_type": "string",
"vendor_infos": [
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
]
}
]
}
],
"cursor": "string",
"total_count": "integer"
}string
cursor
Optional
cursor
integer As int32 As int32
total_count
Optional
total_count
Time
time in epoch seconds
This data structure has no properties.
TimeRange
JSON Example
{
"start_time": "integer",
"end_time": "integer"
}integer As int64 As int64
start_time
Optional
start_time
integer As int64 As int64
end_time
Optional
end_time
UCSManagerDataSource
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
UCSManagerDataSourceRequest
AllOf
This class requires all of the following:
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
UpdateTimeFrom
Events that were created or updated or closed between this time and update_time_to, in seconds
This data structure has no properties.
UpdateTimeTo
Events that were created or updated or closed between update_time_from and this time, in seconds
This data structure has no properties.
UserDefinedProblemEvent
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer",
"total_count": "integer",
"refs_added_count": "integer",
"refs_deleted_count": "integer",
"subscriptions": [
{
"entity_id": "string",
"entity_type": "string"
}
]
}
UserDefinedProblemWithTime
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"name": "string",
"anchor_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"related_entities": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"message": "string",
"event_tags": [
"string"
],
"admin_state": "string",
"archived": "boolean",
"event_time_epoch_ms": "integer",
"event_type": "string",
"recommendations": [
"string"
],
"severity": "string",
"event_close_time_epoch_ms": "integer",
"total_count": "integer",
"refs_added_count": "integer",
"refs_deleted_count": "integer",
"subscriptions": [
{
"entity_id": "string",
"entity_type": "string"
}
],
"time": "integer"
}string
entity_id
Optional
Entity Identifier
integer As int64 As int64
time
Optional
time
UserGroupResponse
JSON Example
{
"id": "[email protected]",
"group_type": "VIDM",
"group_name": "testgroup",
"domain": "vidmlabs.com",
"role": "ADMIN"
}string
id
Optional
Unique identifier assigned to user-group.
string
group_name
Optional
Group-name of the user-group.
string
domain
Optional
Domain name to which user-group belongs to.
UserGroupType
The type of user-group.
This data structure has no properties.
Enumeration: LDAP, LOCAL, VIDM,
UserResponse
JSON Example
{
"id": "[email protected]",
"user_type": "VIDM",
"username": "alleymartin123",
"domain": "vidmlabs.com",
"display_name": "alley martin",
"role": "ADMIN"
}
UserType
The type of user.
This data structure has no properties.
Enumeration: LDAP, LOCAL, VIDM,
UserUpdateRequest
JSON Example
{
"username": "admin@local",
"new_password": "password"
}string
username
Optional
username
string
new_password
Optional
new_password
VCDatacenter
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"vendor_id": "string",
"vcenter_manager": {
"entity_id": "string",
"entity_type": "string"
}
}
VCenterDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"is_vmc": "boolean"
}
VCenterDataSourceRequest
AllOf
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
},
"is_vmc": "boolean"
}
VCenterManager
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_address": {
"ip_address": "string",
"netmask": "string",
"network_address": "string"
},
"fqdn": "string",
"vm": {
"entity_id": "string",
"entity_type": "string"
},
"nsx_manager": {
"entity_id": "string",
"entity_type": "string"
},
"vc_uuid": "string"
}
VeloCloudDataSource
AllOf
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
Parameter To
VeloCloudDataSourceRequest
AllOf
JSON Example
{
"ip": "192.168.10.1",
"fqdn": "your.domain.com",
"proxy_id": "1000:104:12313412",
"nickname": "vc1",
"enabled": "boolean",
"notes": "string",
"credentials": {
"username": "string",
"password": "string"
}
}
VendorId
JSON Example
{
"id_type": "string",
"id_value": "string"
}string
id_type
Optional
id_type
string
id_value
Optional
id_value
VendorInfo
JSON Example
{
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
],
"manager": {
"entity_id": "string",
"entity_type": "string"
}
}
VendorInfoWithMk
JSON Example
{
"entity_id": "string",
"entity_type": "string",
"entity_name": "string",
"vendor_ids": [
{
"id_type": "string",
"id_value": "string"
}
]
}string
entity_id
Optional
entity_id
string
entity_type
Optional
entity_type
string
entity_name
Optional
entity_name
VersionResponse
JSON Example
{
"api_version": "string"
}string
api_version
Optional
api_version
Vlan
JSON Example
{
"begin": "integer",
"end": "integer"
}integer
begin
Optional
begin
integer
end
Optional
end
Vmknic
AllOf
JSON Example
{
"entity_id": "string",
"name": "string",
"entity_type": "string",
"ip_addresses": [
{
"ip_address": "string",
"netmask": "string",
"network_address": "string"
}
],
"vlan": {
"begin": "integer",
"end": "integer"
},
"host": {
"entity_id": "string",
"entity_type": "string"
},
"layer2_network": {
"entity_id": "string",
"entity_type": "string"
}
}
WANConfig
JSON Example
{
"site": "Washington DC",
"region": "US East",
"interfaces": [
{
"id": "string",
"name": "string",
"type": "string"
}
]
}string
site
Optional
site
string
region
Optional
region
Parameter To
Node: apidepo-liferay-dxp-v1-be-w-0:8080: