VMware NSX
VMware NSX provides an agile software-defined infrastructure to build cloud-native application environments.
Types of Assets Fetched
This adapter fetches the following types of assets:
- Devices, Load Balancers, Network/Firewall Rules
Parameters
-
Host Name or IP Address (required) - The hostname or IP address of the VMware NSX server.
-
User Name and Password (required) - The credentials for a user account that has the Required Permissions to fetch assets.
-
Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. To learn more, see SSL Trust & CA Settings.
-
HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.
-
HTTPS Proxy User Name (optional) - The user name to use when connecting to the value supplied in Host Name or IP Address via the value supplied in HTTPS Proxy.
-
HTTPS Proxy Password (optional) - The password to use when connecting to the server using the HTTPS Proxy.
To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

Advanced Settings
Note
Advanced settings can either apply to all connections for this adapter, or to a specific connection. Refer to βAdvanced Configuration for Adapters.
- Device types to fetch (required, default: NSX Device) - Select from dropdown the device types that will be fetched with this connection. Supported device types: Cloud Device, NSX Device, NSX LoadBalancer.
- Fetch firewall rules (required, default: true) - Select this option to enrich devices with firewall rules.
- Fetch Policy API distributed and gateway firewall rules as Firewall assets (default: disabled) - Select this option to fetch the Policy API distributed and gateway firewall rules as individual Firewall assets (asset type NSX Policy Firewall Rule). The assets include the policy, action, direction, groups, services, scope, and rule status.
- Fetch Tier-0 and Tier-1 gateway NAT rules as Firewall assets (default: disabled) - Select this option to fetch the Tier-0 and Tier-1 gateway NAT rules as individual Firewall assets (asset type NSX Gateway NAT Rule). The adapter records the NAT rule details and the supported translations for SNAT, DNAT, and REFLEXIVE rules.
- Fetch load balancer pools and virtual server listeners (default: disabled) - Select this option to fetch the load balancer pools and add listener data to the Load Balancer assets. Each listener maps a virtual server address and port to the addresses and ports of its pool members.
Note
To learn more about Adapter Configuration tab advanced settings, see Adapter Advanced Settings.
APIs
Axonius uses the NSX-T Data Center REST API.
Endpoints
POST /api/session/create- Authenticate and get a session token.GET /api/v1/csm/virtual-machines- Fetch Cloud Devices. Used when Cloud Device is selected in Device types to fetch.GET /api/v1/fabric/virtual-machines- Fetch NSX Devices. Used when NSX Device is selected in Device types to fetch.GET /api/v1/fabric/vifs- Fetch the virtual network interfaces of NSX Devices.GET /policy/api/v1/infra/lb-virtual-servers- Fetch load balancer virtual servers. Used when NSX LoadBalancer is selected in Device types to fetch.GET /policy/api/v1/infra/lb-services- Fetch load balancer services. Used when NSX LoadBalancer is selected in Device types to fetch.GET /policy/api/v1/infra/lb-pools- Fetch load balancer pools and their members. Used when Fetch load balancer pools and virtual server listeners is enabled.GET /api/v1/firewall/sections- Fetch firewall sections. Used when Fetch firewall rules is enabled.GET /api/v1/firewall/sections/{section_id}/rules- Fetch the rules of a firewall section. Used when Fetch firewall rules is enabled.GET /api/v1/ns-groups- Fetch NS groups. Used when Fetch firewall rules is enabled.GET /api/v1/ns-groups/{group_id}/effective-virtual-machine-members- Fetch the virtual machine members of an NS group. Used when Fetch firewall rules is enabled.GET /policy/api/v1/infra/domains- Fetch Policy API domains. Used when Fetch Policy API distributed and gateway firewall rules as Firewall assets is enabled.GET /policy/api/v1/infra/domains/{domain_id}/security-policies- Fetch the distributed firewall policies of a domain. Used when Fetch Policy API distributed and gateway firewall rules as Firewall assets is enabled.GET /policy/api/v1/infra/domains/{domain_id}/gateway-policies- Fetch the gateway firewall policies of a domain. Used when Fetch Policy API distributed and gateway firewall rules as Firewall assets is enabled.GET /policy/api/v1/{policy_path}/rules- Fetch the rules of a policy. Used when Fetch Policy API distributed and gateway firewall rules as Firewall assets is enabled.GET /policy/api/v1/{group_path}/members/ip-addresses- Fetch the IP addresses of the groups that a rule references. Used when Fetch Policy API distributed and gateway firewall rules as Firewall assets is enabled.GET /policy/api/v1/infra/services- Fetch the services that rules reference. Used when Fetch Policy API distributed and gateway firewall rules as Firewall assets or Fetch Tier-0 and Tier-1 gateway NAT rules as Firewall assets is enabled.GET /policy/api/v1/infra/tier-0s- Fetch Tier-0 gateways. Used when Fetch Tier-0 and Tier-1 gateway NAT rules as Firewall assets is enabled.GET /policy/api/v1/infra/tier-1s- Fetch Tier-1 gateways. Used when Fetch Tier-0 and Tier-1 gateway NAT rules as Firewall assets is enabled.GET /policy/api/v1/{gateway_path}/nat/{section}/nat-rules- Fetch the NAT rules of a gateway. Used when Fetch Tier-0 and Tier-1 gateway NAT rules as Firewall assets is enabled.
Required Permissions
The value supplied in User Name must have the following permissions in order to fetch assets:
- read:cloud_resources
- read:vm_vm_info
- read:firewall_general (optional, required for fetching firewall rules)
Version Matrix
This adapter was only tested with the versions marked as supported, but may work with other versions. Contact Axonius Support if you have a version that is not listed, which is not functioning as expected.
| Version | Supported | Notes |
|---|---|---|
| VMware NSX device API V3.1.2 | Yes | -- |
| VMware NSX device API V2.4 | Partial | Some endpoints do not exist. |
| VMware NSX device API V4.0 | Partial | Some endpoints are deprecated. |
Supported From Version
Supported from Axonius version 4.8
Updated 29 days ago
