Axonius Documentation
Start typing to search…

VMware Network Configuration Manager

VMware Network Configuration Manager is a network automation and compliance tool that provides configuration, change, and compliance management for multi-vendor network devices.

Asset Types Fetched

  • Devices, Users, Containers, SaaS Applications etc

Before You Begin

Ports If there are more than one, a bulleted list

Authentication Method

e.g.

  • User name/password for Cloud
  • API Key/API Token for on-prem

APIs

Axonius uses the [API NAME + hyperlink].

Permissions

To retrieve network device configuration and activity data, the API token or credentials must be associated with an account that has sufficient rights to:

  • Access the VMware Network Configuration Manager (NCM) platform
  • View device inventory and configuration details
  • Retrieve software version, serial number, and vendor-specific metadata
  • Access device contact information and any associated activity or audit logs

If the account does not have the appropriate role-based access control (RBAC) permissions—specifically, System Administrator privileges—API requests may return incomplete data, restricted fields, or authorization errors (e.g., 403 Forbidden).

Recommended Steps:

  • Ensure the account used by the API adapter has System Administrator privileges within VMware NCM. This can be granted via the NCM admin interface or user role configuration.

  • Validate that the account is either:

    • A member of the sysadmin group
    • Or explicitly assigned system-admin capabilities in the role configuration settings

  • Run a test query to a device configuration endpoint to confirm access before integrating at scale.

  • If possible, establish a dedicated read-only system-admin service account for use with Axonius to ensure security and traceability.

Supported From Version

Supported from Axonius version x.x.x.x

Connecting the Adapter in Axonius

To connect the adapter in Axonius, provide the following parameters:

Required Parameters

  1. Host Name or IP Address - The hostname or IP address of the VMware Network Configuration Manager server.

  2. User Name and Password - The credentials for a user account that has the Required Permissions to fetch assets.

  3. Port (default: xxx) - The port used for the connection.

  4. API Key - An API Key associated with a user account that has the Required Permissions to fetch assets.

💡

If either API Token/key or username/password are used

If there can be 2 alternative ways of authentication, both are written as optional, this can be confusing, therefore add the following as notes next to the relevant items

Note to use when either API token is needed or username and pw ::: info (Note:) When API Token is not supplied, User Name and Password are required.

📘

Note

When User Name and Password are not supplied, API Key is required.

💡

Template - Adapter Screenshot

Add adapter connection screenshot:

  • Recommended size: {height="" width="500"}

  • Not populated

  • With no errors

  • With only the adapter params - no connection label and no buttons - e.g.: image.png

Optional Parameters

  1. 2FA Secret Key (only used to fetch SaaS data) - The secret generated in [ADAPTER NAME] for setting up 2-factor authentication for the adapter user created to collect SaaS Application data.

  2. SSO Provider (only used to fetch SaaS data) - If your organization uses [adapter name] for SSO, this adapter can be set as an SSO provider see Connecting your SSO Solution Provider.

  3. Custom Login URL (only used to fetch SaaS data) - The URL as it appears in the browser's address bar after signing in if using a custom SSO provider.

  4. Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.

  5. HTTPS Proxy - Connect the adapter to a proxy instead of directly connecting it to the domain.

  6. HTTPS Proxy User Name - The user name to use when connecting to the value supplied in Host Name or IP Address via the value supplied in HTTPS Proxy.

  7. HTTPS Proxy Password - 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

💡

Template - Advanced Settings

  • Optional section - specify only When tab exists.

  • List settings in a numbered list.

  • Each parameter should be described in the same format as in the adapter parameters.

  • terminology - Axonius fetches data

  • Add the note below after the described parameters

📘

Note

Advanced settings can either apply to all connections for this adapter, or to a specific connection. Refer to ​Advanced Configuration for Adapters.

  1. Fetch abc (default: x) * - Select this option to fetch x
  2. Fetch abc (default: x) (only for accounts with Axonius SaaS Applications) - Select this option to fetch x
📘

Note

To learn more about Adapter Configuration tab advanced settings, see Adapter Advanced Settings.

Updated about 20 hours ago