ApiError

ApiError

JSON Example

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

string

module_name

Optional

module_name

string

error_message

Optional

error_message

integer As int64 As int64

error_code

Optional

error_code

Returned By

Add Bgp Neighbor

Add Certificate

Add Cluster Node

Add Crl

Add Dne Key Manager

Add Dne Key Policy

Add Dne Rule In Section

Add Dne Rules In Section

Add Dne Section

Add Dne Section With Rules

Add IP Prefix List

Add MAC Address

Add Member

Add Nat Rule

Add Node

Add Or Remove NS Group Expression

Add Route Map

Add Rule In Section

Add Rules In Section

Add Section

Add Section With Rules

Add Static Route

Add Upgrade Units To Group

Add User

Allocate Or Release From Ip Pool

Cancel Task

Check Member If Exists

Collect Support Bundles

Configure Backup Config

Continue Upgrade

Copy From Remote File

Copy To Remote File

Create Appliance Management Service Action

Create Bridge Cluster

Create Bridge Endpoint

Create Cluster Backup

Create Cluster Profile

Create Cluster Restore

Create Dhcp Ip Pool

Create Dhcp Profile

Create Dhcp Relay

Create Dhcp Relay Profile

Create Dhcp Server

Create Dhcp Static Binding

Create Edge Cluster

Create File

Create Host Switch Profile

Create Ip Pool

Create IP Set

Create Ipfix Config

Create License

Create Logical Port

Create Logical Router

Create Logical Router Port

Create Logical Switch

Create MAC Set

Create Metadata Proxy

Create Node Backup

Create Node Network Route

Create Node Restore

Create NS Group

Create NS Service

Create NS Service Group

Create NSX Message Bus Service Action

Create Nsx Upgrade Agent Service Action

Create NTP Service Action

Create Port Mirroring Sessions

Create Proton Service Action

Create Proxy Service Action

Create Proxy Service Apply Certificate Action

Create Rabbit MQ Service Action

Create Remote Directory

Create Repository Service Action

Create Service

Create Service Profile

Create SNMP Service Action

Create SSH Service Action

Create SSH Service Remove Host Fingerprint Action

Create Static Hop Bfd Peer

Create Switching Profile

Create Syslog Service Action

Create Traceflow

Create Transport Node

Create Transport Zone

Create Transport Zone Profile

Create Upgrade Unit Group

Delete Bgp Neighbor

Delete Bridge Cluster

Delete Bridge Endpoint

Delete Certificate

Delete Cluster Node Config

Delete Cluster Profile

Delete Crl

Delete Csr

Delete Dhcp Ip Pool

Delete Dhcp Profile

Delete Dhcp Relay

Delete Dhcp Relay Profile

Delete Dhcp Server

Delete Dhcp Static Binding

Delete Dne Key Manager

Delete Dne Key Policy

Delete Dne Rule

Delete Dne Section

Delete Edge Cluster

Delete File

Delete Host Switch Profile

Delete Ip Pool

Delete IP Prefix List

Delete IP Set

Delete Ipfix Config

Delete License

Delete Logical Port

Delete Logical Router

Delete Logical Router Port

Delete Logical Switch

Delete MAC Set

Delete Metadata Proxy

Delete Nat Rule

Delete Node

Delete Node Network Route

Delete Node Syslog Exporter

Delete NS Group

Delete NS Service

Delete NS Service Group

Delete Port Mirroring Session

Delete Route Map

Delete Rule

Delete Section

Delete Service

Delete Service Profile

Delete Static Hop Bfd Peer

Delete Static Route

Delete Switching Profile

Delete Task

Delete Traceflow

Delete Transport Node

Delete Transport Zone

Delete Transport Zone Profile

Delete Upgrade Unit Group

Generate Csr

Get Aggregation Service Global Config

Get Associations

Get Backup Config

Get Backup History

Get Backup Status

Get Bgp Neighbors Status

Get Bridge Cluster

Get Bridge Cluster Status

Get Bridge Endpoint

Get Bridge Endpoint Statistics

Get Bridge Endpoint Status

Get Certificate

Get Certificates

Get Cluster Profile

Get Crl

Get Crls

Get Csr

Get Csr Pem

Get Csrs

Get Current Barrier

Get Current User Info

Get Dne Key Manager

Get Dne Key Policy

Get Dne Key Policy Stats

Get Dne Rule

Get Dne Rule State

Get Dne Rule Stats

Get Dne Rules

Get Dne Rules By Key Policy

Get Dne Section

Get Dne Section State

Get Dne Section With Rules

Get Effective IP Address Members

Get Effective Logical Port Members

Get Effective Logical Switch Members

Get Error Resolver Info

Get Exclude List

Get Fabric Node Modules

