NSX API Operations Index
All available NSX API Operations
Aaa
POST
Create Registration Token
Create registration access token
POST
Create Role Binding
Assign roles to User or Group
DELETE
Delete Registration Token
Delete registration access token
DELETE
Delete Role Binding
Delete user/group's roles assignment
GET
Get All Role Bindings
Get all users and groups with their roles
GET
Get All Roles Info
Get information about all roles
GET
Get Current User Info
Get information about logged-in user. The permissions parameter of the NsxRole has been deprecated.
GET
Get Group Vidm Search Result
Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API.
GET
Get Registration Token
Get registration access token
GET
Get Role Binding
Get user/group's role information
GET
Get Role Info
Get role information
GET
Get User Vidm Search Result
Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API.
POST
Get Vidm Search Result
Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. This is a non paginated API.
PUT
Update Role Binding
Update User or Group's roles
Aggregation Service
GET
Get Aggregation Service Global Config
Read global health performance monitoring configuration
GET
Get Feature Stack Configuration
Read health performance monitoring configuration for feature stack
GET
List Feature Stack Configurations
List all health performance monitoring feature stacks
POST
Reset Aggregation Service Feature Stack Configuration Reset Collection Frequency
Reset the data collection frequency configuration setting to the default values
PUT
Update Aggregation Service Global Config
Set the global configuration for aggregation service related data collection
PUT
Update Feature Stack Configuration
Update health performance monitoring configuration for feature stack
Api Services
GET
List Tasks
Get information about all tasks
GET
Read Authentication Policy Properties
Read node authentication policy configuration
GET
Read Task Properties
Get information about the specified task
GET
Read Task Result
Get the response of a task
POST
Register Batch Request
Register a Collection of API Calls at a Single End Point
PUT
Update Authentication Policy Properties
Update node authentication policy configuration
App Discovery
POST
Add App Profile
Adds a new app profile
DELETE
Delete App Discovery Session
Cancel and delete the application discovery session
DELETE
Delete App Profile
Delete App Profile
POST
Get Appdiscovery Result App Info And Host Vm In Csv Format Csv
Export app discovery results in CSV format
GET
Get App Discovery Session
Returns the status of the application discovery session and other details
GET
Get Appdiscovery Session App Profile Member Apps In Csv Format Csv
Export app profiles in CSV format for a given sessiom
GET
Get App Discovery Session App Profiles
application profiles in this application discovery session
GET
Get App Discovery Session Installed Apps
Returns the details of the installed apps for the app profile ID in that session
GET
Get App Discovery Session Ns Group Members
vms in the ns-group of the application discovery session
GET
Get App Discovery Session Ns Groups
ns-groups in this application discovery session
GET
Get App Discovery Sessions
Returns the list of the application discovery sessions available
GET
Get App Discovery Session Summary
Returns the summary of the application discovery session
GET
Get App Profile Details
Returns detail of the app profile
GET
Get App Profiles
Returns list of app profile IDs created
POST
Reclassify App Discovery Session
Re-classify a completed application discovery session.
POST
Start App Discovery Session
Starts the discovery of application discovery session
PUT
Update App Profile
Update AppProfile
Associations
GET
Get Associations
Get ResourceReference objects to which the given resource belongs to
Cluster
POST
Add Cluster Node VM
Deploy and register a cluster node VM
POST
Delete Auto Deployed Cluster Node VM Delete
Attempt to delete an auto-deployed cluster node VM
GET
List Cluster Node VM Deployment Requests
Returns info for all cluster node VM auto-deployment attempts
GET
Read Cluster Node VM Deployment Request
Returns info for a cluster-node VM auto-deployment attempt
GET
Read Cluster Node VM Deployment Status
Returns the status of the VM creation/deletion
Configs
GET
Get Inventory Config
Return inventory configuration
Dashboard
POST
Create View
Creates a new View.
POST
Create Widget Configuration
Creates a new Widget Configuration.
DELETE
Delete Widget Configuration
Delete Widget Configuration
DELETE
Delet View
Delete View
GET
Get View
Returns View Information
GET
Get Widget Configuration
Returns Widget Configuration Information
GET
List Views
Returns the Views based on query criteria defined in ViewQueryParameters.
GET
List Widget Configurations
Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.
PUT
Update View
Update View
PUT
Update Widget Configuration
Update Widget Configuration
Error Resolver
GET
Get Error Resolver Info
Fetches metadata about the given error_id
GET
List Error Resolver Info
Fetches a list of metadata for all the registered error resolvers
POST
Resolve Error Resolve Error
Resolves the error
Fabric
POST
Add Compute Manager
Register compute manager with NSX
POST
Add Node
Register and Install NSX Components on a Node
POST
Create Compute Collection Fabric Template
Create a compute collection fabric template
DELETE
Delete Compute Collection Fabric Template
Deletes compute collection fabric template
DELETE
Delete Compute Manager
Unregister a compute manager
DELETE
Delete Node
Delete a Node
GET
Get Compute Collection Fabric Template
Get compute collection fabric template by id
GET
Get Compute Manager State
Get the realized state of a compute manager
GET
Get Fabric Node Modules
Get the module details of a Fabric Node
GET
Get Fabric Node State
Get the Realized State of a Fabric Node.
POST
Host Prep Discovered Node Hostprep
Prepares discovered Node for NSX
GET
List Compute Collection Fabric Templates
Get compute collection fabric templates
GET
List Compute Collections
Return the List of Compute Collections
GET
List Compute Managers
Return the List of Compute managers
GET
List Discovered Nodes
Return the List of Discovered Nodes
GET
List Fabric Node Interfaces
List the specified node's Network Interfaces
GET
List Node Capabilities
Return the List of Capabilities of a Single Node
GET
List Nodes
Return the List of Nodes
GET
List Vifs
Return the List of Virtual Network Interfaces (VIFs)
GET
List Virtual Machines
Return the List of Virtual Machines
POST
Perform Host Node Upgrade Action Upgrade Infra
Perform a service deployment upgrade on a host node
POST
Perform Node Action
Perform an Action on Fabric Node
GET
Read Compute Collection
Return Compute Collection Information
GET
Read Compute Manager
Return compute manager Information
GET
Read Compute Manager Status
Return runtime status information for a compute manager
GET
Read Discovered Node
Return Discovered Node Information
GET
Read Fabric Node Interface
Read the node's Network Interface
GET
Read Fabric Node Interface Statistics
Read the NSX Manager's Network Interface Statistics
GET
Read Node
Return Node Information
GET
Read Nodes Status
Return Runtime Status Information for given Nodes
GET
Read Node Status
Return Runtime Status Information for a Node
POST
Restart Inventory Sync Restart Inventory Sync
Restart the inventory sync for the node if it is paused currently.
PUT
Update Compute Collection Fabric Template
Updates compute collection fabric template
PUT
Update Compute Manager
Update compute manager
PUT
Update Node
Update a Node
POST
Update Virtual Machine Tags Update Tags
Update tags applied to a virtual machine
Grouping Objects
POST
Add MAC Address
Add a MAC address to a MACSet
POST
Add Or Remove NS Group Expression
Add NSGroup expression
POST
Create IP Set
Create IPSet
POST
Create MAC Set
Create MACSet
POST
Create NS Group
Create NSGroup
POST
Create NS Service
Create NSService
POST
Create NS Service Group
Create NSServiceGroup
DELETE
Delete IP Set
Delete IPSet
DELETE
Delete MAC Set
Delete MACSet
DELETE
Delete NS Group
Delete NSGroup
DELETE
Delete NS Service
Delete NSService
DELETE
Delete NS Service Group
Delete NSServiceGroup
GET
Get Effective IP Address Members
Get Effective IPAddress translated from the NSGroup
GET
Get Effective Logical Port Members
Get Effective Logical Ports translated from the NSgroup
GET
Get Effective Logical Switch Members
Get Effective switch members translated from the NSGroup
GET
Get Effective Virtual Machine Members
Get Effective Virtual Machine members of the specified NSGroup.
GET
Get MAC Addresses
Get all MACAddresses in a MACSet
GET
Get Member Types
Get member types from NSGroup
GET
Get Service Associations
Get services to which the given nsgroup belongs to
GET
Get Unassociated Virtual Machines
Get the list of all the virtual machines that are not a part of any existing NSGroup.
GET
List IP Sets
List IPSets
GET
List MAC Sets
List MACSets
GET
List NS Groups
List NSGroups
GET
List NS Service Groups
List all NSServiceGroups
GET
List NS Services
List all NSServices
GET
Read IP Set
Read IPSet
GET
Read MAC Set
Read MACSet
GET
Read NS Group
Read NSGroup
GET
Read NS Service
Read NSService
GET
Read NS Service Group
Read NSServiceGroup
DELETE
Remove MAC Address
Remove a MAC address from given MACSet
PUT
Update IP Set
Update IPSet
PUT
Update MAC Set
Update MACSet
PUT
Update NS Group
Update NSGroup
PUT
Update NS Service
Update NSService
PUT
Update NS Service Group
Update NSServiceGroup
Licensing
POST
Accept EULA
Accept end user license agreement
POST
Accept Upgrade EULA
Accept end user license agreement
POST
Create License
Add a new license key
DELETE
Delete License
Deprecated. Remove a license identified by the license-key
POST
Delete License Key Delete
Remove a license
GET
Get EULA Acceptance
Return the acceptance status of end user license agreement
GET
Get EULA Content
Return the content of end user license agreement
GET
Get License
Deprecated. Return the Enterprise License
GET
Get License By Key
Deprecated. Get license properties for license identified by the license-key
GET
Get Licenses
Get all licenses
GET
Get License Usage Report
Get usage report of all registered modules
GET
Get License Usage Report In Csv Format Csv
Get usage report of all registred modules in CSV format
GET
Get Upgrade EULA Acceptance
Return the acceptance status of end user license agreement
GET
Get Upgrade EULA Content
Return the content of end user license agreement
PUT
Update License
Deprecated. Assign an Updated Enterprise License Key
Logical Routing And Services
POST
Add Bgp Neighbor
Add a new BGP Neighbor on a Logical Router
POST
Add IP Prefix List
Add IPPrefixList on a Logical Router
POST
Add Nat Rule
Add a NAT rule in a specific logical router
POST
Add Route Map
Add RouteMap on a Logical Router
POST
Add Static Route
Add Static Routes on a Logical Router
POST
Create BGP Community List
Create a new BGP community list on a Logical Router
POST
Create Dhcp Relay
Create a DHCP Relay Service
POST
Create Dhcp Relay Profile
Create a DHCP Relay Profile
POST
Create Logical Router
Create a Logical Router
POST
Create Logical Router Port
Create a Logical Router Port
POST
Create Service
Create a Logical Router Service
POST
Create Service Profile
Create a Service Profile
POST
Create Static Hop Bfd Peer
Create a static hop BFD peer
DELETE
Delete BGP Community List
Delete a specific BGP community list from a Logical Router
DELETE
Delete Bgp Neighbor
Delete a specific BGP Neighbor on a Logical Router
DELETE
Delete Dhcp Relay
Delete a DHCP Relay Service
DELETE
Delete Dhcp Relay Profile
Delete a DHCP Relay Profile
DELETE
Delete IP Prefix List
Delete a specific IPPrefixList on a Logical Router
DELETE
Delete Logical Router
Delete a Logical Router
DELETE
Delete Logical Router Port
Delete a Logical Router Port
DELETE
Delete Nat Rule
Delete a specific NAT rule from a logical router
DELETE
Delete Route Map
Delete a specific RouteMap on a Logical Router
DELETE
Delete Service
Delete a Logical Router Service
DELETE
Delete Service Profile
Delete a Service Profile
DELETE
Delete Static Hop Bfd Peer
Delete a specified static route BFD peer cofigured on a specified logical router
DELETE
Delete Static Route
Delete a specific Static Route on a Logical Router
GET
Get Bgp Neighbors Status
Get the status of all the BGP neighbors for the Logical Router of the given id
GET
Get Logical Router Forwarding Table
Get FIB table on a specified node for a logical router
GET
Get Logical Router Forwarding Table In Csv Format Csv
Get FIB table on a specified node for a logical router
GET
Get Logical Router Port Arp Table
Get the ARP table for the Logical Router Port of the given id
GET
Get Logical Router Port Arp Table In Csv Format Csv
Get the ARP table for the Logical Router Port of the given id
GET
Get Logical Router Port Statistics
Get the statistics of a specified logical router port on all or a specified node
GET
Get Logical Router Port Statistics Summary
Get the statistics summary of a specified logical router port
GET
Get Logical Router Route Table
Get route table on a given node for a logical router
GET
Get Logical Router Route Table In Csv Format Csv
Get route table on a node for a logical router
GET
Get Logical Router Routing Table
Get RIB table on a specified node for a logical router
GET
Get Logical Router Routing Table In Csv Format Csv
Get RIB table on a specified node for a logical router
GET
Get Logical Router Status
Get the status for the Logical Router of the given id
GET
Get Nat Rule
Get a specific NAT rule from a given logical router
GET
Get Nat Statistics Per Logical Router
Get the statistics of all rules of the logical router
GET
Get Nat Statistics Per Rule
Get the statistics of a specified logical router NAT Rule
GET
Get Nat Statistics Per Transport Node
Get statistics for all logical router NAT rules on a transport node
GET
List BGP Community Lists
Paginated list of BGP community lists on a Logical Router
GET
List Bgp Neighbors
Paginated list of BGP Neighbors on a Logical Router
GET
List Dhcp Relay Profiles
List All DHCP Relay Profiles
GET
List Dhcp Relays
List all DHCP Relay Services
GET
List IP Prefix Lists
Paginated List of IPPrefixLists
GET
List Logical Router Ports
List Logical Router Ports
GET
List Logical Routers
List Logical Routers
GET
List Nat Rules
List NAT rules of the logical router
GET
List Route Maps
Paginated List of RouteMaps
GET
List Service Profiles
List All Service Profiles
GET
List Services
List all Logical Router Services
GET
List Static Hop Bfd Peers
List static routes BFD Peers
GET
List Static Routes
Paginated List of Static Routes
GET
Read Advertisement Config
Read the Advertisement Configuration on a Logical Router
GET
Read Advertise Rule List
Read the Advertisement Rules on a Logical Router
GET
Read BGP Community List
Read a specific BGP community list from a Logical Router
GET
Read Bgp Config
Read the BGP Configuration on a Logical Router
GET
Read Bgp Neighbor
Read a specific BGP Neighbor on a Logical Router
GET
Read Bgp Neighbor With Password Show Sensitive Data
Read a specific BGP Neighbor with password on a Logical Router
GET
Read Debug Info Text
Read the debug information for the logical router
GET
Read Dhcp Relay
Read a DHCP Relay Service
GET
Read Dhcp Relay Profile
Read a DHCP Relay Profile
GET
Read IP Prefix List
Get a specific IPPrefixList on a Logical Router
GET
Read Logical Router
Read Logical Router
GET
Read Logical Router Port
Read Logical Router Port
GET
Read Redistribution Config
Read the Redistribution Configuration on a Logical Router
GET
Read Redistribution Rule List
Read All the Redistribution Rules on a Logical Router
GET
Read Route Map
Get a specific RouteMap on a Logical Router
GET
Read Routing Bfd Config
Read the Routing BFD Configuration
GET
Read Routing Config
Read the Routing Configuration
GET
Read Service
Read a Logical Router Service
GET
Read Service Profile
Read a Service Profile
GET
Read Static Hop Bfd Peer
Read a static route BFD peer
GET
Read Static Route
Get a specific Static Route on a Logical Router
POST
Re Process Logical Router Reprocess
Reprocesses a logical router configuration and publish updates to controller
POST
Un Set Password On Bgp Neighbor
Unset/Delete password property on specific BGP Neighbor on Logical Router
PUT
Update Advertisement Config
Update the Advertisement Configuration on a Logical Router
PUT
Update Advertise Rule List
Update the Advertisement Rules on a Logical Router
PUT
Update BGP Community List
Update a specific BGP community list from a Logical Router
PUT
Update Bgp Config
Update the BGP Configuration on a Logical Router
PUT
Update Bgp Neighbor
Update a specific BGP Neighbor on a Logical Router
PUT
Update Dhcp Relay
Update a DHCP Relay Service
PUT
Update Dhcp Relay Profile
Update a DHCP Relay Profile
PUT
Update IP Prefix List
Update a specific IPPrefixList on a Logical Router
PUT
Update Logical Router
Update a Logical Router
PUT
Update Logical Router Port
Update a Logical Router Port
PUT
Update Nat Rule
Update a specific NAT rule from a given logical router
PUT
Update Redistribution Config
Update the Redistribution Configuration on a Logical Router
PUT
Update Redistribution Rule List
Update All the Redistribution Rules on a Logical Router
PUT
Update Route Map
Update a specific RouteMap on a Logical Router
PUT
Update Routing Bfd Config
Update the BFD Configuration for BFD peers for routing
PUT
Update Routing Config
Update the Routing Configuration
PUT
Update Service
Update a Logical Router Service
PUT
Update Service Profile
Update a Service Profile
PUT
Update Static Hop Bfd Peer
Update a static route BFD peer
PUT
Update Static Route
Update a specific Static Route Rule on a Logical Router
Logical Switching
POST
Create Logical Port
Create a Logical Port
POST
Create Logical Switch
Create a Logical Switch
POST
Create Switching Profile
Create a Switching Profile
DELETE
Delete Logical Port
Delete a Logical Port
DELETE
Delete Logical Switch
Delete a Logical Switch
DELETE
Delete Switching Profile
Delete a Switching Profile
GET
Get Logical Port
Get Information About a Logical Port
GET
Get Logical Port Mac Table
Get MAC table of a logical port with a given port id (lport-id)
GET
Get Logical Port Mac Table In Csv Format Csv
Get MAC table of a logical port with a given port id (lport-id)
GET
Get Logical Port Operational Status
Get Operational Status for Logical Port of a Given Port ID (lport-id)
GET
Get Logical Port State
Get realized state & location of a logical port
GET
Get Logical Port Statistics
Get Statistics for Logical Port of a Given Port ID (lport-id)
GET
Get Logical Port Status Summary
Get Operational Status Summary of All Logical Ports in the System
GET
Get Logical Switch
Get Logical Switch associated with the provided id (lswitch-id)
GET
Get Logical Switch Mac Table
Get MAC Table for Logical Switch of the Given ID (lswitch-id)
GET
Get Logical Switch Mac Table In Csv Format Csv
Get MAC Table for Logical Switch of the Given ID (lswitch-id)
GET
Get Logical Switch State
Get the realized state associated with provided logical switch id
GET
Get Logical Switch Statistics
Get Statistics for Logical Switch of the Given ID (lswitch-id)
GET
Get Logical Switch Status
Get Logical Switch runtime status info for a given logical switch
GET
Get Logical Switch Status Summary
Get Status Summary of All Logical Switches in the System
GET
Get Logical Switch Vtep Table
Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id)
GET
Get Logical Switch Vtep Table In Csv Format Csv
Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id)
GET
Get Switching Profile
Get Switching Profile by ID
GET
Get Switching Profile Status
Get Counts of Ports and Switches Using This Switching Profile
GET
List Logical Ports
List All Logical Ports
GET
List Logical Switches
List all Logical Switches
GET
List Logical Switches By State
List logical switches by realized state
GET
List Switching Profiles
List Switching Profiles
PUT
Update Logical Port
Update a Logical Port
PUT
Update Logical Switch
Update a Logical Switch
PUT
Update Switching Profile
Update a Switching Profile
Network Transport
POST
Create Bridge Cluster
Create a Bridge Cluster
POST
Create Bridge Endpoint
Create a Bridge Endpoint
POST
Create Bridge Endpoint Profile
Create a Bridge Endpoint Profile
POST
Create Cluster Profile
Create a Cluster Profile
POST
Create Compute Collection Transport Node Template
Create transport node template for compute collection.
POST
Create Edge Cluster
Create Edge Cluster
POST
Create Host Switch Profile
Create a Hostswitch Profile
POST
Create Network Migration Spec
Create a template of network migration specification.
POST
Create Transport Node
Create a Transport Node
POST
Create Transport Zone
Create a Transport Zone
POST
Create Transport Zone Profile
Create a transport zone Profile
DELETE
Delete Bridge Cluster
Delete a Bridge Cluster
DELETE
Delete Bridge Endpoint
Delete a Bridge Endpoint
DELETE
Delete Bridge Endpoint Profile
Delete a Bridge Endpoint Profile
DELETE
Delete Cluster Profile
Delete a cluster profile
DELETE
Delete Compute Collection Transport Node Template
Delete a compute collection transport node template
DELETE
Delete Edge Cluster
Delete Edge Cluster
DELETE
Delete Host Switch Profile
Delete a Hostswitch Profile
DELETE
Delete Network Migration Spec
Delete a network migration specification template
DELETE
Delete Transport Node
Delete a Transport Node
DELETE
Delete Transport Zone
Delete a Transport Zone
DELETE
Delete Transport Zone Profile
Delete a transport zone Profile
GET
Get Bridge Cluster
Get Information about a bridge cluster
GET
Get Bridge Cluster Status
Returns status of a specified Bridge Cluster
GET
Get Bridge Endpoint
Get Information about a bridge endpoint
GET
Get Bridge Endpoint Profile
Get Information about a bridge endpoint Profile
GET
Get Bridge Endpoint Statistics
Returns statistics of a specified Bridge Endpoint
GET
Get Bridge Endpoint Status
Returns status of a specified Bridge Endpoint
GET
Get Cluster Profile
Get cluster profile by Id
GET
Get Compute Collection Transport Node Template
Get compute collection transportnode template by id
GET
Get Compute Collection Transport Node Template State
Get compute collection transportnode template application states
GET
Get Host Switch Profile
Get a Hostswitch Profile by ID
GET
Get Network Migration Spec
Get network migration specification template by id.
GET
Get Transport Node
Get a Transport Node
GET
Get Transport Node State
Get a Transport Node's State
GET
Get Transport Zone
Get a Transport Zone
GET
Get Transport Zone Profile
Get transport zone profile by identifier
GET
Get Transport Zone Status
Get a Transport Zone's Current Runtime Status Information
GET
List Bridge Clusters
List All Bridge Clusters
GET
List Bridge Endpoint Profiles
List All Bridge Endpoint Profiles
GET
List Bridge Endpoints
List All Bridge Endpoints
GET
List Cluster Profiles
List Cluster Profiles
GET
List Compute Collection Transport Node Templates
List compute collection transportnode templates
GET
List Edge Clusters
List Edge Clusters
GET
List Host Switch Profiles
List Hostswitch Profiles
GET
List Neighbor Properties
List LLDP Neighbor Properties
GET
List Network Migration Specs
List all network migration specification templates.
GET
List Transport Nodes
List Transport Nodes
GET
List Transport Nodes By State
List transport nodes by realized state
GET
List Transport Zone Profiles
List transport zone profiles
GET
List Transport Zones
List Transport Zones
GET
Read Edge Cluster
Read Edge Cluster
GET
Read Neighbor Properties
Read LLDP Neighbor Properties
POST
Replace Edge Cluster Member Transport Node Replace Transport Node
Replace the transport node in the specified member of the edge-cluster
POST
Resync Transport Node Resync Host Config
Resync a Transport Node
PUT
Update Bridge Cluster
Update a Bridge Cluster
PUT
Update Bridge Endpoint
Update a Bridge Endpoint
PUT
Update Bridge Endpoint Profile
Update a Bridge Endpoint Profile
PUT
Update Cluster Profile
Update a cluster profile
PUT
Update Compute Collection Transport Node Template
Update compute collection transportnode template
PUT
Update Edge Cluster
Update Edge Cluster
PUT
Update Host Switch Profile
Update a Hostswitch Profile
PUT
Update Network Migration Spec
Update a template of network migration specification.
PUT
Update Transport Node
Update a Transport Node
POST
Update Transport Node Maintenance Mode
Update transport node maintenance mode
PUT
Update Transport Zone
Update a Transport Zone
PUT
Update Transport Zone Profile
Update a transport zone profile
Normalization
GET
Get Normalizations
Get normalizations based on the query parameters
Nsx Component Administration
POST
Add Certificate Import
Add a New Certificate
POST
Add Cluster Node
Add a Node to the Cluster
POST
Add Crl Import
Add a New Certificate Revocation List
POST
Add Node User Ssh Key Add Ssh Key
Add SSH public key to authorized_keys file for node user
POST
Advance Cluster Restore Advance
Advance any suspended restore operation
POST
Cancel Appliance Management Task Cancel
Cancel specified task
POST
Cancel Cluster Restore Cancel
Cancel any running restore operation
GET
Check Rabbit MQ Management Port
Check if RabbitMQ management port is enabled or not
POST
Clear Cluster Certificate Clear Cluster Certificate
Clear the cluster certificate
GET
Collect Alarms
Collect alarms from all NSX nodes
POST
Collect Audit Logs
Collect audit logs from registered manager nodes
POST
Collect Support Bundles Collect
Collect support bundles from registered cluster and fabric nodes
PUT
Configure Backup Config
Configure backup
PUT
Configure Restore Config
Configure Restore SFTP server credentials
POST
Copy From Remote File Copy From Remote File
Copy a remote file to the file store
POST
Copy To Remote File Copy To Remote File
Copy file in the file store to a remote file store
POST
Create Appliance Management Service Action Restart
Restart the node management service
POST
Create Cluster Boot Manager Service Action Restart
Restart, start or stop the cluster boot manager service
POST
Create Cluster Boot Manager Service Action Start
Restart, start or stop the cluster boot manager service
POST
Create Cluster Boot Manager Service Action Stop
Restart, start or stop the cluster boot manager service
POST
Create Cminventory Service Action Restart
Restart, start or stop the manager service
POST
Create Cminventory Service Action Start
Restart, start or stop the manager service
POST
Create Cminventory Service Action Stop
Restart, start or stop the manager service
POST
Create Datastore Service Action Restart
Restart, start or stop the datastore service process
POST
Create Datastore Service Action Start
Restart, start or stop the datastore service process
POST
Create Datastore Service Action Stop
Restart, start or stop the datastore service process
POST
Create File
Upload a file to the file store
POST
Create Liagent Service Action Restart
Restart, start or stop the liagent service
POST
Create Liagent Service Action Start
Restart, start or stop the liagent service
POST
Create Liagent Service Action Stop
Restart, start or stop the liagent service
POST
Create Node Network Route
Create node network route
POST
Create NSX Message Bus Service Action Restart
Restart, start or stop the NSX Message Bus service
POST
Create NSX Message Bus Service Action Start
Restart, start or stop the NSX Message Bus service
POST
Create NSX Message Bus Service Action Stop
Restart, start or stop the NSX Message Bus service
POST
Create Nsx Ui Service Service Action Restart
Restart, Start and Stop the ui service
POST
Create Nsx Ui Service Service Action Start
Restart, Start and Stop the ui service
POST
Create Nsx Ui Service Service Action Stop
Restart, Start and Stop the ui service
POST
Create Nsx Upgrade Agent Service Action Restart
Restart, start or stop the NSX upgrade agent service
POST
Create Nsx Upgrade Agent Service Action Start
Restart, start or stop the NSX upgrade agent service
POST
Create Nsx Upgrade Agent Service Action Stop
Restart, start or stop the NSX upgrade agent service
POST
Create NTP Service Action Restart
Restart, start or stop the NTP service
POST
Create NTP Service Action Start
Restart, start or stop the NTP service
POST
Create NTP Service Action Stop
Restart, start or stop the NTP service
POST
Create Phonehome Coordinator Service Action Restart
Restart, start or stop Telemetry service
POST
Create Phonehome Coordinator Service Action Start
Restart, start or stop Telemetry service
POST
Create Phonehome Coordinator Service Action Stop
Restart, start or stop Telemetry service
POST
Create Proton Service Action Restart
Restart, start or stop the service
POST
Create Proton Service Action Start
Restart, start or stop the service
POST
Create Proton Service Action Stop
Restart, start or stop the service
POST
Create Proxy Service Action Restart
Restart the http service
POST
Create Proxy Service Action Start
Start the http service
POST
Create Proxy Service Action Stop
Stop the http service
POST
Create Proxy Service Apply Certificate Action Apply Certificate
Update http service certificate
POST
Create Rabbit MQ Service Action Restart
Restart, start or stop the Rabbit MQ service
POST
Create Rabbit MQ Service Action Start
Restart, start or stop the Rabbit MQ service
POST
Create Rabbit MQ Service Action Stop
Restart, start or stop the Rabbit MQ service
POST
Create Remote Directory Create Remote Directory
Create directory in remote file server
POST
Create Repository Service Action Restart
Restart, start or stop the NSX install-upgrade service
POST
Create Repository Service Action Start
Restart, start or stop the NSX install-upgrade service
POST
Create Repository Service Action Stop
Restart, start or stop the NSX install-upgrade service
POST
Create Search Service Action Restart
Restart, start or stop the NSX Search service
POST
Create Search Service Action Start
Restart, start or stop the NSX Search service
POST
Create Search Service Action Stop
Restart, start or stop the NSX Search service
POST
Create SNMP Service Action Restart
Restart, start or stop the SNMP service
POST
Create SNMP Service Action Start
Restart, start or stop the SNMP service
POST
Create SNMP Service Action Stop
Restart, start or stop the SNMP service
POST
Create SSH Service Action Restart
Restart, start or stop the ssh service
POST
Create SSH Service Action Start
Restart, start or stop the ssh service
POST
Create SSH Service Action Stop
Restart, start or stop the ssh service
POST
Create SSH Service Remove Host Fingerprint Action Remove Host Fingerprint
Remove a host's fingerprint from known hosts file
POST
Create Syslog Service Action Restart
Restart, start or stop the syslog service
POST
Create Syslog Service Action Start
Restart, start or stop the syslog service
POST
Create Syslog Service Action Stop
Restart, start or stop the syslog service
DELETE
Delete Appliance Management Task
Delete task
DELETE
Delete Certificate
Delete Certificate for the Given Certificate ID
DELETE
Delete Cluster Node Config
Remove a Node from the Cluster
DELETE
Delete Crl
Delete a CRL
DELETE
Delete Csr
Delete a CSR
DELETE
Delete File
Delete file
DELETE
Delete Node Network Route
Delete node network route
DELETE
Delete Node Syslog Exporter
Delete node syslog exporter
POST
Delete Node User Ssh Key Remove Ssh Key
Remove SSH public key from authorized_keys file for node user
DELETE
Delete Principal Identity
Delete a principal identity
DELETE
DELETE Rabbit MQ Management Port
Delete RabbitMQ management port
POST
Generate Csr
Generate a New Certificate Signing Request
GET
Get Backup Config
Get backup configuration
GET
Get Backup History
Get backup history
GET
Get Backup Status
Get backup status
GET
Get Certificate
Show Certificate Data for the Given Certificate ID
GET
Get Certificates
Return All the User-Facing Components' Certificates
GET
Get Cluster Certificate Id
Read cluster certificate ID
GET
Get Crl
Show CRL Data for the Given CRL ID
GET
Get Crls
Return All Added CRLs
GET
Get Csr
Show CSR Data for the Given CSR ID
GET
Get Csr Pem
Get CSR PEM File for the Given CSR ID
GET
Get Csrs
Return All the Generated CSRs
GET
Get Node Mandatory Access Control
Gets the enable status for Mandatory Access Control
GET
Get Node Mandatory Access Control Report
Get the report for Mandatory Access Control
GET
Get Node Mode
NodeMode
GET
Get Principal Identities
Return the list of principal identities
GET
Get Principal Identity
Get a Principal Identity
GET
Get Restore Config
Get Restore configuration
POST
Get Ssh Fingerprint Of Server Retrieve Ssh Fingerprint
Get ssh fingerprint of remote(backup) server
GET
Get Trust Objects
Return the Properties of a Trust Manager
POST
Import Certificate Import
Import a Certificate Associated with an Approved CSR
POST
Initiate Cluster Restore Start
Initiate a restore operation
DELETE
Invoke Delete Cluster Central API
Invoke DELETE request on target cluster node
DELETE
Invoke Delete Fabric Central API
Invoke DELETE request on target fabric node
GET
Invoke Get Cluster Central API
Invoke GET request on target cluster node
GET
Invoke Get Fabric Central API
Invoke GET request on target fabric node
POST
Invoke Post Cluster Central API
Invoke POST request on target cluster node
POST
Invoke Post Fabric Central API
Invoke POST request on target fabric node
PUT
Invoke Put Cluster Central API
Invoke PUT request on target cluster node
PUT
Invoke Put Fabric Central API
Invoke PUT request on target fabric node
GET
List Appliance Management Tasks
List appliance management tasks
GET
List Cluster Backup Timestamps
List timestamps of all available Cluster Backups.
GET
List Cluster Node Configs
List Cluster Node Configurations
GET
List Cluster Node Interfaces
List the specified node's Network Interfaces
GET
List Files
List node files
GET
List Node Interfaces
List the NSX Manager's Network Interfaces
GET
List Node Network Routes
List node network routes
GET
List Node Processes
List node processes
GET
List Node Services
List node services
GET
List Node Syslog Exporters
List node syslog exporters
GET
List Node Users
List node users
GET
List Node User Ssh Keys
List SSH keys from authorized_keys file for node user
GET
List Restore Instruction Resources
List resources for a given instruction, to be shown to/executed by users.
POST
Post Node Syslog Exporter
Add node syslog exporter
GET
Query Cluster Restore Status
Query Restore Request Status
GET
Read Appliance Management Service
Read appliance management service properties
GET
Read Appliance Management Service Status
Read appliance management service status
GET
Read Appliance Management Task Properties
Read task properties
GET
Read Appliance Node Status
Read node status
GET
Read Asnyc Appliance Management Task Response
Read asynchronous task response
GET
Read Auth Provider Vidm
Read AAA provider vIDM properties
GET
Read Auth Provider Vidm Status
Read AAA provider vIDM status
GET
Read Cluster Boot Manager Service
Read cluster boot manager service properties
GET
Read Cluster Boot Manager Service Status
Read cluster boot manager service status
GET
Read Cluster Config
Read Cluster Configuration
GET
Read Cluster Node Config
Read Cluster Node Configuration
GET
Read Cluster Node Interface
Read the node's Network Interface
GET
Read Cluster Node Interface Statistics
Read the NSX Manager/Controller's Network Interface Statistics
GET
Read Cluster Nodes Aggregate Status
Read Cluster Status
GET
Read Cluster Node Status
Read Cluster Node Status
GET
Read Cluster Status
Read Cluster Status
GET
Read Cminventory Service
Read cm inventory service properties
GET
Read Cminventory Service Status
Read manager service status
GET
Read Datastore Service
Read datastore service properties
GET
Read Datastore Service Status
Read datastore service status
GET
Read File
Read file contents
GET
Read File Properties
Read file properties
GET
Read File Thumbprint
Read file thumbprint
GET
Read Liagent Service
Read liagent service properties
GET
Read Liagent Service Status
Read liagent service status
GET
Read Management Config
Read NSX Management nodes global configuration.
GET
Read Network Interface Statistics
Read the NSX Manager's Network Interface Statistics
GET
Read Network Properties
Read network configuration properties
GET
Read Node Interface
Read the NSX Manager's Network Interface
GET
Read Node Name Servers
Read the NSX Manager's Name Servers
GET
Read Node Network Route
Read node network route
GET
Read Node Process
Read node process
GET
Read Node Properties
Read node properties
GET
Read Node Search Domains
Read the NSX Manager's Search Domains
GET
Read Node Support Bundle
Read node support bundle
GET
Read Node Syslog Exporter
Read node syslog exporter
GET
Read Node User
Read node user
GET
Read Node Version
Read node version
GET
Read NSX Message Bus Service
Read NSX Message Bus service properties
GET
Read NSX Message Bus Service Status
Read NSX Message Bus service status
GET
Read Nsx Ui Service Service
Read ui service properties
GET
Read Nsx Ui Service Service Status
Read ui service status
GET
Read Nsx Upgrade Agent Service
Read NSX upgrade Agent service properties
GET
Read Nsx Upgrade Agent Service Status
Read Nsx upgrade agent service status
GET
Read NTP Service
Read NTP service properties
GET
Read NTP Service Status
Read NTP service status
GET
Read Phonehome Coordinator Service
Read Telemetry service properties
GET
Read Phonehome Coordinator Service Status
Read Telemetry service status
GET
Read Proton Service
Read service properties
GET
Read Proton Service Status
Read service status
GET
Read Proxy Service
Read http service properties
GET
Read Proxy Service Status
Read http service status
GET
Read Rabbit MQ Service
Read Rabbit MQ service properties
GET
Read Rabbit MQ Service Status
Read Rabbit MQ service status
GET
Read Repository Service
Read NSX install-upgrade service properties
GET
Read Repository Service Status
Read NSX install-upgrade service status
GET
Read Search Service
Read NSX Search service properties
GET
Read Search Service Status
Read NSX Search service status
GET
Read SNMP Service
Read SNMP service properties
GET
Read SNMP Service Status
Read SNMP service status
GET
Read SSH Service
Read ssh service properties
GET
Read SSH Service Status
Read ssh service status
GET
Read Syslog Service
Read syslog service properties
GET
Read Syslog Service Status
Read syslog service status
POST
Register Principal Identity
Register a name-certificate combination.
POST
Request Onetime Backup Backup To Remote
Request one-time backup
POST
Request Onetime Inventory Summary Summarize Inventory To Remote
Request one-time inventory summary.
POST
Reset Proton Service Logging Level Action Reset Manager Logging Levels
Reset the logging levels to default values
POST
Restart Or Shutdown Node Restart
Restart or shutdown node
POST
Restart Or Shutdown Node Shutdown
Restart or shutdown node
POST
Retry Cluster Restore Retry
Retry any failed restore operation
POST
Revoke Missing Cluster Node Config Revoke Missing Nodes
Revoke Missing Nodes from the Cluster
POST
Self Sign Certificate Self Sign
Self-Sign the CSR
POST
Set Cluster Certificate Set Cluster Certificate
Set the cluster certificate
PUT
Set Node Mandatory Access Control
Enable or disable Mandatory Access Control
POST
Set Rabbit MQ Management Port
Set RabbitMQ management port
POST
Suspend Cluster Restore Suspend
Suspend any running restore operation
PUT
Update Auth Provider Vidm
Update AAA provider vIDM properties
PUT
Update Cluster Config
Update Cluster Configuration
PUT
Update Crl
Update CRL for the Given CRL ID
PUT
Update File
Replace file contents
PUT
Update Management Config
Update NSX Management nodes global configuration
PUT
Update Node Interface
Update the NSX Manager's Network Interface
PUT
Update Node Name Servers
Update the NSX Manager's Name Servers
PUT
Update Node Properties
Update node properties
PUT
Update Node Search Domains
Update the NSX Manager's Search Domains
PUT
Update Node User
Update node user
PUT
Update NTP Service
Update NTP service properties
POST
Update Principal Identity Certificate Update Certificate
Update a Principal Identity's certificate
PUT
Update Proton Service
Update service properties
PUT
Update Proxy Service
Update http service properties
PUT
Update Repository Service
Update NSX install-upgrade service properties
PUT
Update SNMP Service
Update SNMP service properties
PUT
Update SSH Service
Update ssh service properties
Operations
POST
Create Ipfix Collector Config
Create a new IPFIX collector configuration
POST
Create Ipfix Config
Create a new IPFIX configuration
DELETE
Delete Ipfix Collector Config
Delete an existing IPFIX collector configuration
DELETE
Delete Ipfix Config
Delete an existing IPFIX configuration
GET
Get Ipfix Collector Config
Get an existing IPFIX collector configuration
GET
Get Ipfix Config
Get an existing IPFIX configuration
GET
List Ipfix Collector Config
List IPFIX collector configurations
GET
List Ipfix Config
List IPFIX configuration
PUT
Update Ipfix Collector Config
Update an existing IPFIX collector configuration
PUT
Update Ipfix Config
Update an existing IPFIX configuration
Pool Management
POST
Allocate Or Release From Ip Block Subnet
Allocate or Release an IP Address from a Ip Subnet
POST
Allocate Or Release From Ip Pool
Allocate or Release an IP Address from a Pool
POST
Create Ip Block
Create a new IP address block.
POST
Create Ip Block Subnet
Create subnet of specified size within an IP block
POST
Create Ip Pool
Create an IP Pool
DELETE
Delete Ip Block
Delete an IP Address Block
DELETE
Delete Ip Block Subnet
Delete subnet within an IP block
DELETE
Delete Ip Pool
Delete an IP Pool
GET
List Ip Blocks
Returns list of configured IP address blocks.
GET
List Ip Block Subnets
List subnets within an IP block
GET
List Ip Pool Allocations
List IP Pool Allocations
GET
List Ip Pools
List IP Pools
GET
List Mac Pools
List MAC Pools
GET
List VNI Pools
List VNI Pools
GET
List Vtep Label Pools
List virtual tunnel endpoint Label Pools
GET
Read Ip Block
Get IP address block information.
GET
Read Ip Block Subnet
Get the subnet within an IP block
GET
Read Ip Pool
Read IP Pool
GET
Read Mac Pool
Read MAC Pool
GET
Read VNI Pool
Read VNI Pool
GET
Read Vtep Label Pool
Read a virtual tunnel endpoint label pool
PUT
Update Ip Block
Update an IP Address Block
PUT
Update Ip Pool
Update an IP Pool
PUT
Update VNI Pool
Update a VNI Pool
Realization
GET
Get Current Barrier
Gets the current barrier number
GET
Get Realization State Barrier Config
Gets the realization state barrier configuration
POST
Increment Realization State Barrier Increment
Increments the barrier count by 1
PUT
Update Realization State Barrier Config
Updates the barrier configuration
Services
POST
Add Member Add Member
Add a new object in the exclude list
POST
Add Rule In Section
Add a Single Rule in a Section
POST
Add Rules In Section Create Multiple
Add Multiple Rules in a Section
POST
Add Section
Create a New Empty Section
POST
Add Section With Rules Create With Rules
Create a Section with Rules
POST
Add Service Insertion Rule In Section
Add a Single Rule in a Section
POST
Add Service Insertion Rules In Section Create Multiple
Add Multiple Rules in a Section
POST
Add Service Insertion Section
Create a New Empty Section
POST
Add Service Insertion Section With Rules Create With Rules
Create a Section with Rules
POST
Add Service Insertion Service
Create a Service-Insertion Service
POST
Add Service Instance
Add a Service Instance for a specified Service.
POST
Check Member If Exists Check If Exists
Check if the object a member of the exclude list
POST
Create Dhcp Ip Pool
Create an IP pool for a DHCP server
POST
Create Dhcp Profile
Create a DHCP server profile
POST
Create Dhcp Server
Create a DHCP server
POST
Create Dhcp Static Binding
Create a static binding for a DHCP server
POST
Create Dns Forwader
Create a dns forwader
POST
Create Load Balancer Application Profile
Create a load balancer application profile
POST
Create Load Balancer Client Ssl Profile
Create a load balancer client-ssl profile
POST
Create Load Balancer Monitor
Create a load balancer monitor
POST
Create Load Balancer Persistence Profile
Create a load balancer persistence profile
POST
Create Load Balancer Pool
Create a load balancer pool
POST
Create Load Balancer Rule
Create a load balancer rule
POST
Create Load Balancer Server Ssl Profile
Create a load balancer server-ssl profile
POST
Create Load Balancer Service
Create a load balancer service
POST
Create Load Balancer Tcp Profile
Create a load balancer TCP profile
POST
Create Load Balancer Virtual Server
Create a load balancer virtual server
POST
Create Metadata Proxy
Create a metadata proxy
DELETE
Delete Dhcp Ip Pool
Delete a DHCP server's IP pool
DELETE
Delete Dhcp Profile
Delete a DHCP server profile
DELETE
Delete Dhcp Server
Delete a DHCP server
DELETE
Delete Dhcp Static Binding
Delete a static binding
DELETE
Delete Dns Forwarder
Delete a specific dns forwarder
DELETE
Delete Load Balancer Application Profile
Delete a load balancer application profile
DELETE
Delete Load Balancer Client Ssl Profile
Delete a load balancer client-ssl profile
DELETE
Delete Load Balancer Monitor
Delete a load balancer monitor
DELETE
Delete Load Balancer Persistence Profile
Delete a load balancer persistence profile
DELETE
Delete Load Balancer Pool
Delete a load balancer pool
DELETE
Delete Load Balancer Rule
Delete a load balancer rule
DELETE
Delete Load Balancer Server Ssl Profile
Delete a load balancer server-ssl profile
DELETE
Delete Load Balancer Service
Delete a load balancer service
DELETE
Delete Load Balancer Tcp Profile
Delete a load balancer TCP profile
DELETE
Delete Load Balancer Virtual Server
Delete a load balancer virtual server
DELETE
Delete Metadata Proxy
Delete a metadata proxy
DELETE
Delete Rule
Delete an Existing Rule
DELETE
Delete Section
Delete an Existing Section and Its Associated Rules
DELETE
Delete Service Insertion Rule
Delete an Existing Rule
DELETE
Delete Service Insertion Section
Delete an Existing Section and Its Associated Rules
DELETE
Delete Service Insertion Service
Delete an existing Service and the Service-Instance associated with it.
DELETE
Delete Service Instance
Delete an existing Service-Instance
POST
Delete Service V Ms Delete
Remove service VMs either as standalone or HA
POST
Deploy Service V Ms Deploy
Deploy and set up service VMs either as standalone or HA
POST
Disable Firewall On Target Resource Disable Firewall
Disable firewall on target resource in dfw context
POST
Enable Firewall On Target Resource Enable Firewall
Enable firewall on target resource in dfw context
GET
Get Dhcp Lease Info
Get lease info of a given dhcp server id
GET
Get Dhcp Statistics
Get DHCP statistics with given dhcp server id
GET
Get Dhcp Status
Get DHCP service status with given dhcp server id
GET
Get Exclude List
Get list of entities in exclude list
GET
Get Firewall Section Stats
Get Firewall section level statistics section
GET
Get Firewall Stats
Get Firewall rule level statistics
GET
Get Firewall Status
Get firewall global status for dfw context
GET
Get Firewall Status On Target Resource
Get firewall status for target resource in dfw context
GET
Get Load Balancer Pool Statistics
Get the statistics of load balancer pool
GET
Get Load Balancer Pool Status
Get the status of load balancer pool
GET
Get Load Balancer Service Statistics
Get the statistics of load balancer service
GET
Get Load Balancer Service Status
Get the status of the given load balancer service
GET
Get Load Balancer Virtual Server Statistics
Get the statistics of the given load balancer virtual server
GET
Get Load Balancer Virtual Server Status
Get the status of the load balancer virtual server
GET
Get Metadata Proxy Statistics
Get Metadata Proxy statistics with given proxy id
GET
Get Metadata Proxy Status
Get Metadata Proxy status with given proxy id and attached logical switch.
GET
Get Rule
Read an Existing Rule
GET
Get Rules
Get All the Rules for a Section
GET
Get Rule State
Get the Realized State of a Firewall Rule
GET
Get Runtime Interface Operational Status
Get operational status for an interface
GET
Get Runtime Interface Statistics
Get statistics for a given interface identified by the interface index
GET
Get Section
Get an Existing Section
GET
Get Sections Summary
Get the summary of sections in the firewall configuration.
GET
Get Section State
Get the Realized State of a Firewall Section
POST
Get Section With Rules List With Rules
Get an Existing Section, Including Rules
GET
Get Service Insertion Rule
Read an Existing Rule
GET
Get Service Insertion Rules
Get All the Rules for a Section
GET
Get Service Insertion Section
Get an Existing Section
POST
Get Service Insertion Section With Rules List With Rules
Get an Existing Section, Including Rules
GET
Get Service Insertion Service
Get an existing Service
GET
Get Service Instance
Get Service-Instance for Service.
GET
List Dhcp Ip Pools
Get a paginated list of a DHCP server's IP pools
GET
List Dhcp Profiles
Get a paginated list of DHCP server profiles
GET
List Dhcp Servers
Get a paginated list of DHCP servers
GET
List Dhcp Static Bindings
Get a paginated list of a DHCP server's static bindings
GET
List Dns Forwaders
Get a paginated list of dns forwarders
GET
List Firewall Status
List all firewall status for supported contexts
GET
List Instance Runtimes
Returns list of instance runtimes of service VM being deployed
GET
List Load Balancer Application Profiles
Retrieve a paginated list of load balancer application profiles
GET
List Load Balancer Client Ssl Profiles
Retrieve a paginated list of load balancer client-ssl profiles
GET
List Load Balancer Monitors
Retrieve a paginated list of load balancer monitors
GET
List Load Balancer Persistence Profiles
Retrieve a paginated list of load balancer persistence profiles
GET
List Load Balancer Pools
Retrieve a paginated list of load balancer pools
GET
List Load Balancer Pool Statistics
Get the statistics list of load balancer pools
GET
List Load Balancer Pool Statuses
Get the status list of load balancer pools
GET
List Load Balancer Rules
Retrieve a paginated list of load balancer rules
GET
List Load Balancer Server Ssl Profiles
Retrieve a paginated list of load balancer server-ssl profiles
GET
List Load Balancer Services
Retrieve a paginated list of load balancer services
GET
List Load Balancer Ssl Ciphers And Protocols
Retrieve a list of supported SSL ciphers and protocols
GET
List Load Balancer Tcp Profiles
Retrieve a paginated list of load balancer TCP profiles
GET
List Load Balancer Virtual Servers
Retrieve a paginated list of load balancer virtual servers
GET
List Load Balancer Virtual Servers Statistics
Get the statistics list of virtual servers
GET
List Load Balancer Virtual Server Statuses
Get the status list of virtual servers in given load balancer service
GET
List Metadata Proxy
Get a paginated list of metadata proxies
GET
List Sections
List All Firewall Sections
GET
List Service Insertion Sections
List All Service Insertion Sections
GET
List Service Insertion Services
List all Service-Insertion Services.
GET
List Service Instances For Service
Get all Service-Instances for Service.
POST
Perform Pool Member Action
Add, remove, or modify load balancer pool members
GET
Read Dhcp Ip Pool
Get a DHCP server's IP pool with the specified pool ID
GET
Read Dhcp Profile
Get a DHCP server profile
GET
Read Dhcp Server
Get a DHCP server
GET
Read Dhcp Static Binding
Get a DHCP server's static binding with the specified binding ID
GET
Read Dns Forwader
Retrieve a dns forwarder
GET
Read Firewall Rule
Read an Existing Rule
GET
Read Load Balancer Application Profile
Retrieve a load balancer application profile
GET
Read Load Balancer Client Ssl Profile
Retrieve a load balancer client-ssl profile
GET
Read Load Balancer Monitor
Retrieve a load balancer monitor
GET
Read Load Balancer Persistence Profile
Retrieve a load balancer persistence profile
GET
Read Load Balancer Pool
Retrieve a load balancer pool
GET
Read Load Balancer Rule
Retrieve a load balancer rule
GET
Read Load Balancer Server Ssl Profile
Retrieve a load balancer server-ssl profile
GET
Read Load Balancer Service
Retrieve a load balancer service
GET
Read Load Balancer Service Debug Info
Read the debug information of the load balancer service
GET
Read Load Balancer Tcp Profile
Retrieve a load balancer TCP profile
GET
Read Load Balancer Virtual Server
Retrieve a load balancer virtual server
GET
Read Metadata Proxy
Get a metadata proxy
POST
Remove Member Remove Member
Remove an existing object from the exclude list
POST
Reset Firewall Rule Stats Reset
Reset firewall rule statistics
POST
Revise Rule Revise
Update an Existing Rule and Reorder the Rule
POST
Revise Section Revise
Update an Existing Section, Including Its Position
POST
Revise Section With Rules Revise With Rules
Update an Existing Section with Rules
POST
Revise Service Insertion Rule Revise
Update an Existing Rule and Reorder the Rule
POST
Revise Service Insertion Section Revise
Update an Existing Section, Including Its Position
POST
Revise Service Insertion Section With Rules Revise With Rules
Update an Existing Section with Rules
PUT
Update Dhcp Ip Pool
Update a DHCP server's IP pool
PUT
Update Dhcp Profile
Update a DHCP server profile
PUT
Update Dhcp Server
Update a DHCP server
PUT
Update Dhcp Static Binding
Update a DHCP server's static binding
PUT
Update Dns Forwarder
Update a specific dns forwarder
PUT
Update Exclude List
Modify exclude list
PUT
Update Firewall Status
Update global firewall status for dfw context
PUT
Update Load Balancer Application Profile
Update a load balancer application profile
PUT
Update Load Balancer Client Ssl Profile
Update a load balancer client-ssl profile
PUT
Update Load Balancer Monitor
Update a load balancer monitor
PUT
Update Load Balancer Persistence Profile
Update a load balancer persistence profile
PUT
Update Load Balancer Pool
Update a load balancer pool
PUT
Update Load Balancer Rule
Update a load balancer rule
PUT
Update Load Balancer Server Ssl Profile
Update a load balancer server-ssl profile
PUT
Update Load Balancer Service
Update a load balancer service
PUT
Update Load Balancer Tcp Profile
Update a load balancer TCP profile
PUT
Update Load Balancer Virtual Server
Update a load balancer virtual server
PUT
Update Metadata Proxy
Update a metadata proxy
PUT
Update Rule
Update an Existing Rule
PUT
Update Section
Update an Existing Section
POST
Update Section With Rules Update With Rules
Update an Existing Section, Including Its Rules
PUT
Update Service Insertion Rule
Update an Existing Rule
PUT
Update Service Insertion Section
Update an Existing Section
POST
Update Service Insertion Section With Rules Update With Rules
Update an Existing Section, Including Its Rules
PUT
Update Service Insertion Service
Update an existing Service
PUT
Update Service Instance
Update an existing Service-Instance.
POST
Upgrade Service V Ms Upgrade
Upgrade service VMs using newer version of OVF
Transport Entities
GET
Get Tunnel
Tunnel properties
GET
Query Tunnels
List of tunnels
Troubleshooting And Monitoring
POST
Create Packet Capture Session
Create an new packet capture session
POST
Create Port Mirroring Sessions
Create a mirror session
POST
Create Traceflow
Initiate a Traceflow Operation on the Specified Port
POST
Delete All Capture Sessions Delete
Delete all the packet capture sessions
POST
Delete Packet Capture Session Delete
Delete the packet capture session by session id.
DELETE
Delete Port Mirroring Session
Delete the mirror session
DELETE
Delete Traceflow
Delete the Traceflow round
GET
Get All Transport Nodes Status
Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.
GET
Get All Transport Zone Status
Get high-level summary of a transport zone. The service layer does not support source = realtime or cached.
GET
Get Forwarding Path
Get networking entities between two logical ports with VIF attachment
GET
Get Heatmap Transport Zone Status
Get high-level summary of a transport zone
GET
Get Ipfix Obs Points
Get the list of IPFIX observation points
GET
Get Pnic Statuses For Transport Node
Get high-level summary of a transport node
GET
Get Port Mirroring Session
Get the mirror session
GET
Get Switch Ipfix Config
Read global switch IPFIX export configuration
GET
Get Traceflow
Get the Traceflow round status and result summary
GET
Get Traceflow Observations
Get observations for the Traceflow round
GET
Get Transport Node Report
Creates a status report of transport nodes of all the transport zones
GET
Get Transport Node Report For A Transport Zone
Creates a status report of transport nodes in a transport zone
GET
Get Transport Node Status
Read status of a transport node
GET
List Node Logs
List available node logs
GET
List Packet Capture Sessions
Get the information of all packet capture sessions
GET
List Port Mirroring Session
List all mirror sessions
GET
List Remote Transport Node Status
Read status of all transport nodes with tunnel connections to transport node
GET
List Traceflows
List all Traceflow rounds
GET
List Transport Node Status
Read status of all the transport nodes
GET
List Transport Node Status For Transport Zone
Read status of transport nodes in a transport zone
GET
Read Node Log
Read node log properties
GET
Read Node Log Data
Read node log contents
GET
Read Packet Capture Session
Get the status of packet capture session
POST
Terminate Packet Capture Session Terminate
Terminate the packet capture session by session id
PUT
Update Port Mirroring Session
Update the mirror session
PUT
Update Switch Ipfix Config
Update global switch IPFIX export configuration
POST
Verify Port Mirroring Session Verify
Verify whether the mirror session is still valid
Unified Nsgroup Profile Management
POST
Create Ipfix Collector Upm Profile
Create a new IPFIX collector profile
POST
Create Ipfix Upm Profile
Create a new IPFIX profile
DELETE
Delete Ipfix Collector Upm Profile
Delete an existing IPFIX collector profile
DELETE
Delete Ipfix Upm Profile
Delete an existing IPFIX profile
GET
Get Ipfix Collector Upm Profile
Get an existing IPFIX collector profile
GET
Get Ipfix Upm Profile
Get an existing IPFIX profile
GET
List Ipfix Collector Upm Profiles
List IPFIX Collector Profies
GET
List Ipfix Upm Profiles
List IPFIX Profies
PUT
Update Ipfix Collector Upm Profile
Update an existing IPFIX collector profile
PUT
Update Ipfix Upm Profile
Update an existing IPFIX profile
Upgrade
POST
Add Upgrade Units To Group Add Upgrade Units
Add upgrade units to specified upgrade unit group
POST
Continue Upgrade Continue
Continue upgrade
POST
Create Upgrade Unit Group
Create a group
DELETE
Delete Upgrade Unit Group
Delete the upgrade unit group
POST
Fetch Upgrade Bundle From Url
Fetch upgrade bundle from given url
GET
Get Nodes
Get list of nodes across all types
GET
Get Nodes Summary
Get summary of nodes
GET
Get Upgrade Bundle Info
Get uploaded upgrade bundle information
GET
Get Upgrade Bundle Upload Status
Get uploaded upgrade bundle upload status
GET
Get Upgrade History
Get upgrade history
GET
Get Upgrade Plan Settings
Get upgrade plan settings for the component
GET
Get Upgrade Status Summary
Get upgrade status summary
GET
Get Upgrade Summary
Get upgrade summary
GET
Get Upgrade Unit
Get a specific upgrade unit
GET
Get Upgrade Unit Aggregate Info
Get upgrade units aggregate-info
GET
Get Upgrade Unit Group
Return upgrade unit group information
GET
Get Upgrade Unit Group Aggregate Info
Return aggregate information of all upgrade unit groups
GET
Get Upgrade Unit Groups
Return information of all upgrade unit groups
GET
Get Upgrade Unit Groups Status
Get upgrade status for upgrade unit groups
GET
Get Upgrade Unit Group Status
Get upgrade status for group
GET
Get Upgrade Units
Get upgrade units
GET
Get Upgrade Units Stats
Get upgrade units stats
GET
Get Version Whitelist
Get the version whitelist
GET
Get Version Whitelist By Component
Get the version whitelist for the specified component
POST
Pause Upgrade Pause
Pause upgrade
POST
Reorder Upgrade Unit Group Reorder
Reorder upgrade unit group
POST
Reorder Upgrade Unit Reorder
Reorder an upgrade unit within the upgrade unit group
POST
Reset Upgrade Plan Reset
Reset upgrade plan to default plan
POST
Start Upgrade Start
Start upgrade
POST
Trigger Uc Upgrade Upgrade Uc
Upgrade the upgrade coordinator.
PUT
Update Upgrade Plan Settings
Update upgrade plan settings for the component
PUT
Update Upgrade Unit Group
Update the upgrade unit group
PUT
Update Version Whitelist
Update the version whitelist for the specified component type
POST
Upgrade Selected Units Upgrade Selected Units
Upgrade selected units
Vpn
POST
Create IP Sec VPNDPD Profile
Create dead peer detection (DPD) profile
POST
Create IP Sec VPNIKE Profile
Create custom internet key exchange (IKE) Profile
POST
Create IP Sec VPN Local Endpoint
Create custom local endpoint
POST
Create IP Sec VPN Peer End Point
Create custom peer endpoint
POST
Create IP Sec VPN Service
Create VPN service
POST
Create IP Sec VPN Session
Create new VPN session
POST
Create IP Sec VPN Tunnel Profile
Create custom IPSec tunnel profile
POST
Create L2 Vpn Service
Create L2VPN service
POST
Create L2 Vpn Session
Create L2VPN session
DELETE
Delete IP Sec VPNDPD Profile
Delete dead peer detection (DPD) profile
DELETE
Delete IP Sec VPNIKE Profile
Delete custom IKE Profile
DELETE
Delete IP Sec VPN Local Endpoint
Delete custom IPSec local endpoint
DELETE
Delete IP Sec VPN Peer Endpoint
Delete custom IPSec VPN peer endpoint
DELETE
Delete IP Sec VPN Service
Delete IPSec VPN service
DELETE
Delete IP Sec VPN Session
Delete IPSec VPN session
DELETE
Delete IP Sec VPN Tunnel Profile
Delete custom IPSecTunnelProfile
DELETE
Delete L2 Vpn Service
Delete a L2VPN service
DELETE
Delete L2 Vpn Session
Delete a L2VPN session
GET
Get IP Sec VPNDPD Profile
Get IPSec dead peer detection (DPD) profile
GET
Get IP Sec VPNIKE Profile
Get IKE Profile
GET
Get IP Sec VPNIKE Service
Cumulative statistics for one IKE service instance
GET
Get IP Sec VPNIKE Session Status
Get IPSec VPN IKE session status
GET
Get IP Sec VPN Local Endpoint
Get custom IPSec local endpoint
GET
Get IP Sec VPN Peer Endpoint
Get IPSec VPN peer endpoint
GET
Get IP Sec VPN Peer Endpoint With PSK Show Sensitive Data
Get IPSec VPN peer endpoint with PSK
GET
Get IP Sec VPN Service
Get IPSec VPN service
GET
Get IP Sec VPN Session
Fetch IPSec VPN session
GET
Get IP Sec VPN Session Statistics
Get IPSec VPN session statistics
GET
Get IP Sec VPN Session Summary
VPN session summary
GET
Get IP Sec VPN Tunnel Profile
Get IPSec tunnel profile
GET
Get L2 Vpn Service
Get L2VPN service
GET
Get L2 Vpn Session
Get a L2VPN session
GET
Get L2 Vpn Session Peer Codes
Get peer codes for the L2VpnSession
GET
Get L2VPN Session Remote Macs For LS
Get L2VPN session remote mac for logical switch
GET
Get L2VPN Session Statistics
Get L2VPN session statistics
GET
Get L2VPN Session Status
Get L2VPN session status
GET
Get L2VPN Session Summary
Get status summary of all existing L2VPN sessions.
GET
Get Peer Config
Get VPN configuration for the peer site
GET
List IP Sec VPNDPD Profiles
Get IPSec dead peer detection (DPD) profile list result
GET
List IP Sec VPNIKE Profiles
List IKE profiles
GET
List IP Sec VPN Local Endpoints
Get IPSec local endpoint list result
GET
List IP Sec VPN Peer Endpoints
Get IPSecVPNPeerEndpoint List Result
GET
List IP Sec VPN Services
Get IPSec VPN service list result
GET
List IP Sec VPN Sessions
Get IPSec VPN session list result
GET
List IP Sec VPN Tunnel Profiles
Get IPSecTunnelProfile List Result
GET
List L2 Vpn Services
Get all L2VPN services
GET
List L2 Vpn Sessions
Get all L2VPN sessions
PUT
Update IP Sec VPNDPD Profile
Edit IPSec dead peer detection (DPD) profile
PUT
Update IP Sec VPNIKE Profile
Edit custom IKE Profile
PUT
Update IP Sec VPN Local Endpoint
Edit custom IPSec local endpoint
PUT
Update IP Sec VPN Peer Endpoint
Edit custom IPSecPeerEndpoint
PUT
Update IP Sec VPN Service
Edit IPSec VPN service
PUT
Update IP Sec VPN Session
Edit IPSec VPN session
PUT
Update IP Sec VPN Tunnel Profile
Edit custom IPSecTunnelProfile
PUT
Update L2 Vpn Service
Edit a L2VPN service
PUT
Update L2 Vpn Session
Edit a L2VPN session
Telemetry
GET
Get Telemetry Agreement
Returns telemetry agreement information
GET
Get Telemetry Config
Returns the telemetry configuration
PUT
Update Telemetry Agreement
Set telemetry agreement information
PUT
Update Telemetry Config
Creates or updates the telemetry configuration