[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Path Firewall Rules

Description

Get firewall rules applicable in path for a client IP and server IP for specified port/protocol.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/path/firewall-rules
Copy

Request Body

Request Body

PathFirewallRulesRequest of type(s) application/json Required

VMware Identity Manager configuration details

{
    "destination_ip_address": "1.1.1.1",
    "port": 80,
    "protocol": "TCP",
    "source_ip_address": "2.2.2.2"
}
string
destination_ip_address Optional

Destination IP configured in firewall rule


integer as int32
port Optional

Port number configured in firewall rule


string
protocol Optional

Protocol configured in firewall rule


string
source_ip_address Optional

Source IP configured in firewall rule


integer as int64
time Optional

Timestamp of object

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PathFirewallRules of type(s) application/json
{
	"firewalls": [
		{
			"firewall_entity_id": {
				"entity_id": "string",
				"entity_type": "VirtualMachine"
			},
			"manager": {
				"entity_id": "string",
				"entity_type": "VirtualMachine"
			},
			"rules": [
				{
					"action": "ALLOW",
					"destination_any": false,
					"destination_inversion": false,
					"destinations": [
						{
							"entity_id": "string",
							"entity_type": "VirtualMachine"
						}
					],
					"disabled": false,
					"entity_id": "1000:104:12213212",
					"entity_type": "VirtualMachine",
					"name": "My Name",
					"port_ranges": [
						{
							"display": "string",
							"end": 0,
							"iana_name": "string",
							"iana_port_display": "string",
							"start": 0
						}
					],
					"rule_id": "string",
					"section_id": "string",
					"section_name": "string",
					"sequence_number": 0,
					"service_any": false,
					"services": [
						{
							"entity_id": "string",
							"entity_type": "VirtualMachine"
						}
					],
					"source_any": false,
					"source_inversion": false,
					"sources": [
						{
							"entity_id": "string",
							"entity_type": "VirtualMachine"
						}
					]
				}
			],
			"vendor_info": {
				"manager": {
					"entity_id": "string",
					"entity_type": "VirtualMachine"
				},
				"vendor_ids": [
					{
						"id_type": "string",
						"id_value": "string"
					}
				]
			}
		}
	]
}
array of FirewallRuleSet
firewalls Optional
Errors

Errors

ApiError
400

Bad Request


401

Unauthorized


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"destination_ip_address":"1.1.1.1","port":80,"protocol":"TCP","source_ip_address":"2.2.2.2"}' https://vrni.example.com/api/ni/path/firewall-rules


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Feedback

Was this page helpful?