Get Fabric Node State

Get Feature Stack Configuration

Get Firewall Stats

Get Forwarding Path

Get Heatmap Transport Zone Status

Get Host Switch Profile

Get Ipfix Config

Get Ipfix Obs Points

Get License

Get License By Key

Get Licenses

Get Logical Port

Get Logical Port Operational Status

Get Logical Port State

Get Logical Port Statistics

Get Logical Port Status Summary

Get Logical Router Forwarding Table

Get Logical Router Forwarding Table In Csv Format

Get Logical Router Port Arp Table

Get Logical Router Port Arp Table In Csv Format

Get Logical Router Port Statistics

Get Logical Router Port Statistics Summary

Get Logical Router Route Table

Get Logical Router Route Table In Csv Format

Get Logical Router Routing Table

Get Logical Router Routing Table In Csv Format

Get Logical Router Status

Get Logical Switch

Get Logical Switch Mac Table

Get Logical Switch Mac Table In Csv Format

Get Logical Switch State

Get Logical Switch Statistics

Get Logical Switch Status

Get Logical Switch Status Summary

Get Logical Switch Vtep Table

Get Logical Switch Vtep Table In Csv Format

Get MAC Addresses

Get Nat Rule

Get Nat Statistics Per Logical Router

Get Nat Statistics Per Rule

Get Nat Statistics Per Transport Node

Get Node Mandatory Access Control

Get Node Mandatory Access Control Report

Get Nodes

Get Nodes Summary

Get Normalizations

Get Port Mirroring Session

Get Realization State Barrier Config

Get Rule

Get Rule State

Get Rules

Get Section

Get Section State

Get Section With Rules

Get Switch Ipfix Config

Get Switching Profile

Get Switching Profile Status

Get Traceflow

Get Traceflow Observations

Get Transport Node

Get Transport Node Report

Get Transport Node Report For A Transport Zone

Get Transport Node State

Get Transport Node Status

Get Transport Zone

Get Transport Zone Profile

Get Transport Zone Status

Get Trust Objects

Get Tunnel

Get Upgrade History

Get Upgrade Plan Settings

Get Upgrade Status Summary

Get Upgrade Summary

Get Upgrade Unit

Get Upgrade Unit Aggregate Info

Get Upgrade Unit Group

Get Upgrade Unit Group Aggregate Info

Get Upgrade Unit Group Status

Get Upgrade Unit Groups

Get Upgrade Unit Groups Status

Get Upgrade Units

Get Upgrade Units Stats

Get Version Whitelist

Get Version Whitelist By Component

Import Certificate

Increment Realization State Barrier

List Bgp Neighbors

List Bridge Clusters

List Bridge Endpoints

List Cluster Node Configs

List Cluster Node Interfaces

List Cluster Profiles

List Dhcp Ip Pools

List Dhcp Profiles

List Dhcp Relay Profiles

List Dhcp Relays

List Dhcp Servers

List Dhcp Static Bindings

List Dne Key Managers

List Dne Key Policies

List Dne Sections

List Edge Clusters

List Error Resolver Info

List Fabric Node Interfaces

List Feature Stack Configurations

List Files

List Host Switch Profiles

List Ip Pool Allocations

List Ip Pools

List IP Prefix Lists

List IP Sets

List Ipfix Config

List Logical Ports

List Logical Router Ports

List Logical Routers

List Logical Switches

List Logical Switches By State

List MAC Sets

List Metadata Proxy

List Nat Rules

List Neighbor Properties

List Node Capabilities

List Node Interfaces

List Node Logs

List Node Network Routes

List Node Processes

List Node Services

List Node Syslog Exporters

List Node Users

List Nodes

List NS Groups

List NS Service Groups

List NS Services

List Port Mirroring Session

List Remote Transport Node Status

List Route Maps

List Sections

List Service Profiles

List Services

List Static Hop Bfd Peers

List Static Routes

List Switching Profiles

List Tasks

List Traceflows

List Transport Node Status

List Transport Node Status For Transport Zone

List Transport Nodes

List Transport Nodes By State

List Transport Zone Profiles

List Transport Zones

List Vifs

List Virtual Machines

List VNI Pools

Pause Upgrade

Perform Host Node Upgrade Action

Perform Node Action

Post Node Syslog Exporter

Query Tunnels

Re Process Logical Router

Read Advertise Rule List

Read Advertisement Config

Read Appliance Management Service

Read Appliance Management Service Status

Read Asnyc Task Response

Read Authentication Policy Properties

Read Bgp Config

Read Bgp Neighbor

Read Cluster Config

Read Cluster Node Config

Read Cluster Node Interface

Read Cluster Node Interface Statistics

Read Cluster Node Status

Read Cluster Nodes Aggregate Status

Read Cluster Status

Read Debug Info

Read Dhcp Ip Pool

Read Dhcp Profile

Read Dhcp Relay

Read Dhcp Relay Profile

Read Dhcp Server

Read Dhcp Static Binding

Read Edge Cluster

Read Fabric Node Interface

Read Fabric Node Interface Statistics

Read File

Read File Properties

Read File Thumbprint

Read Ip Pool

Read IP Prefix List

Read IP Set

Read Logical Router

Read Logical Router Port

Read MAC Set

Read Metadata Proxy

Read Neighbor Properties

Read Network Interface Statistics

Read Network Properties

Read Node

Read Node Interface

Read Node Log

Read Node Log Data

Read Node Name Servers

Read Node Network Route

Read Node Process

Read Node Properties

Read Node Search Domains

Read Node Status

Read Node Support Bundle

Read Node Syslog Exporter

Read Node User

Read Nodes Status

Read NS Group

Read NS Service

Read NS Service Group

Read NSX Message Bus Service

Read NSX Message Bus Service Status

Read Nsx Upgrade Agent Service

Read Nsx Upgrade Agent Service Status

Read NTP Service

Read NTP Service Status

Read Proton Service

Read Proton Service Status

Read Proxy Service

Read Proxy Service Status

Read Rabbit MQ Service

Read Rabbit MQ Service Status

Read Redistribution Config

Read Redistribution Rule List

Read Repository Service

Read Repository Service Status

Read Route Map

Read Routing Bfd Config

Read Routing Config

Read Service

Read Service Profile

Read SNMP Service

Read SNMP Service Status

Read SSH Service

Read SSH Service Status

Read Static Hop Bfd Peer

Read Static Route

Read Syslog Service

Read Syslog Service Status

Read Task Properties

Read Task Result

Read VNI Pool

Register Batch Request

Remove MAC Address

Remove Member

Remove User

Reorder Upgrade Unit

Reorder Upgrade Unit Group

Replace Edge Cluster Member Transport Node

Request Onetime Backup

Request Onetime Inventory Summary

Reset Aggregation Service Feature Stack Configuration

Reset Default Dne Key Policy To System Default

Reset Proton Service Logging Level Action

Reset Upgrade Plan

Resolve Error

Restart Inventory Sync

Restart Or Shutdown Node

Resync Transport Node

Revise Dne Rule

Revise Dne Section

Revise Dne Section With Rules

Revise Rule

Revise Section

Revise Section With Rules

Revoke Dne Key Policy

Revoke Missing Cluster Node Config

Rotate Dne Key Policy

Self Sign Certificate

Set Node Mandatory Access Control

Start Upgrade

Trigger Uc Upgrade

Un Set Password On Bgp Neighbor

Update Advertise Rule List

Update Advertisement Config

Update Aggregation Service Global Config

Update Authentication Policy Properties

Update Bgp Config

Update Bgp Neighbor

Update Bridge Cluster

Update Bridge Endpoint

Update Cluster Profile

Update Crl

Update Dhcp Ip Pool

Update Dhcp Profile

Update Dhcp Relay

Update Dhcp Relay Profile

Update Dhcp Server

Update Dhcp Static Binding

Update Dne Key Manager

Update Dne Key Policy

Update Dne Rule

Update Dne Section

Update Dne Section With Rules

Update Edge Cluster

Update Exclude List

Update Feature Stack Configuration

Update File

Update Host Switch Profile

Update Ip Pool

Update IP Prefix List

Update IP Set

Update Ipfix Config

Update License

Update Logical Port

Update Logical Router

Update Logical Router Port

Update Logical Switch

Update MAC Set

Update Metadata Proxy

Update Nat Rule

Update Node

Update Node Interface

Update Node Name Servers

Update Node Properties

Update Node Search Domains

Update Node User

Update NS Group

Update NS Service

Update NS Service Group

Update NTP Service

Update Port Mirroring Session

Update Proton Service

Update Proxy Service

Update Realization State Barrier Config

Update Redistribution Config

Update Redistribution Rule List

Update Repository Service

Update Route Map

Update Routing Bfd Config

Update Routing Config

Update Rule

Update Section

Update Section With Rules

Update Service

Update Service Profile

Update SNMP Service

Update SSH Service

Update Static Hop Bfd Peer

Update Static Route

Update Switch Ipfix Config

Update Switching Profile

Update Transport Node

Update Transport Zone

Update Transport Zone Profile

Update Upgrade Plan Settings

Update Upgrade Unit Group

Update User

Update Version Whitelist

Update Virtual Machine Tags

Update VNI Pool

Upload CA Signed Cert

Upload Upgrade Bundle

Verify Port Mirroring Session